Configure OpenID Connect (OIDC) authentication with Keycloak

This topic describes how to configure Keycloak as an Identity provider for OpenId Connect to login in Release and protect the REST APIs using the Bearer Token Authorization.


Keycloak is an open source Identity and Access management solution. It is based on popular standards such as Security Assertion Markup Language (SAML) 2.0, OpenID Connect, and OAuth 2.0.


See the Keycloak documentation website, for more information on the hardware requirements, distribution directory structure, and operation mode.

We use the docker-compose example from to setup keycloak.

Keycloak default screen

Set up a realm

First, we will create a new realm. On the top left, navigate to Master, open the dropdown menu, and click Add realm.

Add realm

Add a new digitalai-platform realm as shown below.

digitalai-platform realm

Realm details

Add roles

We will add different roles in Keycloak as shown below.

Add role

All roles

Add users

We will now add new users in Keycloak. Fill in all fields, such as Username, Email, First Name, and Last Name.

Add user

Select the appropriate role mappings for a user.

Map roles

All users

Set up a client

The next step is to create a client in our realm, as shown below.

Add client

Fill in all of the mandatory fields in the client form. Pay attention to Direct Grant Flow and set its value to direct grant. Change the Access Type to confidential.

Client details

Direct grant

Select builtin mappers for newly created client.

Client mappers

Make sure that username and groups mappings are present in both the id token and the access token.

Group mapping

Add new client scope

Next, we have to create a new client scope for REST APIs, as shown below.

Add client scope

Add new protocol mapper

Add a new protocol mapper to add audience information in the access token, as shown below.

Add protocol mapper

Set default client scope

The final step is to add the client scope release-rest-api as the default for the release client, as shown below.

Add default client scope

Copy the client’s credentials which we will be using later.

Client credentials

Set up Release

Now let’s configure OpenID Connect (OIDC) authentication for Release. Follow the setup process from Release OIDC Setup Guide.

Below is our oidc configuration from xl-release.conf.

xl {
    security {
        auth {
            providers {
                oidc {


                    scopes =["openid"]

Using Keycloak on Kubernetes Operator-based Deployment

If you are planning to use Keycloak with Release, you must set the oidc.enabled to True, and configure the value for the OIDC parameters in the cr.yaml file as described in the following table:

Description Configuration
Client credentials from Release to Keycloak
Client credentials from Release to Keycloak
User property mappings
URLs from Browser to Keycloak
URLs from Browser to Release
URLs from Release to Keycloak

Note: The path-based routing will not work if you use OIDC authentication. To enable path-based routing, you must modify the ingress specification in the cr.yaml file as follows:

  • Set /$2 to /
  • Set ingress.path: /xl-release(/|$)(.*) to /

For more information about Kubernetes Operator, see Kubernetes Operator.

Test your set up

Open your Release URL in the browser and you should be redirected to Keycloak login page. Enter credentials of any user created on keycloak.

Release login

User profile will be created for the new user in release.

After login

Test public REST APIs

Generate an access token using the password grant type flow for your client. You can use the curl command, as shown below.

curl -L -X POST 'http://localhost/auth/realms/digitalai-platform/protocol/openid-connect/token' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id=release' \
--data-urlencode 'grant_type=password' \
--data-urlencode 'client_secret=61c5c3d6-5eb5-40cd-a396-32dd3d271f63' \
--data-urlencode 'scope=release-rest-api' \
--data-urlencode 'username=alice' \
--data-urlencode 'password=alice'

Alternatively, we can use REST API tools like Postman, as shown below.

Postman request

The response would be a valid JWT Token:

    "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUI...Daw3OcJ2aPFzXY1cpHmH0W36TTfgfYGHgnDqB4w",
    "expires_in": 600,
    "refresh_expires_in": 1800,
    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldU...YlO6MzdDRhx_J3WShGXesjOmhY",
    "token_type": "bearer",
    "not-before-policy": 0,
    "session_state": "d2c14e42-9bc3-4416-9bea-02aa6adb770e",
    "scope": "profile release-rest-api email"

We can now pass the access_token as a Bearer Token to authenticate the Release public REST APIs.

curl -L -X GET 'http://localhost:5516/api/v1/releases/' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUI...Daw3OcJ2aPFzXY1cpHmH0W36TTfgfYGHgnDqB4w'