• management
• SDK
• PromptsClient

Class PromptsClient

Index

Accessors

renderingcustomTextpartials

Constructors

constructor

Methods

getSettingsupdateSettings

Properties

_options_rendering_customText_partials

Accessors

rendering

get rendering(): RenderingClient

Returns RenderingClient

customText

get customText(): CustomTextClient

Returns CustomTextClient

partials

get partials(): PartialsClient

Returns PartialsClient

Constructors

constructor

new PromptsClient(options: BaseClientOptions): PromptsClient

Parameters

• options: BaseClientOptions

Returns PromptsClient

Methods

getSettings

getSettings(
requestOptions?: PromptsClient.RequestOptions,
): HttpResponsePromise<GetSettingsResponseContent>

Retrieve details of the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features.

Parameters

• OptionalrequestOptions: PromptsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetSettingsResponseContent>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.prompts.getSettings()Copy

updateSettings

updateSettings(
request?: UpdateSettingsRequestContent,
requestOptions?: PromptsClient.RequestOptions,
): HttpResponsePromise<UpdateSettingsResponseContent>

Update the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features.

Parameters

• request: UpdateSettingsRequestContent = {}
• OptionalrequestOptions: PromptsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<UpdateSettingsResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.prompts.updateSettings()Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Protected_rendering

_rendering: RenderingClient | undefined

Protected_customText

_customText: CustomTextClient | undefined

Protected_partials

_partials: PartialsClient | undefined

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Accessors renderingcustomTextpartials Constructors constructor Methods getSettingsupdateSettings Properties _options_rendering_customText_partials