Skip to main content

Authenticate an Admin API application

Use this example to authenticate an Admin API application and obtain the auth token required by later Administration API requests.

Submit the Admin API application's ID and shared secret to the authentication endpoint.

  • Method: POST
  • Path: /api/web/v1/adminapi/authenticate
  • Content type: application/json

Example request body​

Use the application ID and shared secret generated when the Admin API application was created:

{
  "applicationId": "d3737e0f-4d8e-431c-b1d8-cd17ad4d633d",
  "sharedSecret": "<admin-api-shared-secret>"
}

Example response body​

The endpoint returns an auth token when authentication succeeds:

{
  "authToken": "<admin-api-auth-token>",
  "expirationTime": "2026-08-14T19:07:50.328+0000",
  "creationTime": "2026-08-14T18:52:50.329+0000"
}

Include the returned authToken as a bearer token in subsequent Administration API requests:

Authorization: Bearer <admin-api-auth-token>

The token remains valid until expirationTime. Authenticate again after it expires. For the complete request schema and error responses, see Authenticate to an Admin API application.