API ReferenceAccess Keys (API Keys)
POST
/v1/auth/accesskey/exchange

Exchange API key for access token

This API Endpoint will take an API key for the project and provide an access token to be used for accessing the application. The session token JWT token will be valid for the configured Session Token Timeout, and its expiration time will be provided in the expiration field of the response object.

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<Project ID:Access Key\>

Try it

/v1/auth/accesskey/exchange

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

loginOptionsobject

Status codeDescription
200OK
curl -X POST "https://api.descope.com/v1/auth/accesskey/exchange" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <Project ID:Access Key>" \
  -d '{
  "loginOptions": {
    "customClaims": {}
  }
}'

{
  "keyId": "string",
  "sessionJwt": "string"
}

Was this helpful?

Previous

Reset Password

Next

Token Validation Key (V1)