Class Prompts

Index

Accessors

rendering customText partials

Constructors

Methods

getSettings updateSettings _getAuthorizationHeader

Properties

_options _rendering _customText _partials

Accessors

rendering

get rendering(): Rendering
Returns Rendering

customText

get customText(): CustomText
Returns CustomText

partials

get partials(): Partials
Returns Partials

Constructors

constructor

new Prompts(_options: Prompts.Options): Prompts
Parameters
- _options: Prompts.Options
Returns Prompts

Methods

getSettings

getSettings(
requestOptions?: Prompts.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: Prompts.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetSettingsResponseContent>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.prompts.getSettings()
```

updateSettings

updateSettings(
request?: Management.UpdateSettingsRequestContent,
requestOptions?: Prompts.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: Management.UpdateSettingsRequestContent = {}
- OptionalrequestOptions: Prompts.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<UpdateSettingsResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.prompts.updateSettings()
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: Prompts.Options

`Protected`_rendering

_rendering: undefined | Rendering

`Protected`_customText

_customText: undefined | CustomText

`Protected`_partials

_partials: undefined | Partials