Class SelfServiceProfiles

Index

Accessors

customText

get customText(): CustomText
Returns CustomText

ssoTicket

get ssoTicket(): SsoTicket
Returns SsoTicket

Constructors

constructor

new SelfServiceProfiles(
_options: SelfServiceProfiles.Options,
): SelfServiceProfiles
Parameters
- _options: SelfServiceProfiles.Options
Returns SelfServiceProfiles

Methods

list

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

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError

Throws
Management.InternalServerError
Example
```
await client.selfServiceProfiles.list()
```

create

create(
request: Management.CreateSelfServiceProfileRequestContent,
requestOptions?: SelfServiceProfiles.RequestOptions,
): HttpResponsePromise<CreateSelfServiceProfileResponseContent>
Creates a self-service profile.
Parameters
- request: Management.CreateSelfServiceProfileRequestContent
- OptionalrequestOptions: SelfServiceProfiles.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?: SelfServiceProfiles.RequestOptions,
): HttpResponsePromise<GetSelfServiceProfileResponseContent>
Retrieves a self-service profile by Id.
Parameters
- id: string
  The id of the self-service profile to retrieve
- OptionalrequestOptions: SelfServiceProfiles.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?: SelfServiceProfiles.RequestOptions,
): HttpResponsePromise<void>
Deletes a self-service profile by Id.
Parameters
- id: string
  The id of the self-service profile to delete
- OptionalrequestOptions: SelfServiceProfiles.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?: Management.UpdateSelfServiceProfileRequestContent,
    requestOptions?: SelfServiceProfiles.RequestOptions,
): HttpResponsePromise<UpdateSelfServiceProfileResponseContent>
Updates a self-service profile.
Parameters
- id: string
  The id of the self-service profile to update
- request: Management.UpdateSelfServiceProfileRequestContent = {}
- OptionalrequestOptions: SelfServiceProfiles.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")
```

`Protected`_getAuthorizationHeader

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

Properties

`Protected` `Readonly`_options

_options: SelfServiceProfiles.Options

`Protected`_customText

_customText: undefined | CustomText

`Protected`_ssoTicket

_ssoTicket: undefined | SsoTicket

Class SelfServiceProfiles

Index

Accessors

Constructors

Methods

Properties

Accessors

customText

Returns CustomText

ssoTicket

Returns SsoTicket

Constructors

constructor

Parameters

Returns SelfServiceProfiles

Methods

list

Parameters

Returns Promise<Page<SelfServiceProfile>>

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

Protected_getAuthorizationHeader

Returns Promise<string>

Properties

Protected Readonly_options

Protected_customText

Protected_ssoTicket

Settings

On This Page

`Protected`_getAuthorizationHeader

`Protected` `Readonly`_options

`Protected`_customText

`Protected`_ssoTicket