Back to Node Auth0

Class CustomTextClient

docs/classes/management.SDK.CustomTextClient-1.html

5.9.14.5 KB
Original Source

Class CustomTextClient

Index

Constructors

constructor

Methods

listset

Properties

_options

Constructors

constructor

new CustomTextClient(options: BaseClientOptions): CustomTextClient

Parameters

Returns CustomTextClient

Methods

list

list(
id: string,
language: "en",
page: "get-started",
requestOptions?: CustomTextClient.RequestOptions,
): HttpResponsePromise<ListSelfServiceProfileCustomTextResponseContent>

Retrieves text customizations for a given self-service profile, language and Self-Service Enterprise Configuration flow page.

Parameters

  • id: string

The id of the self-service profile.

  • language: "en"

The language of the custom text.

  • page: "get-started"

The page where the custom text is shown.

Request-specific configuration.

Returns HttpResponsePromise<ListSelfServiceProfileCustomTextResponseContent>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.selfServiceProfiles.customText.list("id", "en", "get-started")Copy

set

set(
id: string,
language: "en",
page: "get-started",
request: SetSelfServiceProfileCustomTextRequestContent,
requestOptions?: CustomTextClient.RequestOptions,
): HttpResponsePromise<SetSelfServiceProfileCustomTextResponseContent>

Updates text customizations for a given self-service profile, language and Self-Service Enterprise Configuration flow page.

Parameters

  • id: string

The id of the self-service profile.

  • language: "en"

The language of the custom text.

  • page: "get-started"

The page where the custom text is shown.

Request-specific configuration.

Returns HttpResponsePromise<SetSelfServiceProfileCustomTextResponseContent>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.selfServiceProfiles.customText.set("id", "en", "get-started", { "key": "value" })Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods listset Properties _options