Connect to an existing Keycloak instance

In this guide, we'll demonstrate how to connect Identity to your existing Keycloak instance.

Prerequisites

• Access to your Keycloak Admin Console
• A basic understanding of administering realms and clients in Keycloak

Steps

To connect Identity to an existing Keycloak instance, take the following steps for your Camunda installation:

Non-Helm installations

1. Log in to your Keycloak Admin Console.
2. Select the realm you would like to connect Identity to. In our example, this is camunda-platform.
3. Select Clients in the navigation menu, and click the Create button to create a new client.
4. Enter a client ID and click Next.
   What client ID should I use?

   By default, Identity uses the Client ID camunda-identity, so we recommend using this too. If you choose a different client ID, this will need to be set in the Identity application environment variables.

   
5. Toggle Client authentication to on, select Service accounts roles and click Next.
6. Enter the URL of where your Identity instance will be hosted in the Root URL field and click Save to create the client.
7. On the page for the created client navigate to the Service account roles tab in the top navigation.
8. Click Assign role and change the filter to Filter by clients.
9. Select the manage-clients, manage-realm, and manage-users role from the list and click Assign.
   Why does Identity need these roles?

   Identity is designed to allow users to manage the various entities related to Camunda. To achieve this, it requires specific access to the realm.

10. Navigate to the Credentials tab and copy the client secret.
11. Set the IDENTITY_CLIENT_SECRET environment variable with the value from Step 9.
12. Set the KEYCLOAK_REALM environment variable to the realm you selected in Step 2.
    tip

    If you are using a specific realm, you need to set additional variables to use the intended realm. See the environment variables page for details of Keycloak-specific variables to consider.

13. Start Identity.

Helm installations

1. Log in to your Keycloak Admin Console.
2. Verify the name of the realm you would like to connect Identity to. In our example, this is camunda-platform.
3. Set the KEYCLOAK_REALM environment variable to the realm you selected in Step 2.
4. Start Identity.

What does Identity create when starting?

Identity creates a base set of configurations required to function successfully. To understand more about what is created and why, see the starting configuration.

Considerations

When connecting Identity to a shared realm, accurately determining what clients should and should not be displayed in the Identity UI is not possible. Therefore, the clients in the realm you connect Identity to will be shown in the Identity UI and can have their secrets viewed and updated. Users with access to Identity should be considered as having administrator-level access to the system.