v1

latestOpenAPI 3.0.02026-07-24212113249.1 KB
Authentication

Authenticate a user

Get an authentication token

post/auth/sign-in

Headers

organizationstring required

The URL of the end-user web application

Request body

emailstring required

The email address associated with the account

passwordstring required

Password

Response

Successful resopnse

Example response

{
  "account": {
    "display_name": "John Doe",
    "username": "johndoe",
    "first_name": "John",
    "last_name": "Doe",
    "email": "John",
    "organization": "698kow9a3efc39a89a96l9wf",
    "roles": [
      [
        {
          "permissions": [
            {
              "subject": {
                "id": "896632c05f1a59b6d395b963",
                "fields": [
                  "name",
                  "address"
                ],
                "entity": "accountstatuses"
              }
            }
          ],
          "name": "DEFAULT-USER",
          "description": "This role allows user basic functionalities",
          "default": true
        }
      ]
    ],
    "is_admin": true,
    "is_tenant_user": true,
    "is_super_user": true
  }
}