keycloak_to_azure.py

A script to sync users/groups from keycloak to azure AD federated accounts.

What it does ...

• The script loops a configurable map of groups.
• Each element in the map has a keycloak and an azure key value pair.
  • The keycloak and azure groups have to exist and are not created by the script.
• If a user is found in the keycloak group:
  • it is invited as a B2B guest user.
  • it is updated so that the user is of the type Member (not Guest) and placed in the configured azure group.
• If a member is removed from a keycloak group it is also removed in it's azure equivalent.

Dependencies and Requirements

We need a few Python packages installed.

To interact with the keycloak API:

• python-keycloak package

To parse the yaml config file:

• path package
• strictyaml package

The easiest way of installing these is:

pip install -r requirements.txt

Configuration

To use the script you need to supply it with several environment variables and a configfile.

Keycloak user

To read the users and groups from keycloak, you need a keycloak user with these roles:

• query-clients
• query-groups
• query-users
• view-clients
• view-groups
• view-users

Look at the Keycloak - Managing users documentation to get more information.

The user has to be passed to this script by setting these environment variables:

• KEYCLOAK_USER
• KEYCLOAK_PASSWORD

Azure application credentials

Wo add users to Azure AD, you need an azure app registration with these API permissions:

• Microsoft Graph -> User.*
• Microsoft Graph -> Group.*
• Microsoft Graph -> GroupMember.*

Look at the Quickstart: Register an application with the Microsoft identity platform documentation to get more information. Be sure to add a client secret.

The credentials have to be passed as these environment variables:

• AZURE_TENANT_ID
• AZURE_CLIENT_ID
• AZURE_CLIENT_SECRET (max expiry is 24 month!!!)

Script configuration

The script has a self-explanatory config file.

Do a cp keycloak_to_azure.config.yaml.example keycloak_to_azure.config.yaml and adapt the config to get started.

Please make sure that all the configured keycloak and azure groups already exist. The script will not take care of that.

Example configuration file:

❯ cat keycloak_to_azure.config.yaml.example
logfile: keycloak_to_azure.log
keycloak_url: https://auth.example.com/auth
keycloak_realm: acme
groups:
  - keycloak: group1
    azure: acme-group-1
  - keycloak: group2
    azure: acme-group-2
  - keycloak: group3
    azure: acme-group-3

Running the Script

If you configured all the environment variables, the config file and the keycloak and azure groups are created, you can run the script.

It will now take care of syncing the configured groups and their users.

./keycloak_to_azure.py
2023-04-03 07:46:42,250 [INFO] start run
2023-04-03 07:46:42,250 [INFO] invited azure user: [email protected]
2023-04-03 07:46:42,250 [INFO] updated azure user: xxxx-xxxx-xxxx-xxxx-xxxx - Firstname1 Lastname1
2023-04-03 07:46:42,250 [INFO] added user to group: xxxx-xxxx-xxxx-xxxx-xxxx xxxx-xxxx-xxxx-xxxx-xxxx
2023-04-03 07:46:47,107 [INFO] end run

Congratulations! You just synced your users and groups from keycloak to azure.