Builder used to create functions for Firebase Auth user lifecycle events.

**Signature:**

    export declare class UserBuilder 

## Methods

| Method | Modifiers | Description |
|---|---|---|
| [beforeCreate(handler)](https://firebase.google.com/docs/reference/functions/firebase-functions.auth.userbuilder#authuserbuilderbeforecreate) |   | Blocks request to create a Firebase Auth user. |
| [beforeEmail(handler)](https://firebase.google.com/docs/reference/functions/firebase-functions.auth.userbuilder#authuserbuilderbeforeemail) |   |   |
| [beforeSignIn(handler)](https://firebase.google.com/docs/reference/functions/firebase-functions.auth.userbuilder#authuserbuilderbeforesignin) |   | Blocks request to sign-in a Firebase Auth user. |
| [beforeSms(handler)](https://firebase.google.com/docs/reference/functions/firebase-functions.auth.userbuilder#authuserbuilderbeforesms) |   |   |
| [onCreate(handler)](https://firebase.google.com/docs/reference/functions/firebase-functions.auth.userbuilder#authuserbuilderoncreate) |   | Responds to the creation of a Firebase Auth user. |
| [onDelete(handler)](https://firebase.google.com/docs/reference/functions/firebase-functions.auth.userbuilder#authuserbuilderondelete) |   | Responds to the deletion of a Firebase Auth user. |

## auth.UserBuilder.beforeCreate()

Blocks request to create a Firebase Auth user.

**Signature:**

    beforeCreate(handler: (user: AuthUserRecord, context: AuthEventContext) => MaybeAsync<BeforeCreateResponse | void>): BlockingFunction;

### Parameters

| Parameter | Type | Description |
|---|---|---|
| handler | (user: AuthUserRecord, context: AuthEventContext) =\> MaybeAsync\<BeforeCreateResponse \| void\> | Event handler that blocks creation of a Firebase Auth user. |

**Returns:**

[BlockingFunction](https://firebase.google.com/docs/reference/functions/firebase-functions.blockingfunction#blockingfunction_interface)

## auth.UserBuilder.beforeEmail()

**Signature:**

    beforeEmail(handler: (context: AuthEventContext) => MaybeAsync<BeforeEmailResponse | void>): BlockingFunction;

### Parameters

| Parameter | Type | Description |
|---|---|---|
| handler | (context: AuthEventContext) =\> MaybeAsync\<BeforeEmailResponse \| void\> |   |

**Returns:**

[BlockingFunction](https://firebase.google.com/docs/reference/functions/firebase-functions.blockingfunction#blockingfunction_interface)

## auth.UserBuilder.beforeSignIn()

Blocks request to sign-in a Firebase Auth user.

**Signature:**

    beforeSignIn(handler: (user: AuthUserRecord, context: AuthEventContext) => MaybeAsync<BeforeSignInResponse | void>): BlockingFunction;

### Parameters

| Parameter | Type | Description |
|---|---|---|
| handler | (user: AuthUserRecord, context: AuthEventContext) =\> MaybeAsync\<BeforeSignInResponse \| void\> | Event handler that blocks sign-in of a Firebase Auth user. |

**Returns:**

[BlockingFunction](https://firebase.google.com/docs/reference/functions/firebase-functions.blockingfunction#blockingfunction_interface)

## auth.UserBuilder.beforeSms()

**Signature:**

    beforeSms(handler: (context: AuthEventContext) => MaybeAsync<BeforeSmsResponse | void>): BlockingFunction;

### Parameters

| Parameter | Type | Description |
|---|---|---|
| handler | (context: AuthEventContext) =\> MaybeAsync\<BeforeSmsResponse \| void\> |   |

**Returns:**

[BlockingFunction](https://firebase.google.com/docs/reference/functions/firebase-functions.blockingfunction#blockingfunction_interface)

## auth.UserBuilder.onCreate()

Responds to the creation of a Firebase Auth user.

**Signature:**

    onCreate(handler: (user: UserRecord, context: EventContext) => PromiseLike<any> | any): CloudFunction<UserRecord>;

### Parameters

| Parameter | Type | Description |
|---|---|---|
| handler | (user: [UserRecord](https://firebase.google.com/docs/reference/functions/firebase-functions.auth#authuserrecord), context: [EventContext](https://firebase.google.com/docs/reference/functions/firebase-functions.eventcontext#eventcontext_interface)) =\> PromiseLike\<any\> \| any | Event handler that responds to the creation of a Firebase Auth user. |

**Returns:**

[CloudFunction](https://firebase.google.com/docs/reference/functions/firebase-functions.cloudfunction#cloudfunction_interface)\<[UserRecord](https://firebase.google.com/docs/reference/functions/firebase-functions.auth#authuserrecord)\>

## auth.UserBuilder.onDelete()

Responds to the deletion of a Firebase Auth user.

**Signature:**

    onDelete(handler: (user: UserRecord, context: EventContext) => PromiseLike<any> | any): CloudFunction<UserRecord>;

### Parameters

| Parameter | Type | Description |
|---|---|---|
| handler | (user: [UserRecord](https://firebase.google.com/docs/reference/functions/firebase-functions.auth#authuserrecord), context: [EventContext](https://firebase.google.com/docs/reference/functions/firebase-functions.eventcontext#eventcontext_interface)) =\> PromiseLike\<any\> \| any | Event handler that responds to the deletion of a Firebase Auth user. |

**Returns:**

[CloudFunction](https://firebase.google.com/docs/reference/functions/firebase-functions.cloudfunction#cloudfunction_interface)\<[UserRecord](https://firebase.google.com/docs/reference/functions/firebase-functions.auth#authuserrecord)\>