Skip to content
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

Update authentication.md #3

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Update authentication.md #3

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
24 changes: 12 additions & 12 deletions docs/thehive/installation-and-configuration/configuration/authentication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ Authenticates HTTP requests using a cookie. This module manage the cookie creati
| `warning` | duration | the time before the expiration TheHive returns a warning message |


!!! Example
!!! Example

```yaml
auth {
providers = [
Expand Down Expand Up @@ -144,7 +144,7 @@ Authenticate the user using an external OAuth2 authenticator server. It accepts
| -----------------------| ------- | ------------------------------------ |
| `clientId` | string | client ID in the OAuth2 server |
| `clientSecret` | string | client secret in the OAuth2 server |
| `redirectUri` | string | the url of TheHive AOuth2 page ( `xxx/api/ssoLogin`) |
| `redirectUri` | string | the url of TheHive AOuth2 page ( `xxx/api/v1/ssoLogin`) |
| `responseType` | string | type of the response. Currently only "code" is accepted |
| `grantType` | string | type of the grant. Currently only "authorization_code" is accepted |
| `authorizationUrl` | string | the url of the OAuth2 server |
Expand Down Expand Up @@ -173,7 +173,7 @@ Authenticate the user using an external OAuth2 authenticator server. It accepts
name: oauth2
clientId: "CLIENT_ID"
clientSecret: "CLIENT_SECRET"
redirectUri: "http://THEHIVE_URL/api/ssoLogin"
redirectUri: "http://THEHIVE_URL/api/v1/ssoLogin"
responseType: "code"
grantType: "authorization_code"
authorizationUrl: "http://KEYCLOAK/auth/realms/TENANT/protocol/openid-connect/auth"
Expand Down Expand Up @@ -202,7 +202,7 @@ Authenticate the user using an external OAuth2 authenticator server. It accepts
name: oauth2
clientId: "CLIENT_ID"
clientSecret: "CLIENT_SECRET"
redirectUri: "http://THEHIVE_URL/api/ssoLogin"
redirectUri: "http://THEHIVE_URL/api/v1/ssoLogin"
responseType: "code"
grantType: "authorization_code"
authorizationUrl: "https://OKTA/oauth2/v1/authorize"
Expand Down Expand Up @@ -231,7 +231,7 @@ Authenticate the user using an external OAuth2 authenticator server. It accepts
name: oauth2
clientId: "CLIENT_ID"
clientSecret: "CLIENT_SECRET"
redirectUri: "http://THEHIVE_URL/api/ssoLogin"
redirectUri: "http://THEHIVE_URL/api/v1/ssoLogin"
responseType: code
grantType: "authorization_code"
authorizationUrl: "https://github.com/login/oauth/authorize"
Expand All @@ -242,16 +242,16 @@ Authenticate the user using an external OAuth2 authenticator server. It accepts
userIdField: "email"
#userOrganisation: ""
}

]
}
```

!!! Note
- `CLIENT_ID` and `CLIENT_SECRET` are created in the _OAuth Apps_ section at [https://github.com/settings/developers](https://github.com/settings/developers).
- this configuration requires that users set the _Public email_ in their Public Profile on [https://github.com/settings/profile](https://github.com/settings/profile).

=== "Microsoft 365"
=== "Microsoft 365"

```yaml

Expand All @@ -266,7 +266,7 @@ Authenticate the user using an external OAuth2 authenticator server. It accepts
name: oauth2
clientId: "CLIENT_ID"
clientSecret: "CLIENT_SECRET"
redirectUri: "http://THEHIVE_URL/api/ssoLogin"
redirectUri: "http://THEHIVE_URL/api/v1/ssoLogin"
responseType: code
grantType: "authorization_code"
authorizationUrl: "https://login.microsoftonline.com/TENANT/oauth2/v2.0/authorize"
Expand All @@ -284,7 +284,7 @@ Authenticate the user using an external OAuth2 authenticator server. It accepts
!!! Note
To create `CLIENT_ID`, `CLIENT_SECRET` and `TENANT`, register a new app at [https://aad.portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredApps](https://aad.portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredApps).

=== "Google"
=== "Google"

```yaml

Expand All @@ -299,7 +299,7 @@ Authenticate the user using an external OAuth2 authenticator server. It accepts
name: oauth2
clientId: "CLIENT_ID"
clientSecret: "CLIENT_SECRET"
redirectUri: "http://THEHIVE_URL/api/ssoLogin"
redirectUri: "http://THEHIVE_URL/api/v1/ssoLogin"
responseType: code
grantType: "authorization_code"
authorizationUrl: "https://accounts.google.com/o/oauth2/v2/auth"
Expand Down