docs: add supported scopes of oauth provider

This commit is contained in:
Jens Langhammer 2020-06-18 19:39:58 +02:00
parent 5e8a1e3c0d
commit bdf0e74af3
2 changed files with 8 additions and 1 deletions

View File

@ -10,6 +10,13 @@ This provider uses the commonly used OpenID Connect variation of OAuth2.
This provider is slightly different than the OpenID Provider. While it uses the same basic OAuth2 Protocol, it provides a GitHub-compatible Endpoint. This allows you to integrate Applications, which don't support Custom OpenID Providers. This provider is slightly different than the OpenID Provider. While it uses the same basic OAuth2 Protocol, it provides a GitHub-compatible Endpoint. This allows you to integrate Applications, which don't support Custom OpenID Providers.
The API exposes Username, E-Mail, Name and Groups in a GitHub-compatible format. The API exposes Username, E-Mail, Name and Groups in a GitHub-compatible format.
This provider currently supports the following scopes:
- `openid`: Access OpenID Userinfo
- `userinfo`: Access OpenID Userinfo
- `email`: Access OpenID Email
- `user:email`: GitHub Compatibility: User Email
- `read:org`: GitHub Compatibility: User Groups
## SAML Provider ## SAML Provider

View File

@ -23,7 +23,7 @@ OAUTH2_PROVIDER = {
# this is the list of available scopes # this is the list of available scopes
"SCOPES": { "SCOPES": {
"openid": "Access OpenID Userinfo", "openid": "Access OpenID Userinfo",
"openid:userinfo": "Access OpenID Userinfo", "userinfo": "Access OpenID Userinfo",
"email": "Access OpenID Email", "email": "Access OpenID Email",
"user:email": "GitHub Compatibility: User Email", "user:email": "GitHub Compatibility: User Email",
"read:org": "GitHub Compatibility: User Groups", "read:org": "GitHub Compatibility: User Groups",