EN

Site Navigation

Your Account

Choose Language

Authentication

Authentication with the API is done using authorization tokens. However, most public API endpoints do not require a token, making it easy for users to get started without one. For scenarios where a token is required, it can be managed using the following endpoints. Authentication is performed by setting the authorization token in a header.

Examples of authenticating via the API can be found in our GitHub repository. Additionally, here is an example using curl: 

curl -H "Authorization: api AUTHTOKEN" \ 
     -H "X-App-Id: FEDCBA0987654321"

POST /user/token

Create an authorization token for an existing user account using the provided credentials.

POST /users/reset_password

Request a password reset for a given email. Given that the specified email address has an account, send a password reset link to the email address

POST /users

Register a new user account. You must be logged in as an Admin to create new user accounts on sites with public registration disabled. Limited to legacy API users who have been granted an app id.

DELETE /user/token

Log out the current user by deleting the authorization token.

POST /user/token/impersonate

Create an authorization token for the specified userid without specifying a password. Note: endpoint only accessible to authenticated admins.