v1

latestOpenAPI 3.0.12026-07-248498266.5 KB

Authentication

Create an Access Token

Use API credentials from the Dashboard to create an Access Token that has permission to use all Arcadia API endpoints. API access tokens are valid for one hour.

post/oauth2/token

Response

Successful response

access_tokenstring required

The access token that can be used to access the Arcadia API. This token should be included in the “Authorization” header in the format “Bearer ACCESS_TOKEN".

expires_ininteger required

The number of seconds until the access token expires. Defaults to 3600 seconds (one hour).

refresh_expires_ininteger required

If one is provided, indicates the number of seconds until the refresh token expires. Currently, the refresh token grant type is not supported, so this value will always be 0.

token_typestring required

Specifies the type of access token, per the OAuth2 spec. Always returns a value of “Bearer”, indicating the access token should be added to requests in the “Authorization” header in the format “Bearer ACCESS_TOKEN”.

not-before-policyinteger required

A timestamp that specifies the earliest time the access token is valid. A value of 0 means there is no restriction on when the token become valid, and can be used immediately.

scopestring required

The scope of the access token. This will always currently be “profile email”.

Example response

{
  "access_token": "foobar",
  "expires_in": 3600,
  "refresh_expires_in": 0,
  "token_type": "Bearer",
  "not-before-policy": 0,
  "scope": "profile email"
}