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, handle security operations, 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. |
Security
| 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 currently signed-in user using email and password. Required for sensitive account operations. |
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. |
Sign Out
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Sign Out | – | On Sign Out: Called after the user has been signed out. | Signs out the currently authenticated user. |
User Profile
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Update Email | NewEmail (string) |
On Success: Called when the email is updated successfully. 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 successfully. On Failure (Error Message, Error Code): Called if the update fails. |
Updates the password of the currently authenticated user. |
Account Deletion
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| 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. |
ID Token
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| 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. |
User Profile Getters
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Is Signed In | – | bool |
Returns whether a Firebase Authentication user is currently signed in. |
| 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 authentication provider ID of the current user. |
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 or sign-out events. |