API Reference: auth-login

Used to collect a token for a registered user.

URL : /api/v1/auth/login

Method : POST

Auth required : NO

Data constraints

{
    "username": "[valid email address or username]",
    "password": "[password in plain text]"
}

Data example

{
    "username": "administrator",
    "password": "abcd1234"
}

Success Response

Code : 200 OK

Content example

{
  "id": 1,
  "username": "administrator",
  "email": "alali@domain.com",
  "token": "...-...",
  "roles": [
    "_administrator_"
  ],
  "permissions": [
    "form-archive-file:edit",
    "form-archive-file:view",
    "form-core-samples:edit",
    "form-core-samples:view",
    "form-cores:edit",
    "form-cores:view",
    "form-hole:edit",
    "form-hole:view",
    "form-init-gas:edit",
    "form-init-gas:view",
    "form-init-temp:edit",
    "form-init-temp:view",
    "form-project-site-1:edit",
    "form-project-site-1:view",
    "form-section:edit",
    "form-section:view"
  ]
}

Error Response

Condition : If the 'username' and 'password' combination is wrong.

Code : 422 Unprocessable Entity

Content :

[
  {
    "field": "password",
    "message": "Login data is invalid"
  }
]