k-space/dex
Archived
11
0
Fork 0
Code Issues Pull Requests Packages Projects Activity

connector/github: enable private, primary emails; refactor API calls

Browse Source 
Documentation: removed private emails caveats section
This commit is contained in:
Eric Stroczynski
2017-08-07 15:58:26 -07:00
parent 45bf061236
commit 26527011ab
2 changed files with 139 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/github-connector.md
View File

@@ -6,10 +6,6 @@ One of the login options for dex uses the GitHub OAuth2 flow to identify the end
When a client redeems a refresh token through dex, dex will re-query GitHub to update user information in the ID Token. To do this, __dex stores a readonly GitHub access token in its backing datastore.__ Users that reject dex's access through GitHub will also revoke all dex clients which authenticated them through GitHub.
## Caveats
* Please note that in order for a user to be authenticated via GitHub, the user needs to mark their email id as public on GitHub. This will enable the API to return the user's email to Dex.
## Configuration
Register a new application with [GitHub][github-oauth2] ensuring the callback URL is `(dex issuer)/callback`. For example if dex is listening at the non-root path `https://auth.example.com/dex` the callback would be `https://auth.example.com/dex/callback`.