Get embedded link settings | API Reference

GET

/v1/mgmt/embeddedlink/settings

Authorization

Descope Project ID and Management Key

AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Get the project's embedded link settings, using a valid management key.

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

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

ResponseOK

{
  "enabled": true,
  "expirationTime": 0,
  "expirationTimeUnit": "string"
}

{  "enabled": true,  "expirationTime": 0,  "expirationTimeUnit": "string"}

TypeScript

/**
 * Embedded link (Terraform: descope_embeddedlink_settings). Carries the same representation
 *  used in exported snapshots, and the Get response and Set request are the same message.
 *  Patch semantics: omitted fields are left untouched; present fields are written.
 */
export interface Response {
enabled?: boolean
expirationTime?: number
expirationTimeUnit?: string
}

/** * Embedded link (Terraform: descope_embeddedlink_settings). Carries the same representation *  used in exported snapshots, and the Get response and Set request are the same message. *  Patch semantics: omitted fields are left untouched; present fields are written. */export interface Response {enabled?: booleanexpirationTime?: numberexpirationTimeUnit?: string}

Was this helpful?