Skip to content

Commit 55fe166

Browse files
authored
Add extraScopes and enforceScopes configuration options to OAuth2 documentation (#62)
Signed-off-by: santhana krishnan <29514440+hashkrish@users.noreply.github.com>
1 parent 62b4de3 commit 55fe166

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

docs/reference/auth-oauth2.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,10 @@ auth:
9898
url: https://your-oidc-server.example.com/
9999
deviceFlow: true|false
100100
authorizationCodeFlow: true|false
101+
extraScopes:
102+
- scope1
103+
- scope2
104+
enforceScopes: true
101105
<other oidc options>
102106
```
103107

@@ -109,6 +113,8 @@ The following configuration options are supported:
109113
| `authorizationCodeFlow` | `bool` | Use authorization code flow when authenticating. Defaults to false. |
110114
| `usernameField` | `string` | The field from the result of the userinfo OIDC endpoint to use as the username. Defaults to `sub` |
111115
| `redirectURI` | `string` | The URI the client is returned to after successful authorization flow authentication. |
116+
| `extraScopes` | `[]string` | A list of extra scopes to request from the user in addition to "openid". |
117+
| `enforceScopes` | `bool` | If set to `true` the authentication will fail if the user doesn't grant the scopes requested in `extraScopes`. |
112118

113119
The device flow takes precedence over the authorization code flow if enabled.
114120

0 commit comments

Comments
 (0)