Skip to content

Authentication API Reference

This section documents all Firebase Authentication Blueprint nodes provided by the plugin. These nodes allow you to initialize authentication, sign users in and out, manage user accounts, perform security-sensitive operations, link authentication providers, and observe authentication state changes.

All Authentication nodes require Firebase to be successfully initialized before use.


Authentication Initialization

Node Parameters Callbacks / Return Description
Initialize Authentication Initializes the Firebase Authentication subsystem. This should be called once before using any authentication-related functionality.

Sign In - Anonymous

Node Parameters Callbacks / Return Description
Sign In Anonymously On Success (UserId): Called when the anonymous user is signed in successfully.
On Failure (Error Message, Error Code): Called if anonymous sign-in fails.
Signs the user in anonymously and creates a temporary Firebase Authentication user.

Sign In - Google

Node Parameters Callbacks / Return Description
Sign In With Google On Success (UserId): Called when Google sign-in succeeds.
On Failure (Error Message, Error Code): Called if Google sign-in fails.
Signs the user in using Google Sign-In. Requires SHA keys to be configured in Firebase project settings.

Sign In - Email and Password

Node Parameters Callbacks / Return Description
Create User With Email and Password Email, Password (string) On Success (UserId): Called when the user account is created successfully.
On Failure (Error Message, Error Code): Called if user creation fails.
Creates a new Firebase Authentication user using email and password.
Sign In With Email and Password Email, Password (string) On Success (UserId): Called when sign-in succeeds.
On Failure (Error Message, Error Code): Called if sign-in fails.
Signs the user in using email and password credentials.
Send Password Reset Email Email (string) On Success: Called when the password reset email is sent.
On Failure (Error Message, Error Code): Called if the request fails.
Sends a password reset email to the specified address.

Linking Providers

Node Parameters Callbacks / Return Description
Link With Email and Password Email, Password (string) On Success: Called when linking succeeds.
On Failure (Error Message, Error Code): Called if linking fails.
Links the currently authenticated user with an email and password provider.
Link With Google On Success: Called when linking succeeds.
On Failure (Error Message, Error Code): Called if linking fails.
Links the currently authenticated user with a Google account.
Get Linked Providers Array<string> Returns a list of authentication providers linked to the current user.

Reauthentication

Node Parameters Callbacks / Return Description
Reauthenticate With Email and Password Email, Password (string) On Success: Called when reauthentication succeeds.
On Failure (Error Message, Error Code): Called if reauthentication fails.
Reauthenticates the current user using email and password. Required for sensitive account operations.
Reauthenticate With Google On Success: Called when Google reauthentication succeeds.
On Failure (Error Message, Error Code): Called if reauthentication fails.
Reauthenticates the current user using Google Sign-In.

Email Verification

Node Parameters Callbacks / Return Description
Send Email Verification On Success: Called when the verification email is sent.
On Failure (Error Message, Error Code): Called if sending fails.
Sends a verification email to the currently authenticated user.
Is Email Verified bool Returns whether the current user's email address has been verified.

Session

Node Parameters Callbacks / Return Description
Sign Out On Sign Out: Called after the user has been signed out. Signs out the currently authenticated user.
Is Signed In bool Returns whether a Firebase Authentication user currently exists.
Get ID Token bForceRefresh (bool) On Success (Token): Called when the ID token is retrieved successfully.
On Failure (Error Message, Error Code): Called if token retrieval fails.
Retrieves the Firebase Authentication ID token for the current user.

Current User - Account

Node Parameters Callbacks / Return Description
Reload User On Success: Called when the user data is reloaded.
On Failure (Error Message, Error Code): Called if reload fails.
Reloads the current Firebase user from the server, updating profile data and verification state.
Delete Current User On Success: Called when the user is deleted successfully.
On Failure (Error Message, Error Code): Called if deletion fails.
Permanently deletes the currently authenticated user account.

Current User - Profile Getters

Node Parameters Callbacks / Return Description
Get Current User ID string Returns the UID of the currently authenticated user.
Get Current User Email string Returns the email address of the current user, if available.
Get Current User Display Name string Returns the display name of the current user, if available.
Get Current User Photo URL string Returns the photo URL of the current user, if available.
Get Current User Provider ID string Returns the primary authentication provider ID of the current user.

Current User - Profile Setters

Node Parameters Callbacks / Return Description
Update Email NewEmail (string) On Success: Called when the email is updated.
On Failure (Error Message, Error Code): Called if the update fails.
Updates the email address of the currently authenticated user.
Update Password NewPassword (string) On Success: Called when the password is updated.
On Failure (Error Message, Error Code): Called if the update fails.
Updates the password of the currently authenticated user.
Update User Display Name DisplayName (string) On Success: Called when the display name is updated.
On Failure (Error Message, Error Code): Called if the update fails.
Updates the display name of the current user.
Update User Photo PhotoUrl (string) On Success: Called when the photo URL is updated.
On Failure (Error Message, Error Code): Called if the update fails.
Updates the photo URL of the current user profile.

Authentication State Listener

Node Parameters Callbacks / Return Description
Listen Auth State On Changed (UserId): Called whenever the authentication state changes. Registers a listener that is triggered when the Firebase Authentication state changes, such as sign-in, sign-out, or user switching.