Synchronize users with an Identity Provider
The Console uses external Identity Providers to manage user identities and authentication; configuration details can be found in the Console Installation documentation section dedicated to the Authentication Provider.
The list of supported providers is:
- Okta
- Keycloak
- GitLab
- GitHub
- Microsoft
- Bitbucket
How to setup user synchronization
If you want to synchronize users between the Identity Provider and the Console, making it possible to automatically create or delete users in the Console when you create or delete them on your Identity Provider, you can use the following webhook:
POST /api/webhooks/apps/console/providers/:providerId/user
Where providerId must be set based on the authProvider.name configuration field set in the installation chart
Webhooks are not exposed by default, to make them available check-out user synchronization activation flag.
User synchronization is officially supported only for Okta OIE.
To find out more about Event Hooks and how to configure them check out the official documentation page.