Signin

Authenticate a user

Request

Definition

POST /api/v1/signin

Headers

• Content-Type required

  application/json

Request body

{
  "password": "password",
  "username": "username"
}

Response

Status codes

Status code	Message
200	"You are successfully logged in"
401	"Invalid username or password"

Response body

Attributes

• data.token string

  Authentication token.

• data.user.id string

  User ID.

• data.user.username string

  Username.

• data.user.first_name string

  User's first name.

• data.user.last_name string

  User's last name.

• data.user.auth_type string

  Authentication type used by user.

• data.user.is_first_access boolean

  Indicates whether it is the user's first access.

• data.user.is_disabled boolean

  Indicates whether the user is disabled.

• data.user.password_updated_at string

  Date of the last password update.

• data.user.attrs_updated_at string

  Date of last attributes update.

• data.user.email string

  User's email.

• data.user.groups array<object>

  List of Groups which the user belongs to.

• data.user.inserted_at string

  Date of the user insertion.

Example

{
"data": {
    "token": "3IA-gbhGfw-MX3_JyHcCgMpmDHZwv1Tc43fwdbguUPM",
    "user": {
        "access_limits": null,
        "attrs_updated_at": "2024-01-17T13:11:22Z",
        "auth_type": "basic",
        "email": "user@seerbox",
        "first_name": null,
        "id": "64b16bad-cc5c-4654-bdcf-cc36fdd6a160",
        "inserted_at": "2024-01-17T13:11:22Z",
        "is_first_access": true,
        "last_name": null,
        "password_updated_at": "2024-01-17T13:11:22Z",
        "permissions": [],
        "username": "username"
    }
},
"message": "You are successfully logged in",
"status": "ok"
}