AbstractProtected_Protected Abstract_Protected_Protected Abstract_Protected Abstract_StaticUserThe User class reference to be used by the adapter.
Deletes a user account from the auth store.
Target user entity.
Promise resolving to true.
Exchanges the temporary authorization code for an access token packet.
The temporary auth code.
OptionalredirectUri: stringOptional redirect URL context.
Access token payload.
Returns the authorization redirect URL.
OptionalredirectUri: stringThe callback URL.
The requested authorization scopes.
Optionalstate: stringThe state parameters for CSRF protection.
The generated authorization URL.
AbstractgetRetrieves and validates an auth token payload for the given raw token string.
Raw authorization token string.
The resolved token payload or user claims.
Returns the pluggable endpoint handler function for this adapter, if any.
The EndpointHandler callback or null.
Retrieves a configuration parameter.
The parameter key to fetch.
The corresponding configuration value.
Express middleware capturing Bearer JWT tokens to execute auth verification.
The middleware function.
Initiates password recovery/reset process for a user.
The user email.
OptionalredirectTo: stringOptional redirect destination.
Refreshes an expired access token using a refresh token string.
Target refresh token.
Throws an error if refresh token logic is not implemented by the provider.
Registers a new user account (unsupported for OAuth adapters).
Target user entity.
OptionalclearPassword: stringOptional cleartext password.
Throws an error indicating registration is unsupported.
Revokes the access token (noop default).
Target token to revoke.
Inject custom claims (not supported by default).
Target user ID.
Payload claims.
Assigns a configuration parameter for the adapter.
The parameter key.
The parameter value.
Signs out the specified user session.
Target user entity.
Promise resolving to true.
Performs user signup with credentials (unsupported for OAuth adapters).
Login identifier string.
Password string.
Throws an error indicating signup should use exchangeCodeForToken.
Updates user profile attributes in the auth store.
Target user entity.
Attributes payload to update.
Promise resolving to true.
Abstract class summarizing typical OAuth2 Web Application Flows. Extend this to implement providers like GitHub, GitLab, Google, etc.