POST
/v1/mgmt/accesskey/search

Authorization

AuthorizationRequiredBearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

application/jsonRequired
tenantIdsarray<string>
textstring
sortarray<object>
curl -X POST "https://api.descope.com/v1/mgmt/accesskey/search" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "tenantIds": [
      "string"
    ],
    "text": "string",
    "sort": [
      {
        "field": "string",
        "desc": true
      }
    ]
  }'

OK

{
  "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?

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>`

Create Access Key POST

### Create an access key, using a valid management key. This API endpoint allows administrators to create an access key. During the creation of the access key, you can set the name, expiration time, roles and tenant:role pairs to associated with the key. ### Next Steps Once you have the access key, you can utilize it to configure external items such as [SCIM](/api/scimmanagement/), or use it to [exchange for a JWT](/api/access-keys/exchange-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>`