authentication

Generates an authentication token for API access.

This endpoint generates a time-sensitive authentication token, enabling secure access to the system's API.</br></br>Key features include:</br></br>- Clear success messaging: Returns a 200 success code with a confirmation message indicating the successful completion of the requested action.</br>- Comprehensive error handling: Returns 401 and 403 error codes with clear descriptions and resolution suggestions when requests fail.</br>- Seamless token generation: Facilitates the generation of an authentication token in-line with the appropriate schema, ensuring smooth and efficient organization.

post/auth/login

Request

Response

Token generated successfully.

access_tokenstring
fullnamestring
usernamestring
federated_user_idstring
expires_ininteger
token_typestring

Example response

{
  "access_token": "eyJhbGciOiJSUzI1NiJ9.eyJhY2NvdW50SWQiOjEwMDEsInNvdXJjZUlwIjoiMDowOjA6MDowOjA6MDoxIiwidXNlcklkIjoxMDAwLCJzdWIiOiJqZG9lIiwiaWF0IjoxNjg1NTM5MjE4LCJleHAiOjE2ODU1NDI4MTh9.CbDsDQlJLMqKTbPsE-hpq1x6KuGUkOehZsz_igevVQ1_7ccM-SQy4fAtJKOaTMGpKAyeJMjD-_z4GZWXqOR8lRoLbAmg2mDnCIjqf6MqdnK_tQ5QA3e3gFykM-AP0cITeehEvqHVZnKwGlZ4E2BMOVSZ8i3WC2Wk80XE6HLSj6qYeuanTxipSFF84C1nxUD0-AXbJ9rqhw74sECMJOtWkXyz33BUnTiroN8u1AwPa_TiI9sAwzRIxaNWHs-LsIAo6_hg_Hl2Z5ym7rq-hl08jKF-rpx1L4zwZgl4GvGLBSBs-hh2Ng8uuGmSp3pvbSsGw_BJ7RuvvLjORRX3o8UNIw",
  "fullname": "Bob Smith",
  "username": "bsmith",
  "federated_user_id": "12345678-0abb-4e69-b647-9001111bae11",
  "expires_in": 3600,
  "token_type": "bearer",
  "scopes": [
    {
      "admin": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.