Keycloak Auth Module
The Keycloak authentication module is a pre-configured OAuth 2.0 auth module that lets users log in to Hub and any connected service with their Keycloak credentials.
Enable Keycloak Authentication
To let users with existing Keycloak accounts to log in to Hub, enable the authentication module.
This procedure takes place in three steps:
Create a Keycloak Auth Module. When you create an authentication module, Hub generates a redirect URI to use with the authorization service. This URI identifies the source of each login request.
Generate a Client ID and Secret in Keycloak. Every login request sent from Hub includes a unique identifier. The ID and secret you store in the authentication module tell the Keycloak authorization service that each login request is authorized.
Enable the Auth Module in Hub. When you have generated the information Hub uses to authenticate with the Keycloak authorization service, copy the values into Hub and enable the module.
Create a Keycloak Auth Module in Hub
First, create the Keycloak authentication module. When you perform this action, Hub generates a redirect URI to use with the authorization service.
To create a Keycloak authentication module:
In the Access Management section of the Administration menu, select .
From the New Module drop-down list, select Keycloak.
The New Keycloak Auth Module dialog opens.
In the New Keycloak Auth Module dialog, enter values for the following settings:
Keycloak root URL
Enter the root URL for your Keycloak server.
Enter the name of the Keycloak realm where you manage the user accounts that you want to allow access to Hub.
Click the Create button.
The Auth Modules page displays the settings for a new Keycloak authentication module.
Hub generates a redirect URI for you to use in the authorization service.
Generate a Client ID and Secret
The next step is to obtain a client ID and secret from Keycloak.
Log in to the admin console with your administrator account.
Select your realm from the list.
From the Configure menu, select Clients.
Click the Create button.
The Add Client dialog opens.
Enter values for the following settings:
For the Client ID, enter a value that helps you identify the client application.
For the Client Protocol, select openid-connect.
For the Root URL, enter the base URL for your Hub installation.
Click the Save button.
The page that stores the settings for your new client application opens.
On the Settings tab for your client app, change the Access Type to confidential.
Click the Save button.
Use the value that is stored as the Client ID to enable the authentication module in Hub.
Select the Credentials tab, then use the value that is stored as the Secret to enable the authentication module in Hub.
For additional information, please refer to the Keycloak documentation.
Enable the Auth Module in Hub
To complete the setup, store the client ID and secret from the authorization service in the Keycloak auth module.
Copy the Client ID from the Settings tab in Keycloak and paste it into the Client ID input field in Hub.
Copy the Secret from the Credentials tab in Keycloak and paste it into the Client secret input field in Hub.
Configure the optional settings for the authentication module. For more information, see Additional Settings.
Click the Save button to apply the settings.
Click the Enable module button.
The Keycloak authentication module is enabled.
The icon stored in the Button image setting is added to the login dialog window. Users can click this icon to log in to Hub with their Keycloak credentials.
The first section of the settings page displays the general settings for the authentication module. Here, you also find the redirect URI that you use to register Hub in the authorization service and the input fields that store the Client ID and Client Secret that are generated in the authorization service.
Displays the type of authorization service that is enabled for third-party authentication in Hub.
Stores the name of the authentication module. Use this setting to distinguish this module from other authentication modules in the Auth Modules list.
Displays the image used for the button that a user clicks to log in to Hub with a their account in the connected authorization service. You can upload a JPG, GIF or PNG file. The image is resized to 48 x 48 pixels automatically.
Displays the authorized redirect URI that is used to register the connection to Hub in the authorization service.
Stores the identifier that the authorization service uses to validate a login request. You generate this value in the authorization service when you configure the authorization settings for a web application and enter an authorized redirect URI.
Stores the secret or password used to validate the client ID. You generate this value in the authorization service together with the client ID.
Saves the value that is used to identify the authentication module when used for extension grants. If a value is provided, Hub will process requests to exchange access tokens that are issued by the authorization service for tokens that grant access to Hub.
To exchange access tokens successfully, the authentication module must be authorized in the third-party authentication service and enabled in Hub.
To learn how to exchange access tokens using the Hub REST API, see Extension Grants.
Authorization Service Endpoints
The settings in this section of the page store the OAuth 2.0 endpoints used by Keycloak.
For pre-configured OAuth 2.0 modules, the values that are used by the selected authorization service are set automatically.
Stores the endpoint that Hub uses to obtain authorization from the resource owner via user-agent redirection.
Stores the endpoint that Hub uses to exchange an authorization grant for an access token.
Stores the endpoint used to locate profile data for the authenticated user.
The endpoint used to locate the email address of the authenticated user. Use only when the email address is not stored in the user profile.
The endpoint used to locate the binary file that is used as the avatar for the authenticated user. Use only when the avatar isn’t stored directly in the user profile.
When a user profile response object is returned by Keycloak, values from the specified field paths are copied to the user profile in Hub. Use the following settings to define the endpoint that locates profile data for the authenticated user and map fields that are stored in the authorization service to user accounts in Hub.
For the predefined Keycloak module, the User ID, Email, Email verification state, Full name, and Groups are set automatically. If you need to modify these values to suit your needs, you can overwrite them.
To specify paths to fields inside nested objects, enter a sequence of segments separated by the slash character (
To reference values that may be stored in more than one location, use the "Elvis operator" (
?:) as a delimiter for multiple paths. With this option, Hub uses the first non-empty value it encounters in the specified field.
Maps to the field that stores the value to copy to the User ID property in Hub.
Maps to the field that stores the value to copy to the Username field in the Hub profile.
This option is available in Hub versions 2023.1.15453 and later.
Maps to the field that stores the value to copy to the Full name field in the Hub profile.
Maps to the field that stores the value to copy to the Email field in the Hub profile.
Email verification state
Maps to the field that stores the value to copy to the verified email property in Hub.
Maps to the field that stores the image to use as the Avatar in the Hub profile.
Image URL pattern
Generates an image URL for avatars that are referenced by an ID. Use the <picture-id> placeholder to reference the field that stores the avatar.
Maps to the attribute that stores group membership assignments in the connected authorization service.
When this value is specified, you can map and sync group memberships in the authorization service with corresponding groups in Hub. For details, see Group Mappings.
The following options are located at the bottom of the page. These settings let you define the request scope and choose how to authenticate with the service.
For the predefined Keycloak module, the Scope is set automatically. If you need to modify this value to suit your needs, you can overwrite it.
Other options in this section let you manage Hub account creation and group membership and reduce the loss of processing resources consumed by idle connections.
Sets the scope for the access request. Enter a list of scopes, separated by spaces.
Determines how credentials are passed to the authorization service.
Enables creation of Hub accounts for unregistered users who log in with an account that is stored in the connected authorization service. Hub uses the email address to determine whether the user has an existing account.
Determines how Hub sets the verification status of an email address when the authentication service does not return a value for this attribute.
Adds users to a group when they log in with an account that is stored in the connected authorization service. You can select one or more groups. New users that auto-join a group inherit all the permissions assigned to this group.
We recommend that you add users to at least one group. Otherwise, a new user is only granted the permissions that are currently assigned to the All Users group.
Sets the period of time to wait to establish a connection to the authorization service. The default setting is 5000 milliseconds (5 seconds).
Sets the period of time to wait to read and retrieve user profile data from the authorization service. The default setting is 5000 milliseconds (5 seconds).
Links to the Audit Events page in Hub. There, you can view a list of changes that were applied to this authentication module.
On the Group Mappings tab, you can map existing groups in the authorization service to the groups in Hub.
If you want to map groups in Keycloak to groups in Hub, you need to specify the Groups attribute that stores Keycloak group memberships in the Field Mapping section of the settings for this auth module. For the predefined Keycloak module, the Groups attribute and Scope are set automatically.
When group mappings are configured, Hub checks for Keycloak group memberships when users log in with accounts that are managed in the directory service. Hub performs the following operations for each Keycloak group that is mapped to a Hub group:
Users who are members of a mapped Keycloak group and are not members of the mapped Hub group are added to the group in Hub.
Users who are not members of a mapped Keycloak group and are members of the mapped Hub group are removed from the group in Hub.
Changes to group memberships in the authorization service are only applied in Hub when users log in using their Keycloak accounts.
You can map multiple Keycloak groups to a single target group in Hub. You can't map Keycloak groups to more than one Hub group.
To map group from Keycloak to a group in Hub:
Open your Keycloak auth module.
Select the Group Mappings tab.
Click the Add mapping button.
The Add Mapping dialog opens.
Enter the name of the Keycloak group in the OAuth group name field.
Select a group from the Target group list.
Click the Add button.
The mapping is added to the list.