API ReferenceManagementAccess Keys
POST
/v1/mgmt/accesskey/search

Search access keys, using a valid management key.

This API endpoint allows administrators to search for details of existing access keys for a given array of tenants.

The response contains an array of details for the access keys returned by the search 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/search

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

tenantIdsarray<string>

textstring

sortarray<object>

Status codeDescription
200OK
curl -X POST "https://api.descope.com/v1/mgmt/accesskey/search" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <ProjectId:ManagementKey>" \
  -d '{
  "tenantIds": [
    "string"
  ],
  "text": "string",
  "sort": [
    {
      "field": "string",
      "desc": true
    }
  ]
}'

{
  "keys": [
    {
      "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

Load An Access Key

Next

Create Access Key