@lucia-auth/oauth

createOAuth2AuthorizationUrl()#

Creates a new authorization url for OAuth 2.0 authorization code grant with a state. Use createOAuth2AuthorizationUrlWithPKCE() for creating urls with PKCE code challenge.

const createOAuth2AuthorizationUrl: (
	url: string | URL,
	options: {
		clientId: string;
		scope: string[];
		redirectUri?: string;
	}
) => Promise<readonly [authorizationUrl: URL, state: string]>;

Parameters#

Returns#

createOAuth2AuthorizationUrlWithPKCE()#

Creates a new authorization url for OAuth 2.0 authorization code grant with a state and PKCE code challenge.

const createOAuth2AuthorizationUrlWithPKCE: (
	url: string | URL,
	options: {
		clientId: string;
		scope: string[];
		codeChallengeMethod: "S256";
		redirectUri?: string;
	}
) => Promise<
	readonly [authorizationUrl: URL, codeVerifier: string, state: string]
>;

Parameters#

Returns#

decodeIdToken()#

Decodes the OpenID Connect Id Token and returns the claims. Does NOT validate the JWT. Throws SyntaxError if provided id token is invalid or malformed.

const decodeIdToken: <_Claims extends {}>(
	idToken: string
) => {
	iss: string;
	aud: string;
	exp: number;
} & _Claims;

Parameters#

Generics#

Returns#

JWT payload.

OAuthRequestError#

class. See OAuthRequestError.

providerUserAuth()#

Creates a new ProviderUserAuth instance.

const providerUserAuth: (
	auth: Auth,
	providerId: string,
	providerUserId: string
) => ProviderUserAuth;

Parameters#

Returns#

validateOAuth2AuthorizationCode()#

Validates OAuth 2.0 authorization code by sending a request to the provided url. Returns the JSON-parsed response body.

const validateOAuth2AuthorizationCode: <_ResponseBody extends {}>(
	authorizationCode: string,
	url: string | URL,
	options: {
		clientId: string;
		redirectUri?: string;
		codeVerifier?: string;
		clientPassword?: {
			clientSecret: string;
			authenticateWith: "client_secret" | "http_basic_auth";
		};
	}
) => Promise<_ResponseBody>;

Parameters#

Generics#

AuthenticateWithOptions#