Update Management Key | API Reference

Authorization

Descope Project ID and Management Key

AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Request Body

application/json

id?string

name?string

description?string

permittedIps?array<string>

string

status?string

Update a management key using another management key. All supported fields will be reset if not provided.

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

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

ResponseOK

{
  "key": {
    "id": "string",
    "name": "string",
    "description": "string",
    "status": "string",
    "createdTime": 0,
    "expireTime": 0,
    "permittedIps": [
      "string"
    ],
    "reBac": {
      "companyRoles": [
        "string"
      ],
      "projectRoles": [
        {
          "projectIds": [
            "string"
          ],
          "roles": [
            "string"
          ]
        }
      ],
      "tagRoles": [
        {
          "tags": [
            "string"
          ],
          "roles": [
            "string"
          ]
        }
      ]
    },
    "version": 0,
    "authzVersion": 0
  }
}

{  "key": {    "id": "string",    "name": "string",    "description": "string",    "status": "string",    "createdTime": 0,    "expireTime": 0,    "permittedIps": [      "string"    ],    "reBac": {      "companyRoles": [        "string"      ],      "projectRoles": [        {          "projectIds": [            "string"          ],          "roles": [            "string"          ]        }      ],      "tagRoles": [        {          "tags": [            "string"          ],          "roles": [            "string"          ]        }      ]    },    "version": 0,    "authzVersion": 0  }}

TypeScript

export interface Response {
key?: {
id?: string
name?: string
description?: string
status?: string
createdTime?: number
expireTime?: number
permittedIps?: string[]
reBac?: {
companyRoles?: string[]
projectRoles?: ManagementKeyProjectRole[]
tagRoles?: ManagementKeyTagRole[]
}
version?: number
authzVersion?: number
}
}
export interface ManagementKeyProjectRole {
projectIds?: string[]
roles?: string[]
}
/**
 * Management key
 */
export interface ManagementKeyTagRole {
tags?: string[]
roles?: string[]
}

export interface Response {key?: {id?: stringname?: stringdescription?: stringstatus?: stringcreatedTime?: numberexpireTime?: numberpermittedIps?: string[]reBac?: {companyRoles?: string[]projectRoles?: ManagementKeyProjectRole[]tagRoles?: ManagementKeyTagRole[]}version?: numberauthzVersion?: number}}export interface ManagementKeyProjectRole {projectIds?: string[]roles?: string[]}/** * Management key */export interface ManagementKeyTagRole {tags?: string[]roles?: string[]}

Was this helpful?

Ask AI about this page