keycloak.starter — keycloak-clojure 1.25.1

-main clj

(-main & args)

CLI_CONFIG clj

create-mappers! clj

(create-mappers! keycloak-client realm-name client-id mappers)

dissoc-sensitive-data clj

(dissoc-sensitive-data config-data)

edn-resources-bindings clj

(edn-resources-bindings resources-dir)

export-json clj

(export-json export-dir export-file-without-extension client-id path secrets)

export-secret-in-files! clj

(export-secret-in-files! keycloak-client
                         realm-name
                         client-id
                         {:keys [name-without-extension export-dir path]
                          :as secret-file})

export-secret-in-vault! clj multimethod

take the vendor value to dispatch the call to proper function, other value are specific to vault implementation:

• :hashicorp: in infra-context, [:vault :path] is a string with placeholders as: %1$s is the environment, %2$s is the color, %3$s is the base-domains, %4$s is the client-id (client-id depends of your realm-config.clj code)
• :gcp-sm: the vault entry of infra-contect must contains project-id and secret-id, also the google_application_credentials must be properly defined and available at runtime

export-yaml clj

(export-yaml export-dir export-file-without-extension client-id path secrets)

gen-users! clj

(gen-users! admin-client realm-name {:keys [groups] :as data})

generate-user clj

(generate-user username-creator-fn role group subgroup idx & opts)

init! clj

(init! admin-client data infra-context & [opts])

Create a structure of keycloak entities (realm, clients, roles) and fill it with groups and users. Arguments are:

• admin-client: admin client's Keycloak object obtained with: (keycloak.deployment/keycloak-client (keycloak.deployment/client-conf "http://localhost:8090" "master" "admin-cli") admin-login admin-password)
• data: the configuration data with keys realm, roles, groups and users (see the documentation for more details https://cljdoc.org/d/keycloak-clojure/keycloak-clojure/1.18.0/doc/administrative-tasks#declarative-creation-of-keycloak-objects)
• infra-context: a description of the keycloak infrastructure, the keys needed here is the :vault for secret export during clients creation
• opts: with two boolean entries dry-run? and apply-deletions?, respectively not applying the detected steps for attaining the desired state in data and whether the steps should delete the entities in Keycloak not in that state (sort of a very strict mode)

init-cli! clj

(init-cli! args)

init-cli-opts clj

init-clients! clj

(init-clients! admin-client realm-name clients-data infra-context)

init-realm! clj

(init-realm! admin-client
             {:keys [name themes login tokens smtp user-admin] :as realm-data})

init-roles! clj

(init-roles! admin-client realm-name roles-data)

init-users! clj

(init-users! admin-client realm-name users-data & [opts])

keycloak-auth-server-url clj

(keycloak-auth-server-url protocol host port)

process-args clj

(process-args {:keys [realm-config infra-context] :as args})