Get Scope Claim Mapping | API Reference

POST

/v1/mgmt/scopeClaimMapping/get

Authorization

Descope Project ID and Management Key

AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Get the project-wide mapping of OIDC scopes to JWT claims. Returns an empty mapping when none has been configured.

curl -X POST "https://api.descope.com/v1/mgmt/scopeClaimMapping/get"

curl -X POST "https://api.descope.com/v1/mgmt/scopeClaimMapping/get"

ResponseOK

{
  "mappings": [
    {
      "scope": "string",
      "claims": {
        "property1": "string",
        "property2": "string"
      },
      "description": "string"
    }
  ]
}

{  "mappings": [    {      "scope": "string",      "claims": {        "property1": "string",        "property2": "string"      },      "description": "string"    }  ]}

TypeScript

export interface Response {
/**
 * Ordered list of scope→claims entries. When two entries set the same claim
 *  name, the entry appearing later in the list wins.
 */
mappings?: {
scope?: string
claims?: {
[k: string]: string
}
description?: string
}[]
}

export interface Response {/** * Ordered list of scope→claims entries. When two entries set the same claim *  name, the entry appearing later in the list wins. */mappings?: {scope?: stringclaims?: {[k: string]: string}description?: string}[]}

Was this helpful?