Back to Node Auth0

Class TicketsClient

docs/classes/management.SDK.TicketsClient.html

5.9.14.6 KB
Original Source

Class TicketsClient

Index

Constructors

constructor

Methods

verifyEmailchangePassword

Properties

_options

Constructors

constructor

new TicketsClient(options: BaseClientOptions): TicketsClient

Parameters

Returns TicketsClient

Methods

verifyEmail

verifyEmail(
request: VerifyEmailTicketRequestContent,
requestOptions?: TicketsClient.RequestOptions,
): HttpResponsePromise<VerifyEmailTicketResponseContent>

Create an email verification ticket for a given user. An email verification ticket is a generated URL that the user can consume to verify their email address.

Parameters

Request-specific configuration.

Returns HttpResponsePromise<VerifyEmailTicketResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.tickets.verifyEmail({ user_id: "user_id" })Copy

changePassword

changePassword(
request?: ChangePasswordTicketRequestContent,
requestOptions?: TicketsClient.RequestOptions,
): HttpResponsePromise<ChangePasswordTicketResponseContent>

Create a password change ticket for a given user. A password change ticket is a generated URL that the user can consume to start a reset password flow.

Note: This endpoint does not verify the given user’s identity. If you call this endpoint within your application, you must design your application to verify the user’s identity.

Parameters

Request-specific configuration.

Returns HttpResponsePromise<ChangePasswordTicketResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.tickets.changePassword()Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods verifyEmailchangePassword Properties _options