login

Login Access Token Api Key

API key login, get a bearer token for future requests.

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

Include your API key in the x-api-key header.

post/api/v1/login/access-token/api-key

Request

  • The document declares no server URL.
  • Auth: APIKeyHeader (a scheme the document does not define)

Query parameters

account_namestring required

The name of the account to authenticate the API key against.

emailstring email required

The email address of the user in this account to authenticate.

createboolean

Whether to create the user if it doesn't exist. If set to false and the user with the email is not part of the account, the endpoint will return a 404. If set to true and the user does not exist, the endpoint will create the user and add them to the account. If set to true and the user exists, the endpoint will add the user to the 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.