Search Management Keys | API Reference

Authorization

Descope Project ID and Management Key

AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Search management keys using another management key.

curl -X GET "https://api.descope.com/v1/mgmt/managementkey/search"

curl -X GET "https://api.descope.com/v1/mgmt/managementkey/search"

ResponseOK

{
  "keys": [
    {
      "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
    }
  ]
}

{  "keys": [    {      "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 {
keys?: ManagementKey[]
}
export interface ManagementKey {
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 {keys?: ManagementKey[]}export interface ManagementKey {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