AuthPasskeyApi

import type { AuthPasskeyApi } from "https://esm.sh/@supabase/supabase-js@2.105.4/dist/index.d.mts";

Lower-level two-step API and management methods for passkeys. Access via supabase.auth.passkey.

interface AuthPasskeyApi {

delete(params: PasskeyDeleteParams): Promise<AuthPasskeyDeleteResponse>;

list(): Promise<AuthPasskeyListResponse>;

startAuthentication(params?: StartPasskeyAuthenticationParams): Promise<AuthPasskeyAuthenticationOptionsResponse>;

startRegistration(): Promise<AuthPasskeyRegistrationOptionsResponse>;

update(params: PasskeyUpdateParams): Promise<AuthPasskeyUpdateResponse>;

verifyAuthentication(params: VerifyPasskeyAuthenticationParams): Promise<AuthPasskeyAuthenticationVerifyResponse>;

verifyRegistration(params: VerifyPasskeyRegistrationParams): Promise<AuthPasskeyRegistrationVerifyResponse>;

}

§Methods

delete(params: PasskeyDeleteParams): Promise<AuthPasskeyDeleteResponse>

[src]

Deletes a passkey for the currently signed-in user.

list(): Promise<AuthPasskeyListResponse>

[src]

Lists all passkeys registered for the currently signed-in user.

startAuthentication(params?: StartPasskeyAuthenticationParams): Promise<AuthPasskeyAuthenticationOptionsResponse>

[src]

Starts the passkey authentication ceremony. Fetches an authentication challenge and credential request options from the server. Used as the first step of a two-step sign-in flow when the caller wants to handle navigator.credentials.get() themselves.

startRegistration(): Promise<AuthPasskeyRegistrationOptionsResponse>

[src]

Starts the passkey registration ceremony. Fetches a registration challenge and credential creation options from the server. Used as the first step of a two-step registration flow when the caller wants to handle navigator.credentials.create() themselves.

update(params: PasskeyUpdateParams): Promise<AuthPasskeyUpdateResponse>

[src]

Updates a passkey's friendly name.

verifyAuthentication(params: VerifyPasskeyAuthenticationParams): Promise<AuthPasskeyAuthenticationVerifyResponse>

[src]

Verifies a passkey authentication credential against a previously issued challenge. Used as the second step of a two-step sign-in flow.

verifyRegistration(params: VerifyPasskeyRegistrationParams): Promise<AuthPasskeyRegistrationVerifyResponse>

[src]

Verifies a passkey registration credential against a previously issued challenge. Used as the second step of a two-step registration flow.