API ReferenceManagementScope Claim Mapping
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"
{  "mappings": [    {      "scope": "string",      "claims": {        "property1": "string",        "property2": "string"      },      "description": "string",      "claimTargets": {        "property1": {          "tokens": [            "string"          ]        },        "property2": {          "tokens": [            "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/** * claimTargets narrows which tokens a claim is written to, keyed by the claim *  name as it appears in `claims`. A claim with no entry — or an entry with an *  empty token list — is written to every token. Keys with no matching claim *  are ignored. */claimTargets?: {/** * ClaimTokenTargets lists the tokens a single mapped claim is written to. An empty *  list means every token, which is the default for claims with no entry. *  *  Values are plain strings rather than an enum because this field is served over two *  JSON surfaces with different enum encodings: the management API marshals via protojson *  (enum names) while the console API marshals the proto with encoding/json (enum numbers). *  A string renders identically on both. Unknown values are dropped on write, so a claim *  with no valid target falls back to the "every token" default. *  *  Wrapper message because proto3 map values cannot be `repeated`. */[k: string]: {tokens?: string[]}}}[]}
Was this helpful?