Skip to main content
POST
/
api
/
v1
/
auth
/
login
Log in
curl --request POST \
  --url https://api.main.apexscore.ai/api/v1/auth/login \
  --header 'Content-Type: application/json' \
  --data '{
  "username": "<string>",
  "password": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "token": "<string>",
  "organizations": "<string>",
  "password": "<string>",
  "last_login": "2023-11-07T05:31:56Z",
  "is_superuser": true,
  "is_staff": true,
  "is_active": true,
  "date_joined": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "email": "jsmith@example.com",
  "first_name": "<string>",
  "last_name": "<string>",
  "groups": [
    123
  ],
  "user_permissions": [
    123
  ]
}

Body

application/json
​
username
string
required
​
password
string
required

Response

201 - application/json
​
id
string<uuid>
required
​
token
string
required
​
organizations
string
required
​
password
string
required
Maximum length: 128
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
email
string<email>
required
Maximum length: 255
​
last_login
string<date-time> | null
​
is_superuser
boolean

Designates that this user has all permissions without explicitly assigning them.

​
is_staff
boolean

Designates whether the user can log into this admin site.

​
is_active
boolean

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

​
date_joined
string<date-time>
​
first_name
string | null
Maximum length: 50
​
last_name
string | null
Maximum length: 100
​
groups
integer[]

The groups this user belongs to. A user will get all permissions granted to each of their groups.

​
user_permissions
integer[]

Specific permissions for this user.