Skip to main content
POST
OAuth token endpoint

Body

application/json

OAuth token endpoint

username
string
required

The public identifier used to authenticate the API client.

Required string length: 8 - 128
password
string
required

The secret key used to authenticate the API client. Must be kept confidential and never exposed in client-side code or logs.

Required string length: 8 - 128
tenant
string
required

The unique tenant identifier that determines the target environment for authentication. Scopes the issued token to the resources of the specified tenant.

Required string length: 3 - 128
context
enum<string>
required

Defines the api clients type being authenticated. Determines the scope and permissions of the resulting token.

Available options:
apikey,
contract,
user,
client,
employee
Example:

"apikey"

Response

OAuth 2.0 token

access_token
string
required

Access token

refresh_token
string
required

Refresh token

token_type
string
required

Token type

expires_in
integer<int64>
required

Token expiration time. UNIX timestamp.