Skip to content

Authentication API

Endpoints to login with token-based authentication.

Login and get token

Request

Use the ID and password issued to you to login and generate and refresh/renew an access token. All REST API calls should pass this token to access authenticated services.

The access token is in SSO_TOKEN of the response header. Your token is valid for a limited time.

Security
SSO_TOKEN
Bodyapplication/json
userstring, <= 30 charactersrequired

API user ID.

passstring, <= 128 charactersrequired

Password.

orgstring, <= 30 charactersrequired

API user’s organization ID.

POST
/v2/sso/login
{ "user": "apiUserId", "pass": "This is a long password!", "org": "apiOrganizationId" }

Responses

Object with token expiry time. The access token is in SSO_TOKEN of the response header.

Headers
Bodyapplication/json
statusstring, <= 36 characters

Request status.

errorCodestring or null, <= 64 characters

Error code, if any.

responseTuplesobject or null

List of JSON objects with additional information on the response, if any.

expiryTimeinteger, (int64)

Expiry time of API session in milliseconds.

serverUTCTimeinteger, (int64)

Start time of API session in milliseconds.

Response
{ "status": "OK", "errorCode": null, "responseTuples": null, "expiryTime": 1665490480729, "serverUTCTime": 1665490420730 }