Forrest logo
tool overview
On this page you find all important commands for the CLI tool kcadm.sh. If the command you are looking for is missing please ask our AI.

kcadm.sh

  1. The kcadm.sh command line tool is a utility for managing Keycloak, an open-source identity and access management system.
  2. It provides a convenient way to interact with Keycloak's administrative features without relying on the graphical user interface.
  3. The tool is primarily used for automating administrative tasks, such as creating realms, managing users, and defining client applications.
  4. kcadm.sh is written in Bash scripting language and comes bundled with the Keycloak distribution.
  5. It can be found in the "bin" directory of the Keycloak installation.
  6. The tool requires authentication via a Keycloak administrator username and password or client credentials.
  7. With kcadm.sh, administrators can easily manage roles and permissions, set up user federation, and configure authentication flows and policies.
  8. It supports a wide range of commands, including creating and deleting users, groups, and roles, importing and exporting realm configurations, and updating various Keycloak settings.
  9. The output of executed commands can be formatted in multiple formats, such as JSON, YAML, or plain text, making it suitable for integrating with other automation tools.
  10. kcadm.sh is a powerful tool that greatly simplifies the administration of Keycloak, enabling administrators to efficiently manage various aspects of the system via the command line interface.

List of commands for kcadm.sh:

  • kcadm.sh:tldr:06bb7 kcadm.sh: Start an authenticated session.
    $ kcadm.sh config credentials --server ${host} --realm ${realm_name} --user ${username} --password ${password}
    try on your machine
    explain this command
  • kcadm.sh:tldr:39700 kcadm.sh: Update a realm with JSON config.
    $ kcadm.sh update realms/${realm_name} -f ${filename-json}
    try on your machine
    explain this command
  • kcadm.sh:tldr:6c7a8 kcadm.sh: Create a user.
    $ kcadm.sh create users -s username=${username} -r ${realm_name}
    try on your machine
    explain this command
  • kcadm.sh:tldr:c8fb5 kcadm.sh: List all realms.
    $ kcadm.sh get realms
    try on your machine
    explain this command
tool overview