Load An Access Key | API Reference | Descope Documentation

Authorization

Descope Project ID and Management Key

AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Query Parameters

id?string

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.

{
  "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": {
      "claim-name": "claim-value"
    },
    "editable": true,
    "description": "string",
    "permittedIps": [
      "string"
    ],
    "customAttributes": {
      "attribute-key": "attribute-value"
    }
  }
}

{  "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": {      "claim-name": "claim-value"    },    "editable": true,    "description": "string",    "permittedIps": [      "string"    ],    "customAttributes": {      "attribute-key": "attribute-value"    }  }}

TypeScript

export interface Response {
key?: {
id?: string
name?: string
roleNames?: string[]
keyTenants?: AssociatedTenantAK[]
status?: string
createdTime?: number
expireTime?: number
createdBy?: string
clientId?: string
boundUserId?: string
/**
 * Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans.
 */
customClaims?: {
[k: string]: string
}
editable?: boolean
description?: string
permittedIps?: string[]
/**
 * Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays.
 */
customAttributes?: {
[k: string]: string
}
}
}
export interface AssociatedTenantAK {
tenantId?: string
roleNames?: string[]
tenantName?: string
}

export interface Response {key?: {id?: stringname?: stringroleNames?: string[]keyTenants?: AssociatedTenantAK[]status?: stringcreatedTime?: numberexpireTime?: numbercreatedBy?: stringclientId?: stringboundUserId?: string/** * Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. */customClaims?: {[k: string]: string}editable?: booleandescription?: stringpermittedIps?: string[]/** * Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. */customAttributes?: {[k: string]: string}}}export interface AssociatedTenantAK {tenantId?: stringroleNames?: string[]tenantName?: string}

Was this helpful?

Authorization

Query Parameters

Load an access key, using a valid management key.

Next Steps

See also