login

Login Access Token

OAuth2-compatible token login, get a bearer token for future requests.

The bearer token must be included in the Authorization header of all future requests.

Note that access token authentication cannot be used to access user-specific resources such as user passwords and superuser status.

post/api/v1/login/access-token

Request

  • The document declares no server URL.
  • Auth: none declared

Query parameters

account_namestring nullable

The name of the account to validate that the user is authorized to access. If the user does not have access to this account, the endpoint will return a 403 even if the user is successfully authenticated. This is useful for third party applications which want users to be restricted to a particular account.

m2m_tokenstring nullable

A custom M2M access token in case one is needed to access resources in your environment. This is not relevant for cloud customers. It's only used for VPC deployments.

Response

Successful Response

access_tokenstring required
token_typestring required

Changes

No recorded changes to this operation across all 2 revisions of this API.