API ReferenceManagementAccess Keys
GET
/v1/mgmt/accesskey

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, Activate an access key, Deactivate an access key, or Delete an access key.

See also

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<ProjectId:ManagementKey\>

Try it

/v1/mgmt/accesskey

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

Query Parameters

idstring

Status codeDescription
200OK
curl -X GET "https://api.descope.com/v1/mgmt/accesskey?id=string" \
  -H "Authorization: Bearer <ProjectId:ManagementKey>"

{
  "key": {
    "id": "string",
    "name": "string",
    "roleNames": [
      "string"
    ],
    "keyTenants": [
      {
        "tenantId": "string",
        "roleNames": [
          "string"
        ],
        "tenantName": "string"
      }
    ],
    "status": "string",
    "createdTime": 0,
    "expireTime": 0,
    "createdBy": "string",
    "clientId": "string",
    "boundUserId": "string",
    "customClaims": {},
    "editable": true,
    "description": "string",
    "permittedIps": [
      "string"
    ]
  }
}

Was this helpful?

Previous

Access Key Management API Overview

Next

Search Access Keys