2020-03-12 22:37:35 +01:00
---
title: OpenID Connect Configuration
category: Getting Started
chapter: 1
order: 9
---
2020-03-21 21:09:41 +01:00
Generally, Dependency-Track can be used with any identity provider that implements the [OpenID Connect standard ](https://openid.net/connect/ ).
2020-03-17 19:08:08 +01:00
connect2id maintains a list of [public OpenID Connect Identity Providers ](https://connect2id.com/products/nimbus-oauth-openid-connect-sdk/openid-connect-providers ).
Although usage with public providers is technically possible, it's strongly recommended to only use providers
that you or your organization have full control over. Misconfiguration may allow third parties to gain access to
your Dependency-Track instance!
2020-03-12 22:37:35 +01:00
2020-03-21 21:09:41 +01:00
Dependency-Track has been tested with multiple OpenID Connect identity providers. The following are
2020-03-17 19:08:08 +01:00
some example configurations that are known to work. If you find that the provider of your choice does not work
with Dependency-Track, please [file an issue ](https://github.com/DependencyTrack/dependency-track/issues ).
2020-03-12 22:37:35 +01:00
#### GitLab (gitlab.com)
```ini
2020-03-17 19:08:08 +01:00
alpine.oidc.enabled=true
2020-03-22 19:23:30 +01:00
alpine.oidc.issuer=https://gitlab.com
2020-03-17 19:08:08 +01:00
alpine.oidc.user.provisioning=true
2020-03-12 22:37:35 +01:00
alpine.oidc.username.claim=nickname
2020-03-17 19:08:08 +01:00
alpine.oidc.team.synchronization=true
alpine.oidc.always.sync.teams=true
2020-03-12 22:37:35 +01:00
alpine.oidc.teams.claim=groups
```
Please refer to the official documentation on [how to use GitLab as OpenID Connect Identity Provider ](https://docs.gitlab.com/ee/integration/openid_connect_provider.html ).
#### Keycloak
```ini
2020-03-17 19:08:08 +01:00
alpine.oidc.enabled=true
2020-03-22 19:23:30 +01:00
alpine.oidc.issuer=http://localhost:8080/auth/realms/master
2020-03-17 19:08:08 +01:00
alpine.oidc.user.provisioning=true
2020-03-12 22:37:35 +01:00
alpine.oidc.username.claim=preferred_username
2020-03-17 19:08:08 +01:00
alpine.oidc.team.synchronization=true
alpine.oidc.always.sync.teams=true
2020-04-11 12:21:44 +02:00
alpine.oidc.teams.claim=groups
2020-03-12 22:37:35 +01:00
```
2020-03-17 19:08:08 +01:00
Keycloak does not include group or role information in its UserInfo endpoint per default. If you want to use
Dependency-Track's team synchronization feature, you'll have to create a mapper for the Dependency-Track client:
Depending on your setup you would use the mapper types `Group Membership` (as shown above) or `User Realm Role` .
2020-03-21 21:09:41 +01:00
Make sure `Add to userinfo` is enabled.
