Skip to content
This repository has been archived by the owner on Sep 20, 2023. It is now read-only.

Commit

Permalink
#70 fix oauth2
Browse files Browse the repository at this point in the history
  • Loading branch information
jeromeleonard committed Oct 29, 2020
1 parent 773b186 commit 1981fce
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions admin/admin-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ This administration guide applies to Cortex 2 only.
* [Database](#database)
* [Analyzers](#analyzers-1)
* [Authentication](#authentication)
* [OAuth2/OpenID Connect](#OAuth2openid-connect)
* [Cache](#cache)
* [Performance](#performance)
* [Analyzer Results](#analyzer-results)
Expand Down Expand Up @@ -334,7 +335,7 @@ auth {
# The endpoint from which to obtain user details using the OAuth token, after successful login
#userUrl = "https://auth-site.com/api/User"
#scope = "openid profile"
#scope = ["openid profile"]
}
# Single-Sign On
Expand Down Expand Up @@ -389,7 +390,17 @@ session {
}
```

#### OAuth2
#### OAuth2/OpenID Connect

To enable authentication using OAuth2/OpenID Connect, edit the `application.conf` file and supply the values of `auth.oauth2` according to your environment. In addition, you need to supply:

- `auth.sso.attributes.login`: name of the attribute containing the OAuth2 user's login in retreived user info (mandatory)
- `auth.sso.attributes.name`: name of the attribute containing the OAuth2 user's name in retreived user info (mandatory)
- `auth.sso.attributes.groups`: name of the attribute containing the OAuth2 user's groups (mandatory using groups mappings)
- `auth.sso.attributes.roles`: name of the attribute containing the OAuth2 user's roles in retreived user info (mandatory using simple mapping)

##### Important notes


Authenticate the user using an external OAuth2 authenticator server. The configuration is:

Expand Down

0 comments on commit 1981fce

Please sign in to comment.