API Reference/Management

Access Key Management

Overview

The Descope service supports access to an application utilizing the Descope authentication service via Access Keys. These keys are similar to API keys and allow for administrators to authenticate into their application using the Access Key. These access keys can late be exchanged for a session JWT. The Descope service offers API endpoints for managing Access Keys.

Use Cases

  1. Load An Access Key
  2. Search Access Keys
  3. Create Access Key
  4. Update Access Key
  5. Activate Access Key
  6. Deactivate Access Key
  7. Activate Access Keys in Batch
  8. Deactivate Access Keys in Batch
  9. Delete Access Keys In Batch
  10. Delete Access Key

Examples

Example - Create an access key and exchange it for a JWT

  1. Utilize the Create Access Key Endpoint and capture the generated key from the cleartext in the response.
  2. Utilize the generated key within the Exchange Access Key Endpoint to exchange the key for a JWT.

Example - Search and deactivate an access key

  1. Utilize the Search Access Keys Endpoint and review the response for the key you would like to deactivate
  2. Utilize the Deactivate Access Key Endpoint using the access key Id from step 1.
Was this helpful?

Delete a Custom Attributes POST

### Delete a custom attributes to configure on users within a project, using a valid management key. This API endpoint will delete a custom attribute within a project. ### See also - See [Custom Attributes](/manage/users#custom-user-attributes) for further details on custom user attributes - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. ### Endpoint Authentication Use authorization bearer header with the following format: `Authorization: Bearer <ProjectId:ManagementKey>`

Load An Access Key GET

### Load an access key, using a valid management key. This API endpoint allows administrators to load the details of an existing access key. The response contains details of the access key including associated roles and tenants as well as details of the key's creation, status, and expiration. ### Next Steps Once you have this data, you can utilize the response to [Update an access key](/api/management/access-keys/update-access-key), [Activate an access key](/api/management/access-keys/activate-access-key), [Deactivate an access key](/api/management/access-keys/deactivate-access-key), or [Delete an access key](/api/management/access-keys/delete-access-key). ### See also - See [Access Key Management](/access-keys) for further details on managing access keys. ### Endpoint Authentication Use authorization bearer header with the following format: `Authorization: Bearer <ProjectId:ManagementKey>`

On this page