Get admin portal settings | API Reference

GET

/v1/mgmt/adminportal/settings

Authorization

Descope Project ID and Management Key

AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Get the project's admin portal settings, using a valid management key.

curl -X GET "https://api.descope.com/v1/mgmt/adminportal/settings"

curl -X GET "https://api.descope.com/v1/mgmt/adminportal/settings"

ResponseOK

{
  "enabled": true,
  "styleId": "string",
  "widgets": null
}

{  "enabled": true,  "styleId": "string",  "widgets": null}

TypeScript

/**
 * Admin portal settings (Terraform: descope_admin_portal).
 *  Patch semantics: omitted fields are left untouched; present fields are written.
 */
export interface Response {
enabled?: boolean
styleId?: string
/**
 * 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.
 */
widgets?: {
[k: string]: unknown
}
}

/** * Admin portal settings (Terraform: descope_admin_portal). *  Patch semantics: omitted fields are left untouched; present fields are written. */export interface Response {enabled?: booleanstyleId?: string/** * 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. */widgets?: {[k: string]: unknown}}

Was this helpful?