Skip to content

Add documentation for the new all_emails scope in OIDC #201

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.

Sign up for GitHub

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

Merged
jmhooper merged 3 commits into from
Nov 5, 2021
Merged

Add documentation for the new all_emails scope in OIDC #201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
412f2cb
Add documentation for the new `all_emails` scope in OIDC
jmhooper Oct 20, 2021
01ff970
pr feedback
jmhooper Oct 20, 2021
f13ad28
pr feedback, but better
jmhooper Oct 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions _pages/attributes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,23 @@ Requires the `email` scope.
</tr>
<tr>
<td markdown="1">
**All emails**<br />All of the email addresses on the user's account
</td>
<td markdown="1">
![checkmark][checkmark]
</td>
<td markdown="1">
![checkmark][checkmark]
</td>
<td markdown="1">
`all_emails` (array of strings)
</td>
<td markdown="1">
Not implemented
Copy link
Contributor

@orenyk orenyk Oct 22, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: should we make this bold or something to emphasize it? Maybe red? Also, can we say Not yet implemented since presumably we will implement it at some point?

</td>
</tr>
<tr>
<td markdown="1">
**IAL**<br />Identity Assurance Level [NIST 800-63-3](https://pages.nist.gov/800-63-3/).
</td>
<td markdown="1">
Expand Down
2 changes: 2 additions & 0 deletions _pages/oidc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,7 @@ https://idp.int.identitysandbox.gov/openid_connect/authorize?
- `openid`
- `address`
- `email`
- `all_emails`
- `phone`
- `profile:birthdate`
- `profile:name`
Expand Down Expand Up @@ -384,6 +385,7 @@ Here's an example response:
"birthdate": "1970-01-01",
"email": "test@example.com",
"email_verified": true,
"all_emails": ["test@example.com", "test2@example.com"],
"family_name": "Smith",
"given_name": "John",
"iss": "https://idp.int.identitysandbox.gov",
Expand Down