Skip to main content
Version: Current

Get Access Token

Overview​

Obtain an access token by signing in with your account credentials.

Endpoint​

POST /api/auth/login

Use the service origin described in Getting started. The path above already includes /api.

Authentication​

This operation uses the credentials or refresh token in the request body.

Request headers​

Accept: application/json
Content-Type: application/json

Request body​

ParameterTypeRequirementDescription
tenantNamestringSee notesTenant name for your deployment.
userNamestringRequiredUser name used to sign in or select tasks.
passwordstringRequiredAccount password.
clientIdstringRequiredClient identifier. Use browser for this login request.

Types reflect the example below. Unless marked required, field requirements, defaults, and validation limits need confirmation for your deployed version.

{
"tenantName": "example-tenant",
"userName": "sample-user",
"password": "REDACTED",
"clientId": "browser"
}

Request example​

The following example uses cURL in a POSIX shell. Replace example credentials and IDs before running it. Replace the AI Command Center origin with your deployment address.

curl --request POST \
--url 'https://command-center.example.com/api/auth/login' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"tenantName": "example-tenant",
"userName": "sample-user",
"password": "REDACTED",
"clientId": "browser"
}'

Response​

Successful status: 200 OK.

The following is an illustrative response with synthetic contact and credential values. Arrays are shortened to one representative item.

{
"accesstoken": "EXAMPLE_ACCESSTOKEN"
}

Use accesstoken as the Bearer token. This response does not document a refresh token or expiry field. Confirm token lifetime and sign-in renewal behavior with your administrator.

Response fields​

The table describes selected fields in the response. Types reflect the example; this is not an exhaustive schema or nullability contract.

FieldExample typeDescription
accesstokenstringAccess token to send in the Bearer authorization header.

Errors​

Endpoint-specific error statuses and response bodies are not yet documented. See Usage and troubleshooting for general handling guidance.