Create Access Key | API Reference | Descope Documentation

Authorization

Descope Project ID and Management Key

AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Request Body

application/json

name?string

expireTime?string

roleNames?array<string>

string

keyTenants?array<managementv1.AssociatedTenant>

userId?string

customClaims?object

Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans.

Example

{
  "claim-name": "claim-value"
}

description?string

permittedIps?array<string>

string

customAttributes?object

Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays.

Example

{
  "attribute-key": "attribute-value"
}

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, or use it to exchange for a JWT.

{
  "cleartext": "string",
  "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"
    }
  }
}

{  "cleartext": "string",  "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 {
cleartext?: string
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 {cleartext?: stringkey?: {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

Request Body

Create an access key, using a valid management key.

Next Steps

See also