Back to Node Auth0

Class SsoTicketClient

docs/classes/management.SDK.SsoTicketClient.html

5.9.14.6 KB
Original Source

Class SsoTicketClient

Index

Constructors

constructor

Methods

createrevoke

Properties

_options

Constructors

constructor

new SsoTicketClient(options: BaseClientOptions): SsoTicketClient

Parameters

Returns SsoTicketClient

Methods

create

create(
id: string,
request?: CreateSelfServiceProfileSsoTicketRequestContent,
requestOptions?: SsoTicketClient.RequestOptions,
): HttpResponsePromise<CreateSelfServiceProfileSsoTicketResponseContent>

Creates an access ticket to initiate the Self-Service Enterprise Configuration flow using a self-service profile.

Parameters

  • id: string

The id of the self-service profile to retrieve

Request-specific configuration.

Returns HttpResponsePromise<CreateSelfServiceProfileSsoTicketResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.selfServiceProfiles.ssoTicket.create("id")Copy

revoke

revoke(
profileId: string,
id: string,
requestOptions?: SsoTicketClient.RequestOptions,
): HttpResponsePromise<void>

Revokes a Self-Service Enterprise Configuration access ticket and invalidates associated sessions. The ticket will no longer be accepted to initiate a Self-Service Enterprise Configuration session. If any users have already started a session through this ticket, their session will be terminated. Clients should expect a 202 Accepted response upon successful processing, indicating that the request has been acknowledged and that the revocation is underway but may not be fully completed at the time of response. If the specified ticket does not exist, a 202 Accepted response is also returned, signaling that no further action is required. Clients should treat these 202 responses as an acknowledgment that the request has been accepted and is in progress, even if the ticket was not found.

Parameters

  • profileId: string

The id of the self-service profile

  • id: string

The id of the ticket to revoke

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.selfServiceProfiles.ssoTicket.revoke("profileId", "id")Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods createrevoke Properties _options