[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-11-21 UTC."],[],[],null,["# auth namespace\n\nFunctions\n---------\n\n| Function | Description |\n|-------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|\n| [user(userOptions)](./firebase-functions.auth.md#authuser) | Handles events related to Firebase Auth users events. |\n| [userRecordConstructor(wireData)](./firebase-functions.auth.md#authuserrecordconstructor) | Helper function that creates a `UserRecord` class from data sent over the wire. |\n\nClasses\n-------\n\n| Class | Description |\n|----------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|\n| [HttpsError](./firebase-functions.auth.httpserror.md#authhttpserror_class) | An explicit error that can be thrown from a handler to send an error to the client that called the function. |\n| [UserBuilder](./firebase-functions.auth.userbuilder.md#authuserbuilder_class) | Builder used to create functions for Firebase Auth user lifecycle events. |\n| [UserRecordMetadata](./firebase-functions.auth.userrecordmetadata.md#authuserrecordmetadata_class) | Helper class to create the user metadata in a `UserRecord` object. |\n\nInterfaces\n----------\n\n| Interface | Description |\n|-----------------------------------------------------------------------------------|-------------------------------------|\n| [UserOptions](./firebase-functions.auth.useroptions.md#authuseroptions_interface) | Options for Auth blocking function. |\n\nType Aliases\n------------\n\n| Type Alias | Description |\n|-----------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [UserInfo](./firebase-functions.auth.md#authuserinfo) | `UserInfo` that is part of the `UserRecord`. |\n| [UserRecord](./firebase-functions.auth.md#authuserrecord) | The `UserRecord` passed to Cloud Functions is the same [UserRecord](https://firebase.google.com/docs/reference/admin/node/firebase-admin.auth.userrecord) that is returned by the Firebase Admin SDK. |\n\nauth.user()\n-----------\n\nHandles events related to Firebase Auth users events.\n\n**Signature:** \n\n export declare function user(userOptions?: UserOptions): UserBuilder;\n\n### Parameters\n\n| Parameter | Type | Description |\n|-------------|-----------------------------------------------------------------------------------|------------------------|\n| userOptions | [UserOptions](./firebase-functions.auth.useroptions.md#authuseroptions_interface) | Resource level options |\n\n**Returns:**\n\n[UserBuilder](./firebase-functions.auth.userbuilder.md#authuserbuilder_class)\n\nUserBuilder - Builder used to create functions for Firebase Auth user lifecycle events\n\nauth.userRecordConstructor()\n----------------------------\n\nHelper function that creates a `UserRecord` class from data sent over the wire.\n\n**Signature:** \n\n export declare function userRecordConstructor(wireData: Record\u003cstring, unknown\u003e): UserRecord;\n\n### Parameters\n\n| Parameter | Type | Description |\n|-----------|---------------------------|-------------------------|\n| wireData | Record\\\u003cstring, unknown\\\u003e | data sent over the wire |\n\n**Returns:**\n\n[UserRecord](./firebase-functions.auth.md#authuserrecord)\n\nan instance of `UserRecord` with correct toJSON functions\n\nauth.UserInfo\n-------------\n\n`UserInfo` that is part of the `UserRecord`.\n\n**Signature:** \n\n export type UserInfo = auth.UserInfo;\n\nauth.UserRecord\n---------------\n\nThe `UserRecord` passed to Cloud Functions is the same [UserRecord](https://firebase.google.com/docs/reference/admin/node/firebase-admin.auth.userrecord) that is returned by the Firebase Admin SDK.\n\n**Signature:** \n\n export type UserRecord = auth.UserRecord;"]]