Forrest logo
back to the kcadm.sh tool

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

This command is using the "kcadm.sh" script to update a Keycloak realm with the specified JSON file.

Here is a breakdown of the command:

  • "kcadm.sh" is a script provided by Keycloak, an open-source identity and access management tool. It is used to perform administrative tasks via the command line.
  • "update" is the action being performed by the script, indicating that the specified realm should be updated with the data from the JSON file.
  • "realms/${realm_name}" specifies the realm name as a variable. You need to replace "${realm_name}" with the actual name of the realm you want to update.
  • "-f ${filename-json}" indicates that the JSON data for the update is stored in a file. You need to replace "${filename-json}" with the actual file name, including the .json extension, that contains the update data.

In summary, this command is telling the Keycloak administration script to update a specific realm using the JSON data stored in a specified file.

This explanation was created by an AI. In most cases those are correct. But please always be careful and never run a command you are not sure if it is safe.
back to the kcadm.sh tool