docs/classes/management.SDK.SelfServiceProfilesClient.html
get customText(): CustomTextClient
get ssoTicket(): SsoTicketClient
new SelfServiceProfilesClient(
options: BaseClientOptions,
): SelfServiceProfilesClient
list(
request?: ListSelfServiceProfilesRequestParameters,
requestOptions?: SelfServiceProfilesClient.RequestOptions,
): Promise<
Page<
SelfServiceProfile,
ListSelfServiceProfilesPaginatedResponseContent,
>,
>
Retrieves self-service profiles.
OptionalrequestOptions: SelfServiceProfilesClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
Management.InternalServerError
await client.selfServiceProfiles.list({ page: 1, per_page: 1, include_totals: true })Copy
create(
request: CreateSelfServiceProfileRequestContent,
requestOptions?: SelfServiceProfilesClient.RequestOptions,
): HttpResponsePromise<CreateSelfServiceProfileResponseContent>
Creates a self-service profile.
OptionalrequestOptions: SelfServiceProfilesClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
Management.InternalServerError
await client.selfServiceProfiles.create({ name: "name" })Copy
get(
id: string,
requestOptions?: SelfServiceProfilesClient.RequestOptions,
): HttpResponsePromise<GetSelfServiceProfileResponseContent>
Retrieves a self-service profile by Id.
The id of the self-service profile to retrieve
OptionalrequestOptions: SelfServiceProfilesClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
Management.InternalServerError
await client.selfServiceProfiles.get("id")Copy
delete(
id: string,
requestOptions?: SelfServiceProfilesClient.RequestOptions,
): HttpResponsePromise<void>
Deletes a self-service profile by Id.
The id of the self-service profile to delete
OptionalrequestOptions: SelfServiceProfilesClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
Management.InternalServerError
await client.selfServiceProfiles.delete("id")Copy
update(
id: string,
request?: UpdateSelfServiceProfileRequestContent,
requestOptions?: SelfServiceProfilesClient.RequestOptions,
): HttpResponsePromise<UpdateSelfServiceProfileResponseContent>
Updates a self-service profile.
The id of the self-service profile to update
OptionalrequestOptions: SelfServiceProfilesClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
Management.InternalServerError
await client.selfServiceProfiles.update("id")Copy
Protected Readonly_options_options: NormalizedClientOptionsWithAuth<BaseClientOptions>
Protected_customText_customText: CustomTextClient | undefined
Protected_ssoTicket_ssoTicket: SsoTicketClient | undefined
Member Visibility
ThemeOSLightDark
Accessors customTextssoTicket Constructors constructor Methods listcreategetdeleteupdate Properties _options_customText_ssoTicket