Skip to content

chore: document OIDC scopes requested by Coder #1151

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
merged 1 commit into from
Oct 17, 2022
Merged

chore: document OIDC scopes requested by Coder #1151

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions admin/access-control/manage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ article.

## Coder's OIDC claims

Coder will request the scopes `openid`, `email`, and `profile` from your OIDC
provider.

Coder expects the following
[OIDC claims](https://developer.okta.com/blog/2017/07/25/oidc-primer-part-1#whats-a-claim)
from your OIDC provider:
Expand All @@ -26,6 +29,11 @@ from your OIDC provider:

- `preferred_username` (username for dev URLs)

If the `name` or `email` claims are not present in the identity token returned
from your OIDC provider, Coder will request these from the `user-info` endpoint
of your OIDC provider. If hitting this endpoint is problematic, ensure that your
OIDC provider returns these claims in the tokens it provides.

You may need to map these to your existing claims within your OIDC provider's
admin console. If `name` and `preferred_username` are not provided, Coder will
derive both claims from the email address.
Expand Down