Login For Access Token

Authenticate user and create access token with login history recording.

Request

Header Params

user-agent

User-Agent

optional

Any of

string

null

Body Params application/x-www-form-urlencoded

grant_type

Grant Type

optional

Any of

string

null

Match pattern:

password

username

string

Username

required

password

string

Password

required

scope

string

Scope

optional

Default:

client_id

Client Id

optional

Any of

string

null

client_secret

Client Secret

optional

Any of

string

null

Responses

🟢200OK

application/json

Successful Response

Body

access_token

string

Access Token

required

token_type

string

Token Type

required

expires_in

integer

Expires In

required

user_info

object (UserInfo)

required

integer

required

string

required

username

string

Username

required

role

string

Role

required

manager_id

Manager Id

optional

license

object (LicenseInfo)

required

Example:

{"expiry_date":"2024-12-31T23:59:59","is_trial":false,"license_type":"Standard","remaining_days":300,"total_admins":2,"total_users":10,"used_admins":1,"used_users":5}

license_type

string

License Type

required

expiry_date

string <date-time>

Expiry Date

required

total_users

integer

Total Users

required

used_users

integer

Used Users

required

total_admins

integer

Total Admins

required

used_admins

integer

Used Admins

required

is_trial

boolean

Is Trial

required

remaining_days

Remaining Days

optional

billing_cycle

optional

Example

{
  "access_token": "string",
  "token_type": "string",
  "expires_in": 0,
  "user_info": {
    "id": 0,
    "email": "string",
    "username": "string",
    "role": "string",
    "manager_id": 0
  },
  "license": {
    "expiry_date": "2024-12-31T23:59:59",
    "is_trial": false,
    "license_type": "Standard",
    "remaining_days": 300,
    "total_admins": 2,
    "total_users": 10,
    "used_admins": 1,
    "used_users": 5
  }
}

🟠422Parameter Error