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.