CloudFireAuth Docs

Appearance

cloudfire-auth / UpdateRequest

Interface: UpdateRequest ​

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

Interface representing the properties to update on the provided user.

Extended by ​

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.

displayName? ​

optional displayName: string | null

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

The user's display name.

email? ​

optional email: string

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

The user's primary email.

emailVerified? ​

optional emailVerified: boolean

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

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

multiFactor? ​

optional multiFactor: MultiFactorUpdateSettings

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

The user's updated multi-factor related properties.

password? ​

optional password: string

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

The user's unhashed password.

phoneNumber? ​

optional phoneNumber: string | null

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

The user's primary phone number.

photoURL? ​

optional photoURL: string | null

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

The user's photo URL.

optional providersToUnlink: string[]

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

Unlinks this user from the specified providers.

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.