Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 1.63 KB

README.md

File metadata and controls

31 lines (24 loc) · 1.63 KB
Raw

keycloak-converger

Build Status

This command line tool converges a keycloak realm to ensure it contains the required clients. The set of clients are based on set of keycloak json configuration files contained in a directory. The keycloak configuration may have handlebars replacement sections inside it to make it easy to customize the templates for the environment.

All clients that appear in the directory will be created (if not present in realm) or updated (if alreayd in the realm). If a client does not exist in client directory and has not been specified as an "unmanaged-client" then it will be deleted.

The easiest way to see the options for the command is to pass the --help parameter to the command via:

java -jar keycloak-converger.jar --help

However, a typical command that converges a default looking keycloak realm

java -jar keycloak-converger.jar \
          -d config \
          --admin-password=secret \
          --server-url=https://id.example.com/ \
          --realm-name=MyRealm \
          --unmanaged-client=admin-cli \
          --unmanaged-client=account \
          --unmanaged-client=broker \
          --unmanaged-client=realm-management \
          --unmanaged-client=security-admin-console