API ReferenceManagementOauth Management
POST
/v1/mgmt/wellknown/settings

Authorization

Descope Project ID and Management Key
AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Request Body

application/json

enabled?boolean

Applies the customization to the served documents. Off by default: the customization is kept and the default documents are served.

hiddenFields?object

Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.

removedValues?object

Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.

scopesSupported?object

Delta over a base advisory list: extra values are advertised in addition to the base values, excluded values are removed from them

claimsSupported?object

Delta over a base advisory list: extra values are advertised in addition to the base values, excluded values are removed from them

Update the project's customization of its OIDC discovery documents, using a valid management key. Only the fields present in the request are changed.

curl -X POST "https://api.descope.com/v1/mgmt/wellknown/settings" \  -H "Content-Type: application/json" \  -d '{}'
{  "enabled": true,  "hiddenFields": null,  "removedValues": null,  "scopesSupported": {    "extra": [      "string"    ],    "excluded": [      "string"    ]  },  "claimsSupported": {    "extra": [      "string"    ],    "excluded": [      "string"    ]  }}
/** * Patch semantics: omitted fields are left untouched; present fields are written. *  Customization of the project's OIDC discovery documents: the project document and the shared inbound apps document. *  Advertised content only, the endpoints and capabilities themselves stay enabled. */export interface Response {/** * Applies the customization to the served documents. Off by default: the customization is kept and the default documents are served. */enabled?: boolean/** * Array of field names to omit from the documents. Hideable fields: backchannel_authentication_endpoint, pushed_authorization_request_endpoint, request_parameter_supported, registration_endpoint, end_session_endpoint, introspection_endpoint, device_authorization_endpoint, revocation_endpoint, userinfo_endpoint, backchannel_logout_supported. */hiddenFields?: {[k: string]: unknown}/** * Array of objects naming a list field and the values to remove from it, such as [{"field": "grant_types_supported", "values": ["client_credentials"]}]. Returned sorted by field. A list is never emptied: removing every value keeps the full list. */removedValues?: {[k: string]: unknown}/** * Scopes added to or excluded from scopes_supported. */scopesSupported?: {extra?: string[]excluded?: string[]}/** * Claims added to or excluded from claims_supported. */claimsSupported?: {extra?: string[]excluded?: string[]}}
Was this helpful?