auth namespace
Functions
| Function | Description |
|---|---|
| user(userOptions) | Handles events related to Firebase Auth users events. |
| userRecordConstructor(wireData) | Helper function that creates aUserRecord class from data sent over the wire. |
Classes
| Class | Description |
|---|---|
| HttpsError | An explicit error that can be thrown from a handler to send an error to the client that called the function. |
| UserBuilder | Builder used to create functions for Firebase Auth user lifecycle events. |
| UserRecordMetadata | Helper class to create the user metadata in aUserRecord object. |
Interfaces
| Interface | Description |
|---|---|
| UserOptions | Options for Auth blocking function. |
Type Aliases
| Type Alias | Description |
|---|---|
| UserInfo | UserInfo that is part of theUserRecord. |
| UserRecord | TheUserRecord passed to Cloud Functions is the sameUserRecord that is returned by the Firebase Admin SDK. |
auth.user()
Handles events related to Firebase Auth users events.
Signature:
exportdeclarefunctionuser(userOptions?:UserOptions):UserBuilder;Parameters
| Parameter | Type | Description |
|---|---|---|
| userOptions | UserOptions | Resource level options |
Returns:
UserBuilder - Builder used to create functions for Firebase Auth user lifecycle events
auth.userRecordConstructor()
Helper function that creates aUserRecord class from data sent over the wire.
Signature:
exportdeclarefunctionuserRecordConstructor(wireData:Record<string,unknown>):UserRecord;Parameters
| Parameter | Type | Description |
|---|---|---|
| wireData | Record<string, unknown> | data sent over the wire |
Returns:
an instance ofUserRecord with correct toJSON functions
auth.UserInfo
UserInfo that is part of theUserRecord.
Signature:
exporttypeUserInfo=auth.UserInfo;auth.UserRecord
TheUserRecord passed to Cloud Functions is the sameUserRecord that is returned by the Firebase Admin SDK.
Signature:
exporttypeUserRecord=auth.UserRecord;Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-11-21 UTC.