Skip to content

Commit 36c974d

Browse files
authored
Merge pull request #1 from dbgate/keycloak-auth
Keycloak doc
2 parents f68ba5d + cfea377 commit 36c974d

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

content/admin/auth.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,25 @@ There are several methods of authentication. Use will choose authentication meth
1717

1818
### Option "Allow only defined logins"
1919
For external identity providers, user doesn't have to exist in DbGate storage database. If this checkbox is checked, user, which is not found in storage database, is not allowed to login
20+
21+
### Keycloak
22+
23+
Keycloak can be integrated with DbGate using the generic OAuth 2.0 Provider. To configure Keycloak authentication, you need to:
24+
25+
1. Create a new client in your Keycloak realm
26+
2. Configure the client settings
27+
3. Set up the OAuth 2.0 provider in DbGate with the following parameters:
28+
29+
**Required Configuration:**
30+
- **OAuth auth endpoint**: `https://keycloak.company.com/realms/your-realm/protocol/openid-connect/auth`
31+
- **OAuth token endpoint**: `https://keycloak.company.com/realms/your-realm/protocol/openid-connect/token`
32+
- **OAuth logout endpoint**: `https://keycloak.company.com/realms/your-realm/protocol/openid-connect/logout`
33+
- **OAuth client**: Your Keycloak client ID
34+
- **OAuth login field**: the Keycloak claim that contains the user's login identifier (commonly `preferred_username`; depending on your Keycloak configuration you may also use `given_name`, `email`, or another suitable claim)
35+
36+
**Keycloak Client Configuration:**
37+
- Valid Redirect URIs: `https://dbgate.company.com/`
38+
39+
Make sure your Keycloak user attributes are properly mapped to provide the necessary claims (email, name, username) that DbGate expects from the OAuth provider.
40+
41+

0 commit comments

Comments
 (0)