CloudFireAuth Docs

Appearance

cloudfire-auth / CreateRequest

Interface: CreateRequest ​

Defined in: types/firebase-admin/auth-config.ts:201

Interface representing the properties to set on a new user record to be created.

Extends ​

Properties ​

disabled? ​

optional disabled: boolean

Defined in: types/firebase-admin/auth-config.ts:120

Whether or not the user is disabled: true for disabled; false for enabled.

Inherited from ​

UpdateRequest.disabled

displayName? ​

optional displayName: string | null

Defined in: types/firebase-admin/auth-config.ts:124

The user's display name.

Inherited from ​

UpdateRequest.displayName

email? ​

optional email: string

Defined in: types/firebase-admin/auth-config.ts:128

The user's primary email.

Inherited from ​

UpdateRequest.email

emailVerified? ​

optional emailVerified: boolean

Defined in: types/firebase-admin/auth-config.ts:132

Whether or not the user's primary email is verified.

Inherited from ​

UpdateRequest.emailVerified

multiFactor? ​

optional multiFactor: MultiFactorCreateSettings

Defined in: types/firebase-admin/auth-config.ts:209

The user's multi-factor related properties.

Overrides ​

UpdateRequest.multiFactor

password? ​

optional password: string

Defined in: types/firebase-admin/auth-config.ts:136

The user's unhashed password.

Inherited from ​

UpdateRequest.password

phoneNumber? ​

optional phoneNumber: string | null

Defined in: types/firebase-admin/auth-config.ts:140

The user's primary phone number.

Inherited from ​

UpdateRequest.phoneNumber

photoURL? ​

optional photoURL: string | null

Defined in: types/firebase-admin/auth-config.ts:144

The user's photo URL.

Inherited from ​

UpdateRequest.photoURL

optional providersToUnlink: string[]

Defined in: types/firebase-admin/auth-config.ts:166

Unlinks this user from the specified providers.

Inherited from ​

UpdateRequest.providersToUnlink

optional providerToLink: UserProvider

Defined in: types/firebase-admin/auth-config.ts:162

Links this user to the specified provider.

Linking a provider to an existing user account does not invalidate the refresh token of that account. In other words, the existing account would continue to be able to access resources, despite not having used the newly linked provider to log in. If you wish to force the user to authenticate with this new provider, you need to (a) revoke their refresh token (see https://firebase.google.com/docs/auth/admin/manage-sessions#revoke_refresh_tokens), and (b) ensure no other authentication methods are present on this account.

Inherited from ​

UpdateRequest.providerToLink

uid? ​

optional uid: string

Defined in: types/firebase-admin/auth-config.ts:205

The user's uid.