method

RiduAuth.requestVerification

Request an email-verification token through the configured delivery hook.

Arguments

ArgumentTypeDescription
input{ email: string; } & AuthCollectionInput<DefaultAuth, Slug>The account email and optional collection.
optionsRequestOptions | undefinedRequest options.

Returns

The declared result.

Promise<AuthActionEnvelope>

Full signature

RiduAuth.requestVerification< Slug extends AuthCollectionSlug<Config> = SessionCollection<Config, DefaultAuth>, >( input: { email: string; } & AuthCollectionInput<DefaultAuth, Slug>, options?: RequestOptions, ): Promise<AuthActionEnvelope>

Source packages/sdk/src/types.ts:1649

Related types

  • AuthCollectionSlug

    Collection slugs with the generated auth capability.

  • SessionCollection

    Auth collections a client's sessions can belong to: its default, or every auth collection.

  • AuthCollectionInput

    Selects the auth collection for one call. It is optional only when the client was created with auth.collection, which becomes Default; otherwise every call names its collection.

  • RequestOptions

    Options shared by every request.

  • AuthActionEnvelope

    A successful auth maintenance action.