auth namespace

Functions

Function Description
user(userOptions) Handles events related to Firebase Auth users events.
userRecordConstructor(wireData) Helper function that creates a UserRecord 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 a UserRecord object.

Interfaces

Interface Description
UserOptions Options for Auth blocking function.

Type Aliases

Type Alias Description
UserInfo UserInfo that is part of the UserRecord.
UserRecord The UserRecord passed to Cloud Functions is the same UserRecord that is returned by the Firebase Admin SDK.

auth.user()

Handles events related to Firebase Auth users events.

Signature:

export declare function user(userOptions?: UserOptions): UserBuilder;

Parameters

Parameter Type Description
userOptions UserOptions Resource level options

Returns:

UserBuilder

UserBuilder - Builder used to create functions for Firebase Auth user lifecycle events

auth.userRecordConstructor()

Helper function that creates a UserRecord class from data sent over the wire.

Signature:

export declare function userRecordConstructor(wireData: Record<string, unknown>): UserRecord;

Parameters

Parameter Type Description
wireData Record<string, unknown> data sent over the wire

Returns:

UserRecord

an instance of UserRecord with correct toJSON functions

auth.UserInfo

UserInfo that is part of the UserRecord.

Signature:

export type UserInfo = auth.UserInfo;

auth.UserRecord

The UserRecord passed to Cloud Functions is the same UserRecord that is returned by the Firebase Admin SDK.

Signature:

export type UserRecord = auth.UserRecord;