Import 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

keys?array<ImportAccessKeyRequest>

Import an access key by providing its plaintext value, using a valid management key.

curl -X POST "https://api.descope.com/v1/mgmt/accesskey/import" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X POST "https://api.descope.com/v1/mgmt/accesskey/import" \  -H "Content-Type: application/json" \  -d '{}'

ResponseOK

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

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

TypeScript

export interface Response {
keys?: {
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 {keys?: {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?

Ask AI about this page