-
Notifications
You must be signed in to change notification settings - Fork 375
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(auth): Defines missing DecodedIdToken
types.
#852
Conversation
DecodedIdToken
types.DecodedIdToken
types.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Over to @egilmorez for doc review.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some suggestions and questions, thanks!
src/auth.d.ts
Outdated
@@ -420,6 +420,17 @@ export namespace admin.auth { | |||
*/ | |||
auth_time: number; | |||
|
|||
/** | |||
* The email corresponding to the user who the ID token belonged to, if available. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The email of the user to whom the ID token belonged, if available.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
src/auth.d.ts
Outdated
email?: string; | ||
|
||
/** | ||
* Whether the email corresponding to the user who the ID token belonged to is |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest "Whether or not the email of the user to whom the ID token belonged is verified, provided the user has an email."
Are the valid values true and false?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, true or false. Done.
src/auth.d.ts
Outdated
@@ -494,6 +505,18 @@ export namespace admin.auth { | |||
*/ | |||
iss: string; | |||
|
|||
/** | |||
* The phone number corresponding to the user who the ID token belonged to, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest "The phone number of the user to whom the ID token belonged, if available."
Or -- can these be present tense "belongs?" That would be preferable if it is accurate.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done on both.
src/auth.d.ts
Outdated
phone_number?: string; | ||
|
||
/** | ||
* The photo URL corresponding to the user who the ID token belonged to, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest "The photo URL for the user to whom the ID token belonged..."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
Fixes #846
RELEASE NOTE: Exposed
email
,email_verified
,phone_number
andpicture
fields from theDecodedIdToken
type.