CredentialsAuthProvider

View Source

Summary

Public shape for a credentials-based provider used by verifyCredentials().

Signature

interface CredentialsAuthProvider<input, result, provider> {
  name: provider;
  parse(context: RequestContext): input | Promise<input>;
  verify(
    input: input,
    context: RequestContext,
  ): result | Promise<result | null> | null;
}

Properties

name

Provider name used for session metadata and diagnostics.

Methods

parse(context: RequestContext): input | Promise

Parses submitted credentials from the current request.

context

verify(input: input, context: RequestContext): result | Promise<result | null> | null

Verifies parsed credentials and returns the authenticated result on success.

input

context