Skip to main content
POST
/
v1
/
auth
/
login
Login with credentials
curl --request POST \
  --url https://{base_url}/v1/auth/login \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "password": "password123"
}
'
{
  "id": "<string>",
  "email": "<string>",
  "name": "<string>",
  "provider": "AccountToken",
  "given_name": "<string>",
  "family_name": "<string>",
  "users": [
    {
      "id": "<string>",
      "org_id": "<string>",
      "account_id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "state": "Active",
      "roles": [
        "AppGuest"
      ],
      "created_at": "<string>",
      "profile_picture": "<string>",
      "job_position_name": "<string>",
      "job_position_description": "<string>"
    }
  ],
  "roles": [
    "AppGuest"
  ]
}

Body

application/json

Login with email and password

email
string
required
password
string
required

Response

200 - application/json

Successful login

id
string
required
email
string
required
name
string
required
provider
enum<string>
required
Available options:
AccountToken,
UserToken,
AccountSession,
UserSession,
Credentials,
Mock,
Google,
Microsoft,
Confluence,
SharePoint
given_name
string
family_name
string
users
object[]
roles
enum<string>[]
Available options:
AppGuest,
AppMember,
AppAdmin,
AppOwner,
Basic,
Developer,
Admin,
SuperAdmin