Defines the d.ts multi-factor related comments for reference generation. #766
Conversation
Adds missing multi-factor related claims to the `DecodedIdToken` interface.
src/index.d.ts
Outdated
| interface MultiFactorInfo { | ||
|
|
||
| /** | ||
| * The unique identifier of the enrolled second factor. |
There was a problem hiding this comment.
Nit: This is the user's unique ID from the 2nd factor right? Perhaps make that a bit clear.
src/index.d.ts
Outdated
| interface MultiFactorInfo { | ||
|
|
||
| /** | ||
| * The user's unique ID of the enrolled second factor. |
There was a problem hiding this comment.
The ID of the enrolled second factor. This ID is unique to the user.
src/index.d.ts
Outdated
| uid: string; | ||
|
|
||
| /** | ||
| * The optional display name for an enrolled second factor. |
There was a problem hiding this comment.
The optional display name of the enrolled second factor.
src/index.d.ts
Outdated
| enrollmentTime?: string; | ||
|
|
||
| /** | ||
| * The second factor type identifier. For SMS second factor, this is `"phone"`. |
There was a problem hiding this comment.
The type identifier of the second factor. For SMS second factors, this is phone.
src/index.d.ts
Outdated
| @@ -639,14 +681,21 @@ declare namespace admin.auth { | |||
| */ | |||
| tenantId?: string | null; | |||
|
|
|||
| /** | |||
| * The multi-factor related properties for the current user if available. | |||
src/index.d.ts
Outdated
| }>; | ||
|
|
||
| /** | ||
| * List of enrolled second factors on the current user record. |
There was a problem hiding this comment.
List of second factors enrolled with the current user.
src/index.d.ts
Outdated
| }> | null; | ||
|
|
||
| /** | ||
| * The user's updated list of enrolled second factors. The provided list will always |
There was a problem hiding this comment.
The updated list of enrolled second factors. The provided list overwrites the user's existing list of second factors. When null is passed, all of the user's existing second factors are removed.
src/index.d.ts
Outdated
| @@ -791,6 +915,19 @@ declare namespace admin.auth { | |||
| */ | |||
| sign_in_provider: string; | |||
|
|
|||
| /** | |||
| * This is the type identifier or `factorId` of the second factor, provided the | |||
There was a problem hiding this comment.
The type identifier..
src/index.d.ts
Outdated
| sign_in_second_factor?: string; | ||
|
|
||
| /** | ||
| * This is the `uid` of the second factor used to sign in, provided the |
Adds missing multi-factor related claims to the
DecodedIdTokeninterface.