Documentation
    Preparing search index...

    Authentication adapter implementing the Google Firebase Auth ecosystem. Handles server-side validation of JWTs and admin functions via firebase-admin.

    Hierarchy

    • AbstractAuthAdapter
      • FirebaseAuthAdapter
    Index

    Constructors

    • Parameters

      • params: AuthParameters = {}

      Returns FirebaseAuthAdapter

    Properties

    _alias: string
    _params: AuthParameters
    UserClass: typeof User

    The User class reference to be used by the adapter.

    Accessors

    • get alias(): string

      Returns string

    • set alias(alias: string): void

      Parameters

      • alias: string

      Returns void

    Methods

    • Completely removes a user from the Firebase Auth registry.

      Parameters

      • user: User

        Target user.

      Returns Promise<any>

    • Verifies a Firebase ID token using the admin SDK.

      Parameters

      • bearer: string

        The JWT token string.

      Returns Promise<DecodedIdToken>

      A promise resolving to the decoded token object.

    • Returns the pluggable endpoint handler function for this adapter, if any.

      Returns any

      The EndpointHandler callback or null.

    • Retrieves a configuration parameter.

      Parameters

      • key: AuthParametersKeys

        The parameter key to fetch.

      Returns any

      The corresponding configuration value.

    • Express middleware capturing Bearer JWT tokens to execute auth verification.

      Returns ApiMiddleware

      The middleware function.

    • Initiates password recovery/reset process for a user.

      Parameters

      • email: string

        The user email.

      • OptionalredirectTo: string

        Optional redirect destination.

      Returns Promise<any>

    • Requests a new ID token using a refresh token via Google Secure Token API.

      Parameters

      • refreshToken: string

        The active refresh token.

      Returns Promise<any>

      The generated token payload.

    • Register new user in authentication

      Parameters

      • user: User
      • OptionalclearPassword: string

      Returns Promise<string>

      user unique id

    • Revokes a specific access token.

      Parameters

      • token: string

        The token string.

      Returns Promise<void>

    • Updates the custom JWT claims embedded in a user's Firebase token.

      Parameters

      • id: string

        User UID.

      • claims: any

        Claims dictionary.

      Returns Promise<void>

    • Assigns a configuration parameter for the adapter.

      Parameters

      • key: AuthParametersKeys

        The parameter key.

      • value: any

        The parameter value.

      Returns void

    • Signs out the user (No-op in server-side stateless Firebase admin).

      Parameters

      • user: User

        Target user.

      Returns Promise<any>

    • User authentication flow (Not natively supported on Firebase Admin Server SDK). Usually handled on the client.

      Parameters

      • login: string

        Email address.

      • password: string

        Plain password.

      Returns Promise<void>

    • Modifies an existing user's attributes in the Firebase Auth registry.

      Parameters

      • user: User

        Target user.

      • updatable: UpdateRequest

        Properties to modify (e.g. displayName, disabled status).

      Returns Promise<any>

    • Bootstraps the adapter using Firebase credentials.

      Parameters

      • config: any

        Firebase admin SDK configuration block.

      Returns FirebaseAuthAdapter

      The adapter instance.