Class CustomTextClient

Index

Constructors

Methods

Properties

Constructors

constructor

new CustomTextClient(options: BaseClientOptions): CustomTextClient
Parameters
- options: BaseClientOptions
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 SSO 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.
- OptionalrequestOptions: CustomTextClient.RequestOptions
  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")
```

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 SSO 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: SetSelfServiceProfileCustomTextRequestContent
- OptionalrequestOptions: CustomTextClient.RequestOptions
  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"
    })
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>