Class SelfServiceProfilesClient

Index

Accessors

customText

get customText(): CustomTextClient

Returns CustomTextClient

ssoTicket

get ssoTicket(): SsoTicketClient

Returns SsoTicketClient

Constructors

constructor

new SelfServiceProfilesClient(
options: BaseClientOptions,
): SelfServiceProfilesClient
Parameters
- options: BaseClientOptions
Returns SelfServiceProfilesClient

Methods

list

list(
    request?: ListSelfServiceProfilesRequestParameters,
    requestOptions?: SelfServiceProfilesClient.RequestOptions,
): Promise<
    Page<
        SelfServiceProfile,
        ListSelfServiceProfilesPaginatedResponseContent,
    >,
>
Retrieves self-service profiles.
Parameters
- request: ListSelfServiceProfilesRequestParameters = {}
- OptionalrequestOptions: SelfServiceProfilesClient.RequestOptions
  Request-specific configuration.
Returns Promise<
    Page<
        SelfServiceProfile,
        ListSelfServiceProfilesPaginatedResponseContent,
    >,
>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError

Throws
Management.InternalServerError
Example
```
await client.selfServiceProfiles.list({
        page: 1,
        per_page: 1,
        include_totals: true
    })
```

create

create(
request: CreateSelfServiceProfileRequestContent,
requestOptions?: SelfServiceProfilesClient.RequestOptions,
): HttpResponsePromise<CreateSelfServiceProfileResponseContent>
Creates a self-service profile.
Parameters
- request: CreateSelfServiceProfileRequestContent
- OptionalrequestOptions: SelfServiceProfilesClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<CreateSelfServiceProfileResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError

Throws
Management.InternalServerError
Example
```
await client.selfServiceProfiles.create({
        name: "name"
    })
```

get

get(
id: string,
requestOptions?: SelfServiceProfilesClient.RequestOptions,
): HttpResponsePromise<GetSelfServiceProfileResponseContent>
Retrieves a self-service profile by Id.
Parameters
- id: string
  The id of the self-service profile to retrieve
- OptionalrequestOptions: SelfServiceProfilesClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetSelfServiceProfileResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError

Throws
Management.InternalServerError
Example
```
await client.selfServiceProfiles.get("id")
```

delete

delete(
id: string,
requestOptions?: SelfServiceProfilesClient.RequestOptions,
): HttpResponsePromise<void>
Deletes a self-service profile by Id.
Parameters
- id: string
  The id of the self-service profile to delete
- OptionalrequestOptions: SelfServiceProfilesClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError

Throws
Management.InternalServerError
Example
```
await client.selfServiceProfiles.delete("id")
```

update

update(
    id: string,
    request?: UpdateSelfServiceProfileRequestContent,
    requestOptions?: SelfServiceProfilesClient.RequestOptions,
): HttpResponsePromise<UpdateSelfServiceProfileResponseContent>
Updates a self-service profile.
Parameters
- id: string
  The id of the self-service profile to update
- request: UpdateSelfServiceProfileRequestContent = {}
- OptionalrequestOptions: SelfServiceProfilesClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<UpdateSelfServiceProfileResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError

Throws
Management.InternalServerError
Example
```
await client.selfServiceProfiles.update("id")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

`Protected`_customText

_customText: CustomTextClient | undefined

`Protected`_ssoTicket

_ssoTicket: SsoTicketClient | undefined

Class SelfServiceProfilesClient

Index

Accessors

Constructors

Methods

Properties

Accessors

customText

Returns CustomTextClient

ssoTicket

Returns SsoTicketClient

Constructors

constructor

Parameters

Returns SelfServiceProfilesClient

Methods

list

Parameters

Returns Promise< Page< SelfServiceProfile, ListSelfServiceProfilesPaginatedResponseContent, >,>

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateSelfServiceProfileResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetSelfServiceProfileResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateSelfServiceProfileResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Example

Properties

Protected Readonly_options

Protected_customText

Protected_ssoTicket

Settings

On This Page

Returns Promise<
Page<
SelfServiceProfile,
ListSelfServiceProfilesPaginatedResponseContent,
>,
>

`Protected` `Readonly`_options

`Protected`_customText

`Protected`_ssoTicket