diff --git a/3.1.2/.buildinfo b/3.1.2/.buildinfo new file mode 100644 index 0000000..adb6965 --- /dev/null +++ b/3.1.2/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file records the configuration used when building these files. When it is not found, a full rebuild will be done. +config: d467fc61b229e225ee7a5201e1d13e3b +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/3.1.2/CHANGELOG.html b/3.1.2/CHANGELOG.html new file mode 100644 index 0000000..84af850 --- /dev/null +++ b/3.1.2/CHANGELOG.html @@ -0,0 +1,1406 @@ + + + + + + + + + middleware_automation.keycloak Release Notes — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

middleware_automation.keycloak Release Notes

+ +

This changelog describes changes after version 0.2.6.

+
+

v3.1.2

+
+

Major Changes

+
    +
  • Port integration tests from community.general #409

  • +
+
+
+

Minor Changes

+
    +
  • AMW-642 keycloak_identity_provider: add support for Do not store users from transient-users feature #430

  • +
  • AMW-644 keycloak_user_federation module always reports task as changed in check mode #433

  • +
+
+
+

Bugfixes

+
    +
  • Fix health check URL to use localhost with protocol and port #429

  • +
  • Issue#421 Remove default setting of JAVA_OPTS and restrict to JAVA_OPTS_KC_HEAP and JAVA_OPTS_APPEND #425

  • +
+
+
+
+

v3.1.1

+
+

Minor Changes

+
    +
  • Add support for the description attribute of keycloak groups #419

  • +
  • Bump Keycloak to 26.7.3 and RHBK to 26.4.15 #422

  • +
+
+
+

Bugfixes

+
    +
  • Fix keycloak_quarkus_health_check_url crash when hostname is unset #424

  • +
+
+
+
+

v3.1.0

+
+

Minor Changes

+
    +
  • 369 add integration tests for keycloak_authentication_v2 #374

  • +
  • AMW-578 Replace deprecated community.general.yaml callback with result #413

  • +
  • AMW-615 Inconsistent support of authentication via client credentials #400

  • +
  • AMW-622 keycloak collection spelling and grammar checking for PRs #406

  • +
  • AMW-626 keycloak_user_rolemapping raises 403 error code while listing assignable Roles if invoker lacks view-realm Role #411

  • +
  • Add use_netrc option to prevent .netrc overriding bearer token #408

  • +
  • Address issue #370, add keycloak_realm: max_secondary_auth_failures parameter #404

  • +
  • Fix #396 keycloak_user_federation.py mapper sorting now happens after unspecified mappers are merged in #414

  • +
  • Fix issue #397 #398 crash on first role assignment #405

  • +
  • In a flow definition, handle non-existing keys correctly #402

  • +
  • Normalize hostname that includes http_relative_path suffix #392

  • +
  • Replace deprecated top-level fact variables with ansible_fact #412

  • +
  • authentication_v2: Fix validation for FormActions #384

  • +
  • keycloak_group: fix subgroup lookup on Keycloak older than 25 #407

  • +
  • keycloak_user: fix attributes always reporting changed=True #399

  • +
+
+
+
+

v3.0.11

+
+

Minor Changes

+
    +
  • Add certification checks to the upstream repo #378

  • +
  • Fix cert workflow #389

  • +
  • Fix health check URL to include HTTP relative path #364

  • +
  • fix(keycloak_quarkus): avoid leaking maven provider password in logs #363

  • +
+
+
+

Bugfixes

+
    +
  • AMW-592 AMW Github Actions are failing because of latest molecule #366

  • +
  • AMW-594 Upstream release is failing due to recent rules change #373

  • +
+
+
+
+

v3.0.10

+
+

Major Changes

+
    +
  • Fixing linting issues #357

  • +
+
+
+

Minor Changes

+
    +
  • AMW-571 keycloak_identity_provider hide_on_login_page not working #356

  • +
  • Fixing vars naming issue #359

  • +
  • Removing from __future__ import annotations broke runtime type hints using Sequence and union syntax, causing sanity import failures and molecule module errors #358

  • +
+
+
+
+

v3.0.9

+
+

Bugfixes

+
    +
  • AMW-551 Providing correct rhbk version #344

  • +
+
+
+
+

v3.0.8

+
+
+

v3.0.7

+
+

Major Changes

+
    +
  • Migrate Keycloak modules from the community.general collection to Keycloak collection. #341

  • +
+
+
+

Minor Changes

+ +
+
+

Bugfixes

+
    +
  • Fix molecule tests #339

  • +
+
+
+
+

v3.0.6

+
+

Major Changes

+
    +
  • AMW-540 Fix the upstream collection requirements with common v1.2.4 #337

  • +
+
+
+
+

v3.0.5

+
+

Minor Changes

+
    +
  • AMW-528 Deployment fails in keycloak_quarkus due to missing escalation variables #335

  • +
+
+
+
+

v3.0.4

+
+

Major Changes

+
    +
  • AMW-467 Download keycloak binary from password protected HTTP location #321

  • +
  • v26.4.x compability #317

  • +
+
+
+

Minor Changes

+
    +
  • AMW-518 Validating arguments against arg spec ‘main’ fails unexpectedly. #324

  • +
+
+
+

Bugfixes

+
    +
  • Removing parseable from lint file as Additional properties are not allowed #319

  • +
+
+
+
+

v3.0.3

+
+

Major Changes

+
    +
  • Update to keycloak 26.3.0 #293

  • +
  • ansible-core 2.19 compatibility #310

  • +
+
+
+

Minor Changes

+
    +
  • Allow to install provider jars from remote paths #303

  • +
  • Declared proxy_mode as deprecated, updated quarkus and realm readme #306

  • +
  • Fix config_key_store_file description to match variable name #308

  • +
+
+
+

Bugfixes

+
    +
  • keycloak collection CI label is showing no status #312

  • +
  • keycloak_realm: allow secret in keycloak_clients #304

  • +
+
+
+
+

v3.0.2

+
+

Minor Changes

+
    +
  • New checksum property for keycloak_quarkus_providers #280

  • +
  • New parameter to set the jgroups host IP address #281

  • +
  • Session storage / distributed caches #287

  • +
  • Update keycloak/RHBK to v26.2.4 #283

  • +
+
+
+

Bugfixes

+
    +
  • Fix keycloak_quarkus_force_install parameter being ignored by install #296

  • +
  • Fix alternate download location being ignored (JBossNeworkAPI always used) #298

  • +
  • Run config rebuild after SPI providers update #285

  • +
  • Use jdk21 as default in debian #289

  • +
  • keycloak_realm: federation default provider type should be a string #302

  • +
+
+
+
+

v3.0.1

+
+

Minor Changes

+
    +
  • Version update to 26.0.8 / rhbk 26.0.11 #277

  • +
+
+
+

Bugfixes

+
    +
  • Trigger rebuild handler on envvars file change #276

  • +
+
+
+
+

v3.0.0

+
+

Minor Changes

+
    +
  • Add theme cache invalidation handler #252

  • +
  • keycloak_realm: change url variables to defaults #268

  • +
+
+
+

Breaking Changes / Porting Guide

+
    +
  • Bump major and ansible-core versions #266

  • +
  • Rename parameters to follow upstream #270

  • +
  • Update for keycloak v26 #254

  • +
+
+
+

Bugfixes

+
    +
  • Access token lifespan is too short for ansible run #251

  • +
  • Load environment vars during kc rebuild #274

  • +
  • Rebuild config and restart service for local providers #250

  • +
  • Rename and honour parameter keycloak_quarkus_http_host #271

  • +
+
+
+

New Modules

+
    +
  • middleware_automation.keycloak.keycloak_realm - Allows administration of Keycloak realm via Keycloak API

  • +
+
+
+
+

v2.4.3

+
+

Minor Changes

+
    +
  • Update keycloak to 24.0.5 #241

  • +
+
+
+
+

v2.4.2

+
+

Minor Changes

+
    +
  • New parameter keycloak_quarkus_download_path #239

  • +
+
+
+

Bugfixes

+
    +
  • Add wait_for_port number parameter #237

  • +
+
+
+
+

v2.4.1

+
+

Release Summary

+

Internal release, documentation or test changes only.

+
+
+
+

v2.4.0

+
+

Major Changes

+
    +
  • Enable by default health check on restart #234

  • +
  • Update minimum ansible-core version > 2.15 #232

  • +
+
+
+
+

v2.3.0

+
+

Major Changes

+
    +
  • Allow for custom providers hosted on maven repositories #223

  • +
  • Restart handler strategy behaviour #231

  • +
+
+
+

Minor Changes

+
    +
  • Add support for policy files #225

  • +
  • Allow to add extra custom env vars in sysconfig file #229

  • +
  • Download from alternate URL with optional http authentication #220

  • +
  • Update Keycloak to version 24.0.4 #218

  • +
  • proxy-header enhancement #227

  • +
+
+
+

Bugfixes

+
    +
  • kc.sh build uses configured jdk #211

  • +
+
+
+
+

v2.2.2

+
+

Minor Changes

+
    +
  • Copying of key material for TLS configuration #210

  • +
  • Validate certs parameter for JDBC driver downloads #207

  • +
+
+
+

Bugfixes

+
    +
  • Turn off controller privilege escalation #209

  • +
+
+
+
+

v2.2.1

+
+

Release Summary

+

Internal release, documentation or test changes only.

+
+
+

Bugfixes

+
    +
  • JDBC provider: fix clause in argument validation #204

  • +
+
+
+
+

v2.2.0

+
+

Major Changes

+
    +
  • Support java keystore for configuration of sensitive options #189

  • +
+
+
+

Minor Changes

+
    +
  • Add wait_for_port and wait_for_log systemd unit logic #199

  • +
  • Customize jdbc driver downloads, optional authentication #202

  • +
  • Keystore-based vault SPI configuration #196

  • +
  • New keycloak_quarkus_hostname_strict_https parameter #195

  • +
  • Providers config and custom providers #201

  • +
  • Remove administrator credentials from files once keycloak is bootstrapped #197

  • +
  • Update keycloak to 24.0 #194

  • +
+
+
+
+

v2.1.2

+
+

Release Summary

+

Internal release, documentation or test changes only.

+
+
+
+

v2.1.1

+
+

Minor Changes

+
    +
  • Add reverse proxy_headers config, supersedes proxy_mode #187

  • +
  • Debian/Ubuntu compatibility #178

  • +
  • Use keycloak_realm as default for sub-entities #180

  • +
+
+
+

Bugfixes

+
    +
  • Fix permissions on controller-side downloaded artifacts #184

  • +
  • JVM args moved to JAVA_OPTS envvar (instead of JAVA_OPTS_APPEND) #186

  • +
  • Unrelax configuration file permissions #191

  • +
  • Utilize comment filter for ansible_managed annotations #176

  • +
+
+
+
+

v2.1.0

+
+

Major Changes

+
    +
  • Implement infinispan TCPPING discovery protocol #159

  • +
+
+
+

Minor Changes

+
    +
  • Set enable-recovery when xa transactions are enabled #167

  • +
  • keycloak_quarkus: Allow configuring log rotate options in quarkus configuration #161

  • +
  • keycloak_quarkus: sticky-session for infinispan routes #163

  • +
+
+
+

Breaking Changes / Porting Guide

+
    +
  • keycloak_quarkus: renamed infinispan host list configuration #157

  • +
+
+
+

Bugfixes

+
    +
  • keycloak_quarkus: fix custom JAVA_HOME parameter name #171

  • +
+
+
+
+

v2.0.2

+
+

Minor Changes

+
    +
  • keycloak_quarkus: Add support for sqlserver jdbc driver #148

  • +
  • keycloak_quarkus: allow configuration of hostname-strict-backchannel #152

  • +
  • keycloak_quarkus: systemd restart behavior #145

  • +
+
+
+

Bugfixes

+
    +
  • keycloak_quarkus: Use keycloak_quarkus_java_opts #154

  • +
  • keycloak_quarkus: allow ports <1024 (e.g. :443) in systemd unit #150

  • +
+
+
+
+

v2.0.1

+
+

Minor Changes

+
    +
  • keycloak_quarkus: add hostname-strict parameter #139

  • +
  • keycloak_quarkus: update to version 23.0.1 #133

  • +
+
+
+

Bugfixes

+
    +
  • keycloak_quarkus: template requires lowercase boolean values #138

  • +
+
+
+
+

v2.0.0

+
+

Minor Changes

+
    +
  • Add new parameter for port offset configuration #124

  • +
  • Update Keycloak to version 22.0.5 #122

  • +
+
+
+

Breaking Changes / Porting Guide

+
    +
  • Add support for more http-related configs #115

  • +
  • Update minimum ansible-core version > 2.14 #119

  • +
  • keycloak_quarkus: enable config of key store and trust store #116

  • +
+
+
+
+

v1.3.0

+
+

Major Changes

+
    +
  • Run service as keycloak_service_user #106

  • +
+
+
+

Minor Changes

+
    +
  • keycloak_quarkus: Update Keycloak to version 22.0.3 #112

  • +
  • keycloak_quarkus: fix admin console redirect when running locally #111

  • +
  • keycloak_quarkus: skip proxy config if keycloak_quarkus_proxy_mode is none #109

  • +
+
+
+

Bugfixes

+
    +
  • keycloak_quarkus: fix validation failure upon port configuration change #113

  • +
+
+
+
+

v1.2.8

+
+

Minor Changes

+
    +
  • keycloak_quarkus: set openjdk 17 as default #103

  • +
  • keycloak_quarkus: update to version 22.0.1 #107

  • +
+
+
+

Bugfixes

+
    +
  • Fix incorrect checks for keycloak_jgroups_subnet #98

  • +
  • Undefine keycloak_db_valid_conn_sql default #91

  • +
  • Update bindep.txt package python3-devel to support RHEL9 #105

  • +
+
+
+
+

v1.2.7

+
+

Minor Changes

+
    +
  • Allow to override jgroups subnet #93

  • +
  • keycloak-quarkus: update keycloakx to v21.1.1 #92

  • +
+
+
+
+

v1.2.6

+
+

Minor Changes

+
    +
  • Add profile features enabling/disabling #87

  • +
  • Improve service restart behavior configuration #88

  • +
  • Update default xa_datasource_class value for mariadb jdbc configuration #89

  • +
+
+
+

Bugfixes

+
    +
  • Handle WFLYCTL0117 when background validation millis is 0 #90

  • +
+
+
+
+

v1.2.5

+
+

Minor Changes

+
    +
  • Add configuration for database connection pool validation #85

  • +
  • Allow to configure administration endpoint URL #86

  • +
  • Allow to force backend URLs to frontend URLs #84

  • +
  • Introduce systemd unit restart behavior #81

  • +
+
+
+
+

v1.2.4

+
+

Minor Changes

+
    +
  • Add sqlserver to keycloak role jdbc configurations #78

  • +
  • Add configurability for XA transactions #73

  • +
+
+
+

Bugfixes

+
    +
  • Fix deprecation warning for ipaddr #77

  • +
  • Fix undefined facts when offline patching sso #71

  • +
+
+
+
+

v1.2.1

+
+

Minor Changes

+
    +
  • Allow to setup keycloak HA cluster without remote cache store #68

  • +
+
+
+

Bugfixes

+
    +
  • Pass attributes to realm clients #69

  • +
+
+
+
+

v1.2.0

+
+

Major Changes

+
    +
  • Provide config for multiple modcluster proxies #60

  • +
+
+
+

Minor Changes

+
    +
  • Allow to configure TCPPING for cluster discovery #62

  • +
  • Drop community.general from dependencies #61

  • +
  • Switch middleware_automation.redhat_csp_download for middleware_automation.common #63

  • +
  • Switch to middleware_automation.common for rh-sso patching #64

  • +
+
+
+
+

v1.1.1

+
+

Bugfixes

+
    +
  • keycloak-quarkus: fix cache-config-file path in keycloak.conf.j2 template #53

  • +
+
+
+
+

v1.1.0

+
+

Minor Changes

+
    +
  • Update keycloak to 18.0.2 - sso to 7.6.1 #46

  • +
  • Variable keycloak_no_log controls ansible no_log parameter (for debugging purposes) #47

  • +
  • Variables to override service start retries and delay #51

  • +
  • keycloak_quarkus: variable to enable development mode #45

  • +
+
+
+

Breaking Changes / Porting Guide

+
    +
  • Rename variables from infinispan_ prefix to keycloak_infinispan_ #42

  • +
+
+
+

Bugfixes

+
    +
  • keycloak_quarkus: fix /var/log/keycloak symlink to keycloak log directory #44

  • +
+
+
+
+

v1.0.7

+
+

Breaking Changes / Porting Guide

+
    +
  • keycloak_quarkus: use absolute path for certificate files #39

  • +
+
+
+

Bugfixes

+
    +
  • keycloak_quarkus: use become for tasks that will otherwise fail #38

  • +
+
+
+
+

v1.0.6

+
+

Bugfixes

+
    +
  • keycloak_quarkus: add selected java to PATH in systemd unit #34

  • +
  • keycloak_quarkus: set logfile path correctly under keycloak home #35

  • +
+
+
+
+

v1.0.5

+
+

Minor Changes

+
    +
  • Update config options: keycloak and quarkus #32

  • +
+
+
+
+

v1.0.4

+
+

Release Summary

+

Internal release, documentation or test changes only.

+
+
+
+

v1.0.3

+
+

Major Changes

+
    +
  • New role for installing keycloak >= 17.0.0 (quarkus) #29

  • +
+
+
+

Minor Changes

+
    +
  • Add keycloak_config_override_template parameter for passing a custom xml config template #30

  • +
+
+
+

Bugfixes

+
    +
  • Make sure systemd unit starts with selected java JVM #31

  • +
+
+
+
+

v1.0.2

+
+

Minor Changes

+
    +
  • Make keycloak_admin_password a default with assert (was: role variable) #26

  • +
  • Simplify dependency install logic and reduce play execution time #19

  • +
+
+
+

Bugfixes

+
    +
  • Set keycloak_frontend_url default according to other defaults #25

  • +
+
+
+
+

v1.0.1

+
+

Release Summary

+

Minor enhancements, bug and documentation fixes.

+
+
+

Major Changes

+
    +
  • Apply latest cumulative patch of RH-SSO automatically when new parameter keycloak_rhsso_apply_patches is true #18

  • +
+
+
+

Minor Changes

+
    +
  • Clustered installs now perform database initialization on first node to avoid locking issues #17

  • +
+
+
+
+

v1.0.0

+
+

Release Summary

+

This is the first stable release of the middleware_automation.keycloak collection.

+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/README.html b/3.1.2/README.html new file mode 100644 index 0000000..39e2407 --- /dev/null +++ b/3.1.2/README.html @@ -0,0 +1,371 @@ + + + + + + + + + Ansible Collection - middleware_automation.keycloak — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Ansible Collection - middleware_automation.keycloak

+ +

Build Status

+
+

NOTE: If you are Red Hat customer, install redhat.rhbk (for Red Hat Build of Keycloak) or redhat.sso (for Red Hat Single Sign-On) from Automation Hub as the certified version of this collection.

+
+ + +

Collection to install and configure Keycloak or Red Hat Single Sign-On / Red Hat Build of Keycloak.

+ + +
+

Ansible version compatibility

+

This collection has been tested against following Ansible versions: >=2.16.0.

+

Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions.

+ +
+
+

Installation

+ +
+

Installing the Collection from Ansible Galaxy

+

Before using the collection, you need to install it with the Ansible Galaxy CLI:

+
ansible-galaxy collection install middleware_automation.keycloak
+
+
+ +

You can also include it in a requirements.yml file and install it via ansible-galaxy collection install -r requirements.yml, using the format:

+
---
+collections:
+  - name: middleware_automation.keycloak
+
+
+

The keycloak collection also depends on the following python packages to be present on the controller host:

+
    +
  • netaddr

  • +
  • lxml

  • +
+

A requirement file is provided to install:

+
pip install -r requirements.txt
+
+
+ +
+
+

Included roles

+
    +
  • keycloak_quarkus: role for installing keycloak (>= 19.0.0, quarkus based).

  • +
  • keycloak_realm: role for configuring a realm, user federation(s), clients and users, in an installed service.

  • +
  • keycloak: role for installing legacy keycloak (<= 19.0, wildfly based).

  • +
+ +
+
+

Included modules

+

All Keycloak administration modules from community.general are provided in this collection for Keycloak 17+ (Quarkus). Use auth_keycloak_url without the legacy /auth context path (for example http://localhost:8080). Set keycloak_context to /auth only when automating WildFly-based Keycloak with the keycloak role.

+
    +
  • keycloak_authentication: manage authentication flows and executions using Keycloak Admin REST API.

  • +
  • keycloak_authentication_flow: manage custom authentication flows and flow executions.

  • +
  • keycloak_authentication_required_actions: manage required actions available in realm authentication.

  • +
  • keycloak_authentication_v2: manage authentication flows with newer Keycloak API handling.

  • +
  • keycloak_authz_authorization_scope: manage authorization scopes for a client resource server.

  • +
  • keycloak_authz_custom_policy: manage custom authorization policies for a client resource server.

  • +
  • keycloak_authz_permission: manage authorization permissions for a client resource server.

  • +
  • keycloak_authz_permission_info: retrieve authorization permission information for a client resource server.

  • +
  • keycloak_client: manage Keycloak clients (create/update/delete).

  • +
  • keycloak_client_rolemapping: manage client role mappings for users and groups.

  • +
  • keycloak_client_rolescope: manage client role scope mappings.

  • +
  • keycloak_client_scope: manage client scopes and protocol mappers (replaces community.general.keycloak_clientscope).

  • +
  • keycloak_client_scope_type: manage default and optional client scope assignments.

  • +
  • keycloak_clientsecret_info: retrieve client secret information.

  • +
  • keycloak_clientsecret_regenerate: regenerate a client secret.

  • +
  • keycloak_clienttemplate: manage legacy client templates.

  • +
  • keycloak_component: manage realm components.

  • +
  • keycloak_component_info: retrieve realm component information.

  • +
  • keycloak_group: manage realm groups and subgroups.

  • +
  • keycloak_identity_provider: manage identity provider instances and configuration.

  • +
  • keycloak_realm: manage realms (create/update/delete).

  • +
  • keycloak_realm_info: retrieve realm information.

  • +
  • keycloak_realm_key: manage realm key providers.

  • +
  • keycloak_realm_keys_metadata_info: retrieve realm keys metadata.

  • +
  • keycloak_realm_localization: manage realm localization texts.

  • +
  • keycloak_realm_rolemapping: manage realm role mappings for users and groups.

  • +
  • keycloak_realm_users_info: retrieve users from a realm.

  • +
  • keycloak_role: manage realm and client roles.

  • +
  • keycloak_user: manage users (create/update/delete).

  • +
  • keycloak_user_execute_actions_email: trigger execute-actions emails for users.

  • +
  • keycloak_user_federation: manage user federation providers (for example LDAP/AD).

  • +
  • keycloak_user_rolemapping: manage user role mappings.

  • +
  • keycloak_userprofile: manage user profile configuration.

  • +
+
+
+
+

Usage

+

The collection provides roles to install Keycloak and modules to manage realms, clients, users, and related settings via the Keycloak Admin REST API.

+

For Quarkus-based Keycloak (17+), set auth_keycloak_url to the server root URL without the legacy /auth path, for example http://localhost:8080. When using the legacy keycloak role with WildFly-based Keycloak, set keycloak_context to /auth in the keycloak_realm role.

+
+

Install Keycloak

+ +

For full service configuration details, refer to the keycloak_quarkus role README or the keycloak role README.

+
+

Install from controller node (offline)

+

Making the keycloak zip archive available to the playbook working directory, and setting keycloak_offline_install to true, allows to skip +the download tasks. The local path for the archive does match the downloaded archive path, so that it is also used as a cache when multiple hosts are provisioned in a cluster.

+
keycloak_offline_install: true
+
+
+ + +
+
+

Install from alternate sources (like corporate Nexus, artifactory, proxy, etc)

+

It is possible to perform downloads from alternate sources, using the keycloak_download_url variable; make sure the final downloaded filename matches with the source filename (ie. keycloak-legacy-x.y.zip or rh-sso-x.y.z-server-dist.zip).

+
+
+

Example installation command

+

Execute the following command from the source root directory:

+
ansible-playbook -i <ansible_hosts> playbooks/keycloak_quarkus.yml -e keycloak_quarkus_bootstrap_admin_password=<changeme>
+
+
+
    +
  • keycloak_quarkus_bootstrap_admin_password password for the administration console user account.

  • +
  • ansible_hosts is the inventory, below is an example inventory for deploying to localhost

    +
    [keycloak]
    +localhost ansible_connection=local
    +
    +
    +
  • +
+

Note: when deploying clustered configurations, all hosts belonging to the cluster must be present in ansible_play_batch; ie. they must be targeted by the same ansible-playbook execution.

+
+
+
+

Configure with roles

+ + + + +
+

Example configuration command

+

Execute the following command from the source root directory:

+
ansible-playbook -i <ansible_hosts> playbooks/keycloak_realm.yml -e keycloak_realm_admin_password=<changeme> -e keycloak_realm_realm=test
+
+
+
    +
  • keycloak_realm_admin_password password for the administration console user account.

  • +
  • keycloak_realm_realm name of the realm to be created/used.

  • +
  • ansible_hosts is the inventory, below is an example inventory for deploying to localhost

    +
    [keycloak]
    +localhost ansible_connection=local
    +
    +
    +
  • +
+ +

For full configuration details, refer to the keycloak_realm role README.

+ +
+
+
+

Configure with modules

+

Module playbooks target an already running Keycloak instance. All modules use the middleware_automation.keycloak collection namespace.

+ +

Example task using shared authentication defaults:

+
- hosts: localhost
+  module_defaults:
+    group/middleware_automation.keycloak.keycloak:
+      auth_keycloak_url: http://localhost:8080
+      auth_realm: master
+      auth_username: admin
+      auth_password: "{{ keycloak_admin_password }}"
+  tasks:
+    - name: Create a user in a realm
+      middleware_automation.keycloak.keycloak_user:
+        realm: TestRealm
+        username: testuser
+        first_name: Test
+        last_name: User
+        email: testuser@example.com
+        enabled: true
+        state: present
+
+
+

When migrating from community.general, replace the collection prefix in playbooks (for example community.general.keycloak_user becomes middleware_automation.keycloak.keycloak_user) and use keycloak_client_scope instead of keycloak_clientscope.

+
+
+
+

Support

+ +

For bug reports and feature requests, use GitHub Issues.

+ +
+
+

Release and Upgrade Notes

+

For details on changes between versions, please see the CHANGELOG for this collection.

+
+
+

License

+

Apache License v2.0 or later

+ +

See LICENSE to view the full text.

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/_downloads/7a1ffec81340e26b924b5291048874ac/keycloak_client_scope.yml b/3.1.2/_downloads/7a1ffec81340e26b924b5291048874ac/keycloak_client_scope.yml new file mode 100644 index 0000000..aa5ed3d --- /dev/null +++ b/3.1.2/_downloads/7a1ffec81340e26b924b5291048874ac/keycloak_client_scope.yml @@ -0,0 +1,48 @@ +--- +- name: Playbook for Keycloak Client Scope Configuration + hosts: all + vars: + keycloak_admin_user: admin + keycloak_admin_password: "remembertochangeme" + keycloak_url: "http://localhost:8080" + keycloak_realm: TestRealm + tasks: + - name: Create client scope with protocol mappers + middleware_automation.keycloak.keycloak_client_scope: + auth_keycloak_url: "{{ keycloak_url }}" + auth_realm: master + auth_username: "{{ keycloak_admin_user }}" + auth_password: "{{ keycloak_admin_password }}" + realm: "{{ keycloak_realm }}" + name: TestClientScope + description: "Client scope created via Ansible" + protocol: openid-connect + protocol_mappers: + - name: email + protocolMapper: oidc-usermodel-attribute-mapper + config: + user.attribute: email + claim.name: email + jsonType.label: String + id.token.claim: "true" + access.token.claim: "true" + userinfo.token.claim: "true" + - name: firstName + protocolMapper: oidc-usermodel-attribute-mapper + config: + user.attribute: firstName + claim.name: given_name + jsonType.label: String + id.token.claim: "true" + access.token.claim: "true" + userinfo.token.claim: "true" + - name: username + protocolMapper: oidc-usermodel-attribute-mapper + config: + user.attribute: username + claim.name: preferred_username + jsonType.label: String + id.token.claim: "true" + access.token.claim: "true" + userinfo.token.claim: "true" + state: present diff --git a/3.1.2/_downloads/a0468922d38230cfdad1d445a6b10b9e/keycloak_realm.yml b/3.1.2/_downloads/a0468922d38230cfdad1d445a6b10b9e/keycloak_realm.yml new file mode 100644 index 0000000..cbdb0d2 --- /dev/null +++ b/3.1.2/_downloads/a0468922d38230cfdad1d445a6b10b9e/keycloak_realm.yml @@ -0,0 +1,26 @@ +--- +- name: Playbook for Keycloak Hosts + hosts: all + vars: + keycloak_realm_admin_password: "remembertochangeme" + keycloak_realm_clients: + - name: TestClient1 + client_id: TestClient1 + roles: + - TestClient1Admin + - TestClient1User + realm: TestRealm + public_client: true + web_origins: + - http://testclient1origin/application + - http://testclient1origin/other + users: + - username: TestUser + password: password + client_roles: + - client: TestClient1 + role: TestClient1User + realm: TestRealm + roles: + - role: middleware_automation.keycloak.keycloak_realm + keycloak_realm_realm: TestRealm diff --git a/3.1.2/_downloads/bf30f2df147c4911eb753f8cef6007e1/keycloak_authentication_flow.yml b/3.1.2/_downloads/bf30f2df147c4911eb753f8cef6007e1/keycloak_authentication_flow.yml new file mode 100644 index 0000000..38878b5 --- /dev/null +++ b/3.1.2/_downloads/bf30f2df147c4911eb753f8cef6007e1/keycloak_authentication_flow.yml @@ -0,0 +1,27 @@ +--- +- name: Playbook for Keycloak Authentication Flow Configuration + hosts: all + vars: + keycloak_admin_user: admin + keycloak_admin_password: "remembertochangeme" + keycloak_url: "http://localhost:8080" + keycloak_realm: TestRealm + tasks: + - name: Create authentication flow with executions + middleware_automation.keycloak.keycloak_authentication_flow: + auth_keycloak_url: "{{ keycloak_url }}" + auth_realm: master + auth_username: "{{ keycloak_admin_user }}" + auth_password: "{{ keycloak_admin_password }}" + realm: "{{ keycloak_realm }}" + alias: my-browser-flow + description: "Custom browser authentication flow" + provider_id: basic-flow + executions: + - provider_id: auth-cookie + requirement: ALTERNATIVE + - provider_id: auth-password + requirement: REQUIRED + - provider_id: auth-otp-form + requirement: ALTERNATIVE + state: present diff --git a/3.1.2/_sources/CHANGELOG.rst.txt b/3.1.2/_sources/CHANGELOG.rst.txt new file mode 100644 index 0000000..faa6583 --- /dev/null +++ b/3.1.2/_sources/CHANGELOG.rst.txt @@ -0,0 +1,688 @@ +============================================= +middleware\_automation.keycloak Release Notes +============================================= + +.. contents:: Topics + +This changelog describes changes after version 0.2.6. + +v3.1.2 +====== + +Major Changes +------------- + +- Port integration tests from community.general `#409 `_ + +Minor Changes +------------- + +- AMW-642 keycloak_identity_provider: add support for Do not store users from transient-users feature `#430 `_ +- AMW-644 keycloak_user_federation module always reports task as changed in check mode `#433 `_ + +Bugfixes +-------- + +- Fix health check URL to use localhost with protocol and port `#429 `_ +- Issue#421 Remove default setting of JAVA_OPTS and restrict to JAVA_OPTS_KC_HEAP and JAVA_OPTS_APPEND `#425 `_ + +v3.1.1 +====== + +Minor Changes +------------- + +- Add support for the ``description`` attribute of keycloak groups `#419 `_ +- Bump Keycloak to 26.7.3 and RHBK to 26.4.15 `#422 `_ + +Bugfixes +-------- + +- Fix keycloak_quarkus_health_check_url crash when hostname is unset `#424 `_ + +v3.1.0 +====== + +Minor Changes +------------- + +- 369 add integration tests for keycloak_authentication_v2 `#374 `_ +- AMW-578 Replace deprecated community.general.yaml callback with result `#413 `_ +- AMW-615 Inconsistent support of authentication via client credentials `#400 `_ +- AMW-622 keycloak collection spelling and grammar checking for PRs `#406 `_ +- AMW-626 keycloak_user_rolemapping raises 403 error code while listing assignable Roles if invoker lacks view-realm Role `#411 `_ +- Add use_netrc option to prevent .netrc overriding bearer token `#408 `_ +- Address issue #370, add keycloak_realm: max_secondary_auth_failures parameter `#404 `_ +- Fix #396 keycloak_user_federation.py mapper sorting now happens after unspecified mappers are merged in `#414 `_ +- Fix issue #397 #398 crash on first role assignment `#405 `_ +- In a flow definition, handle non-existing keys correctly `#402 `_ +- Normalize hostname that includes http_relative_path suffix `#392 `_ +- Replace deprecated top-level fact variables with ansible_fact `#412 `_ +- authentication_v2: Fix validation for FormActions `#384 `_ +- keycloak_group: fix subgroup lookup on Keycloak older than 25 `#407 `_ +- keycloak_user: fix attributes always reporting changed=True `#399 `_ + +v3.0.11 +======= + +Minor Changes +------------- + +- Add certification checks to the upstream repo `#378 `_ +- Fix cert workflow `#389 `_ +- Fix health check URL to include HTTP relative path `#364 `_ +- fix(keycloak_quarkus): avoid leaking maven provider password in logs `#363 `_ + +Bugfixes +-------- + +- AMW-592 AMW Github Actions are failing because of latest molecule `#366 `_ +- AMW-594 Upstream release is failing due to recent rules change `#373 `_ + +v3.0.10 +======= + +Major Changes +------------- + +- Fixing linting issues `#357 `_ + +Minor Changes +------------- + +- AMW-571 keycloak_identity_provider hide_on_login_page not working `#356 `_ +- Fixing vars naming issue `#359 `_ +- Removing from __future__ import annotations broke runtime type hints using Sequence and union syntax, causing sanity import failures and molecule module errors `#358 `_ + +v3.0.9 +====== + +Bugfixes +-------- + +- AMW-551 Providing correct rhbk version `#344 `_ + +v3.0.8 +====== + +v3.0.7 +====== + +Major Changes +------------- + +- Migrate Keycloak modules from the community.general collection to Keycloak collection. `#341 `_ + +Minor Changes +------------- + +- Fixing common module usage `#343 `_ +- fix #336: https://github.com/ansible-middleware/common/pull/38 `#338 `_ + +Bugfixes +-------- + +- Fix molecule tests `#339 `_ + +v3.0.6 +====== + +Major Changes +------------- + +- AMW-540 Fix the upstream collection requirements with common v1.2.4 `#337 `_ + +v3.0.5 +====== + +Minor Changes +------------- + +- AMW-528 Deployment fails in keycloak_quarkus due to missing escalation variables `#335 `_ + +v3.0.4 +====== + +Major Changes +------------- + +- AMW-467 Download keycloak binary from password protected HTTP location `#321 `_ +- v26.4.x compability `#317 `_ + +Minor Changes +------------- + +- AMW-518 Validating arguments against arg spec 'main' fails unexpectedly. `#324 `_ + +Bugfixes +-------- + +- Removing parseable from lint file as Additional properties are not allowed `#319 `_ + +v3.0.3 +====== + +Major Changes +------------- + +- Update to keycloak 26.3.0 `#293 `_ +- ansible-core 2.19 compatibility `#310 `_ + +Minor Changes +------------- + +- Allow to install provider jars from remote paths `#303 `_ +- Declared proxy_mode as deprecated, updated quarkus and realm readme `#306 `_ +- Fix config_key_store_file description to match variable name `#308 `_ + +Bugfixes +-------- + +- keycloak collection CI label is showing no status `#312 `_ +- keycloak_realm: allow secret in keycloak_clients `#304 `_ + +v3.0.2 +====== + +Minor Changes +------------- + +- New ``checksum`` property for keycloak_quarkus_providers `#280 `_ +- New parameter to set the jgroups host IP address `#281 `_ +- Session storage / distributed caches `#287 `_ +- Update keycloak/RHBK to v26.2.4 `#283 `_ + +Bugfixes +-------- + +- Fix ``keycloak_quarkus_force_install`` parameter being ignored by install `#296 `_ +- Fix alternate download location being ignored (JBossNeworkAPI always used) `#298 `_ +- Run config rebuild after SPI providers update `#285 `_ +- Use jdk21 as default in debian `#289 `_ +- keycloak_realm: federation default provider type should be a string `#302 `_ + +v3.0.1 +====== + +Minor Changes +------------- + +- Version update to 26.0.8 / rhbk 26.0.11 `#277 `_ + +Bugfixes +-------- + +- Trigger rebuild handler on envvars file change `#276 `_ + +v3.0.0 +====== + +Minor Changes +------------- + +- Add theme cache invalidation handler `#252 `_ +- keycloak_realm: change url variables to defaults `#268 `_ + +Breaking Changes / Porting Guide +-------------------------------- + +- Bump major and ansible-core versions `#266 `_ +- Rename parameters to follow upstream `#270 `_ +- Update for keycloak v26 `#254 `_ + +Bugfixes +-------- + +- Access token lifespan is too short for ansible run `#251 `_ +- Load environment vars during kc rebuild `#274 `_ +- Rebuild config and restart service for local providers `#250 `_ +- Rename and honour parameter ``keycloak_quarkus_http_host`` `#271 `_ + +New Modules +----------- + +- middleware_automation.keycloak.keycloak_realm - Allows administration of Keycloak realm via Keycloak API + +v2.4.3 +====== + +Minor Changes +------------- + +- Update keycloak to 24.0.5 `#241 `_ + +v2.4.2 +====== + +Minor Changes +------------- + +- New parameter ``keycloak_quarkus_download_path`` `#239 `_ + +Bugfixes +-------- + +- Add wait_for_port number parameter `#237 `_ + +v2.4.1 +====== + +Release Summary +--------------- + +Internal release, documentation or test changes only. + +v2.4.0 +====== + +Major Changes +------------- + +- Enable by default health check on restart `#234 `_ +- Update minimum ansible-core version > 2.15 `#232 `_ + +v2.3.0 +====== + +Major Changes +------------- + +- Allow for custom providers hosted on maven repositories `#223 `_ +- Restart handler strategy behaviour `#231 `_ + +Minor Changes +------------- + +- Add support for policy files `#225 `_ +- Allow to add extra custom env vars in sysconfig file `#229 `_ +- Download from alternate URL with optional http authentication `#220 `_ +- Update Keycloak to version 24.0.4 `#218 `_ +- ``proxy-header`` enhancement `#227 `_ + +Bugfixes +-------- + +- ``kc.sh build`` uses configured jdk `#211 `_ + +v2.2.2 +====== + +Minor Changes +------------- + +- Copying of key material for TLS configuration `#210 `_ +- Validate certs parameter for JDBC driver downloads `#207 `_ + +Bugfixes +-------- + +- Turn off controller privilege escalation `#209 `_ + +v2.2.1 +====== + +Release Summary +--------------- + +Internal release, documentation or test changes only. + +Bugfixes +-------- + +- JDBC provider: fix clause in argument validation `#204 `_ + +v2.2.0 +====== + +Major Changes +------------- + +- Support java keystore for configuration of sensitive options `#189 `_ + +Minor Changes +------------- + +- Add ``wait_for_port`` and ``wait_for_log`` systemd unit logic `#199 `_ +- Customize jdbc driver downloads, optional authentication `#202 `_ +- Keystore-based vault SPI configuration `#196 `_ +- New ``keycloak_quarkus_hostname_strict_https`` parameter `#195 `_ +- Providers config and custom providers `#201 `_ +- Remove administrator credentials from files once keycloak is bootstrapped `#197 `_ +- Update keycloak to 24.0 `#194 `_ + +v2.1.2 +====== + +Release Summary +--------------- + +Internal release, documentation or test changes only. + +v2.1.1 +====== + +Minor Changes +------------- + +- Add reverse ``proxy_headers`` config, supersedes ``proxy_mode`` `#187 `_ +- Debian/Ubuntu compatibility `#178 `_ +- Use ``keycloak_realm`` as default for sub-entities `#180 `_ + +Bugfixes +-------- + +- Fix permissions on controller-side downloaded artifacts `#184 `_ +- JVM args moved to ``JAVA_OPTS`` envvar (instead of JAVA_OPTS_APPEND) `#186 `_ +- Unrelax configuration file permissions `#191 `_ +- Utilize comment filter for ``ansible_managed`` annotations `#176 `_ + +v2.1.0 +====== + +Major Changes +------------- + +- Implement infinispan TCPPING discovery protocol `#159 `_ + +Minor Changes +------------- + +- Set enable-recovery when xa transactions are enabled `#167 `_ +- keycloak_quarkus: Allow configuring log rotate options in quarkus configuration `#161 `_ +- keycloak_quarkus: ``sticky-session`` for infinispan routes `#163 `_ + +Breaking Changes / Porting Guide +-------------------------------- + +- keycloak_quarkus: renamed infinispan host list configuration `#157 `_ + +Bugfixes +-------- + +- keycloak_quarkus: fix custom JAVA_HOME parameter name `#171 `_ + +v2.0.2 +====== + +Minor Changes +------------- + +- keycloak_quarkus: Add support for sqlserver jdbc driver `#148 `_ +- keycloak_quarkus: allow configuration of ``hostname-strict-backchannel`` `#152 `_ +- keycloak_quarkus: systemd restart behavior `#145 `_ + +Bugfixes +-------- + +- keycloak_quarkus: Use ``keycloak_quarkus_java_opts`` `#154 `_ +- keycloak_quarkus: allow ports <1024 (e.g. :443) in systemd unit `#150 `_ + +v2.0.1 +====== + +Minor Changes +------------- + +- keycloak_quarkus: add hostname-strict parameter `#139 `_ +- keycloak_quarkus: update to version 23.0.1 `#133 `_ + +Bugfixes +-------- + +- keycloak_quarkus: template requires lowercase boolean values `#138 `_ + +v2.0.0 +====== + +Minor Changes +------------- + +- Add new parameter for port offset configuration `#124 `_ +- Update Keycloak to version 22.0.5 `#122 `_ + +Breaking Changes / Porting Guide +-------------------------------- + +- Add support for more http-related configs `#115 `_ +- Update minimum ansible-core version > 2.14 `#119 `_ +- keycloak_quarkus: enable config of key store and trust store `#116 `_ + +v1.3.0 +====== + +Major Changes +------------- + +- Run service as ``keycloak_service_user`` `#106 `_ + +Minor Changes +------------- + +- keycloak_quarkus: Update Keycloak to version 22.0.3 `#112 `_ +- keycloak_quarkus: fix admin console redirect when running locally `#111 `_ +- keycloak_quarkus: skip proxy config if ``keycloak_quarkus_proxy_mode`` is ``none`` `#109 `_ + +Bugfixes +-------- + +- keycloak_quarkus: fix validation failure upon port configuration change `#113 `_ + +v1.2.8 +====== + +Minor Changes +------------- + +- keycloak_quarkus: set openjdk 17 as default `#103 `_ +- keycloak_quarkus: update to version 22.0.1 `#107 `_ + +Bugfixes +-------- + +- Fix incorrect checks for ``keycloak_jgroups_subnet`` `#98 `_ +- Undefine ``keycloak_db_valid_conn_sql`` default `#91 `_ +- Update bindep.txt package python3-devel to support RHEL9 `#105 `_ + +v1.2.7 +====== + +Minor Changes +------------- + +- Allow to override jgroups subnet `#93 `_ +- keycloak-quarkus: update keycloakx to v21.1.1 `#92 `_ + +v1.2.6 +====== + +Minor Changes +------------- + +- Add profile features enabling/disabling `#87 `_ +- Improve service restart behavior configuration `#88 `_ +- Update default xa_datasource_class value for mariadb jdbc configuration `#89 `_ + +Bugfixes +-------- + +- Handle WFLYCTL0117 when background validation millis is 0 `#90 `_ + +v1.2.5 +====== + +Minor Changes +------------- + +- Add configuration for database connection pool validation `#85 `_ +- Allow to configure administration endpoint URL `#86 `_ +- Allow to force backend URLs to frontend URLs `#84 `_ +- Introduce systemd unit restart behavior `#81 `_ + +v1.2.4 +====== + +Minor Changes +------------- + +- Add ``sqlserver`` to keycloak role jdbc configurations `#78 `_ +- Add configurability for XA transactions `#73 `_ + +Bugfixes +-------- + +- Fix deprecation warning for ``ipaddr`` `#77 `_ +- Fix undefined facts when offline patching sso `#71 `_ + +v1.2.1 +====== + +Minor Changes +------------- + +- Allow to setup keycloak HA cluster without remote cache store `#68 `_ + +Bugfixes +-------- + +- Pass attributes to realm clients `#69 `_ + +v1.2.0 +====== + +Major Changes +------------- + +- Provide config for multiple modcluster proxies `#60 `_ + +Minor Changes +------------- + +- Allow to configure TCPPING for cluster discovery `#62 `_ +- Drop community.general from dependencies `#61 `_ +- Switch middleware_automation.redhat_csp_download for middleware_automation.common `#63 `_ +- Switch to middleware_automation.common for rh-sso patching `#64 `_ + +v1.1.1 +====== + +Bugfixes +-------- + +- keycloak-quarkus: fix ``cache-config-file`` path in keycloak.conf.j2 template `#53 `_ + +v1.1.0 +====== + +Minor Changes +------------- + +- Update keycloak to 18.0.2 - sso to 7.6.1 `#46 `_ +- Variable ``keycloak_no_log`` controls ansible ``no_log`` parameter (for debugging purposes) `#47 `_ +- Variables to override service start retries and delay `#51 `_ +- keycloak_quarkus: variable to enable development mode `#45 `_ + +Breaking Changes / Porting Guide +-------------------------------- + +- Rename variables from ``infinispan_`` prefix to ``keycloak_infinispan_`` `#42 `_ + +Bugfixes +-------- + +- keycloak_quarkus: fix /var/log/keycloak symlink to keycloak log directory `#44 `_ + +v1.0.7 +====== + +Breaking Changes / Porting Guide +-------------------------------- + +- keycloak_quarkus: use absolute path for certificate files `#39 `_ + +Bugfixes +-------- + +- keycloak_quarkus: use become for tasks that will otherwise fail `#38 `_ + +v1.0.6 +====== + +Bugfixes +-------- + +- keycloak_quarkus: add selected java to PATH in systemd unit `#34 `_ +- keycloak_quarkus: set logfile path correctly under keycloak home `#35 `_ + +v1.0.5 +====== + +Minor Changes +------------- + +- Update config options: keycloak and quarkus `#32 `_ + +v1.0.4 +====== + +Release Summary +--------------- + +Internal release, documentation or test changes only. + +v1.0.3 +====== + +Major Changes +------------- + +- New role for installing keycloak >= 17.0.0 (quarkus) `#29 `_ + +Minor Changes +------------- + +- Add ``keycloak_config_override_template`` parameter for passing a custom xml config template `#30 `_ + +Bugfixes +-------- + +- Make sure systemd unit starts with selected java JVM `#31 `_ + +v1.0.2 +====== + +Minor Changes +------------- + +- Make ``keycloak_admin_password`` a default with assert (was: role variable) `#26 `_ +- Simplify dependency install logic and reduce play execution time `#19 `_ + +Bugfixes +-------- + +- Set ``keycloak_frontend_url`` default according to other defaults `#25 `_ + +v1.0.1 +====== + +Release Summary +--------------- + +Minor enhancements, bug and documentation fixes. + +Major Changes +------------- + +- Apply latest cumulative patch of RH-SSO automatically when new parameter ``keycloak_rhsso_apply_patches`` is ``true`` `#18 `_ + +Minor Changes +------------- + +- Clustered installs now perform database initialization on first node to avoid locking issues `#17 `_ + +v1.0.0 +====== + +Release Summary +--------------- + +This is the first stable release of the ``middleware_automation.keycloak`` collection. diff --git a/3.1.2/_sources/README.md.txt b/3.1.2/_sources/README.md.txt new file mode 100644 index 0000000..5aa3cac --- /dev/null +++ b/3.1.2/_sources/README.md.txt @@ -0,0 +1,225 @@ +# Ansible Collection - middleware_automation.keycloak + + +[![Build Status](https://github.com/ansible-middleware/keycloak/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/ansible-middleware/keycloak/actions/workflows/ci.yml) + +> **_NOTE:_ If you are Red Hat customer, install `redhat.rhbk` (for Red Hat Build of Keycloak) or `redhat.sso` (for Red Hat Single Sign-On) from [Automation Hub](https://console.redhat.com/ansible/ansible-dashboard) as the certified version of this collection.** + + + +Collection to install and configure [Keycloak](https://www.keycloak.org/) or [Red Hat Single Sign-On](https://access.redhat.com/products/red-hat-single-sign-on) / [Red Hat Build of Keycloak](https://access.redhat.com/products/red-hat-build-of-keycloak). + + +## Ansible version compatibility + +This collection has been tested against following Ansible versions: **>=2.16.0**. + +Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions. + + + +## Installation + + +### Installing the Collection from Ansible Galaxy + +Before using the collection, you need to install it with the Ansible Galaxy CLI: + + ansible-galaxy collection install middleware_automation.keycloak + + + +You can also include it in a `requirements.yml` file and install it via `ansible-galaxy collection install -r requirements.yml`, using the format: + +```yaml +--- +collections: + - name: middleware_automation.keycloak +``` + +The keycloak collection also depends on the following python packages to be present on the controller host: + +* netaddr +* lxml + +A requirement file is provided to install: + + pip install -r requirements.txt + + +### Included roles + +* [`keycloak_quarkus`](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak_quarkus/README.md): role for installing keycloak (>= 19.0.0, quarkus based). +* [`keycloak_realm`](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak_realm/README.md): role for configuring a realm, user federation(s), clients and users, in an installed service. +* [`keycloak`](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak/README.md): role for installing legacy keycloak (<= 19.0, wildfly based). + + + +### Included modules + +All Keycloak administration modules from `community.general` are provided in this collection for Keycloak 17+ (Quarkus). Use `auth_keycloak_url` without the legacy `/auth` context path (for example `http://localhost:8080`). Set `keycloak_context` to `/auth` only when automating WildFly-based Keycloak with the `keycloak` role. + +* `keycloak_authentication`: manage authentication flows and executions using Keycloak Admin REST API. +* `keycloak_authentication_flow`: manage custom authentication flows and flow executions. +* `keycloak_authentication_required_actions`: manage required actions available in realm authentication. +* `keycloak_authentication_v2`: manage authentication flows with newer Keycloak API handling. +* `keycloak_authz_authorization_scope`: manage authorization scopes for a client resource server. +* `keycloak_authz_custom_policy`: manage custom authorization policies for a client resource server. +* `keycloak_authz_permission`: manage authorization permissions for a client resource server. +* `keycloak_authz_permission_info`: retrieve authorization permission information for a client resource server. +* `keycloak_client`: manage Keycloak clients (create/update/delete). +* `keycloak_client_rolemapping`: manage client role mappings for users and groups. +* `keycloak_client_rolescope`: manage client role scope mappings. +* `keycloak_client_scope`: manage client scopes and protocol mappers (replaces `community.general.keycloak_clientscope`). +* `keycloak_client_scope_type`: manage default and optional client scope assignments. +* `keycloak_clientsecret_info`: retrieve client secret information. +* `keycloak_clientsecret_regenerate`: regenerate a client secret. +* `keycloak_clienttemplate`: manage legacy client templates. +* `keycloak_component`: manage realm components. +* `keycloak_component_info`: retrieve realm component information. +* `keycloak_group`: manage realm groups and subgroups. +* `keycloak_identity_provider`: manage identity provider instances and configuration. +* `keycloak_realm`: manage realms (create/update/delete). +* `keycloak_realm_info`: retrieve realm information. +* `keycloak_realm_key`: manage realm key providers. +* `keycloak_realm_keys_metadata_info`: retrieve realm keys metadata. +* `keycloak_realm_localization`: manage realm localization texts. +* `keycloak_realm_rolemapping`: manage realm role mappings for users and groups. +* `keycloak_realm_users_info`: retrieve users from a realm. +* `keycloak_role`: manage realm and client roles. +* `keycloak_user`: manage users (create/update/delete). +* `keycloak_user_execute_actions_email`: trigger execute-actions emails for users. +* `keycloak_user_federation`: manage user federation providers (for example LDAP/AD). +* `keycloak_user_rolemapping`: manage user role mappings. +* `keycloak_userprofile`: manage user profile configuration. + +## Usage + +The collection provides roles to install Keycloak and modules to manage realms, clients, users, and related settings via the [Keycloak Admin REST API](https://www.keycloak.org/docs-api/latest/rest-api/index.html). + +For Quarkus-based Keycloak (17+), set `auth_keycloak_url` to the server root URL without the legacy `/auth` path, for example `http://localhost:8080`. When using the legacy `keycloak` role with WildFly-based Keycloak, set `keycloak_context` to `/auth` in the `keycloak_realm` role. + +### Install Keycloak + +* [`playbooks/keycloak_quarkus.yml`](https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak_quarkus.yml) installs Keycloak >= 17 using the `keycloak_quarkus` role. +* [`playbooks/keycloak.yml`](https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak.yml) installs legacy Keycloak (<= 19) using the `keycloak` role. + +For full service configuration details, refer to the [keycloak_quarkus role README](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak_quarkus/README.md) or the [keycloak role README](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak/README.md). + +#### Install from controller node (offline) + +Making the keycloak zip archive available to the playbook working directory, and setting `keycloak_offline_install` to `true`, allows to skip +the download tasks. The local path for the archive does match the downloaded archive path, so that it is also used as a cache when multiple hosts are provisioned in a cluster. + +```yaml +keycloak_offline_install: true +``` + + + + + + +#### Install from alternate sources (like corporate Nexus, artifactory, proxy, etc) + +It is possible to perform downloads from alternate sources, using the `keycloak_download_url` variable; make sure the final downloaded filename matches with the source filename (ie. keycloak-legacy-x.y.zip or rh-sso-x.y.z-server-dist.zip). + + +#### Example installation command + +Execute the following command from the source root directory: + +```bash +ansible-playbook -i playbooks/keycloak_quarkus.yml -e keycloak_quarkus_bootstrap_admin_password= +``` + +- `keycloak_quarkus_bootstrap_admin_password` password for the administration console user account. +- `ansible_hosts` is the inventory, below is an example inventory for deploying to localhost + + ``` + [keycloak] + localhost ansible_connection=local + ``` + +Note: when deploying clustered configurations, all hosts belonging to the cluster must be present in `ansible_play_batch`; ie. they must be targeted by the same ansible-playbook execution. + +### Configure with roles + + +* [`playbooks/keycloak_realm.yml`](https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak_realm.yml) creates or updates provided realm, user federation(s), client(s), client role(s) and client user(s). + +* [`playbooks/keycloak_realm_client.yml`](https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak_realm_client.yml) creates a realm with clients, roles and users using the `keycloak_realm` role. +* [`playbooks/keycloak_federation.yml`](https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak_federation.yml) configures user federation providers. + +#### Example configuration command + +Execute the following command from the source root directory: + +```bash +ansible-playbook -i playbooks/keycloak_realm.yml -e keycloak_realm_admin_password= -e keycloak_realm_realm=test +``` + +- `keycloak_realm_admin_password` password for the administration console user account. +- `keycloak_realm_realm` name of the realm to be created/used. +- `ansible_hosts` is the inventory, below is an example inventory for deploying to localhost + + ``` + [keycloak] + localhost ansible_connection=local + ``` + +For full configuration details, refer to the [keycloak_realm role README](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak_realm/README.md). + + +### Configure with modules + +Module playbooks target an already running Keycloak instance. All modules use the `middleware_automation.keycloak` collection namespace. + +* [`playbooks/keycloak_client_scope.yml`](https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak_client_scope.yml) creates a client scope with protocol mappers using the `keycloak_client_scope` module. +* [`playbooks/keycloak_authentication_flow.yml`](https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak_authentication_flow.yml) creates a custom authentication flow with execution steps using the `keycloak_authentication_flow` module. + +Example task using shared authentication defaults: + +```yaml +- hosts: localhost + module_defaults: + group/middleware_automation.keycloak.keycloak: + auth_keycloak_url: http://localhost:8080 + auth_realm: master + auth_username: admin + auth_password: "{{ keycloak_admin_password }}" + tasks: + - name: Create a user in a realm + middleware_automation.keycloak.keycloak_user: + realm: TestRealm + username: testuser + first_name: Test + last_name: User + email: testuser@example.com + enabled: true + state: present +``` + +When migrating from `community.general`, replace the collection prefix in playbooks (for example `community.general.keycloak_user` becomes `middleware_automation.keycloak.keycloak_user`) and use `keycloak_client_scope` instead of `keycloak_clientscope`. + + +## Support + + + +For bug reports and feature requests, use [GitHub Issues](https://github.com/ansible-middleware/keycloak/issues). + + + + +## Release and Upgrade Notes + +For details on changes between versions, please see the [CHANGELOG](https://github.com/ansible-middleware/keycloak/blob/main/CHANGELOG.rst) for this collection. + + +## License + +Apache License v2.0 or later + +See [LICENSE](https://github.com/ansible-middleware/keycloak/blob/main/LICENSE) to view the full text. + diff --git a/3.1.2/_sources/developing.md.txt b/3.1.2/_sources/developing.md.txt new file mode 100644 index 0000000..d9cb854 --- /dev/null +++ b/3.1.2/_sources/developing.md.txt @@ -0,0 +1,48 @@ +## Developing + +### Build and install locally + +Clone the repository, checkout the tag you want to build, or pick the main branch for the development version; then: + + ansible-galaxy collection build . + ansible-galaxy collection install middleware_automation-keycloak-*.tar.gz + + +### Development environment + +Make sure your development machine has available: + +* python 3.11+ +* virtualenv +* docker (or podman) + +In order to run setup the development environment and run the molecule tests locally, after cloning the repository: + +``` +# create new virtualenv using python 3 +virtualenv $PATH_TO_DEV_VIRTUALENV +# activate the virtual env +source $PATH_TO_DEV_VIRTUALENV/bin/activate +# install ansible and tools onto the virtualenv +pip install yamllint 'molecule>=6.0' 'molecule-plugins[docker]' 'ansible-core>=2.16' ansible-lint +# install collection dependencies +ansible-galaxy collection install -r requirements.yml +# install python dependencies +pip install -r requirements.txt molecule/requirements.txt +# execute the tests (replace --all with -s subdirectory to run a single test) +molecule test --all +``` + +## Contributor's Guidelines + +- All YAML files named with `.yml` extension +- Use spaces around jinja variables. `{{ var }}` over `{{var}}` +- Variables that are internal to the role should be lowercase and start with the role name +- Keep roles self contained - Roles should avoid including tasks from other roles when possible +- Plays should do nothing more than include a list of roles, except where `pre_tasks` and `post_tasks` are required, when possible +- Separators - Use valid names, ie. underscores (e.g. `my_role` `my_playbook`) not dashes (`my-role`) +- Paths - When defining paths, do not include trailing slashes (e.g. `my_path: /foo` not `my_path: /foo/`); when concatenating paths, follow the same convention (e.g. `{{ my_path }}/bar` not `{{ my_path }}bar`) +- Indentation - Use 2 spaces for each indent +- `vars/` vs `defaults/` - internal or interpolated variables that don't need to change or be overridden by user go in `vars/`, those that a user would likely override, go under `defaults/` directory +- All role arguments have a specification in `meta/argument_specs.yml` +- All playbooks/roles should be focused on compatibility with Ansible Automation Platform diff --git a/3.1.2/_sources/index.rst.txt b/3.1.2/_sources/index.rst.txt new file mode 100644 index 0000000..6c46ab1 --- /dev/null +++ b/3.1.2/_sources/index.rst.txt @@ -0,0 +1,34 @@ +.. Red Hat middleware_automation Keycloak Ansible Collection documentation main file + +Welcome to Keycloak Collection documentation +============================================ + +.. toctree:: + :maxdepth: 2 + :caption: User documentation + + README + plugins/index + roles/index + Changelog + +.. toctree:: + :maxdepth: 2 + :caption: Developer documentation + + Developing + Testing + Releasing + +.. toctree:: + :maxdepth: 2 + :caption: Middleware collections + + Keycloak / Red Hat Single Sign-On + Infinispan / Red Hat Data Grid + Wildfly / Red Hat JBoss EAP + Tomcat / Red Hat JWS + ActiveMQ / Red Hat AMQ Broker + Kafka / Red Hat AMQ Streams + Ansible Middleware utilities + JCliff diff --git a/3.1.2/_sources/plugins/index.rst.txt b/3.1.2/_sources/plugins/index.rst.txt new file mode 100644 index 0000000..f456ff9 --- /dev/null +++ b/3.1.2/_sources/plugins/index.rst.txt @@ -0,0 +1,44 @@ +Plugin Index +============ + +.. toctree:: + :caption: modules plugins + :maxdepth: 0 + + keycloak_authentication + keycloak_authentication_flow + keycloak_authentication_required_actions + keycloak_authentication_v2 + keycloak_authz_authorization_scope + keycloak_authz_custom_policy + keycloak_authz_permission + keycloak_authz_permission_info + keycloak_client + keycloak_client_rolemapping + keycloak_client_rolescope + keycloak_client_scope + keycloak_client_scope_rolemappings + keycloak_client_scope_type + keycloak_clientsecret_info + keycloak_clientsecret_regenerate + keycloak_clienttemplate + keycloak_component + keycloak_component_info + keycloak_group + keycloak_identity_provider + keycloak_organization + keycloak_organization_info + keycloak_realm + keycloak_realm_info + keycloak_realm_key + keycloak_realm_keys_metadata_info + keycloak_realm_localization + keycloak_realm_rolemapping + keycloak_realm_users_info + keycloak_role + keycloak_user + keycloak_user_execute_actions_email + keycloak_user_federation + keycloak_user_rolemapping + keycloak_userprofile + diff --git a/3.1.2/_sources/plugins/keycloak_authentication.rst.txt b/3.1.2/_sources/plugins/keycloak_authentication.rst.txt new file mode 100644 index 0000000..c79ecec --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_authentication.rst.txt @@ -0,0 +1,799 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_authentication_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_authentication -- Configure authentication in Keycloak ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_authentication`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module actually can only make a copy of an existing authentication flow, add an execution to it and configure it. +- It can also delete the flow. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

alias

+ +

+ string + / required +

+
+

Alias for the authentication flow.

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

authenticationExecutions

+ +

+ list + / elements=dictionary +

+
+

Configuration structure for the executions.

+
+
+

authenticationConfig

+ +

+ dictionary +

+
+

Describe the config of the authentication.

+
+
+

displayName

+ +

+ string +

+
+

Name of the execution or subflow to create or update.

+
+
+

flowAlias

+ +

+ string +

+
+

Alias of parent flow.

+
+
+

index

+ +

+ integer +

+
+

Priority order of the execution.

+
+
+

providerId

+ +

+ string +

+
+

providerID for the new flow when not copied from an existing flow.

+
+
+

requirement

+ +

+ string +

+
+

Control status of the subflow or execution.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

subFlowType

+ +

+ string +

+
+

For new subflows, optionally specify the type.

+

Is only used at creation.

+

Choices:

+
    +
  • "basic-flow" ← (default)

  • +
  • "form-flow"

  • +
+ +
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

copyFrom

+ +

+ string +

+
+

flowAlias of the authentication flow to use for the copy.

+
+
+

description

+ +

+ string +

+
+

Description of the flow.

+
+
+

force

+ +

+ boolean +

+
+

If true, allows to remove the authentication flow and recreate it.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

providerId

+ +

+ string +

+
+

providerId for the new flow when not copied from an existing flow.

+

Choices:

+
    +
  • "basic-flow"

  • +
  • "client-flow"

  • +
+ +
+
+

realm

+ +

+ string + / required +

+
+

The name of the realm in which is the authentication.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

Control if the authentication flow must exists or not.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_authentication_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_authentication_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_authentication_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Create an authentication flow from first broker login and add an execution to it. + middleware_automation.keycloak.keycloak_authentication: + auth_keycloak_url: http://localhost:8080 + auth_realm: master + auth_username: admin + auth_password: password + realm: master + alias: "Copy of first broker login" + copyFrom: "first broker login" + authenticationExecutions: + - providerId: "test-execution1" + requirement: "REQUIRED" + authenticationConfig: + alias: "test.execution1.property" + config: + test1.property: "value" + - providerId: "test-execution2" + requirement: "REQUIRED" + authenticationConfig: + alias: "test.execution2.property" + config: + test2.property: "value" + state: present + + - name: Re-create the authentication flow + middleware_automation.keycloak.keycloak_authentication: + auth_keycloak_url: http://localhost:8080 + auth_realm: master + auth_username: admin + auth_password: password + realm: master + alias: "Copy of first broker login" + copyFrom: "first broker login" + authenticationExecutions: + - providerId: "test-provisioning" + requirement: "REQUIRED" + authenticationConfig: + alias: "test.provisioning.property" + config: + test.provisioning.property: "value" + state: present + force: true + + - name: Create an authentication flow with subflow containing an execution. + middleware_automation.keycloak.keycloak_authentication: + auth_keycloak_url: http://localhost:8080 + auth_realm: master + auth_username: admin + auth_password: password + realm: master + alias: "Copy of first broker login" + copyFrom: "first broker login" + authenticationExecutions: + - providerId: "test-execution1" + requirement: "REQUIRED" + - displayName: "New Subflow" + requirement: "REQUIRED" + - providerId: "auth-cookie" + requirement: "REQUIRED" + flowAlias: "New Sublow" + state: present + + - name: Remove authentication. + middleware_automation.keycloak.keycloak_authentication: + auth_keycloak_url: http://localhost:8080 + auth_realm: master + auth_username: admin + auth_password: password + realm: master + alias: "Copy of first broker login" + state: absent + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of the authentication after module execution.

+

Returned: on success

+

Sample: {"alias": "Copy of first broker login", "authenticationExecutions": [{"alias": "review profile config", "authenticationConfig": {"alias": "review profile config", "config": {"update.profile.on.first.login": "missing"}, "id": "6f09e4fb-aad4-496a-b873-7fa9779df6d7"}, "configurable": true, "displayName": "Review Profile", "id": "8f77dab8-2008-416f-989e-88b09ccf0b4c", "index": 0, "level": 0, "providerId": "idp-review-profile", "requirement": "REQUIRED", "requirementChoices": ["REQUIRED", "ALTERNATIVE", "DISABLED"]}], "builtIn": false, "description": "Actions taken after first broker login with identity provider account, which is not yet linked to any Keycloak account", "id": "bc228863-5887-4297-b898-4d988f8eaa5c", "providerId": "basic-flow", "topLevel": true}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Philippe Gauthier (@elfelip) +- Gaëtan Daubresse (@Gaetan2907) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_authentication_flow.rst.txt b/3.1.2/_sources/plugins/keycloak_authentication_flow.rst.txt new file mode 100644 index 0000000..95af60d --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_authentication_flow.rst.txt @@ -0,0 +1,696 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_authentication_flow_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_authentication_flow -- Allows administration of Keycloak authentication flows via Keycloak API ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_authentication_flow`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows you to add, remove or modify Keycloak authentication flows via the Keycloak REST API. It requires access to the REST API via OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin\-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles. +- This module supports creating new top\-level authentication flows, copying existing flows, and adding execution steps to a flow. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

alias

+ +

+ string + / required +

+
+

Alias (name) of the authentication flow.

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+
+

copy_from

+ +

aliases: copyFrom

+

+ string +

+
+

If set, the new flow is created as a copy of the flow with this alias.

+

Cannot be used together with executions.

+
+
+

description

+ +

+ string +

+
+

Description of the authentication flow.

+

Default: ""

+
+
+

executions

+ +

+ list + / elements=dictionary +

+
+

A list of executions (authenticator steps) to add to the flow.

+

Each execution is a dict with keys provider_id (or providerId) and requirement.

+

Executions are only added when the flow is first created.

+

Default: []

+
+
+
+

provider_id

+ +

aliases: providerId

+

+ string + / required +

+
+

The authenticator provider ID (e.g. auth-cookie, auth-password, auth-otp-form).

+
+
+

requirement

+ +

+ string + / required +

+
+

The requirement level for this execution.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+
+

provider_id

+ +

aliases: providerId

+

+ string +

+
+

The provider ID for the flow.

+

Default: "basic-flow"

+
+
+

realm

+ +

+ string +

+
+

The Keycloak realm under which this authentication flow resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

State of the authentication flow.

+

On present, the flow will be created if it does not yet exist.

+

On absent, the flow will be removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_authentication_flow_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_authentication_flow_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_authentication_flow_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Create an authentication flow with executions + middleware_automation.keycloak.keycloak_authentication_flow: + auth_keycloak_url: http://localhost:8080 + auth_realm: master + auth_username: admin + auth_password: password + realm: TestRealm + alias: my-browser-flow + description: "Custom browser flow" + provider_id: basic-flow + executions: + - provider_id: auth-cookie + requirement: ALTERNATIVE + - provider_id: auth-password + requirement: REQUIRED + - provider_id: auth-otp-form + requirement: ALTERNATIVE + state: present + delegate_to: localhost + + - name: Create an authentication flow by copying an existing one + middleware_automation.keycloak.keycloak_authentication_flow: + auth_keycloak_url: http://localhost:8080 + auth_realm: master + auth_username: admin + auth_password: password + realm: TestRealm + alias: my-copy-of-browser + copy_from: browser + state: present + delegate_to: localhost + + - name: Create a flow using token authentication + middleware_automation.keycloak.keycloak_authentication_flow: + auth_keycloak_url: http://localhost:8080 + token: MY_TOKEN + realm: TestRealm + alias: my-flow + state: present + delegate_to: localhost + + - name: Delete an authentication flow + middleware_automation.keycloak.keycloak_authentication_flow: + auth_keycloak_url: http://localhost:8080 + auth_realm: master + auth_username: admin + auth_password: password + realm: TestRealm + alias: my-browser-flow + state: absent + delegate_to: localhost + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of the authentication flow after module execution.

+

Returned: on success

+

Sample: {"alias": "my-browser-flow", "builtIn": false, "id": "uuid-here", "providerId": "basic-flow", "topLevel": true}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: "Authentication flow my-browser-flow has been created"

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Paulo Menon (@paulomenon) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_authentication_required_actions.rst.txt b/3.1.2/_sources/plugins/keycloak_authentication_required_actions.rst.txt new file mode 100644 index 0000000..77943b9 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_authentication_required_actions.rst.txt @@ -0,0 +1,792 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_authentication_required_actions_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_authentication_required_actions -- Allows administration of Keycloak authentication required actions ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_authentication_required_actions`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module can register, update and delete required actions. +- It also filters out any duplicate required actions by their alias. The first occurrence is preserved. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

realm

+ +

+ string + / required +

+
+

The name of the realm in which are the authentication required actions.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

required_actions

+ +

+ list + / elements=dictionary +

+
+

Authentication required action.

+
+
+

alias

+ +

+ string + / required +

+
+

Unique name of the required action.

+
+
+

config

+ +

+ dictionary +

+
+

Configuration for the required action.

+
+
+

defaultAction

+ +

+ boolean +

+
+

Indicates whether new users have the required action assigned to them.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

enabled

+ +

+ boolean +

+
+

Indicates, if the required action is enabled or not.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

name

+ +

+ string +

+
+

Displayed name of the required action. Required for registration.

+
+
+

priority

+ +

+ integer +

+
+

Priority of the required action.

+
+
+

providerId

+ +

+ string +

+
+

Provider ID of the required action. Required for registration.

+
+
+

state

+ +

+ string + / required +

+
+

Control if the realm authentication required actions are going to be registered/updated (present) or deleted (absent).

+

Choices:

+
    +
  • "absent"

  • +
  • "present"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_authentication_required_actions_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_authentication_required_actions_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_authentication_required_actions_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Register a new required action. + middleware_automation.keycloak.keycloak_authentication_required_actions: + auth_client_id: "admin-cli" + auth_keycloak_url: "http://localhost:8080" + auth_password: "password" + auth_realm: "master" + auth_username: "admin" + realm: "master" + required_actions: + - alias: "TERMS_AND_CONDITIONS" + name: "Terms and conditions" + providerId: "TERMS_AND_CONDITIONS" + enabled: true + state: "present" + + - name: Update the newly registered required action. + middleware_automation.keycloak.keycloak_authentication_required_actions: + auth_client_id: "admin-cli" + auth_keycloak_url: "http://localhost:8080" + auth_password: "password" + auth_realm: "master" + auth_username: "admin" + realm: "master" + required_actions: + - alias: "TERMS_AND_CONDITIONS" + enabled: false + state: "present" + + - name: Delete the updated registered required action. + middleware_automation.keycloak.keycloak_authentication_required_actions: + auth_client_id: "admin-cli" + auth_keycloak_url: "http://localhost:8080" + auth_password: "password" + auth_realm: "master" + auth_username: "admin" + realm: "master" + required_actions: + - alias: "TERMS_AND_CONDITIONS" + state: "absent" + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ complex +

+
+

Representation of the authentication required actions after module execution.

+

Returned: on success

+
+
+

alias

+ +

+ string +

+
+

Unique name of the required action.

+

Returned: success

+

Sample: "test-provider-id"

+
+
+

config

+ +

+ dictionary +

+
+

Configuration for the required action.

+

Returned: success

+

Sample: {}

+
+
+

defaultAction

+ +

+ boolean +

+
+

Indicates whether new users have the required action assigned to them.

+

Returned: success

+

Sample: false

+
+
+

enabled

+ +

+ boolean +

+
+

Indicates, if the required action is enabled or not.

+

Returned: success

+

Sample: false

+
+
+

name

+ +

+ string +

+
+

Displayed name of the required action. Required for registration.

+

Returned: success

+

Sample: "Test provider ID"

+
+
+

priority

+ +

+ integer +

+
+

Priority of the required action.

+

Returned: success

+

Sample: 90

+
+
+

providerId

+ +

+ string +

+
+

Provider ID of the required action. Required for registration.

+

Returned: success

+

Sample: "test-provider-id"

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Skrekulko (@Skrekulko) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_authentication_v2.rst.txt b/3.1.2/_sources/plugins/keycloak_authentication_v2.rst.txt new file mode 100644 index 0000000..80e30c0 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_authentication_v2.rst.txt @@ -0,0 +1,1987 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_authentication_v2_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_authentication_v2 -- Configure authentication flows in Keycloak in an idempotent and safe manner. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_authentication_v2`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows the creation, deletion, and modification of Keycloak authentication flows using the Keycloak REST API. +- Rather than modifying an existing flow in place, the module re\-creates the flow using the :strong:`Safe Swap` mechanism described below. +- :strong:`Safe Swap mechanism` \- When an authentication flow needs to be updated, the module never modifies the existing flow in place. Instead it follows a multi\-step swap procedure to ensure the flow is never left in an intermediate or unsafe state during the update. This is especially important when the flow is actively bound to a realm binding, a client override, or as an identity\-provider login\-flow or post\-flow, because a partially\-updated flow could inadvertently allow unauthorised access. +- The :strong:`Safe Swap mechanism` is as follows. 1. A new flow is created under a temporary name (the original alias plus a configurable suffix, for example :literal:`myflow\_tmp\_for\_swap`\ ). 2. All executions and their configurations are added to the new temporary flow. 3. If the existing flow is currently bound to a realm or a client, all bindings are redirected to the new temporary flow. This ensures continuity and avoids any gap in active authentication coverage. 4. The old flow is deleted. 5. The temporary flow is renamed to the original alias, restoring the expected name. +- :strong:`Handling pre\-existing temporary swap flows` \- If a temporary swap flow already exists (for example, from a previously interrupted run), the module can optionally delete it before proceeding. This behaviour is controlled by the :ansopt:`middleware\_automation.keycloak.keycloak\_authentication\_v2#module:force\_temporary\_swap\_flow\_deletion` option. If the option is :ansval:`false` and a temporary flow already exists, the module will fail to prevent accidental data loss. +- :strong:`Idempotency` \- If the existing flow already matches the desired configuration, no changes are made. The module compares a normalised representation of the existing flow against the desired state before deciding whether to trigger the Safe Swap procedure. +- A depth of 10 sub\-flows is supported. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

alias

+ +

+ string + / required +

+
+

The name of the authentication flow.

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

authenticationExecutions

+ +

+ list + / elements=dictionary +

+
+

The desired execution configuration for the flow.

+

Executions at root level.

+
+
+

authenticationConfig

+ +

+ dictionary +

+
+

The configuration for the execution.

+
+
+

alias

+ +

+ string + / required +

+
+

Name of the execution config.

+
+
+

config

+ +

+ dictionary + / required +

+
+

Options for the execution config.

+
+
+

authenticationExecutions

+ +

+ list + / elements=dictionary +

+
+

The execution configuration for executions within the sub-flow.

+

Executions at sub level 1.

+
+
+

authenticationConfig

+ +

+ dictionary +

+
+

The configuration for the execution.

+
+
+

alias

+ +

+ string + / required +

+
+

Name of the execution config.

+
+
+

config

+ +

+ dictionary + / required +

+
+

Options for the execution config.

+
+
+

authenticationExecutions

+ +

+ list + / elements=dictionary +

+
+

The execution configuration for executions within the sub-flow.

+

Executions at sub level 2.

+
+
+

authenticationConfig

+ +

+ dictionary +

+
+

The configuration for the execution.

+
+
+

alias

+ +

+ string + / required +

+
+

Name of the execution config.

+
+
+

config

+ +

+ dictionary + / required +

+
+

Options for the execution config.

+
+
+

authenticationExecutions

+ +

+ list + / elements=dictionary +

+
+

The execution configuration for executions within the sub-flow.

+

Executions at sub level 3.

+
+
+

authenticationConfig

+ +

+ dictionary +

+
+

The configuration for the execution.

+
+
+

alias

+ +

+ string + / required +

+
+

Name of the execution config.

+
+
+

config

+ +

+ dictionary + / required +

+
+

Options for the execution config.

+
+
+

authenticationExecutions

+ +

+ list + / elements=dictionary +

+
+

The execution configuration for executions within the sub-flow.

+

Executions at sub level 4.

+
+
+

authenticationConfig

+ +

+ dictionary +

+
+

The configuration for the execution.

+
+
+

alias

+ +

+ string + / required +

+
+

Name of the execution config.

+
+
+

config

+ +

+ dictionary + / required +

+
+

Options for the execution config.

+
+
+

authenticationExecutions

+ +

+ list + / elements=dictionary +

+
+

The execution configuration for executions within the sub-flow.

+

Executions at sub level 5.

+
+
+

authenticationConfig

+ +

+ dictionary +

+
+

The configuration for the execution.

+
+
+

alias

+ +

+ string + / required +

+
+

Name of the execution config.

+
+
+

config

+ +

+ dictionary + / required +

+
+

Options for the execution config.

+
+
+

authenticationExecutions

+ +

+ list + / elements=dictionary +

+
+

The execution configuration for executions within the sub-flow.

+

Executions at sub level 6.

+
+
+

authenticationConfig

+ +

+ dictionary +

+
+

The configuration for the execution.

+
+
+

alias

+ +

+ string + / required +

+
+

Name of the execution config.

+
+
+

config

+ +

+ dictionary + / required +

+
+

Options for the execution config.

+
+
+

authenticationExecutions

+ +

+ list + / elements=dictionary +

+
+

The execution configuration for executions within the sub-flow.

+

Executions at sub level 7.

+
+
+

authenticationConfig

+ +

+ dictionary +

+
+

The configuration for the execution.

+
+
+

alias

+ +

+ string + / required +

+
+

Name of the execution config.

+
+
+

config

+ +

+ dictionary + / required +

+
+

Options for the execution config.

+
+
+

authenticationExecutions

+ +

+ list + / elements=dictionary +

+
+

The execution configuration for executions within the sub-flow.

+

Executions at sub level 8.

+
+
+

authenticationConfig

+ +

+ dictionary +

+
+

The configuration for the execution.

+
+
+

alias

+ +

+ string + / required +

+
+

Name of the execution config.

+
+
+

config

+ +

+ dictionary + / required +

+
+

Options for the execution config.

+
+
+

authenticationExecutions

+ +

+ list + / elements=dictionary +

+
+

The execution configuration for executions within the sub-flow.

+

Executions at sub level 9.

+
+
+

authenticationConfig

+ +

+ dictionary +

+
+

The configuration for the execution.

+
+
+

alias

+ +

+ string + / required +

+
+

Name of the execution config.

+
+
+

config

+ +

+ dictionary + / required +

+
+

Options for the execution config.

+
+
+

authenticationExecutions

+ +

+ list + / elements=dictionary +

+
+

The execution configuration for executions within the sub-flow.

+

Executions at sub level 10 (last sub level).

+
+
+

authenticationConfig

+ +

+ dictionary +

+
+

The configuration for the execution.

+
+
+

alias

+ +

+ string + / required +

+
+

Name of the execution config.

+
+
+

config

+ +

+ dictionary + / required +

+
+

Options for the execution config.

+
+
+

providerId

+ +

+ string + / required +

+
+

The providerId of the execution.

+
+
+

requirement

+ +

+ string + / required +

+
+

The requirement status of the execution or sub-flow.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

providerId

+ +

+ string +

+
+

The providerId of the execution.

+
+
+

requirement

+ +

+ string + / required +

+
+

The requirement status of the execution or sub-flow.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

subFlow

+ +

+ string +

+
+

The name of the sub-flow.

+
+
+

subFlowType

+ +

+ string +

+
+

The type of the sub-flow.

+

Choices:

+
    +
  • "basic-flow" ← (default)

  • +
  • "form-flow"

  • +
+ +
+
+

providerId

+ +

+ string +

+
+

The providerId of the execution.

+
+
+

requirement

+ +

+ string + / required +

+
+

The requirement status of the execution or sub-flow.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

subFlow

+ +

+ string +

+
+

The name of the sub-flow.

+
+
+

subFlowType

+ +

+ string +

+
+

The type of the sub-flow.

+

Choices:

+
    +
  • "basic-flow" ← (default)

  • +
  • "form-flow"

  • +
+ +
+
+

providerId

+ +

+ string +

+
+

The providerId of the execution.

+
+
+

requirement

+ +

+ string + / required +

+
+

The requirement status of the execution or sub-flow.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

subFlow

+ +

+ string +

+
+

The name of the sub-flow.

+
+
+

subFlowType

+ +

+ string +

+
+

The type of the sub-flow.

+

Choices:

+
    +
  • "basic-flow" ← (default)

  • +
  • "form-flow"

  • +
+ +
+
+

providerId

+ +

+ string +

+
+

The providerId of the execution.

+
+
+

requirement

+ +

+ string + / required +

+
+

The requirement status of the execution or sub-flow.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

subFlow

+ +

+ string +

+
+

The name of the sub-flow.

+
+
+

subFlowType

+ +

+ string +

+
+

The type of the sub-flow.

+

Choices:

+
    +
  • "basic-flow" ← (default)

  • +
  • "form-flow"

  • +
+ +
+
+

providerId

+ +

+ string +

+
+

The providerId of the execution.

+
+
+

requirement

+ +

+ string + / required +

+
+

The requirement status of the execution or sub-flow.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

subFlow

+ +

+ string +

+
+

The name of the sub-flow.

+
+
+

subFlowType

+ +

+ string +

+
+

The type of the sub-flow.

+

Choices:

+
    +
  • "basic-flow" ← (default)

  • +
  • "form-flow"

  • +
+ +
+
+

providerId

+ +

+ string +

+
+

The providerId of the execution.

+
+
+

requirement

+ +

+ string + / required +

+
+

The requirement status of the execution or sub-flow.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

subFlow

+ +

+ string +

+
+

The name of the sub-flow.

+
+
+

subFlowType

+ +

+ string +

+
+

The type of the sub-flow.

+

Choices:

+
    +
  • "basic-flow" ← (default)

  • +
  • "form-flow"

  • +
+ +
+
+

providerId

+ +

+ string +

+
+

The providerId of the execution.

+
+
+

requirement

+ +

+ string + / required +

+
+

The requirement status of the execution or sub-flow.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

subFlow

+ +

+ string +

+
+

The name of the sub-flow.

+
+
+

subFlowType

+ +

+ string +

+
+

The type of the sub-flow.

+

Choices:

+
    +
  • "basic-flow" ← (default)

  • +
  • "form-flow"

  • +
+ +
+
+

providerId

+ +

+ string +

+
+

The providerId of the execution.

+
+
+

requirement

+ +

+ string + / required +

+
+

The requirement status of the execution or sub-flow.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

subFlow

+ +

+ string +

+
+

The name of the sub-flow.

+
+
+

subFlowType

+ +

+ string +

+
+

The type of the sub-flow.

+

Choices:

+
    +
  • "basic-flow" ← (default)

  • +
  • "form-flow"

  • +
+ +
+
+

providerId

+ +

+ string +

+
+

The providerId of the execution.

+
+
+

requirement

+ +

+ string + / required +

+
+

The requirement status of the execution or sub-flow.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

subFlow

+ +

+ string +

+
+

The name of the sub-flow.

+
+
+

subFlowType

+ +

+ string +

+
+

The type of the sub-flow.

+

Choices:

+
    +
  • "basic-flow" ← (default)

  • +
  • "form-flow"

  • +
+ +
+
+

providerId

+ +

+ string +

+
+

The providerId of the execution.

+
+
+

requirement

+ +

+ string + / required +

+
+

The requirement status of the execution or sub-flow.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

subFlow

+ +

+ string +

+
+

The name of the sub-flow.

+
+
+

subFlowType

+ +

+ string +

+
+

The type of the sub-flow.

+

Choices:

+
    +
  • "basic-flow" ← (default)

  • +
  • "form-flow"

  • +
+ +
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

description

+ +

+ string +

+
+

A human-readable description of the flow.

+
+
+

force_temporary_swap_flow_deletion

+ +

+ boolean +

+
+

If true, any pre-existing temporary swap flow (identified by the original alias plus temporary_swap_flow_suffix) is deleted before the Safe Swap procedure begins.

+

Set this to false to cause the module to fail instead of silently removing a pre-existing temporary flow, for example to avoid accidental data loss after an interrupted run.

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

providerId

+ +

+ string +

+
+

The providerId for the new flow.

+

Choices:

+
    +
  • "basic-flow" ← (default)

  • +
  • "client-flow"

  • +
+ +
+
+

realm

+ +

+ string + / required +

+
+

The name of the realm in which the authentication flow resides.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

Whether the authentication flow should exist or not.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

temporary_swap_flow_suffix

+ +

+ string +

+
+

The suffix appended to the alias of the temporary flow created during a Safe Swap update.

+

The temporary flow exists only for the duration of the swap procedure and is renamed to the original alias once all bindings have been successfully transferred.

+

Default: "_tmp_for_swap"

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_authentication_v2_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_authentication_v2_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_authentication_v2_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Create or modify the 'My Login Flow'. + middleware_automation.keycloak.keycloak_authentication_v2: + auth_keycloak_url: http://localhost:8080 + auth_realm: master + auth_username: admin + auth_password: password + realm: master + alias: My Login Flow + authenticationExecutions: + - providerId: idp-review-profile + requirement: REQUIRED + authenticationConfig: + alias: My Login Flow - review profile config + config: + update.profile.on.first.login: "missing" + - subFlow: My Login Flow - User creation or linking + requirement: REQUIRED + authenticationExecutions: + - providerId: idp-create-user-if-unique + requirement: ALTERNATIVE + authenticationConfig: + alias: My Login Flow - create unique user config + config: + require.password.update.after.registration: "true" + - providerId: auth-cookie + requirement: REQUIRED + - subFlow: My Login Flow - Handle Existing Account + requirement: ALTERNATIVE + authenticationExecutions: + - providerId: idp-confirm-link + requirement: REQUIRED + - providerId: auth-cookie + requirement: DISABLED + state: present + + - name: Remove an authentication flow. + middleware_automation.keycloak.keycloak_authentication_v2: + auth_keycloak_url: http://localhost:8080 + auth_realm: master + auth_username: admin + auth_password: password + realm: master + alias: My Login Flow + state: absent + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of the authentication flow after module execution.

+

Returned: on success

+

Sample: {"alias": "My Login Flow", "authenticationExecutions": [{"alias": "review profile config", "authenticationConfig": {"alias": "review profile config", "config": {"update.profile.on.first.login": "missing"}, "id": "6f09e4fb-aad4-496a-b873-7fa9779df6d7"}, "configurable": true, "displayName": "Review Profile", "id": "8f77dab8-2008-416f-989e-88b09ccf0b4c", "index": 0, "level": 0, "providerId": "idp-review-profile", "requirement": "REQUIRED", "requirementChoices": ["REQUIRED", "ALTERNATIVE", "DISABLED"]}], "builtIn": false, "description": "Actions taken after first broker login with identity provider account, which is not yet linked to any Keycloak account", "id": "bc228863-5887-4297-b898-4d988f8eaa5c", "providerId": "basic-flow", "topLevel": true}

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Thomas Bargetz (@thomasbargetz) +- Nils Bergmann (@NilsBergmann) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_authz_authorization_scope.rst.txt b/3.1.2/_sources/plugins/keycloak_authz_authorization_scope.rst.txt new file mode 100644 index 0000000..0d24bbc --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_authz_authorization_scope.rst.txt @@ -0,0 +1,657 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_authz_authorization_scope_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_authz_authorization_scope -- Allows administration of Keycloak client authorization scopes using Keycloak API +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_authz_authorization_scope`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows the administration of Keycloak client Authorization Scopes using the Keycloak REST API. Authorization Scopes are only available if a client has Authorization enabled. +- This module requires access to the REST API using OpenID Connect; the user connecting and the realm being used must have the requisite access rights. In a default Keycloak installation, admin\-cli and an admin user would work, as would a separate realm definition with the scope tailored to your needs and a user having the expected roles. +- The names of module options are snake\_cased versions of the camelCase options used by Keycloak. The Authorization Services paths and payloads have not officially been documented by the Keycloak project. \ `https://www.puppeteers.net/blog/keycloak\-authorization\-services\-rest\-api\-paths\-and\-payload/ `__. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

client_id

+ +

+ string + / required +

+
+

The clientId of the Keycloak client that should have the authorization scope.

+

This is usually a human-readable name of the Keycloak client.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

display_name

+ +

+ string +

+
+

The display name of the authorization scope.

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

icon_uri

+ +

+ string +

+
+

The icon URI for the authorization scope.

+
+
+

name

+ +

+ string + / required +

+
+

Name of the authorization scope to create.

+
+
+

realm

+ +

+ string + / required +

+
+

The name of the Keycloak realm the Keycloak client is in.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

State of the authorization scope.

+

On present, the authorization scope is created (or updated if it exists already).

+

On absent, the authorization scope is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_authz_authorization_scope_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_authz_authorization_scope_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_authz_authorization_scope_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Manage Keycloak file:delete authorization scope + keycloak_authz_authorization_scope: + name: file:delete + state: present + display_name: File delete + client_id: myclient + realm: myrealm + auth_keycloak_url: http://localhost:8080 + auth_username: keycloak + auth_password: keycloak + auth_realm: master + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ complex +

+
+

Representation of the authorization scope after module execution.

+

Returned: on success

+
+
+

display_name

+ +

+ string +

+
+

Display name of the authorization scope.

+

Returned: when state=present

+

Sample: "File delete"

+
+
+

icon_uri

+ +

+ string +

+
+

Icon URI for the authorization scope.

+

Returned: when state=present

+

Sample: "http://localhost/icon.png"

+
+
+

id

+ +

+ string +

+
+

ID of the authorization scope.

+

Returned: when state=present

+

Sample: "a6ab1cf2-1001-40ec-9f39-48f23b6a0a41"

+
+
+

name

+ +

+ string +

+
+

Name of the authorization scope.

+

Returned: when state=present

+

Sample: "file:delete"

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Samuli Seppänen (@mattock) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_authz_custom_policy.rst.txt b/3.1.2/_sources/plugins/keycloak_authz_custom_policy.rst.txt new file mode 100644 index 0000000..d58e8f1 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_authz_custom_policy.rst.txt @@ -0,0 +1,616 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_authz_custom_policy_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_authz_custom_policy -- Allows administration of Keycloak client custom Javascript policies using Keycloak API +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_authz_custom_policy`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows the administration of Keycloak client custom Javascript using the Keycloak REST API. Custom Javascript policies are only available if a client has Authorization enabled and if they have been deployed to the Keycloak server as JAR files. +- This module requires access to the REST API using OpenID Connect; the user connecting and the realm being used must have the requisite access rights. In a default Keycloak installation, admin\-cli and an admin user would work, as would a separate realm definition with the scope tailored to your needs and a user having the expected roles. +- The names of module options are snake\_cased versions of the camelCase options used by Keycloak. The Authorization Services paths and payloads have not officially been documented by the Keycloak project. \ `https://www.puppeteers.net/blog/keycloak\-authorization\-services\-rest\-api\-paths\-and\-payload/ `__. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

client_id

+ +

+ string + / required +

+
+

The clientId of the Keycloak client that should have the custom policy attached to it.

+

This is usually a human-readable name of the Keycloak client.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

name

+ +

+ string + / required +

+
+

Name of the custom policy to create.

+
+
+

policy_type

+ +

+ string + / required +

+
+

The type of the policy. This must match the name of the custom policy deployed to the server.

+

Multiple policies pointing to the same policy type can be created, but their names have to differ.

+
+
+

realm

+ +

+ string + / required +

+
+

The name of the Keycloak realm the Keycloak client is in.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

State of the custom policy.

+

On present, the custom policy is created (or updated if it exists already).

+

On absent, the custom policy is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_authz_custom_policy_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_authz_custom_policy_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_authz_custom_policy_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-none:`none` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Manage Keycloak custom authorization policy + middleware_automation.keycloak.keycloak_authz_custom_policy: + name: OnlyOwner + state: present + policy_type: script-policy.js + client_id: myclient + realm: myrealm + auth_keycloak_url: http://localhost:8080 + auth_username: keycloak + auth_password: keycloak + auth_realm: master + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of the custom policy after module execution.

+

Returned: on success

+
+
+

name

+ +

+ string +

+
+

Name of the custom policy.

+

Returned: when state=present

+

Sample: "file:delete"

+
+
+

policy_type

+ +

+ string +

+
+

Type of custom policy.

+

Returned: when state=present

+

Sample: "File delete"

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Samuli Seppänen (@mattock) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_authz_permission.rst.txt b/3.1.2/_sources/plugins/keycloak_authz_permission.rst.txt new file mode 100644 index 0000000..72c2ae2 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_authz_permission.rst.txt @@ -0,0 +1,835 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_authz_permission_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_authz_permission -- Allows administration of Keycloak client authorization permissions using Keycloak API +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_authz_permission`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows the administration of Keycloak client authorization permissions using the Keycloak REST API. Authorization permissions are only available if a client has Authorization enabled. +- There are some peculiarities in JSON paths and payloads for authorization permissions. In particular POST and PUT operations are targeted at permission endpoints, whereas GET requests go to policies endpoint. To make matters more interesting the JSON responses from GET requests return data in a different format than what is expected for POST and PUT. The end result is that it is not possible to detect changes to things like policies, scopes or resources \- at least not without a large number of additional API calls. Therefore this module always updates authorization permissions instead of attempting to determine if changes are truly needed. +- This module requires access to the REST API using OpenID Connect; the user connecting and the realm being used must have the requisite access rights. In a default Keycloak installation, admin\-cli and an admin user would work, as would a separate realm definition with the scope tailored to your needs and a user having the expected roles. +- The names of module options are snake\_cased versions of the camelCase options used by Keycloak. The Authorization Services paths and payloads have not officially been documented by the Keycloak project. \ `https://www.puppeteers.net/blog/keycloak\-authorization\-services\-rest\-api\-paths\-and\-payload/ `__. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

client_id

+ +

+ string + / required +

+
+

The clientId of the keycloak client that should have the authorization scope.

+

This is usually a human-readable name of the Keycloak client.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

decision_strategy

+ +

+ string +

+
+

The decision strategy to use with this permission.

+

Choices:

+
    +
  • "UNANIMOUS" ← (default)

  • +
  • "AFFIRMATIVE"

  • +
  • "CONSENSUS"

  • +
+ +
+
+

description

+ +

+ string +

+
+

The description of the authorization permission.

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

name

+ +

+ string + / required +

+
+

Name of the authorization permission to create.

+
+
+

permission_type

+ +

+ string + / required +

+
+

The type of authorization permission.

+

On scope create a scope-based permission.

+

On resource create a resource-based permission.

+

Choices:

+
    +
  • "resource"

  • +
  • "scope"

  • +
+ +
+
+

policies

+ +

+ list + / elements=string +

+
+

Policy names to attach to this permission.

+

Default: []

+
+
+

realm

+ +

+ string + / required +

+
+

The name of the Keycloak realm the Keycloak client is in.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

resources

+ +

+ list + / elements=string +

+
+

Resource names to attach to this permission.

+

Scope-based permissions can only include one resource.

+

Resource-based permissions can include multiple resources.

+

Default: []

+
+
+

scopes

+ +

+ list + / elements=string +

+
+

Scope names to attach to this permission.

+

Resource-based permissions cannot have scopes attached to them.

+

Default: []

+
+
+

state

+ +

+ string +

+
+

State of the authorization permission.

+

On present, the authorization permission is created (or updated if it exists already).

+

On absent, the authorization permission is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_authz_permission_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_authz_permission_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_authz_permission_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-none:`none` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Manage scope-based Keycloak authorization permission + middleware_automation.keycloak.keycloak_authz_permission: + name: ScopePermission + state: present + description: Scope permission + permission_type: scope + scopes: + - file:delete + policies: + - Default Policy + client_id: myclient + realm: myrealm + auth_keycloak_url: http://localhost:8080 + auth_username: keycloak + auth_password: keycloak + auth_realm: master + + - name: Manage resource-based Keycloak authorization permission + middleware_automation.keycloak.keycloak_authz_permission: + name: ResourcePermission + state: present + description: Resource permission + permission_type: resource + resources: + - Default Resource + policies: + - Default Policy + client_id: myclient + realm: myrealm + auth_keycloak_url: http://localhost:8080 + auth_username: keycloak + auth_password: keycloak + auth_realm: master + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ complex +

+
+

Representation of the authorization permission after module execution.

+

Returned: on success

+
+
+

decisionStrategy

+ +

+ string +

+
+

The decision strategy to use.

+

Returned: when state=present

+

Sample: "UNANIMOUS"

+
+
+

description

+ +

+ string +

+
+

Description of the authorization permission.

+

Returned: when state=present

+

Sample: "Resource Permission"

+
+
+

id

+ +

+ string +

+
+

ID of the authorization permission.

+

Returned: when state=present

+

Sample: "9da05cd2-b273-4354-bbd8-0c133918a454"

+
+
+

logic

+ +

+ string +

+
+

The logic used for the permission (part of the payload, but has a fixed value).

+

Returned: when state=present

+

Sample: "POSITIVE"

+
+
+

name

+ +

+ string +

+
+

Name of the authorization permission.

+

Returned: when state=present

+

Sample: "ResourcePermission"

+
+
+

policies

+ +

+ list + / elements=string +

+
+

IDs of policies attached to this permission.

+

Returned: when state=present

+

Sample: ["9da05cd2-b273-4354-bbd8-0c133918a454"]

+
+
+

resources

+ +

+ list + / elements=string +

+
+

IDs of resources attached to this permission.

+

Returned: when state=present

+

Sample: ["49e052ff-100d-4b79-a9dd-52669ed3c11d"]

+
+
+

scopes

+ +

+ list + / elements=string +

+
+

IDs of scopes attached to this permission.

+

Returned: when state=present

+

Sample: ["9da05cd2-b273-4354-bbd8-0c133918a454"]

+
+
+

type

+ +

+ string +

+
+

Type of the authorization permission.

+

Returned: when state=present

+

Sample: "resource"

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Samuli Seppänen (@mattock) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_authz_permission_info.rst.txt b/3.1.2/_sources/plugins/keycloak_authz_permission_info.rst.txt new file mode 100644 index 0000000..860db12 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_authz_permission_info.rst.txt @@ -0,0 +1,657 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_authz_permission_info_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_authz_permission_info -- Query Keycloak client authorization permissions information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_authz_permission_info`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows querying information about Keycloak client authorization permissions from the resources endpoint using the Keycloak REST API. Authorization permissions are only available if a client has Authorization enabled. +- This module requires access to the REST API using OpenID Connect; the user connecting and the realm being used must have the requisite access rights. In a default Keycloak installation, admin\-cli and an admin user would work, as would a separate realm definition with the scope tailored to your needs and a user having the expected roles. +- The names of module options are snake\_cased versions of the camelCase options used by Keycloak. The Authorization Services paths and payloads have not officially been documented by the Keycloak project. \ `https://www.puppeteers.net/blog/keycloak\-authorization\-services\-rest\-api\-paths\-and\-payload/ `__. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

client_id

+ +

+ string + / required +

+
+

The clientId of the keycloak client that should have the authorization scope.

+

This is usually a human-readable name of the Keycloak client.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

name

+ +

+ string + / required +

+
+

Name of the authorization permission to create.

+
+
+

realm

+ +

+ string + / required +

+
+

The name of the Keycloak realm the Keycloak client is in.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_authz_permission_info_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_authz_permission_info_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + This action does not modify state. + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_authz_permission_info_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ ` \ :ansible-attribute-support-na:`N/A` + + This action does not modify state. + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Query Keycloak authorization permission + middleware_automation.keycloak.keycloak_authz_permission_info: + name: ScopePermission + client_id: myclient + realm: myrealm + auth_keycloak_url: http://localhost:8080 + auth_username: keycloak + auth_password: keycloak + auth_realm: master + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+
+
+

queried_state

+ +

+ complex +

+
+

State of the resource (a policy) as seen by Keycloak.

+

Returned: on success

+
+
+

config

+ +

+ dictionary +

+
+

Configuration of the permission (empty in all observed cases).

+

Returned: success

+

Sample: {}

+
+
+

decisionStrategy

+ +

+ string +

+
+

The decision strategy.

+

Returned: success

+

Sample: "UNANIMOUS"

+
+
+

description

+ +

+ string +

+
+

Description of the authorization permission.

+

Returned: success

+

Sample: "Resource Permission"

+
+
+

id

+ +

+ string +

+
+

ID of the authorization permission.

+

Returned: success

+

Sample: "9da05cd2-b273-4354-bbd8-0c133918a454"

+
+
+

logic

+ +

+ string +

+
+

The logic used for the permission (part of the payload, but has a fixed value).

+

Returned: success

+

Sample: "POSITIVE"

+
+
+

name

+ +

+ string +

+
+

Name of the authorization permission.

+

Returned: success

+

Sample: "ResourcePermission"

+
+
+

type

+ +

+ string +

+
+

Type of the authorization permission.

+

Returned: success

+

Sample: "resource"

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Samuli Seppänen (@mattock) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_client.rst.txt b/3.1.2/_sources/plugins/keycloak_client.rst.txt new file mode 100644 index 0000000..cdbb64e --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_client.rst.txt @@ -0,0 +1,1992 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_client_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_client -- Allows administration of Keycloak clients using Keycloak API ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_client`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows the administration of Keycloak clients using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin\-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles. +- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ `https://www.keycloak.org/docs\-api/latest/rest\-api/index.html `__. Aliases are provided so camelCased versions can be used as well. +- The Keycloak API does not always sanity check inputs, for example you can set SAML\-specific settings on an OpenID Connect client for instance and the other way around. Be careful. If you do not specify a setting, usually a sensible default is chosen. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+
+

admin_url

+ +

aliases: adminUrl

+

+ string +

+
+

URL to the admin interface of the client. This is adminUrl in the Keycloak REST API.

+
+
+
+

always_display_in_console

+ +

aliases: alwaysDisplayInConsole

+

+ boolean +

+
+

Whether or not to display this client in account console, even if the user does not have an active session.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

attributes

+ +

+ dictionary +

+
+

A dict of further attributes for this client. This can contain various configuration settings; an example is given in the examples section. While an exhaustive list of permissible options is not available; possible options as of Keycloak 3.4 are listed below. The Keycloak API does not validate whether a given option is appropriate for the protocol used; if specified anyway, Keycloak does not use it.

+
+
+

jwks.url

+ +

+ string +

+
+

For OpenID-Connect clients, URL where client keys in JWK are stored.

+
+
+

jwt.credential.certificate

+ +

+ string +

+
+

For OpenID-Connect clients, client certificate for validating JWT issued by client and signed by its key, base64-encoded.

+
+
+

request.object.signature.alg

+ +

+ string +

+
+

For OpenID-Connect clients, JWA algorithm which the client needs to use when sending OIDC request object. One of any, none, RS256.

+
+
+

saml.authnstatement

+ +

+ string +

+
+

For SAML clients, boolean specifying whether or not a statement containing method and timestamp should be included in the login response.

+
+
+

saml.client.signature

+ +

+ string +

+
+

For SAML clients, boolean specifying whether a client signature is required and validated.

+
+
+

saml.encrypt

+ +

+ string +

+
+

Boolean specifying whether SAML assertions should be encrypted with the client's public key.

+
+
+

saml.force.post.binding

+ +

+ string +

+
+

For SAML clients, boolean specifying whether always to use POST binding for responses.

+
+
+

saml.onetimeuse.condition

+ +

+ string +

+
+

For SAML clients, boolean specifying whether a OneTimeUse condition should be included in login responses.

+
+
+

saml.server.signature

+ +

+ string +

+
+

Boolean specifying whether SAML documents should be signed by the realm.

+
+
+

saml.server.signature.keyinfo.ext

+ +

+ string +

+
+

For SAML clients, boolean specifying whether REDIRECT signing key lookup should be optimized through inclusion of the signing key ID in the SAML Extensions element.

+
+
+

saml.signature.algorithm

+ +

+ string +

+
+

Signature algorithm used to sign SAML documents. One of RSA_SHA256, RSA_SHA1, RSA_SHA512, or DSA_SHA1.

+
+
+

saml.signing.certificate

+ +

+ string +

+
+

SAML signing key certificate, base64-encoded.

+
+
+

saml.signing.private.key

+ +

+ string +

+
+

SAML signing key private key, base64-encoded.

+
+
+

saml_assertion_consumer_url_post

+ +

+ string +

+
+

SAML POST Binding URL for the client's assertion consumer service (login responses).

+
+
+

saml_assertion_consumer_url_redirect

+ +

+ string +

+
+

SAML Redirect Binding URL for the client's assertion consumer service (login responses).

+
+
+

saml_force_name_id_format

+ +

+ string +

+
+

For SAML clients, Boolean specifying whether to ignore requested NameID subject format and using the configured one instead.

+
+
+

saml_name_id_format

+ +

+ string +

+
+

For SAML clients, the NameID format to use (one of username, email, transient, or persistent).

+
+
+

saml_signature_canonicalization_method

+ +

+ string +

+
+

SAML signature canonicalization method. This is one of four values, namely http://www.w3.org/2001/10/xml-exc-c14n# for EXCLUSIVE, http://www.w3.org/2001/10/xml-exc-c14n#WithComments for EXCLUSIVE_WITH_COMMENTS, http://www.w3.org/TR/2001/REC-xml-c14n-20010315 for INCLUSIVE, and http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments for INCLUSIVE_WITH_COMMENTS.

+
+
+

saml_single_logout_service_url_post

+ +

+ string +

+
+

SAML POST binding URL for the client's single logout service.

+
+
+

saml_single_logout_service_url_redirect

+ +

+ string +

+
+

SAML redirect binding URL for the client's single logout service.

+
+
+

use.jwks.url

+ +

+ string +

+
+

For OpenID-Connect clients, boolean specifying whether to use a JWKS URL to obtain client public keys.

+
+
+

user.info.response.signature.alg

+ +

+ string +

+
+

For OpenID-Connect clients, JWA algorithm for signed UserInfo-endpoint responses. One of RS256 or unsigned.

+
+
+

x509.allow.regex.pattern.comparison

+ +

+ boolean +

+
+

For OpenID-Connect clients, boolean specifying whether to allow x509.subjectdn as regular expression.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

x509.subjectdn

+ +

+ string +

+
+

For OpenID-Connect clients, subject which is used to authenticate the client.

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+
+

authentication_flow_binding_overrides

+ +

aliases: authenticationFlowBindingOverrides

+

+ dictionary +

+
+

Override realm authentication flow bindings.

+
+
+
+

browser

+ +

+ string +

+
+

Flow ID of the browser authentication flow.

+

authentication_flow_binding_overrides.browser and authentication_flow_binding_overrides.browser_name are mutually exclusive.

+
+
+
+
+
+

browser_name

+ +

aliases: browserName

+

+ string +

+
+

Flow name of the browser authentication flow.

+

authentication_flow_binding_overrides.browser and authentication_flow_binding_overrides.browser_name are mutually exclusive.

+
+
+
+
+
+

direct_grant

+ +

aliases: directGrant

+

+ string +

+
+

Flow ID of the direct grant authentication flow.

+

authentication_flow_binding_overrides.direct_grant and authentication_flow_binding_overrides.direct_grant_name are mutually exclusive.

+
+
+
+
+
+

direct_grant_name

+ +

aliases: directGrantName

+

+ string +

+
+

Flow name of the direct grant authentication flow.

+

authentication_flow_binding_overrides.direct_grant and authentication_flow_binding_overrides.direct_grant_name are mutually exclusive.

+
+
+
+

authorization_services_enabled

+ +

aliases: authorizationServicesEnabled

+

+ boolean +

+
+

Are authorization services enabled for this client or not (OpenID connect). This is authorizationServicesEnabled in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

authorization_settings

+ +

aliases: authorizationSettings

+

+ dictionary +

+
+

A data structure defining the authorization settings for this client. For reference, please see the Keycloak API docs at https://www.keycloak.org/docs-api/latest/rest-api/index.html#_resourceserverrepresentation. This is authorizationSettings in the Keycloak REST API.

+
+
+
+

backchannel_logout_url

+ +

aliases: backchannelLogoutUrl

+

+ string +

+
+

URL that will cause the client to log itself out when a logout request is sent to this realm.

+

This is stored as backchannel.logout.url in the client attributes.

+
+
+
+

base_url

+ +

aliases: baseUrl

+

+ string +

+
+

Default URL to use when the auth server needs to redirect or link back to the client This is baseUrl in the Keycloak REST API.

+
+
+
+

bearer_only

+ +

aliases: bearerOnly

+

+ boolean +

+
+

The access type of this client is bearer-only. This is bearerOnly in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

client_authenticator_type

+ +

aliases: clientAuthenticatorType

+

+ string +

+
+

How do clients authenticate with the auth server? Either client-secret, client-jwt, or client-x509 can be chosen. When using client-secret, the module parameter secret can set it, for client-jwt, you can use the keys use.jwks.url, jwks.url, and jwt.credential.certificate in the attributes module parameter to configure its behavior. For client-x509 you can use the keys x509.allow.regex.pattern.comparison and x509.subjectdn in the attributes module parameter to configure which certificate(s) to accept.

+

This is clientAuthenticatorType in the Keycloak REST API.

+

Choices:

+
    +
  • "client-secret"

  • +
  • "client-jwt"

  • +
  • "client-x509"

  • +
+ +
+
+
+

client_id

+ +

aliases: clientId

+

+ string +

+
+

Client ID of client to be worked on. This is usually an alphanumeric name chosen by you. Either this or id is required. If you specify both, id takes precedence. This is clientId in the Keycloak REST API.

+
+
+
+

client_scopes_behavior

+ +

aliases: clientScopesBehavior

+

+ string +

+
+

Determine how default_client_scopes and optional_client_scopes behave when updating an existing client.

+

ignore: Do not change the client scopes of an existing client. This is the default for backward compatibility.

+

patch: Add missing scopes, do not remove any missing scopes.

+

idempotent: Make the client scopes exactly as specified, adding and removing scopes as needed.

+

Choices:

+
    +
  • "ignore" ← (default)

  • +
  • "patch"

  • +
  • "idempotent"

  • +
+ +
+
+
+

client_template

+ +

aliases: clientTemplate

+

+ string +

+
+

Client template to use for this client. If it does not exist this field is silently dropped. This is clientTemplate in the Keycloak REST API.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+ +
+

consent_required

+ +

aliases: consentRequired

+

+ boolean +

+
+

If enabled, users have to consent to client access. This is consentRequired in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

default_client_scopes

+ +

aliases: defaultClientScopes

+

+ list + / elements=string +

+
+

List of default client scopes.

+

See client_scopes_behavior for how this behaves when updating an existing client.

+
+
+
+

default_roles

+ +

aliases: defaultRoles

+

+ list + / elements=string +

+
+

List of default roles for this client. If the client roles referenced do not exist yet, they are created. This is defaultRoles in the Keycloak REST API.

+
+
+

description

+ +

+ string +

+
+

Description of the client in Keycloak.

+
+
+
+

direct_access_grants_enabled

+ +

aliases: directAccessGrantsEnabled

+

+ boolean +

+
+

Are direct access grants enabled for this client or not (OpenID connect). This is directAccessGrantsEnabled in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

enabled

+ +

+ boolean +

+
+

Is this client enabled or not?

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

frontchannel_logout

+ +

aliases: frontchannelLogout

+

+ boolean +

+
+

Is frontchannel logout enabled for this client or not. This is frontchannelLogout in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

full_scope_allowed

+ +

aliases: fullScopeAllowed

+

+ boolean +

+
+

Is the "Full Scope Allowed" feature set for this client or not. This is fullScopeAllowed in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

id

+ +

+ string +

+
+

ID of client to be worked on. This is usually an UUID. Either this or client_id is required. If you specify both, this takes precedence.

+
+
+
+

implicit_flow_enabled

+ +

aliases: implicitFlowEnabled

+

+ boolean +

+
+

Enable implicit flow for this client or not (OpenID connect). This is implicitFlowEnabled in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

name

+ +

+ string +

+
+

Name of the client (this is not the same as client_id).

+
+
+
+

node_re_registration_timeout

+ +

aliases: nodeReRegistrationTimeout

+

+ integer +

+
+

Cluster node re-registration timeout for this client. This is nodeReRegistrationTimeout in the Keycloak REST API.

+
+
+
+

not_before

+ +

aliases: notBefore

+

+ integer +

+
+

Revoke any tokens issued before this date for this client (this is a UNIX timestamp). This is notBefore in the Keycloak REST API.

+
+
+
+

optional_client_scopes

+ +

aliases: optionalClientScopes

+

+ list + / elements=string +

+
+

List of optional client scopes.

+

See client_scopes_behavior for how this behaves when updating an existing client.

+
+
+

protocol

+ +

+ string +

+
+

Type of client.

+

At creation only, default value is openid-connect if protocol is omitted.

+

The docker-v2 value was added in middleware_automation.keycloak 8.6.0.

+

Choices:

+
    +
  • "openid-connect"

  • +
  • "saml"

  • +
  • "docker-v2"

  • +
+ +
+
+
+

protocol_mappers

+ +

aliases: protocolMappers

+

+ list + / elements=dictionary +

+
+

A list of dicts defining protocol mappers for this client. This is protocolMappers in the Keycloak REST API.

+
+
+
+

config

+ +

+ dictionary +

+
+

Dict specifying the configuration options for the protocol mapper; the contents differ depending on the value of protocol_mappers[].protocolMapper and are not documented other than by the source of the mappers and its parent class(es). An example is given below. It is easiest to obtain valid config values by dumping an already-existing protocol mapper configuration through check-mode in the existing field.

+
+
+
+

consentRequired

+ +

+ boolean +

+
+

Specifies whether a user needs to provide consent to a client for this mapper to be active.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

consentText

+ +

+ string +

+
+

The human-readable name of the consent the user is presented to accept.

+
+
+
+

id

+ +

+ string +

+
+

Usually a UUID specifying the internal ID of this protocol mapper instance.

+
+
+
+

name

+ +

+ string +

+
+

The name of this protocol mapper.

+
+
+
+

protocol

+ +

+ string +

+
+

This specifies for which protocol this protocol mapper is active.

+

Choices:

+
    +
  • "openid-connect"

  • +
  • "saml"

  • +
  • "docker-v2"

  • +
+ +
+
+
+

protocolMapper

+ +

+ string +

+
+

The Keycloak-internal name of the type of this protocol-mapper. While an exhaustive list is impossible to provide since this may be extended through SPIs by the user of Keycloak, by default Keycloak as of 3.4 ships with at least:

+

docker-v2-allow-all-mapper.

+

oidc-address-mapper.

+

oidc-full-name-mapper.

+

oidc-group-membership-mapper.

+

oidc-hardcoded-claim-mapper.

+

oidc-hardcoded-role-mapper.

+

oidc-role-name-mapper.

+

oidc-script-based-protocol-mapper.

+

oidc-sha256-pairwise-sub-mapper.

+

oidc-usermodel-attribute-mapper.

+

oidc-usermodel-client-role-mapper.

+

oidc-usermodel-property-mapper.

+

oidc-usermodel-realm-role-mapper.

+

oidc-usersessionmodel-note-mapper.

+

saml-group-membership-mapper.

+

saml-hardcode-attribute-mapper.

+

saml-hardcode-role-mapper.

+

saml-role-list-mapper.

+

saml-role-name-mapper.

+

saml-user-attribute-mapper.

+

saml-user-property-mapper.

+

saml-user-session-note-mapper.

+

An exhaustive list of available mappers on your installation can be obtained on the admin console by going to Server Info -> Providers and looking under 'protocol-mapper'.

+
+
+
+

public_client

+ +

aliases: publicClient

+

+ boolean +

+
+

Is the access type for this client public or not. This is publicClient in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

realm

+ +

+ string +

+
+

The realm to create the client in.

+

Default: "master"

+
+
+
+

redirect_uris

+ +

aliases: redirectUris

+

+ list + / elements=string +

+
+

Acceptable redirect URIs for this client. This is redirectUris in the Keycloak REST API.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+
+

registered_nodes

+ +

aliases: registeredNodes

+

+ dictionary +

+
+

Dict of registered cluster nodes (with nodename as the key and last registration time as the value). This is registeredNodes in the Keycloak REST API.

+
+
+
+

registration_access_token

+ +

aliases: registrationAccessToken

+

+ string +

+
+

The registration access token provides access for clients to the client registration service. This is registrationAccessToken in the Keycloak REST API.

+
+
+
+

root_url

+ +

aliases: rootUrl

+

+ string +

+
+

Root URL appended to relative URLs for this client. This is rootUrl in the Keycloak REST API.

+
+
+

secret

+ +

+ string +

+
+

When using client_authenticator_type=client-secret (the default), you can specify a secret here (otherwise one is generated if it does not exit). If changing this secret, the module does not register a change currently (but the changed secret is saved).

+
+
+
+

service_accounts_enabled

+ +

aliases: serviceAccountsEnabled

+

+ boolean +

+
+

Are service accounts enabled for this client or not (OpenID connect). This is serviceAccountsEnabled in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

standard_flow_enabled

+ +

aliases: standardFlowEnabled

+

+ boolean +

+
+

Enable standard flow for this client or not (OpenID connect). This is standardFlowEnabled in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

state

+ +

+ string +

+
+

State of the client.

+

On present, the client are created (or updated if it exists already).

+

On absent, the client are removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+
+

surrogate_auth_required

+ +

aliases: surrogateAuthRequired

+

+ boolean +

+
+

Whether or not surrogate auth is required. This is surrogateAuthRequired in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+
+

use_template_config

+ +

aliases: useTemplateConfig

+

+ boolean +

+
+

Whether or not to use configuration from the client_template. This is useTemplateConfig in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

use_template_mappers

+ +

aliases: useTemplateMappers

+

+ boolean +

+
+

Whether or not to use mapper configuration from the client_template. This is useTemplateMappers in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

use_template_scope

+ +

aliases: useTemplateScope

+

+ boolean +

+
+

Whether or not to use scope configuration from the client_template. This is useTemplateScope in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

valid_post_logout_redirect_uris

+ +

aliases: postLogoutRedirectUris

+

+ list + / elements=string +

+
+

Valid post logout redirect URIs for this client.

+

This is stored as post.logout.redirect.uris in the client attributes.

+

Use + as a single list element to allow all redirect URIs.

+
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+
+

web_origins

+ +

aliases: webOrigins

+

+ list + / elements=string +

+
+

List of allowed CORS origins. This is webOrigins in the Keycloak REST API.

+
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Create or update Keycloak client (minimal example), authentication with credentials + middleware_automation.keycloak.keycloak_client: + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + client_id: test + state: present + delegate_to: localhost + + + - name: Create or update Keycloak client (minimal example), authentication with token + middleware_automation.keycloak.keycloak_client: + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + token: TOKEN + client_id: test + state: present + delegate_to: localhost + + + - name: Delete a Keycloak client + middleware_automation.keycloak.keycloak_client: + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + client_id: test + state: absent + delegate_to: localhost + + + - name: Create or update a Keycloak client (minimal example), with x509 authentication + middleware_automation.keycloak.keycloak_client: + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + realm: master + state: present + client_id: test + client_authenticator_type: client-x509 + attributes: + x509.subjectdn: "CN=client" + x509.allow.regex.pattern.comparison: false + + + - name: Create or update a Keycloak client (with all the bells and whistles) + middleware_automation.keycloak.keycloak_client: + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + state: present + realm: master + client_id: test + id: d8b127a3-31f6-44c8-a7e4-4ab9a3e78d95 + name: this_is_a_test + description: Description of this wonderful client + root_url: https://www.example.com/ + admin_url: https://www.example.com/admin_url + base_url: basepath + enabled: true + client_authenticator_type: client-secret + secret: REALLYWELLKEPTSECRET + redirect_uris: + - https://www.example.com/* + - http://localhost:8888/ + web_origins: + - https://www.example.com/* + not_before: 1507825725 + bearer_only: false + consent_required: false + standard_flow_enabled: true + implicit_flow_enabled: false + direct_access_grants_enabled: false + service_accounts_enabled: false + authorization_services_enabled: false + public_client: false + frontchannel_logout: false + protocol: openid-connect + full_scope_allowed: false + node_re_registration_timeout: -1 + client_template: test + use_template_config: false + use_template_scope: false + use_template_mappers: false + always_display_in_console: true + registered_nodes: + node01.example.com: 1507828202 + registration_access_token: eyJWT_TOKEN + surrogate_auth_required: false + default_roles: + - test01 + - test02 + authentication_flow_binding_overrides: + browser: 4c90336b-bf1d-4b87-916d-3677ba4e5fbb + protocol_mappers: + - config: + access.token.claim: true + claim.name: "family_name" + id.token.claim: true + jsonType.label: String + user.attribute: lastName + userinfo.token.claim: true + consentRequired: true + consentText: "${familyName}" + name: family name + protocol: openid-connect + protocolMapper: oidc-usermodel-property-mapper + - config: + attribute.name: Role + attribute.nameformat: Basic + single: false + consentRequired: false + name: role list + protocol: saml + protocolMapper: saml-role-list-mapper + attributes: + saml.authnstatement: true + saml.client.signature: true + saml.force.post.binding: true + saml.server.signature: true + saml.signature.algorithm: RSA_SHA256 + saml.signing.certificate: CERTIFICATEHERE + saml.signing.private.key: PRIVATEKEYHERE + saml_force_name_id_format: false + saml_name_id_format: username + saml_signature_canonicalization_method: "http://www.w3.org/2001/10/xml-exc-c14n#" + user.info.response.signature.alg: RS256 + request.object.signature.alg: RS256 + use.jwks.url: true + jwks.url: JWKS_URL_FOR_CLIENT_AUTH_JWT + jwt.credential.certificate: JWT_CREDENTIAL_CERTIFICATE_FOR_CLIENT_AUTH + delegate_to: localhost + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of client after module execution (sample is truncated).

+

Returned: on success

+

Sample: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}

+
+
+

existing

+ +

+ dictionary +

+
+

Representation of existing client (sample is truncated).

+

Returned: always

+

Sample: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: "Client testclient has been updated"

+
+
+

proposed

+ +

+ dictionary +

+
+

Representation of proposed client.

+

Returned: always

+

Sample: {"clientId": "test"}

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Eike Frost (@eikef) +- Ivan Kokalović (@koke1997) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_client_rolemapping.rst.txt b/3.1.2/_sources/plugins/keycloak_client_rolemapping.rst.txt new file mode 100644 index 0000000..f753c8b --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_client_rolemapping.rst.txt @@ -0,0 +1,781 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_client_rolemapping_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_client_rolemapping -- Allows administration of Keycloak client\_rolemapping with the Keycloak API +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_client_rolemapping`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows you to add, remove or modify Keycloak client\_rolemapping with the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin\-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles. +- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ `https://www.keycloak.org/docs\-api/latest/rest\-api/index.html `__. +- Attributes are multi\-valued in the Keycloak API. All attributes are lists of individual values and are returned that way by this module. You may pass single values for attributes when calling the module, and this is translated into a list suitable for the API. +- When updating a client\_rolemapping, where possible provide the role ID to the module. This removes a lookup to the API to translate the name into the role ID. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

cid

+ +

+ string +

+
+

ID of the client to be mapped.

+

This parameter is not required for updating or deleting the rolemapping but providing it reduces the number of API calls required.

+
+
+

client_id

+ +

+ string +

+
+

Name of the client to be mapped (different than cid).

+

This parameter is required (can be replaced by cid for less API call).

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

gid

+ +

+ string +

+
+

ID of the group to be mapped.

+

This parameter is not required for updating or deleting the rolemapping but providing it reduces the number of API calls required.

+
+
+

group_name

+ +

+ string +

+
+

Name of the group to be mapped.

+

This parameter is required (can be replaced by gid for less API call).

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

parents

+ +

+ list + / elements=dictionary +

+
+

List of parent groups for the group to handle sorted top to bottom.

+

Set this if your group is a subgroup and you do not provide the GID in gid.

+
+
+

id

+ +

+ string +

+
+

Identify parent by ID.

+

Needs less API calls than using parents[].name.

+

A deep parent chain can be started at any point when first given parent is given as ID.

+

Note that in principle both ID and name can be specified at the same time but current implementation only always use just one of them, with ID being preferred.

+
+
+

name

+ +

+ string +

+
+

Identify parent by name.

+

Needs more internal API calls than using parents[].id to map names to ID's under the hood.

+

When giving a parent chain with only names it must be complete up to the top.

+

Note that in principle both ID and name can be specified at the same time but current implementation only always use just one of them, with ID being preferred.

+
+
+

realm

+ +

+ string +

+
+

They Keycloak realm under which this role_representation resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

roles

+ +

+ list + / elements=dictionary +

+
+

Roles to be mapped to the group.

+
+
+

id

+ +

+ string +

+
+

The unique identifier for this role_representation.

+

This parameter is not required for updating or deleting a role_representation but providing it reduces the number of API calls required.

+
+
+

name

+ +

+ string +

+
+

Name of the role_representation.

+

This parameter is required only when creating or updating the role_representation.

+
+
+

state

+ +

+ string +

+
+

State of the client_rolemapping.

+

On present, the client_rolemapping is created if it does not yet exist, or updated with the parameters you provide.

+

On absent, the client_rolemapping is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_client_rolemapping_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_client_rolemapping_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_client_rolemapping_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Map a client role to a group, authentication with credentials + middleware_automation.keycloak.keycloak_client_rolemapping: + realm: MyCustomRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + state: present + client_id: client1 + group_name: group1 + roles: + - name: role_name1 + id: role_id1 + - name: role_name2 + id: role_id2 + delegate_to: localhost + + - name: Map a client role to a group, authentication with token + middleware_automation.keycloak.keycloak_client_rolemapping: + realm: MyCustomRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + token: TOKEN + state: present + client_id: client1 + group_name: group1 + roles: + - name: role_name1 + id: role_id1 + - name: role_name2 + id: role_id2 + delegate_to: localhost + + - name: Map a client role to a subgroup, authentication with token + middleware_automation.keycloak.keycloak_client_rolemapping: + realm: MyCustomRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + token: TOKEN + state: present + client_id: client1 + group_name: subgroup1 + parents: + - name: parent-group + roles: + - name: role_name1 + id: role_id1 + - name: role_name2 + id: role_id2 + delegate_to: localhost + + - name: Unmap client role from a group + middleware_automation.keycloak.keycloak_client_rolemapping: + realm: MyCustomRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + state: absent + client_id: client1 + group_name: group1 + roles: + - name: role_name1 + id: role_id1 + - name: role_name2 + id: role_id2 + delegate_to: localhost + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of client role mapping after module execution.

+

The sample is truncated.

+

Returned: on success

+

Sample: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}

+
+
+

existing

+ +

+ dictionary +

+
+

Representation of existing client role mapping.

+

The sample is truncated.

+

Returned: always

+

Sample: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: "Role role1 assigned to group group1."

+
+
+

proposed

+ +

+ dictionary +

+
+

Representation of proposed client role mapping.

+

Returned: always

+

Sample: {"clientId": "test"}

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Gaëtan Daubresse (@Gaetan2907) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_client_rolescope.rst.txt b/3.1.2/_sources/plugins/keycloak_client_rolescope.rst.txt new file mode 100644 index 0000000..714e51b --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_client_rolescope.rst.txt @@ -0,0 +1,615 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_client_rolescope_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_client_rolescope -- Allows administration of Keycloak client roles scope to restrict the usage of certain roles to a other specific client applications +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_client_rolescope`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows you to add or remove Keycloak roles from clients scope using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin\-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles. +- Client :ansopt:`middleware\_automation.keycloak.keycloak\_client\_rolescope#module:target\_client\_id` must have :ansopt:`middleware\_automation.keycloak.keycloak\_client#module:full\_scope\_allowed` set to :ansval:`false`. +- Attributes are multi\-valued in the Keycloak API. All attributes are lists of individual values and are returned that way by this module. You may pass single values for attributes when calling the module, and this is translated into a list suitable for the API. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

realm

+ +

+ string +

+
+

The Keycloak realm under which clients resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

role_names

+ +

+ list + / elements=string + / required +

+
+

Names of roles to manipulate.

+

If role_owner_client_id is present, all roles must be under this client.

+

If role_owner_client_id is absent, all roles must be under the realm.

+
+
+

role_owner_client_id

+ +

+ string +

+
+

If the role_names are client role, the client ID under which it resides.

+

If this parameter is absent, the roles are considered a realm role.

+
+
+

state

+ +

+ string +

+
+

State of the role mapping.

+

On present, all roles in role_names are mapped if not exist yet.

+

On absent, all roles mapping in role_names are removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

target_client_id

+ +

+ string + / required +

+
+

Roles provided in role_names while be added to this client scope.

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_client_rolescope_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_client_rolescope_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_client_rolescope_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Add roles to public client scope + middleware_automation.keycloak.keycloak_client_rolescope: + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + realm: MyCustomRealm + target_client_id: frontend-client-public + role_owner_client_id: backend-client-private + role_names: + - backend-role-admin + - backend-role-user + + - name: Remove roles from public client scope + middleware_automation.keycloak.keycloak_client_rolescope: + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + realm: MyCustomRealm + target_client_id: frontend-client-public + role_owner_client_id: backend-client-private + role_names: + - backend-role-admin + state: absent + + - name: Add realm roles to public client scope + middleware_automation.keycloak.keycloak_client_rolescope: + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + realm: MyCustomRealm + target_client_id: frontend-client-public + role_names: + - realm-role-admin + - realm-role-user + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ list + / elements=dictionary +

+
+

Representation of role role scope after module execution.

+

Returned: on success

+

Sample: [{"clientRole": false, "composite": false, "containerId": "MyCustomRealm", "id": "47293104-59a6-46f0-b460-2e9e3c9c424c", "name": "backend-role-admin"}, {"clientRole": false, "composite": false, "containerId": "MyCustomRealm", "id": "39c62a6d-542c-4715-92d2-41021eb33967", "name": "backend-role-user"}]

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: "Client role scope for frontend-client-public has been updated"

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Andre Desrosiers (@desand01) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_client_scope.rst.txt b/3.1.2/_sources/plugins/keycloak_client_scope.rst.txt new file mode 100644 index 0000000..ba30d4c --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_client_scope.rst.txt @@ -0,0 +1,714 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_client_scope_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_client_scope -- Allows administration of Keycloak client scopes via Keycloak API ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_client_scope`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows you to add, remove or modify Keycloak client scopes via the Keycloak REST API. It requires access to the REST API via OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin\-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles. +- This module also supports managing protocol mappers within a client scope. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

attributes

+ +

+ dictionary +

+
+

A dict of key/value pairs to set as attributes for the client scope.

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

description

+ +

+ string +

+
+

Description of the client scope.

+

Default: ""

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

name

+ +

+ string + / required +

+
+

Name of the client scope.

+
+
+

protocol

+ +

+ string +

+
+

The protocol associated with the client scope.

+

Choices:

+
    +
  • "openid-connect" ← (default)

  • +
  • "saml"

  • +
+ +
+
+
+

protocol_mappers

+ +

aliases: protocolMappers

+

+ list + / elements=dictionary +

+
+

A list of protocol mappers to associate with the client scope.

+

Each mapper is a dict with the keys name, protocol, protocolMapper, and config.

+

Default: []

+
+
+
+

config

+ +

+ dictionary + / required +

+
+

Configuration for the protocol mapper.

+
+
+
+

name

+ +

+ string + / required +

+
+

Name of the protocol mapper.

+
+
+
+

protocol

+ +

+ string +

+
+

Protocol for the mapper.

+

Default: "openid-connect"

+
+
+
+
+
+

protocolMapper

+ +

aliases: protocol_mapper_type

+

+ string + / required +

+
+

The mapper type (e.g. oidc-usermodel-attribute-mapper, oidc-audience-mapper).

+
+
+

realm

+ +

+ string +

+
+

The Keycloak realm under which this client scope resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

State of the client scope.

+

On present, the client scope will be created if it does not yet exist, or updated with the parameters you provide.

+

On absent, the client scope will be removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_client_scope_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_client_scope_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_client_scope_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Create a client scope with protocol mappers + middleware_automation.keycloak.keycloak_client_scope: + auth_keycloak_url: http://localhost:8080 + auth_realm: master + auth_username: admin + auth_password: password + realm: TestRealm + name: my-client-scope + description: "A custom client scope" + protocol: openid-connect + protocol_mappers: + - name: email + protocol: openid-connect + protocolMapper: oidc-usermodel-attribute-mapper + config: + user.attribute: email + claim.name: email + jsonType.label: String + id.token.claim: "true" + access.token.claim: "true" + userinfo.token.claim: "true" + state: present + delegate_to: localhost + + - name: Create a client scope using token authentication + middleware_automation.keycloak.keycloak_client_scope: + auth_keycloak_url: http://localhost:8080 + token: MY_TOKEN + realm: TestRealm + name: my-scope + state: present + delegate_to: localhost + + - name: Delete a client scope + middleware_automation.keycloak.keycloak_client_scope: + auth_keycloak_url: http://localhost:8080 + auth_realm: master + auth_username: admin + auth_password: password + realm: TestRealm + name: my-client-scope + state: absent + delegate_to: localhost + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of the client scope after module execution.

+

Returned: on success

+

Sample: {"description": "A custom scope", "id": "uuid-here", "name": "my-scope", "protocol": "openid-connect"}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: "Client scope my-scope has been created"

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Paulo Menon (@paulomenon) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_client_scope_rolemappings.rst.txt b/3.1.2/_sources/plugins/keycloak_client_scope_rolemappings.rst.txt new file mode 100644 index 0000000..fd22ee6 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_client_scope_rolemappings.rst.txt @@ -0,0 +1,599 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_client_scope_rolemappings_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_client_scope_rolemappings -- Allows administration of Keycloak client scope scope mappings to restrict the usage of certain roles to specific client scopes +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_client_scope_rolemappings`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows you to add or remove Keycloak roles from client scopes using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, :literal:`admin\-cli` and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles. +- Attributes are multi\-valued in the Keycloak API. All attributes are lists of individual values and are returned that way by this module. You may pass single values for attributes when calling the module, and this is translated into a list suitable for the API. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

client_id

+ +

+ string +

+
+

If the role_names are client roles, the client ID under which it resides.

+

If this parameter is absent, the roles are considered realm roles.

+
+
+

client_scope_id

+ +

+ string + / required +

+
+

Roles provided in role_names will be added to this client scope.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

realm

+ +

+ string +

+
+

The Keycloak realm under which clients resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

role_names

+ +

+ list + / elements=string + / required +

+
+

Names of roles to add.

+

If client_id is present, all roles must be under this client.

+

If client_id is absent, all roles must be under the realm.

+
+
+

state

+ +

+ string +

+
+

State of the role mapping.

+

On present, all roles in role_names are mapped if not exist yet.

+

On absent, all roles mapping in role_names are removed if they exist.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_client_scope_rolemappings_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_client_scope_rolemappings_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_client_scope_rolemappings_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Add roles to client scope + middleware_automation.keycloak.keycloak_client_scope_rolemappings: + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + realm: MyCustomRealm + client_id: frontend-client-public + client_scope_id: frontend-client-scope + role_names: + - backend-role-admin + - backend-role-user + + - name: Remove roles from client scope + middleware_automation.keycloak.keycloak_client_scope_rolemappings: + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + realm: MyCustomRealm + client_id: frontend-client-public + client_scope_id: frontend-client-scope + role_names: + - backend-role-admin + state: absent + + - name: Add realm roles to client scope + middleware_automation.keycloak.keycloak_client_scope_rolemappings: + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + realm: MyCustomRealm + client_scope_id: frontend-client-scope + role_names: + - realm-role-admin + - realm-role-user + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ list + / elements=dictionary +

+
+

Representation of client scope scope mappings after module execution.

+

Returned: on success

+

Sample: [{"clientRole": false, "composite": false, "containerId": "77f9bd4e-13a6-451e-9c72-ee6997299c1f", "description": "User role", "id": "9e155ef7-86f5-4def-b507-581ce7b87013", "name": "realm-role-user"}, {"clientRole": false, "composite": false, "containerId": "77f9bd4e-13a6-451e-9c72-ee6997299c1f", "description": "Admin role", "id": "9e155ef7-86f5-4def-b507-581ce7b87013", "name": "realm-role-admin"}]

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Felix Grzelka (@felix-grzelka) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_client_scope_type.rst.txt b/3.1.2/_sources/plugins/keycloak_client_scope_type.rst.txt new file mode 100644 index 0000000..68d3f88 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_client_scope_type.rst.txt @@ -0,0 +1,605 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_client_scope_type_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_client_scope_type -- Set the type of a client scope in a realm or client using the Keycloak API +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_client_scope_type`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows you to set the type (optional, default) of client scopes using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin\-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+
+

client_id

+ +

aliases: clientId

+

+ string +

+
+

The client_id of the client. If not set the client scope types are set as a default for the realm.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

default_client_scopes

+ +

+ list + / elements=string +

+
+

Client scopes that should be of type default.

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

optional_client_scopes

+ +

+ list + / elements=string +

+
+

Client scopes that should be of type optional.

+
+
+

realm

+ +

+ string +

+
+

The Keycloak realm.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_client_scope_type_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_client_scope_type_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_client_scope_type_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Set default client scopes on realm level + middleware_automation.keycloak.keycloak_client_scope_type: + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + realm: "MyCustomRealm" + default_client_scopes: ['profile', 'roles'] + delegate_to: localhost + + + - name: Set default and optional client scopes on client level with token auth + middleware_automation.keycloak.keycloak_client_scope_type: + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + token: TOKEN + realm: "MyCustomRealm" + client_id: "MyCustomClient" + default_client_scopes: ['profile', 'roles'] + optional_client_scopes: ['phone'] + delegate_to: localhost + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of client scopes after module execution.

+

The sample is truncated.

+

Returned: on success

+

Sample: {"default_client_scopes": ["profile", "role"], "optional_client_scopes": []}

+
+
+

existing

+ +

+ dictionary +

+
+

Representation of client scopes before module execution.

+

Returned: always

+

Sample: {"default_client_scopes": ["profile", "role"], "optional_client_scopes": ["phone"]}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: ""

+
+
+

proposed

+ +

+ dictionary +

+
+

Representation of proposed client scope types mapping.

+

Returned: always

+

Sample: {"default_client_scopes": ["profile", "role"], "optional_client_scopes": []}

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Simon Pahl (@simonpahl) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_clientsecret_info.rst.txt b/3.1.2/_sources/plugins/keycloak_clientsecret_info.rst.txt new file mode 100644 index 0000000..27c57d4 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_clientsecret_info.rst.txt @@ -0,0 +1,615 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_clientsecret_info_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_clientsecret_info -- Retrieve client secret using Keycloak API ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_clientsecret_info`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows you to get a Keycloak client secret using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin\-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles. +- When retrieving a new client secret, where possible provide the client's :ansopt:`middleware\_automation.keycloak.keycloak\_clientsecret\_info#module:id` (not :ansopt:`middleware\_automation.keycloak.keycloak\_clientsecret\_info#module:client\_id`\ ) to the module. This removes a lookup to the API to translate the :ansopt:`middleware\_automation.keycloak.keycloak\_clientsecret\_info#module:client\_id` into the client ID. +- Note that this module returns the client secret. To avoid this showing up in the logs, please add :literal:`no\_log: true` to the task. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+
+

client_id

+ +

aliases: clientId

+

+ string +

+
+

The client_id of the client. Passing this instead of id results in an extra API call.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

id

+ +

+ string +

+
+

The unique identifier for this client.

+

This parameter is not required for getting or generating a client secret but providing it reduces the number of API calls required.

+
+
+

realm

+ +

+ string +

+
+

They Keycloak realm under which this client resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_clientsecret_info_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_clientsecret_info_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + This action does not modify state. + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_clientsecret_info_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ ` \ :ansible-attribute-support-na:`N/A` + + This action does not modify state. + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Get a Keycloak client secret, authentication with credentials + middleware_automation.keycloak.keycloak_clientsecret_info: + id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd' + realm: MyCustomRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + delegate_to: localhost + no_log: true + + - name: Get a new Keycloak client secret, authentication with token + middleware_automation.keycloak.keycloak_clientsecret_info: + id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd' + realm: MyCustomRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + token: TOKEN + delegate_to: localhost + no_log: true + + - name: Get a new Keycloak client secret, passing client_id instead of id + middleware_automation.keycloak.keycloak_clientsecret_info: + client_id: 'myClientId' + realm: MyCustomRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + token: TOKEN + delegate_to: localhost + no_log: true + + - name: Get a new Keycloak client secret, authentication with auth_client_id and auth_client_secret + middleware_automation.keycloak.keycloak_clientsecret_info: + id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd' + realm: MyCustomRealm + auth_client_id: admin-cli + auth_client_secret: SECRET + auth_keycloak_url: https://auth.example.com + delegate_to: localhost + no_log: true + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

clientsecret_info

+ +

+ complex +

+
+

Representation of the client secret.

+

Returned: on success

+
+
+

type

+ +

+ string +

+
+

Credential type.

+

Returned: always

+

Sample: "secret"

+
+
+

value

+ +

+ string +

+
+

Client secret.

+

Returned: always

+

Sample: "cUGnX1EIeTtPPAkcyGMv0ncyqDPu68P1"

+
+
+

msg

+ +

+ string +

+
+

Textual description of whether we succeeded or failed.

+

Returned: always

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Fynn Chen (@fynncfchen) +- John Cant (@johncant) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_clientsecret_regenerate.rst.txt b/3.1.2/_sources/plugins/keycloak_clientsecret_regenerate.rst.txt new file mode 100644 index 0000000..1e7017c --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_clientsecret_regenerate.rst.txt @@ -0,0 +1,611 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_clientsecret_regenerate_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_clientsecret_regenerate -- Regenerate Keycloak client secret using Keycloak API +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_clientsecret_regenerate`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows you to regenerate a Keycloak client secret using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin\-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles. +- When regenerating a client secret, where possible provide the client's ID (not client\_id) to the module. This removes a lookup to the API to translate the client\_id into the client ID. +- Note that this module returns the client secret. To avoid this showing up in the logs, please add :literal:`no\_log: true` to the task. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+
+

client_id

+ +

aliases: clientId

+

+ string +

+
+

The client_id of the client. Passing this instead of ID results in an extra API call.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

id

+ +

+ string +

+
+

The unique identifier for this client.

+

This parameter is not required for getting or generating a client secret but providing it reduces the number of API calls required.

+
+
+

realm

+ +

+ string +

+
+

They Keycloak realm under which this client resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_clientsecret_regenerate_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_clientsecret_regenerate_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_clientsecret_regenerate_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-none:`none` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Regenerate a Keycloak client secret, authentication with credentials + middleware_automation.keycloak.keycloak_clientsecret_regenerate: + id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd' + realm: MyCustomRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + delegate_to: localhost + no_log: true + + - name: Regenerate a Keycloak client secret, authentication with token + middleware_automation.keycloak.keycloak_clientsecret_regenerate: + id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd' + realm: MyCustomRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + token: TOKEN + delegate_to: localhost + no_log: true + + - name: Regenerate a Keycloak client secret, passing client_id instead of id + middleware_automation.keycloak.keycloak_clientsecret_info: + client_id: 'myClientId' + realm: MyCustomRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + token: TOKEN + delegate_to: localhost + no_log: true + + - name: Regenerate a new Keycloak client secret, authentication with auth_client_id and auth_client_secret + middleware_automation.keycloak.keycloak_clientsecret_regenerate: + id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd' + realm: MyCustomRealm + auth_client_id: admin-cli + auth_client_secret: SECRET + auth_keycloak_url: https://auth.example.com + delegate_to: localhost + no_log: true + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ complex +

+
+

Representation of the client credential after module execution.

+

Returned: on success

+
+
+

type

+ +

+ string +

+
+

Credential type.

+

Returned: always

+

Sample: "secret"

+
+
+

value

+ +

+ string +

+
+

Client secret.

+

Returned: always

+

Sample: "cUGnX1EIeTtPPAkcyGMv0ncyqDPu68P1"

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Fynn Chen (@fynncfchen) +- John Cant (@johncant) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_clienttemplate.rst.txt b/3.1.2/_sources/plugins/keycloak_clienttemplate.rst.txt new file mode 100644 index 0000000..46b92a4 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_clienttemplate.rst.txt @@ -0,0 +1,859 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_clienttemplate_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_clienttemplate -- Allows administration of Keycloak client templates using Keycloak API +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_clienttemplate`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows the administration of Keycloak client templates using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin\-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles. +- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ `https://www.keycloak.org/docs\-api/latest/rest\-api/index.html `__. +- The Keycloak API does not always enforce for only sensible settings to be used \-\- you can set SAML\-specific settings on an OpenID Connect client for instance and the other way around. Be careful. If you do not specify a setting, usually a sensible default is chosen. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

attributes

+ +

+ dictionary +

+
+

A dict of further attributes for this client template. This can contain various configuration settings, though in the default installation of Keycloak as of 3.4, none are documented or known, so this is usually empty.

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

description

+ +

+ string +

+
+

Description of the client template in Keycloak.

+
+
+

full_scope_allowed

+ +

+ boolean +

+
+

Is the "Full Scope Allowed" feature set for this client template or not. This is fullScopeAllowed in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

id

+ +

+ string +

+
+

ID of client template to be worked on. This is usually a UUID.

+
+
+

name

+ +

+ string +

+
+

Name of the client template.

+
+
+

protocol

+ +

+ string +

+
+

Type of client template.

+

The docker-v2 value was added in middleware_automation.keycloak 8.6.0.

+

Choices:

+
    +
  • "openid-connect"

  • +
  • "saml"

  • +
  • "docker-v2"

  • +
+ +
+
+

protocol_mappers

+ +

+ list + / elements=dictionary +

+
+

A list of dicts defining protocol mappers for this client template. This is protocolMappers in the Keycloak REST API.

+
+
+

config

+ +

+ dictionary +

+
+

Dict specifying the configuration options for the protocol mapper; the contents differ depending on the value of protocol_mappers[].protocolMapper and are not documented other than by the source of the mappers and its parent class(es). An example is given below. It is easiest to obtain valid config values by dumping an already-existing protocol mapper configuration through check-mode in the existing field.

+
+
+

consentRequired

+ +

+ boolean +

+
+

Specifies whether a user needs to provide consent to a client for this mapper to be active.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

consentText

+ +

+ string +

+
+

The human-readable name of the consent the user is presented to accept.

+
+
+

id

+ +

+ string +

+
+

Usually a UUID specifying the internal ID of this protocol mapper instance.

+
+
+

name

+ +

+ string +

+
+

The name of this protocol mapper.

+
+
+

protocol

+ +

+ string +

+
+

This specifies for which protocol this protocol mapper is active.

+

Choices:

+
    +
  • "openid-connect"

  • +
  • "saml"

  • +
  • "docker-v2"

  • +
+ +
+
+

protocolMapper

+ +

+ string +

+
+

The Keycloak-internal name of the type of this protocol-mapper. While an exhaustive list is impossible to provide since this may be extended through SPIs by the user of Keycloak, by default Keycloak as of 3.4 ships with at least:

+

docker-v2-allow-all-mapper.

+

oidc-address-mapper.

+

oidc-full-name-mapper.

+

oidc-group-membership-mapper.

+

oidc-hardcoded-claim-mapper.

+

oidc-hardcoded-role-mapper.

+

oidc-role-name-mapper.

+

oidc-script-based-protocol-mapper.

+

oidc-sha256-pairwise-sub-mapper.

+

oidc-usermodel-attribute-mapper.

+

oidc-usermodel-client-role-mapper.

+

oidc-usermodel-property-mapper.

+

oidc-usermodel-realm-role-mapper.

+

oidc-usersessionmodel-note-mapper.

+

saml-group-membership-mapper.

+

saml-hardcode-attribute-mapper.

+

saml-hardcode-role-mapper.

+

saml-role-list-mapper.

+

saml-role-name-mapper.

+

saml-user-attribute-mapper.

+

saml-user-property-mapper.

+

saml-user-session-note-mapper.

+

An exhaustive list of available mappers on your installation can be obtained on the admin console by going to Server Info -> Providers and looking under 'protocol-mapper'.

+
+
+

realm

+ +

+ string +

+
+

Realm this client template is found in.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

State of the client template.

+

On present, the client template is created (or updated if it exists already).

+

On absent, the client template is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_clienttemplate_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_clienttemplate_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_clienttemplate_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + +Notes +----- + +.. note:: + - The Keycloak REST API defines further fields (namely :literal:`bearerOnly`\ , :literal:`consentRequired`\ , :literal:`standardFlowEnabled`\ , :literal:`implicitFlowEnabled`\ , :literal:`directAccessGrantsEnabled`\ , :literal:`serviceAccountsEnabled`\ , :literal:`publicClient`\ , and :literal:`frontchannelLogout`\ ) which, while available with keycloak\_client, do not have any effect on Keycloak client\-templates and are discarded if supplied with an API request changing client\-templates. As such, they are not available through this module. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Create or update Keycloak client template (minimal), authentication with credentials + middleware_automation.keycloak.keycloak_client: + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + realm: master + name: this_is_a_test + delegate_to: localhost + + - name: Create or update Keycloak client template (minimal), authentication with token + middleware_automation.keycloak.keycloak_clienttemplate: + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + token: TOKEN + realm: master + name: this_is_a_test + delegate_to: localhost + + - name: Delete Keycloak client template + middleware_automation.keycloak.keycloak_client: + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + realm: master + state: absent + name: test01 + delegate_to: localhost + + - name: Create or update Keycloak client template (with a protocol mapper) + middleware_automation.keycloak.keycloak_client: + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + realm: master + name: this_is_a_test + protocol_mappers: + - config: + access.token.claim: true + claim.name: "family_name" + id.token.claim: true + jsonType.label: String + user.attribute: lastName + userinfo.token.claim: true + consentRequired: true + consentText: "${familyName}" + name: family name + protocol: openid-connect + protocolMapper: oidc-usermodel-property-mapper + full_scope_allowed: false + id: bce6f5e9-d7d3-4955-817e-c5b7f8d65b3f + delegate_to: localhost + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of client template after module execution (sample is truncated).

+

Returned: on success

+

Sample: {"description": "test01", "fullScopeAllowed": false, "id": "9c3712ab-decd-481e-954f-76da7b006e5f", "name": "test01", "protocol": "saml"}

+
+
+

existing

+ +

+ dictionary +

+
+

Representation of existing client template (sample is truncated).

+

Returned: always

+

Sample: {"description": "test01", "fullScopeAllowed": false, "id": "9c3712ab-decd-481e-954f-76da7b006e5f", "name": "test01", "protocol": "saml"}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: "Client template testclient has been updated"

+
+
+

proposed

+ +

+ dictionary +

+
+

Representation of proposed client template.

+

Returned: always

+

Sample: {"name": "test01"}

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Eike Frost (@eikef) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_component.rst.txt b/3.1.2/_sources/plugins/keycloak_component.rst.txt new file mode 100644 index 0000000..4097d46 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_component.rst.txt @@ -0,0 +1,676 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_component_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_component -- Allows administration of Keycloak components using Keycloak API ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_component`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows the administration of Keycloak components using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the realm being used must have the requisite access rights. In a default Keycloak installation, :literal:`admin\-cli` and an :literal:`admin` user would work, as would a separate realm definition with the scope tailored to your needs and a user having the expected roles. +- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ `https://www.keycloak.org/docs\-api/latest/rest\-api/index.html `__. Aliases are provided so camelCased versions can be used as well. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

config

+ +

+ dictionary +

+
+

Configuration properties for the provider.

+

Contents vary depending on the provider type.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

name

+ +

+ string + / required +

+
+

Name of the component to create.

+
+
+

parent_id

+ +

+ string + / required +

+
+

The parent_id of the component. In practice the ID (name) of the realm.

+
+
+

provider_id

+ +

+ string + / required +

+
+

The name of the "provider ID" for the key.

+
+
+

provider_type

+ +

+ string + / required +

+
+

The name of the "provider type" for the key. That is, org.keycloak.storage.UserStorageProvider, org.keycloak.userprofile.UserProfileProvider, ...

+

See https://www.keycloak.org/docs/latest/server_development/index.html#_providers.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

State of the Keycloak component.

+

On present, the component is created (or updated if it exists already).

+

On absent, the component is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_component_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_component_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_component_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Manage Keycloak User Storage Provider + middleware_automation.keycloak.keycloak_component: + auth_keycloak_url: http://localhost:8080 + auth_username: keycloak + auth_password: keycloak + auth_realm: master + name: my storage provider + state: present + parent_id: some_realm + provider_id: my storage + provider_type: "org.keycloak.storage.UserStorageProvider" + config: + myCustomKey: "my_custom_key" + cachePolicy: "NO_CACHE" + enabled: true + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of the keycloak_component after module execution.

+

Returned: on success

+
+
+

config

+ +

+ dictionary +

+
+

Component configuration.

+

Returned: success

+
+
+

id

+ +

+ string +

+
+

ID of the component.

+

Returned: when state=present

+

Sample: "5b7ec13f-99da-46ad-8326-ab4c73cf4ce4"

+
+
+

name

+ +

+ string +

+
+

Name of the component.

+

Returned: when state=present

+

Sample: "mykey"

+
+
+

parentId

+ +

+ string +

+
+

ID of the realm this key belongs to.

+

Returned: when state=present

+

Sample: "myrealm"

+
+
+

providerId

+ +

+ string +

+
+

The ID of the key provider.

+

Returned: when state=present

+

Sample: "rsa"

+
+
+

providerType

+ +

+ string +

+
+

The type of provider.

+

Returned: when state=present

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Björn Bösel (@fivetide) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_component_info.rst.txt b/3.1.2/_sources/plugins/keycloak_component_info.rst.txt new file mode 100644 index 0000000..aa95b59 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_component_info.rst.txt @@ -0,0 +1,575 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_component_info_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_component_info -- Retrieve component info in Keycloak +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_component_info`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module retrieve information on component from Keycloak. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

name

+ +

+ string +

+
+

Name of the Component.

+
+
+

parent_id

+ +

+ string +

+
+

Container ID of the components.

+
+
+

provider_type

+ +

+ string +

+
+

Provider type of components.

+

Examples: org.keycloak.storage.UserStorageProvider, org.keycloak.services.clientregistration.policy.ClientRegistrationPolicy, org.keycloak.keys.KeyProvider, org.keycloak.userprofile.UserProfileProvider, org.keycloak.storage.ldap.mappers.LDAPStorageMapper.

+
+
+

realm

+ +

+ string + / required +

+
+

The name of the realm.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_component_info_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_component_info_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + This action does not modify state. + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_component_info_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ ` \ :ansible-attribute-support-na:`N/A` + + This action does not modify state. + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Retrive info of a UserStorageProvider named myldap + middleware_automation.keycloak.keycloak_component_info: + auth_keycloak_url: http://localhost:8080 + auth_username: admin + auth_password: password + auth_realm: master + realm: myrealm + name: myldap + provider_type: org.keycloak.storage.UserStorageProvider + + - name: Retrive key info component + middleware_automation.keycloak.keycloak_component_info: + auth_keycloak_url: http://localhost:8080 + auth_username: admin + auth_password: password + auth_realm: master + realm: myrealm + name: rsa-enc-generated + provider_type: org.keycloak.keys.KeyProvider + + - name: Retrive all component from realm master + middleware_automation.keycloak.keycloak_component_info: + auth_keycloak_url: http://localhost:8080 + auth_username: admin + auth_password: password + auth_realm: master + realm: myrealm + + - name: Retrive all sub components of parent component filter by type + middleware_automation.keycloak.keycloak_component_info: + auth_keycloak_url: http://localhost:8080 + auth_username: admin + auth_password: password + auth_realm: master + realm: myrealm + parent_id: "075ef2fa-19fc-4a6d-bf4c-249f57365fd2" + provider_type: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper" + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + +

Key

Description

+
+

components

+ +

+ list + / elements=dictionary +

+
+

JSON representation of components.

+

Returned: always

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Andre Desrosiers (@desand01) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_group.rst.txt b/3.1.2/_sources/plugins/keycloak_group.rst.txt new file mode 100644 index 0000000..46c9778 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_group.rst.txt @@ -0,0 +1,912 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_group_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_group -- Allows administration of Keycloak groups using Keycloak API ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_group`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows you to add, remove or modify Keycloak groups using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin\-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles. +- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ `https://www.keycloak.org/docs\-api/20.0.2/rest\-api/index.html `__. +- Attributes are multi\-valued in the Keycloak API. All attributes are lists of individual values and are returned that way by this module. You may pass single values for attributes when calling the module, and this is translated into a list suitable for the API. +- When updating a group, where possible provide the group ID to the module. This removes a lookup to the API to translate the name into the group ID. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

attributes

+ +

+ dictionary +

+
+

A dict of key/value pairs to set as custom attributes for the group.

+

Values may be single values (for example a string) or a list of strings.

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

description

+ +

+ string +

+
+

Description of the group.

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

id

+ +

+ string +

+
+

The unique identifier for this group.

+

This parameter is not required for updating or deleting a group but providing it reduces the number of API calls required.

+
+
+

name

+ +

+ string +

+
+

Name of the group.

+

This parameter is required only when creating or updating the group.

+
+
+

parents

+ +

+ list + / elements=dictionary +

+
+

List of parent groups for the group to handle sorted top to bottom.

+

Set this to create a group as a subgroup of another group or groups (parents) or when accessing an existing subgroup by name.

+

Not necessary to set when accessing an existing subgroup by its ID because in that case the group can be directly queried without necessarily knowing its parent(s).

+
+
+

id

+ +

+ string +

+
+

Identify parent by ID.

+

Needs less API calls than using parents[].name.

+

A deep parent chain can be started at any point when first given parent is given as ID.

+

Note that in principle both ID and name can be specified at the same time but current implementation only always use just one of them, with ID being preferred.

+
+
+

name

+ +

+ string +

+
+

Identify parent by name.

+

Needs more internal API calls than using parents[].id to map names to ID's under the hood.

+

When giving a parent chain with only names it must be complete up to the top.

+

Note that in principle both ID and name can be specified at the same time but current implementation only always use just one of them, with ID being preferred.

+
+
+

realm

+ +

+ string +

+
+

They Keycloak realm under which this group resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

State of the group.

+

On present, the group is created if it does not yet exist, or updated with the parameters you provide.

+

On absent, the group is removed if it exists. Be aware that absenting a group with subgroups automatically deletes all its subgroups too.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_group_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_group_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_group_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + +Notes +----- + +.. note:: + - Presently, the :ansretval:`middleware\_automation.keycloak.keycloak\_group#module:end\_state.realmRoles`\ , :ansretval:`middleware\_automation.keycloak.keycloak\_group#module:end\_state.clientRoles`\ , and :ansretval:`middleware\_automation.keycloak.keycloak\_group#module:end\_state.access` attributes returned by the Keycloak API are read\-only for groups. This limitation will be removed in a later version of this module. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Create a Keycloak group, authentication with credentials + middleware_automation.keycloak.keycloak_group: + name: my-new-kc-group + realm: MyCustomRealm + state: present + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + register: result_new_kcgrp + delegate_to: localhost + + - name: Create a Keycloak group, authentication with token + middleware_automation.keycloak.keycloak_group: + name: my-new-kc-group + realm: MyCustomRealm + state: present + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + token: TOKEN + delegate_to: localhost + + - name: Delete a keycloak group + middleware_automation.keycloak.keycloak_group: + id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd' + state: absent + realm: MyCustomRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + delegate_to: localhost + + - name: Delete a Keycloak group based on name + middleware_automation.keycloak.keycloak_group: + name: my-group-for-deletion + state: absent + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + delegate_to: localhost + + - name: Update the name of a Keycloak group + middleware_automation.keycloak.keycloak_group: + id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd' + name: an-updated-kc-group-name + state: present + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + delegate_to: localhost + + - name: Create a keycloak group with some custom attributes + middleware_automation.keycloak.keycloak_group: + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + name: my-new_group + attributes: + attrib1: value1 + attrib2: value2 + attrib3: + - with + - numerous + - individual + - list + - items + delegate_to: localhost + + - name: Create a Keycloak subgroup of a base group (using parent name) + middleware_automation.keycloak.keycloak_group: + name: my-new-kc-group-sub + realm: MyCustomRealm + state: present + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + parents: + - name: my-new-kc-group + register: result_new_kcgrp_sub + delegate_to: localhost + + - name: Create a Keycloak subgroup of a base group (using parent id) + middleware_automation.keycloak.keycloak_group: + name: my-new-kc-group-sub2 + realm: MyCustomRealm + state: present + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + parents: + - id: "{{ result_new_kcgrp.end_state.id }}" + delegate_to: localhost + + - name: Create a Keycloak subgroup of a subgroup (using parent names) + middleware_automation.keycloak.keycloak_group: + name: my-new-kc-group-sub-sub + realm: MyCustomRealm + state: present + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + parents: + - name: my-new-kc-group + - name: my-new-kc-group-sub + delegate_to: localhost + + - name: Create a Keycloak subgroup of a subgroup (using direct parent id) + middleware_automation.keycloak.keycloak_group: + name: my-new-kc-group-sub-sub + realm: MyCustomRealm + state: present + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + parents: + - id: "{{ result_new_kcgrp_sub.end_state.id }}" + delegate_to: localhost + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ complex +

+
+

Representation of the group after module execution (sample is truncated).

+

Returned: on success

+
+
+

access

+ +

+ dictionary +

+
+

A dict describing the accesses you have to this group based on the credentials used.

+

Returned: always

+

Sample: {"manage": true, "manageMembership": true, "view": true}

+
+
+

attributes

+ +

+ dictionary +

+
+

Attributes applied to this group.

+

Returned: always

+

Sample: {"attr1": ["val1", "val2", "val3"]}

+
+
+

clientRoles

+ +

+ list + / elements=string +

+
+

A list of client-level roles granted to this group.

+

Returned: always

+

Sample: []

+
+
+

description

+ +

+ string +

+
+

A description of the group as string.

+

Returned: when present

+

Sample: "An example group description"

+
+
+

id

+ +

+ string +

+
+

GUID that identifies the group.

+

Returned: always

+

Sample: "23f38145-3195-462c-97e7-97041ccea73e"

+
+
+

name

+ +

+ string +

+
+

Name of the group.

+

Returned: always

+

Sample: "grp-test-123"

+
+
+

path

+ +

+ string +

+
+

URI path to the group.

+

Returned: always

+

Sample: "/grp-test-123"

+
+
+

realmRoles

+ +

+ list + / elements=string +

+
+

An array of the realm-level roles granted to this group.

+

Returned: always

+

Sample: []

+
+
+

subGroups

+ +

+ list + / elements=string +

+
+

A list of groups that are children of this group. These groups have the same parameters as documented here.

+

Returned: always

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Adam Goossens (@adamgoossens) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_identity_provider.rst.txt b/3.1.2/_sources/plugins/keycloak_identity_provider.rst.txt new file mode 100644 index 0000000..489fce1 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_identity_provider.rst.txt @@ -0,0 +1,1312 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_identity_provider_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_identity_provider -- Allows administration of Keycloak identity providers using Keycloak API ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_identity_provider`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows you to add, remove or modify Keycloak identity providers using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin\-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles. +- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ `https://www.keycloak.org/docs\-api/15.0/rest\-api/index.html `__. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+
+

add_read_token_role_on_create

+ +

aliases: addReadTokenRoleOnCreate

+

+ boolean +

+
+

Enable/disable whether new users can read any stored tokens. This assigns the broker.read-token role.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

alias

+ +

+ string + / required +

+
+

The alias uniquely identifies an identity provider and it is also used to build the redirect URI.

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+
+

authenticate_by_default

+ +

aliases: authenticateByDefault

+

+ boolean +

+
+

Specifies if this identity provider should be used by default for authentication even before displaying login screen.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

config

+ +

+ dictionary +

+
+

Dict specifying the configuration options for the provider; the contents differ depending on the value of provider_id. Examples are given below for oidc and saml. It is easiest to obtain valid config values by dumping an already-existing identity provider configuration through check-mode in the existing field.

+
+
+

authorizationUrl

+ +

+ string +

+
+

The Authorization URL.

+
+
+

backchannelSupported

+ +

+ string +

+
+

Does the external IDP support backchannel logout?

+
+
+

clientAuthMethod

+ +

+ string +

+
+

The client authentication method.

+
+
+

clientId

+ +

+ string +

+
+

The client or client identifier registered within the identity provider.

+
+
+

clientSecret

+ +

+ string +

+
+

The client or client secret registered within the identity provider.

+
+
+

defaultScope

+ +

+ string +

+
+

The scopes to be sent when asking for authorization.

+
+
+

doNotStoreUsers

+ +

+ boolean +

+
+

If true, users authenticating through this identity provider will not be stored in the Keycloak database.

+

This requires the transient-users feature to be enabled on the Keycloak server (available since Keycloak 23).

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

entityId

+ +

+ string +

+
+

The Entity ID that is used to uniquely identify this SAML Service Provider.

+
+
+

fromUrl

+ +

+ string +

+
+

IDP well-known OpenID Connect configuration URL.

+

Support only provider_id=oidc.

+

config.fromUrl is mutually exclusive with config.userInfoUrl, config.authorizationUrl, config.tokenUrl, config.logoutUrl, config.issuer and config.jwksUrl.

+
+
+
+

gui_order

+ +

aliases: guiOrder

+

+ integer +

+
+

Number defining order of the provider in GUI (for example, on Login page).

+
+
+

issuer

+ +

+ string +

+
+

The issuer identifier for the issuer of the response. If not provided, no validation is performed.

+
+
+

jwksUrl

+ +

+ string +

+
+

URL where identity provider keys in JWK format are stored. See JWK specification for more details.

+
+
+

logoutUrl

+ +

+ string +

+
+

End session endpoint to use to logout user from external IDP.

+
+
+

nameIDPolicyFormat

+ +

+ string +

+
+

Specifies the URI reference corresponding to a name identifier format.

+
+
+

principalType

+ +

+ string +

+
+

Way to identify and track external users from the assertion.

+
+
+

singleLogoutServiceUrl

+ +

+ string +

+
+

The URL that must be used to send logout requests.

+
+
+

singleSignOnServiceUrl

+ +

+ string +

+
+

The URL that must be used to send authentication requests (SAML AuthnRequest).

+
+
+
+

sync_mode

+ +

aliases: syncMode

+

+ string +

+
+

Default sync mode for all mappers. The sync mode determines when user data is synced using the mappers.

+
+
+

tokenUrl

+ +

+ string +

+
+

The Token URL.

+
+
+

useJwksUrl

+ +

+ boolean +

+
+

If true, identity provider public keys are downloaded from given JWKS URL.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

userInfoUrl

+ +

+ string +

+
+

The User Info URL.

+
+
+

validateSignature

+ +

+ boolean +

+
+

Enable/disable signature validation of external IDP signatures.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+
+

display_name

+ +

aliases: displayName

+

+ string +

+
+

Friendly name for identity provider.

+
+
+

enabled

+ +

+ boolean +

+
+

Enable/disable this identity provider.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

first_broker_login_flow_alias

+ +

aliases: firstBrokerLoginFlowAlias

+

+ string +

+
+

Alias of authentication flow, which is triggered after first login with this identity provider.

+
+
+
+
+

hide_on_login

+ +

aliases: hideOnLogin, hide_on_login_page

+

+ boolean +

+
+

If hidden, login with this provider is possible only if requested explicitly, for example using the kc_idp_hint parameter.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+ +
+

link_only

+ +

aliases: linkOnly

+

+ boolean +

+
+

If true, users cannot log in through this provider. They can only link to this provider. This is useful if you do not want to allow login from the provider, but want to integrate with a provider.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

mappers

+ +

+ list + / elements=dictionary +

+
+

A list of dicts defining mappers associated with this Identity Provider.

+
+
+

config

+ +

+ dictionary +

+
+

Dict specifying the configuration options for the mapper; the contents differ depending on the value of mappers[].identityProviderMapper.

+
+
+

id

+ +

+ string +

+
+

Unique ID of this mapper.

+
+
+

identityProviderAlias

+ +

+ string +

+
+

Alias of the identity provider for this mapper.

+
+
+

identityProviderMapper

+ +

+ string +

+
+

Type of mapper.

+
+
+

name

+ +

+ string +

+
+

Name of the mapper.

+
+
+
+

post_broker_login_flow_alias

+ +

aliases: postBrokerLoginFlowAlias

+

+ string +

+
+

Alias of authentication flow, which is triggered after each login with this identity provider.

+
+
+
+

provider_id

+ +

aliases: providerId

+

+ string +

+
+

Protocol used by this provider (supported values are oidc or saml).

+
+
+

realm

+ +

+ string +

+
+

The Keycloak realm under which this identity provider resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

State of the identity provider.

+

On present, the identity provider is created if it does not yet exist, or updated with the parameters you provide.

+

On absent, the identity provider is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+
+

store_token

+ +

aliases: storeToken

+

+ boolean +

+
+

Enable/disable whether tokens must be stored after authenticating users.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+
+

trust_email

+ +

aliases: trustEmail

+

+ boolean +

+
+

If enabled, email provided by this provider is not verified even if verification is enabled for the realm.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_identity_provider_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_identity_provider_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_identity_provider_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Create OIDC identity provider, authentication with credentials + middleware_automation.keycloak.keycloak_identity_provider: + state: present + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: admin + auth_password: admin + realm: myrealm + alias: oidc-idp + display_name: OpenID Connect IdP + enabled: true + provider_id: oidc + config: + issuer: https://idp.example.com + authorizationUrl: https://idp.example.com + tokenUrl: https://idp.example.com/token + userInfoUrl: https://idp.example.com/userinfo + clientAuthMethod: client_secret_post + clientId: my-client + clientSecret: secret + syncMode: FORCE + mappers: + - name: first_name + identityProviderMapper: oidc-user-attribute-idp-mapper + config: + claim: first_name + user.attribute: first_name + syncMode: INHERIT + - name: last_name + identityProviderMapper: oidc-user-attribute-idp-mapper + config: + claim: last_name + user.attribute: last_name + syncMode: INHERIT + + - name: Create OIDC identity provider, with well-known configuration URL + middleware_automation.keycloak.keycloak_identity_provider: + state: present + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: admin + auth_password: admin + realm: myrealm + alias: oidc-idp + display_name: OpenID Connect IdP + enabled: true + provider_id: oidc + config: + fromUrl: https://the-idp.example.com/realms/idprealm/.well-known/openid-configuration + clientAuthMethod: client_secret_post + clientId: my-client + clientSecret: secret + + - name: Create SAML identity provider, authentication with credentials + middleware_automation.keycloak.keycloak_identity_provider: + state: present + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: admin + auth_password: admin + realm: myrealm + alias: saml-idp + display_name: SAML IdP + enabled: true + provider_id: saml + config: + entityId: https://auth.example.com/realms/myrealm + singleSignOnServiceUrl: https://idp.example.com/login + wantAuthnRequestsSigned: true + wantAssertionsSigned: true + mappers: + - name: roles + identityProviderMapper: saml-user-attribute-idp-mapper + config: + user.attribute: roles + attribute.friendly.name: User Roles + attribute.name: roles + syncMode: INHERIT + + - name: Create OIDC identity provider with transient users (do not store users in database) + middleware_automation.keycloak.keycloak_identity_provider: + state: present + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: admin + auth_password: admin + realm: myrealm + alias: oidc-idp + display_name: OpenID Connect IdP + enabled: true + provider_id: oidc + config: + fromUrl: https://the-idp.example.com/realms/idprealm/.well-known/openid-configuration + clientAuthMethod: client_secret_post + clientId: my-client + clientSecret: secret + doNotStoreUsers: true + + - name: Create OIDC identity provider, authentication with credentials and advanced claim to group + middleware_automation.keycloak.keycloak_identity_provider: + state: present + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: admin + auth_password: admin + realm: myrealm + alias: oidc-idp + display_name: OpenID Connect IdP + enabled: true + provider_id: oidc + config: + issuer: https://idp.example.com + authorizationUrl: https://idp.example.com + tokenUrl: https://idp.example.com/token + userInfoUrl: https://idp.example.com/userinfo + clientAuthMethod: client_secret_post + clientId: my-client + clientSecret: secret + syncMode: FORCE + mappers: + - name: group_name + identityProviderMapper: oidc-advanced-group-idp-mapper + config: + claims: '[{"key":"my_key","value":"my_value"}]' + group: group_name + syncMode: INHERIT + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of identity provider after module execution.

+

Returned: on success

+

Sample: {"addReadTokenRoleOnCreate": false, "alias": "my-idp", "authenticateByDefault": false, "config": {"authorizationUrl": "https://idp.example.com", "clientAuthMethod": "client_secret_post", "clientId": "my-client", "clientSecret": "**********", "issuer": "https://idp.example.com", "tokenUrl": "https://idp.example.com/token", "userInfoUrl": "https://idp.example.com/userinfo"}, "displayName": "OpenID Connect IdP", "enabled": true, "firstBrokerLoginFlowAlias": "first broker login", "internalId": "4d28d7e3-1b80-45bb-8a30-5822bf55aa1c", "linkOnly": false, "providerId": "oidc", "storeToken": false, "trustEmail": false}

+
+
+

existing

+ +

+ dictionary +

+
+

Representation of existing identity provider.

+

Returned: always

+

Sample: {"addReadTokenRoleOnCreate": false, "alias": "my-idp", "authenticateByDefault": false, "config": {"authorizationUrl": "https://old.example.com", "clientAuthMethod": "client_secret_post", "clientId": "my-client", "clientSecret": "**********", "issuer": "https://old.example.com", "syncMode": "FORCE", "tokenUrl": "https://old.example.com/token", "userInfoUrl": "https://old.example.com/userinfo"}, "displayName": "OpenID Connect IdP", "enabled": true, "firstBrokerLoginFlowAlias": "first broker login", "internalId": "4d28d7e3-1b80-45bb-8a30-5822bf55aa1c", "linkOnly": false, "providerId": "oidc", "storeToken": false, "trustEmail": false}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: "Identity provider my-idp has been created"

+
+
+

proposed

+ +

+ dictionary +

+
+

Representation of proposed identity provider.

+

Returned: always

+

Sample: {"config": {"authorizationUrl": "https://idp.example.com", "clientAuthMethod": "client_secret_post", "clientId": "my-client", "clientSecret": "secret", "issuer": "https://idp.example.com", "tokenUrl": "https://idp.example.com/token", "userInfoUrl": "https://idp.example.com/userinfo"}, "displayName": "OpenID Connect IdP", "providerId": "oidc"}

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Laurent Paumier (@laurpaum) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_organization.rst.txt b/3.1.2/_sources/plugins/keycloak_organization.rst.txt new file mode 100644 index 0000000..ba409ae --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_organization.rst.txt @@ -0,0 +1,834 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_organization_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_organization -- Allows administration of Keycloak organizations using Keycloak API ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_organization`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.1.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows you to add, remove or modify Keycloak organizations using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin\-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles. +- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ `https://www.keycloak.org/docs\-api/latest/rest\-api/index.html `__. +- Attributes are multi\-valued in the Keycloak API. All attributes are lists of individual values and are returned that way by this module. You may pass single values for attributes when calling the module, and this is translated into a list suitable for the API. +- Organizations are available in Keycloak 26 and later. The realm must have organizations enabled (\ :literal:`organizations\_enabled=true` in the :ref:`middleware\_automation.keycloak.keycloak\_realm ` module) before this module can be used. +- When updating an organization, where possible provide the organization ID to the module. This removes a lookup to the API to translate the name into the organization ID. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

alias

+ +

+ string +

+
+

URL-friendly alias for the organization.

+

If not provided during creation, defaults to the organization name if URL-safe.

+

The alias is immutable once set and cannot be changed on update.

+
+
+

attributes

+ +

+ dictionary +

+
+

A dict of key/value pairs to set as custom attributes for the organization.

+

Values may be single values (for example a string) or a list of strings.

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

description

+ +

+ string +

+
+

Description of the organization.

+
+
+

domains

+ +

+ list + / elements=dictionary +

+
+

List of internet domains associated with the organization.

+

A domain name can only belong to one organization within a realm.

+
+
+

name

+ +

+ string + / required +

+
+

The domain name (e.g. example.com).

+
+
+

verified

+ +

+ boolean +

+
+

Whether the domain has been verified.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

enabled

+ +

+ boolean +

+
+

Whether the organization is enabled.

+

Disabled organizations block member authentication.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

id

+ +

+ string +

+
+

The unique identifier for this organization.

+

This parameter is not required for updating or deleting an organization but providing it reduces the number of API calls required.

+
+
+

name

+ +

+ string +

+
+

Name of the organization.

+

This parameter is required when creating a new organization.

+
+
+

realm

+ +

+ string +

+
+

The Keycloak realm under which this organization resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

State of the organization.

+

On present, the organization is created if it does not yet exist, or updated with the parameters you provide.

+

On absent, the organization is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_organization_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.1.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_organization_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_organization_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Create a Keycloak organization + middleware_automation.keycloak.keycloak_organization: + name: my-org + description: My Organization + enabled: true + realm: MyRealm + state: present + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + delegate_to: localhost + + - name: Create a Keycloak organization with domains + middleware_automation.keycloak.keycloak_organization: + name: acme-corp + description: Acme Corporation + enabled: true + domains: + - name: acme.com + - name: acme.org + verified: true + realm: MyRealm + state: present + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + delegate_to: localhost + + - name: Update a Keycloak organization + middleware_automation.keycloak.keycloak_organization: + name: my-org + description: Updated description + realm: MyRealm + state: present + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + delegate_to: localhost + + - name: Delete a Keycloak organization + middleware_automation.keycloak.keycloak_organization: + name: my-org + state: absent + realm: MyRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + delegate_to: localhost + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ complex +

+
+

Representation of the organization after module execution.

+

Returned: on success

+
+
+

alias

+ +

+ string +

+
+

URL-friendly alias of the organization.

+

Returned: always

+

Sample: "my-org"

+
+
+

attributes

+ +

+ dictionary +

+
+

Attributes applied to this organization.

+

Returned: always

+

Sample: {"attr1": ["val1", "val2"]}

+
+
+

description

+ +

+ string +

+
+

Description of the organization.

+

Returned: always

+

Sample: "My Organization"

+
+
+

domains

+ +

+ list + / elements=string +

+
+

Domains associated with the organization.

+

Returned: always

+

Sample: [{"name": "example.com", "verified": false}]

+
+
+

enabled

+ +

+ boolean +

+
+

Whether the organization is enabled.

+

Returned: always

+

Sample: true

+
+
+

id

+ +

+ string +

+
+

GUID that identifies the organization.

+

Returned: always

+

Sample: "23f38145-3195-462c-97e7-97041ccea73e"

+
+
+

name

+ +

+ string +

+
+

Name of the organization.

+

Returned: always

+

Sample: "my-org"

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Chris Brown (@chribro) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_organization_info.rst.txt b/3.1.2/_sources/plugins/keycloak_organization_info.rst.txt new file mode 100644 index 0000000..9fa3455 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_organization_info.rst.txt @@ -0,0 +1,559 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_organization_info_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_organization_info -- Retrieve organization info in Keycloak +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_organization_info`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.1.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module retrieves information on organizations from Keycloak. +- Organizations are available in Keycloak 26 and later. The realm must have organizations enabled before this module can be used. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

exact

+ +

+ boolean +

+
+

Whether the search should be an exact match.

+

Only relevant when name is provided.

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

name

+ +

+ string +

+
+

Name of the organization to search for.

+

If not provided, all organizations in the realm are returned.

+
+
+

realm

+ +

+ string + / required +

+
+

The name of the realm.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_organization_info_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.1.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_organization_info_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + This action does not modify state. + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_organization_info_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ ` \ :ansible-attribute-support-na:`N/A` + + This action does not modify state. + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Retrieve a specific organization by name + middleware_automation.keycloak.keycloak_organization_info: + auth_keycloak_url: https://auth.example.com + auth_username: admin + auth_password: password + auth_realm: master + realm: MyRealm + name: my-org + + - name: List all organizations in a realm + middleware_automation.keycloak.keycloak_organization_info: + auth_keycloak_url: https://auth.example.com + auth_username: admin + auth_password: password + auth_realm: master + realm: MyRealm + + - name: Search organizations by partial name + middleware_automation.keycloak.keycloak_organization_info: + auth_keycloak_url: https://auth.example.com + auth_username: admin + auth_password: password + auth_realm: master + realm: MyRealm + name: acme + exact: false + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + +

Key

Description

+
+

organizations

+ +

+ list + / elements=dictionary +

+
+

JSON representation of organizations.

+

Returned: always

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Chris Brown (@chribro) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_realm.rst.txt b/3.1.2/_sources/plugins/keycloak_realm.rst.txt new file mode 100644 index 0000000..c64e3b5 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_realm.rst.txt @@ -0,0 +1,2425 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_realm_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_realm -- Allows administration of Keycloak realm using Keycloak API +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_realm`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows the administration of Keycloak realm using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the realm being used must have the requisite access rights. In a default Keycloak installation, admin\-cli and an admin user would work, as would a separate realm definition with the scope tailored to your needs and a user having the expected roles. +- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ `https://www.keycloak.org/docs\-api/latest/rest\-api/index.html `__. Aliases are provided so camelCased versions can be used as well. +- The Keycloak API does not always sanity check inputs, for example you can set SAML\-specific settings on an OpenID Connect client for instance and also the other way around. :strong:`Be careful`. If you do not specify a setting, usually a sensible default is chosen. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+
+

access_code_lifespan

+ +

aliases: accessCodeLifespan

+

+ integer +

+
+

The realm access code lifespan.

+
+
+
+

access_code_lifespan_login

+ +

aliases: accessCodeLifespanLogin

+

+ integer +

+
+

The realm access code lifespan login.

+
+
+
+

access_code_lifespan_user_action

+ +

aliases: accessCodeLifespanUserAction

+

+ integer +

+
+

The realm access code lifespan user action.

+
+
+
+

access_token_lifespan

+ +

aliases: accessTokenLifespan

+

+ integer +

+
+

The realm access token lifespan.

+
+
+
+

access_token_lifespan_for_implicit_flow

+ +

aliases: accessTokenLifespanForImplicitFlow

+

+ integer +

+
+

The realm access token lifespan for implicit flow.

+
+
+
+

account_theme

+ +

aliases: accountTheme

+

+ string +

+
+

The realm account theme.

+
+
+
+

action_token_generated_by_admin_lifespan

+ +

aliases: actionTokenGeneratedByAdminLifespan

+

+ integer +

+
+

The realm action token generated by admin lifespan.

+
+
+
+

action_token_generated_by_user_lifespan

+ +

aliases: actionTokenGeneratedByUserLifespan

+

+ integer +

+
+

The realm action token generated by user lifespan.

+
+
+
+

admin_events_details_enabled

+ +

aliases: adminEventsDetailsEnabled

+

+ boolean +

+
+

The realm admin events details enabled.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

admin_events_enabled

+ +

aliases: adminEventsEnabled

+

+ boolean +

+
+

The realm admin events enabled.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

admin_permissions_enabled

+ +

aliases: adminPermissionsEnabled

+

+ boolean +

+
+

The realm admin permissions enabled.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

admin_theme

+ +

aliases: adminTheme

+

+ string +

+
+

The realm admin theme.

+
+
+

attributes

+ +

+ dictionary +

+
+

The realm attributes.

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+
+

browser_flow

+ +

aliases: browserFlow

+

+ string +

+
+

The realm browser flow.

+
+
+
+

browser_security_headers

+ +

aliases: browserSecurityHeaders

+

+ dictionary +

+
+

The realm browser security headers.

+
+
+
+

brute_force_protected

+ +

aliases: bruteForceProtected

+

+ boolean +

+
+

The realm brute force protected.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

brute_force_strategy

+ +

aliases: bruteForceStrategy

+

+ string +

+
+

The realm brute force strategy.

+

Choices:

+
    +
  • "LINEAR"

  • +
  • "MULTIPLE"

  • +
+ +
+
+
+

client_authentication_flow

+ +

aliases: clientAuthenticationFlow

+

+ string +

+
+

The realm client authentication flow.

+
+
+
+

client_offline_session_idle_timeout

+ +

aliases: clientOfflineSessionIdleTimeout

+

+ integer +

+
+

All Clients inherit from this setting, time an offline session is allowed to be idle before it expires.

+
+
+
+

client_offline_session_max_lifespan

+ +

aliases: clientOfflineSessionMaxLifespan

+

+ integer +

+
+

All Clients inherit from this setting, max time before an offline session is expired regardless of activity.

+
+
+
+

client_scope_mappings

+ +

aliases: clientScopeMappings

+

+ dictionary +

+
+

The realm client scope mappings.

+
+
+
+

client_session_idle_timeout

+ +

aliases: clientSessionIdleTimeout

+

+ integer +

+
+

All Clients inherit from this setting, time a session is allowed to be idle before it expires.

+
+
+
+

client_session_max_lifespan

+ +

aliases: clientSessionMaxLifespan

+

+ integer +

+
+

All Clients inherit from this setting, max time before a session is expired.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+
+

default_default_client_scopes

+ +

aliases: defaultDefaultClientScopes

+

+ list + / elements=string +

+
+

The realm default default client scopes.

+
+
+
+

default_groups

+ +

aliases: defaultGroups

+

+ list + / elements=string +

+
+

The realm default groups.

+
+
+
+

default_locale

+ +

aliases: defaultLocale

+

+ string +

+
+

The realm default locale.

+
+
+
+

default_optional_client_scopes

+ +

aliases: defaultOptionalClientScopes

+

+ list + / elements=string +

+
+

The realm default optional client scopes.

+
+
+
+

default_roles

+ +

aliases: defaultRoles

+

+ list + / elements=string +

+
+

The realm default roles.

+
+
+
+

default_signature_algorithm

+ +

aliases: defaultSignatureAlgorithm

+

+ string +

+
+

The realm default signature algorithm.

+
+
+
+

direct_grant_flow

+ +

aliases: directGrantFlow

+

+ string +

+
+

The realm direct grant flow.

+
+
+
+

display_name

+ +

aliases: displayName

+

+ string +

+
+

The realm display name.

+
+
+
+

display_name_html

+ +

aliases: displayNameHtml

+

+ string +

+
+

The realm display name HTML.

+
+
+
+

docker_authentication_flow

+ +

aliases: dockerAuthenticationFlow

+

+ string +

+
+

The realm docker authentication flow.

+
+
+
+

duplicate_emails_allowed

+ +

aliases: duplicateEmailsAllowed

+

+ boolean +

+
+

The realm duplicate emails allowed option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

edit_username_allowed

+ +

aliases: editUsernameAllowed

+

+ boolean +

+
+

The realm edit username allowed option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

email_theme

+ +

aliases: emailTheme

+

+ string +

+
+

The realm email theme.

+
+
+

enabled

+ +

+ boolean +

+
+

The realm enabled option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

enabled_event_types

+ +

aliases: enabledEventTypes

+

+ list + / elements=string +

+
+

The realm enabled event types.

+
+
+
+

events_enabled

+ +

aliases: eventsEnabled

+

+ boolean +

+
+

Enables or disables login events for this realm.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

events_expiration

+ +

aliases: eventsExpiration

+

+ integer +

+
+

The realm events expiration.

+
+
+
+

events_listeners

+ +

aliases: eventsListeners

+

+ list + / elements=string +

+
+

The realm events listeners.

+
+
+
+

failure_factor

+ +

aliases: failureFactor

+

+ integer +

+
+

The realm failure factor.

+
+
+
+

first_broker_login_flow

+ +

aliases: firstBrokerLoginFlow

+

+ string +

+
+

The realm first broker login flow.

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

id

+ +

+ string +

+
+

The realm to create.

+
+
+
+

internationalization_enabled

+ +

aliases: internationalizationEnabled

+

+ boolean +

+
+

The realm internationalization enabled option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

localization_texts

+ +

aliases: localizationTexts

+

+ dictionary +

+
+

The custom localization texts for a realm.

+
+
+
+

login_theme

+ +

aliases: loginTheme

+

+ string +

+
+

The realm login theme.

+
+
+
+

login_with_email_allowed

+ +

aliases: loginWithEmailAllowed

+

+ boolean +

+
+

The realm login with email allowed option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

max_delta_time_seconds

+ +

aliases: maxDeltaTimeSeconds

+

+ integer +

+
+

The realm max delta time in seconds.

+
+
+
+

max_failure_wait_seconds

+ +

aliases: maxFailureWaitSeconds

+

+ integer +

+
+

The realm max failure wait in seconds.

+
+
+
+

max_secondary_auth_failures

+ +

aliases: maxSecondaryAuthFailures

+

+ integer +

+
+

The realm max secondary authentication failures (used with brute force detection for secondary auth mechanisms).

+
+
+
+

max_temporary_lockouts

+ +

aliases: maxTemporaryLockouts

+

+ integer +

+
+

The realm max temporary lockouts.

+
+
+
+

minimum_quick_login_wait_seconds

+ +

aliases: minimumQuickLoginWaitSeconds

+

+ integer +

+
+

The realm minimum quick login wait in seconds.

+
+
+
+

not_before

+ +

aliases: notBefore

+

+ integer +

+
+

The realm not before.

+
+
+
+

oauth2_device_code_lifespan

+ +

aliases: oauth2DeviceCodeLifespan

+

+ integer +

+
+

Max time before the device code and user code are expired.

+
+
+
+

oauth2_device_polling_interval

+ +

aliases: oauth2DevicePollingInterval

+

+ integer +

+
+

The minimum amount of time in seconds that the client should wait between polling requests to the token endpoint.

+
+
+
+

offline_session_idle_timeout

+ +

aliases: offlineSessionIdleTimeout

+

+ integer +

+
+

The realm offline session idle timeout.

+
+
+
+

offline_session_max_lifespan

+ +

aliases: offlineSessionMaxLifespan

+

+ integer +

+
+

The realm offline session max lifespan.

+
+
+
+

offline_session_max_lifespan_enabled

+ +

aliases: offlineSessionMaxLifespanEnabled

+

+ boolean +

+
+

The realm offline session max lifespan enabled option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

organizations_enabled

+ +

aliases: organizationsEnabled

+

+ boolean +

+
+

Enables support for experimental organization feature.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

otp_policy_algorithm

+ +

aliases: otpPolicyAlgorithm

+

+ string +

+
+

The realm otp policy algorithm.

+
+
+
+

otp_policy_digits

+ +

aliases: otpPolicyDigits

+

+ integer +

+
+

The realm otp policy digits.

+
+
+
+

otp_policy_initial_counter

+ +

aliases: otpPolicyInitialCounter

+

+ integer +

+
+

The realm otp policy initial counter.

+
+
+
+

otp_policy_look_ahead_window

+ +

aliases: otpPolicyLookAheadWindow

+

+ integer +

+
+

The realm otp policy look ahead window.

+
+
+
+

otp_policy_period

+ +

aliases: otpPolicyPeriod

+

+ integer +

+
+

The realm otp policy period.

+
+
+
+

otp_policy_type

+ +

aliases: otpPolicyType

+

+ string +

+
+

The realm otp policy type.

+
+
+
+

otp_supported_applications

+ +

aliases: otpSupportedApplications

+

+ list + / elements=string +

+
+

The realm otp supported applications.

+
+
+
+

password_policy

+ +

aliases: passwordPolicy

+

+ string +

+
+

The realm password policy.

+
+
+
+

permanent_lockout

+ +

aliases: permanentLockout

+

+ boolean +

+
+

The realm permanent lockout.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

prune_undefined_realm_attributes

+ +

aliases: pruneUndefinedRealmAttributes

+

+ boolean +

+
+

If True all realm attributes which are not defined in the attributes dict will be deleted

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+
+

quick_login_check_milli_seconds

+ +

aliases: quickLoginCheckMilliSeconds

+

+ integer +

+
+

The realm quick login check in milliseconds.

+
+
+

realm

+ +

+ string +

+
+

The realm name.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+
+

refresh_token_max_reuse

+ +

aliases: refreshTokenMaxReuse

+

+ integer +

+
+

The realm refresh token max reuse.

+
+
+
+

registration_allowed

+ +

aliases: registrationAllowed

+

+ boolean +

+
+

The realm registration allowed option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

registration_email_as_username

+ +

aliases: registrationEmailAsUsername

+

+ boolean +

+
+

The realm registration email as username option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

registration_flow

+ +

aliases: registrationFlow

+

+ string +

+
+

The realm registration flow.

+
+
+
+

remember_me

+ +

aliases: rememberMe

+

+ boolean +

+
+

The realm remember me option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

reset_credentials_flow

+ +

aliases: resetCredentialsFlow

+

+ string +

+
+

The realm reset credentials flow.

+
+
+
+

reset_password_allowed

+ +

aliases: resetPasswordAllowed

+

+ boolean +

+
+

The realm reset password allowed option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

revoke_refresh_token

+ +

aliases: revokeRefreshToken

+

+ boolean +

+
+

The realm revoke refresh token option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

smtp_server

+ +

aliases: smtpServer

+

+ dictionary +

+
+

The realm smtp server.

+
+
+
+

ssl_required

+ +

aliases: sslRequired

+

+ string +

+
+

The realm ssl required option.

+

Choices:

+
    +
  • "all"

  • +
  • "external"

  • +
  • "none"

  • +
+ +
+
+
+

sso_session_idle_timeout

+ +

aliases: ssoSessionIdleTimeout

+

+ integer +

+
+

The realm sso session idle timeout.

+
+
+
+

sso_session_idle_timeout_remember_me

+ +

aliases: ssoSessionIdleTimeoutRememberMe

+

+ integer +

+
+

The realm sso session idle timeout remember me.

+
+
+
+

sso_session_max_lifespan

+ +

aliases: ssoSessionMaxLifespan

+

+ integer +

+
+

The realm sso session max lifespan.

+
+
+
+

sso_session_max_lifespan_remember_me

+ +

aliases: ssoSessionMaxLifespanRememberMe

+

+ integer +

+
+

The realm sso session max lifespan remember me.

+
+
+

state

+ +

+ string +

+
+

State of the realm.

+

On present, the realm is created (or updated if it exists already).

+

On absent, the realm is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+
+

supported_locales

+ +

aliases: supportedLocales

+

+ list + / elements=string +

+
+

The realm supported locales.

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+
+

user_managed_access_allowed

+ +

aliases: userManagedAccessAllowed

+

+ boolean +

+
+

The realm user managed access allowed option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+
+

verify_email

+ +

aliases: verifyEmail

+

+ boolean +

+
+

The realm verify email option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

wait_increment_seconds

+ +

aliases: waitIncrementSeconds

+

+ integer +

+
+

The realm wait increment in seconds.

+
+
+
+

web_authn_policy_acceptable_aaguids

+ +

aliases: webAuthnPolicyAcceptableAaguids

+

+ list + / elements=string +

+
+

List of acceptable AAGUIDs for WebAuthn authenticators.

+
+
+
+

web_authn_policy_attestation_conveyance_preference

+ +

aliases: webAuthnPolicyAttestationConveyancePreference

+

+ string +

+
+

Attestation conveyance preference for WebAuthn.

+
+
+
+

web_authn_policy_authenticator_attachment

+ +

aliases: webAuthnPolicyAuthenticatorAttachment

+

+ string +

+
+

Authenticator attachment preference for WebAuthn authenticators.

+
+
+
+

web_authn_policy_avoid_same_authenticator_register

+ +

aliases: webAuthnPolicyAvoidSameAuthenticatorRegister

+

+ boolean +

+
+

Avoid registering the same authenticator multiple times.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

web_authn_policy_create_timeout

+ +

aliases: webAuthnPolicyCreateTimeout

+

+ integer +

+
+

Timeout for WebAuthn credential creation (ms).

+
+
+
+

web_authn_policy_extra_origins

+ +

aliases: webAuthnPolicyExtraOrigins

+

+ list + / elements=string +

+
+

Additional acceptable origins for WebAuthn requests.

+
+
+
+

web_authn_policy_passwordless_acceptable_aaguids

+ +

aliases: webAuthnPolicyPasswordlessAcceptableAaguids

+

+ list + / elements=string +

+
+

List of acceptable AAGUIDs for WebAuthn passwordless authenticators.

+
+
+
+

web_authn_policy_passwordless_attestation_conveyance_preference

+ +

aliases: webAuthnPolicyPasswordlessAttestationConveyancePreference

+

+ string +

+
+

Attestation conveyance preference for WebAuthn passwordless.

+
+
+
+

web_authn_policy_passwordless_authenticator_attachment

+ +

aliases: webAuthnPolicyPasswordlessAuthenticatorAttachment

+

+ string +

+
+

Authenticator attachment for WebAuthn passwordless.

+
+
+
+

web_authn_policy_passwordless_avoid_same_authenticator_register

+ +

aliases: webAuthnPolicyPasswordlessAvoidSameAuthenticatorRegister

+

+ boolean +

+
+

Avoid registering the same authenticator multiple times for passwordless.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

web_authn_policy_passwordless_create_timeout

+ +

aliases: webAuthnPolicyPasswordlessCreateTimeout

+

+ integer +

+
+

Timeout for WebAuthn passwordless credential creation (ms).

+
+
+
+

web_authn_policy_passwordless_extra_origins

+ +

aliases: webAuthnPolicyPasswordlessExtraOrigins

+

+ list + / elements=string +

+
+

Additional acceptable origins for WebAuthn passwordless requests.

+
+
+
+

web_authn_policy_passwordless_passkeys_enabled

+ +

aliases: webAuthnPolicyPasswordlessPasskeysEnabled

+

+ boolean +

+
+

Enable passkeys (conditional UI) authentication in the username forms.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

web_authn_policy_passwordless_require_resident_key

+ +

aliases: webAuthnPolicyPasswordlessRequireResidentKey

+

+ string +

+
+

Whether resident keys are required for WebAuthn passwordless (Yes/No/not specified).

+
+
+
+

web_authn_policy_passwordless_rp_entity_name

+ +

aliases: webAuthnPolicyPasswordlessRpEntityName

+

+ string +

+
+

WebAuthn Passwordless Relying Party Entity Name.

+
+
+
+

web_authn_policy_passwordless_rp_id

+ +

aliases: webAuthnPolicyPasswordlessRpId

+

+ string +

+
+

WebAuthn Passwordless Relying Party ID (domain).

+
+
+
+

web_authn_policy_passwordless_signature_algorithms

+ +

aliases: webAuthnPolicyPasswordlessSignatureAlgorithms

+

+ list + / elements=string +

+
+

List of acceptable WebAuthn signature algorithms for passwordless.

+
+
+
+

web_authn_policy_passwordless_user_verification_requirement

+ +

aliases: webAuthnPolicyPasswordlessUserVerificationRequirement

+

+ string +

+
+

User verification requirement for WebAuthn passwordless.

+
+
+
+

web_authn_policy_require_resident_key

+ +

aliases: webAuthnPolicyRequireResidentKey

+

+ string +

+
+

Whether resident keys are required for WebAuthn (Yes/No/not specified).

+
+
+
+

web_authn_policy_rp_entity_name

+ +

aliases: webAuthnPolicyRpEntityName

+

+ string +

+
+

WebAuthn Relying Party Entity Name.

+
+
+
+

web_authn_policy_rp_id

+ +

aliases: webAuthnPolicyRpId

+

+ string +

+
+

WebAuthn Relying Party ID (domain). Empty string means use request host.

+
+
+
+

web_authn_policy_signature_algorithms

+ +

aliases: webAuthnPolicySignatureAlgorithms

+

+ list + / elements=string +

+
+

List of acceptable WebAuthn signature algorithms.

+
+
+
+

web_authn_policy_user_verification_requirement

+ +

aliases: webAuthnPolicyUserVerificationRequirement

+

+ string +

+
+

User verification requirement for WebAuthn.

+
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_realm_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_realm_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_realm_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Create or update Keycloak realm (minimal example) + middleware_automation.keycloak.keycloak_realm: + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + realm: unique_realm_name + state: present + + - name: Delete a Keycloak realm + middleware_automation.keycloak.keycloak_realm: + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + realm: unique_realm_name + state: absent + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of realm after module execution (sample is truncated).

+

Returned: on success

+

Sample: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}

+
+
+

existing

+ +

+ dictionary +

+
+

Representation of existing realm (sample is truncated).

+

Returned: always

+

Sample: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: "Realm testrealm has been updated"

+
+
+

proposed

+ +

+ dictionary +

+
+

Representation of proposed realm.

+

Returned: always

+

Sample: {"realm": "test"}

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Christophe Gilles (@kris2kris) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_realm_info.rst.txt b/3.1.2/_sources/plugins/keycloak_realm_info.rst.txt new file mode 100644 index 0000000..6bf22d8 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_realm_info.rst.txt @@ -0,0 +1,406 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_realm_info_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_realm_info -- Allows obtaining Keycloak realm public information using Keycloak API +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_realm_info`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows you to get Keycloak realm public information using the Keycloak REST API. +- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ `https://www.keycloak.org/docs\-api/latest/rest\-api/index.html `__. +- Attributes are multi\-valued in the Keycloak API. All attributes are lists of individual values and are returned that way by this module. You may pass single values for attributes when calling the module, and this is translated into a list suitable for the API. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+

realm

+ +

+ string +

+
+

They Keycloak realm ID.

+

Default: "master"

+
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_realm_info_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + This action does not modify state. + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_realm_info_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ ` \ :ansible-attribute-support-na:`N/A` + + This action does not modify state. + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Get a Keycloak public key + middleware_automation.keycloak.keycloak_realm_info: + realm: MyCustomRealm + auth_keycloak_url: https://auth.example.com + delegate_to: localhost + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+
+
+

realm_info

+ +

+ dictionary +

+
+

Representation of the realm public information.

+

Returned: always

+
+
+

account-service

+ +

+ string +

+
+

Account console URL.

+

Returned: always

+

Sample: "https://auth.example.com/realms/MyRealm/account"

+
+
+

public_key

+ +

+ string +

+
+

Public key of the realm.

+

Returned: always

+

Sample: "MIIBIjANBgkqhkiG9w0BAQEFAAO..."

+
+
+

realm

+ +

+ string +

+
+

Realm ID.

+

Returned: always

+

Sample: "MyRealm"

+
+
+

token-service

+ +

+ string +

+
+

Token endpoint URL.

+

Returned: always

+

Sample: "https://auth.example.com/realms/MyRealm/protocol/openid-connect"

+
+
+

tokens-not-before

+ +

+ integer +

+
+

The token not before.

+

Returned: always

+

Sample: 0

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Fynn Chen (@fynncfchen) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_realm_key.rst.txt b/3.1.2/_sources/plugins/keycloak_realm_key.rst.txt new file mode 100644 index 0000000..5e1434c --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_realm_key.rst.txt @@ -0,0 +1,1258 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_realm_key_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_realm_key -- Allows administration of Keycloak realm keys using Keycloak API ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_realm_key`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows the administration of Keycloak realm keys using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the realm being used must have the requisite access rights. In a default Keycloak installation, admin\-cli and an admin user would work, as would a separate realm definition with the scope tailored to your needs and a user having the expected roles. +- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ `https://www.keycloak.org/docs\-api/latest/rest\-api/index.html `__. Aliases are provided so camelCased versions can be used as well. +- This module is unable to detect changes to the actual cryptographic key after importing it. However, if some other property is changed alongside the cryptographic key, then the key also changes as a side\-effect, as the JSON payload needs to include the private key. This can be considered either a bug or a feature, as the alternative would be to always update the realm key whether it has changed or not. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

config

+ +

+ dictionary +

+
+

Dict specifying the key and its properties.

+
+
+

active

+ +

+ boolean +

+
+

Whether they key is active or inactive. Not to be confused with the state of the Ansible resource managed by the state parameter.

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

algorithm

+ +

+ string +

+
+

Key algorithm.

+

The values RS384, RS512, PS256, PS384, PS512, RSA1_5, RSA-OAEP, RSA-OAEP-256 have been added in middleware_automation.keycloak 8.2.0.

+

The values HS256, HS384, HS512 (for HMAC), ES256, ES384, ES512 (for ECDSA), and AES have been added in middleware_automation.keycloak 12.4.0.

+

The values ECDH_ES, ECDH_ES_A128KW, ECDH_ES_A192KW, ECDH_ES_A256KW (for ECDH key exchange), and Ed25519, Ed448 (for EdDSA signing) have been added in middleware_automation.keycloak 12.4.0.

+

For provider_id=rsa, provider_id=rsa-generated, and provider_id=java-keystore, defaults to RS256.

+

For provider_id=rsa-enc and provider_id=rsa-enc-generated, must be one of RSA1_5, RSA-OAEP, RSA-OAEP-256 (required, no default).

+

For provider_id=hmac-generated, must be one of HS256, HS384, HS512 (required, no default).

+

For provider_id=ecdsa-generated, must be one of ES256, ES384, ES512 (required, no default).

+

For provider_id=ecdh-generated, must be one of ECDH_ES, ECDH_ES_A128KW, ECDH_ES_A192KW, ECDH_ES_A256KW (required, no default).

+

For provider_id=eddsa-generated, this option is not used (the algorithm is determined by config.elliptic_curve).

+

For provider_id=aes-generated, this option is not used (AES is always used).

+

Choices:

+
    +
  • "RS256" ← (default)

  • +
  • "RS384"

  • +
  • "RS512"

  • +
  • "PS256"

  • +
  • "PS384"

  • +
  • "PS512"

  • +
  • "RSA1_5"

  • +
  • "RSA-OAEP"

  • +
  • "RSA-OAEP-256"

  • +
  • "HS256"

  • +
  • "HS384"

  • +
  • "HS512"

  • +
  • "ES256"

  • +
  • "ES384"

  • +
  • "ES512"

  • +
  • "AES"

  • +
  • "ECDH_ES"

  • +
  • "ECDH_ES_A128KW"

  • +
  • "ECDH_ES_A192KW"

  • +
  • "ECDH_ES_A256KW"

  • +
  • "Ed25519"

  • +
  • "Ed448"

  • +
+ +
+
+

certificate

+ +

+ string +

+
+

A certificate signed with the private key as an ASCII string. Contents of the key must match config.algorithm and provider_id.

+

If you want Keycloak to automatically generate a certificate using your private key then set this to an empty string.

+

Required when provider_id is rsa or rsa-enc. Not used for auto-generated providers.

+
+
+

elliptic_curve

+ +

+ string +

+
+

The elliptic curve to use for ECDSA, ECDH, or EdDSA keys.

+

For provider_id=ecdsa-generated and provider_id=ecdh-generated, valid values are P-256, P-384, P-521. Default is P-256.

+

For provider_id=eddsa-generated, valid values are Ed25519, Ed448. Default is Ed25519.

+

Choices:

+
    +
  • "P-256"

  • +
  • "P-384"

  • +
  • "P-521"

  • +
  • "Ed25519"

  • +
  • "Ed448"

  • +
+ +
+
+

enabled

+ +

+ boolean +

+
+

Whether the key is enabled or disabled. Not to be confused with the state of the Ansible resource managed by the state parameter.

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

key_alias

+ +

+ string +

+
+

Alias of the key within the keystore.

+

Required when provider_id=java-keystore.

+
+
+

key_password

+ +

+ string +

+
+

Password for the key within the keystore.

+

If not specified, the config.keystore_password is used.

+

Only applicable to provider_id=java-keystore.

+
+
+

key_size

+ +

+ integer +

+
+

The size of the generated key in bits.

+

Only applicable to provider_id=rsa-generated and provider_id=rsa-enc-generated.

+

Valid values are 1024, 2048, 4096. Default is 2048.

+
+
+

keystore

+ +

+ string +

+
+

Path to the Java Keystore file on the Keycloak server filesystem.

+

Required when provider_id=java-keystore.

+
+
+

keystore_password

+ +

+ string +

+
+

Password for the Java Keystore.

+

Required when provider_id=java-keystore.

+
+
+

priority

+ +

+ integer + / required +

+
+

The priority of the key.

+
+
+

private_key

+ +

+ string +

+
+

The private key as an ASCII string. Contents of the key must match config.algorithm and provider_id.

+

Please note that the module cannot detect whether the private key specified differs from the current state's private key. Use force=true to force the module to update the private key if you expect it to be updated.

+

Required when provider_id is rsa or rsa-enc. Not used for auto-generated providers.

+
+
+

secret_size

+ +

+ integer +

+
+

The size of the generated secret key in bytes.

+

Only applicable to provider_id=hmac-generated and provider_id=aes-generated.

+

Valid values are 16, 24, 32, 64, 128, 256, 512.

+

Default is 64 for HMAC, 16 for AES.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

force

+ +

+ boolean +

+
+

Enforce the state of the private key and certificate. This is not automatically the case as this module is unable to determine the current state of the private key and thus cannot trigger an update based on an actual divergence. That said, a private key update may happen even if force is false as a side-effect of other changes.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

name

+ +

+ string + / required +

+
+

Name of the realm key to create.

+
+
+

parent_id

+ +

+ string + / required +

+
+

The parent_id of the realm key. In practice the name of the realm.

+
+
+

provider_id

+ +

+ string +

+
+

The name of the "provider ID" for the key.

+

The value rsa-enc has been added in middleware_automation.keycloak 8.2.0.

+

The value java-keystore has been added in middleware_automation.keycloak 12.4.0. This provider imports keys from a Java Keystore (JKS or PKCS12) file located on the Keycloak server filesystem.

+

The values rsa-generated, hmac-generated, aes-generated, and ecdsa-generated have been added in middleware_automation.keycloak 3.0.0. These are auto-generated key providers where Keycloak manages the key material.

+

The values rsa-enc-generated, ecdh-generated, and eddsa-generated have been added in middleware_automation.keycloak 3.0.0. These correspond to the auto-generated key providers available in Keycloak 26.

+

Choices:

+
    +
  • "rsa" ← (default)

  • +
  • "rsa-enc"

  • +
  • "java-keystore"

  • +
  • "rsa-generated"

  • +
  • "rsa-enc-generated"

  • +
  • "hmac-generated"

  • +
  • "aes-generated"

  • +
  • "ecdsa-generated"

  • +
  • "ecdh-generated"

  • +
  • "eddsa-generated"

  • +
+ +
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

State of the keycloak realm key.

+

On present, the realm key is created (or updated if it exists already).

+

On absent, the realm key is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

update_password

+ +

+ string +

+
+

Controls when passwords are sent to Keycloak for java-keystore provider.

+

always - Always send passwords. Keycloak will update the component even if passwords have not changed. Use when you need to ensure passwords are updated.

+

on_create - Only send passwords when creating a new component. When updating an existing component, send the masked value to preserve existing passwords. This makes the module idempotent for password fields.

+

This is necessary because Keycloak masks passwords in API responses (returns **********), making comparison impossible.

+

Has no effect for providers other than java-keystore.

+

Choices:

+
    +
  • "always" ← (default)

  • +
  • "on_create"

  • +
+ +
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_realm_key_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_realm_key_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_realm_key_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-partial:`partial` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + +Notes +----- + +.. note:: + - Current value of the private key cannot be fetched from Keycloak. Therefore comparing its desired state to the current state is not possible. + - If :ansopt:`middleware\_automation.keycloak.keycloak\_realm\_key#module:config.certificate` is not explicitly provided it is dynamically created by Keycloak. Therefore comparing the current state of the certificate to the desired state (which may be empty) is not possible. + - Due to the private key and certificate options the module is :strong:`not fully idempotent`. You can use :ansopt:`middleware\_automation.keycloak.keycloak\_realm\_key#module:force=true` to force the module to ensure updating if you know that the private key might have changed. + - For auto\-generated providers (\ :ansval:`rsa\-generated`\ , :ansval:`rsa\-enc\-generated`\ , :ansval:`hmac\-generated`\ , :ansval:`aes\-generated`\ , :ansval:`ecdsa\-generated`\ , :ansval:`ecdh\-generated`\ , :ansval:`eddsa\-generated`\ ), Keycloak manages the key material automatically. The :ansopt:`middleware\_automation.keycloak.keycloak\_realm\_key#module:config.private\_key` and :ansopt:`middleware\_automation.keycloak.keycloak\_realm\_key#module:config.certificate` options are not used. + - For :ansval:`java\-keystore` provider, the :ansopt:`middleware\_automation.keycloak.keycloak\_realm\_key#module:config.keystore\_password` and :ansopt:`middleware\_automation.keycloak.keycloak\_realm\_key#module:config.key\_password` values are returned masked by Keycloak. Therefore comparing their current state to the desired state is not possible. Use :ansopt:`middleware\_automation.keycloak.keycloak\_realm\_key#module:update\_password=on\_create` for idempotent playbooks, or use :ansopt:`middleware\_automation.keycloak.keycloak\_realm\_key#module:update\_password=always` (default) if you need to ensure passwords are updated. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Manage Keycloak realm key (certificate autogenerated by Keycloak) + middleware_automation.keycloak.keycloak_realm_key: + name: custom + state: present + parent_id: master + provider_id: rsa + auth_keycloak_url: http://localhost:8080 + auth_username: keycloak + auth_password: keycloak + auth_realm: master + config: + private_key: "{{ private_key }}" + certificate: "" + enabled: true + active: true + priority: 120 + algorithm: RS256 + + - name: Manage Keycloak realm key and certificate + middleware_automation.keycloak.keycloak_realm_key: + name: custom + state: present + parent_id: master + provider_id: rsa + auth_keycloak_url: http://localhost:8080 + auth_username: keycloak + auth_password: keycloak + auth_realm: master + config: + private_key: "{{ private_key }}" + certificate: "{{ certificate }}" + enabled: true + active: true + priority: 120 + algorithm: RS256 + + - name: Create HMAC signing key (auto-generated) + middleware_automation.keycloak.keycloak_realm_key: + name: hmac-custom + state: present + parent_id: master + provider_id: hmac-generated + auth_keycloak_url: http://localhost:8080 + auth_username: keycloak + auth_password: keycloak + auth_realm: master + config: + enabled: true + active: true + priority: 100 + algorithm: HS256 + secret_size: 64 + + - name: Create AES encryption key (auto-generated) + middleware_automation.keycloak.keycloak_realm_key: + name: aes-custom + state: present + parent_id: master + provider_id: aes-generated + auth_keycloak_url: http://localhost:8080 + auth_username: keycloak + auth_password: keycloak + auth_realm: master + config: + enabled: true + active: true + priority: 100 + secret_size: 16 + + - name: Create ECDSA signing key (auto-generated) + middleware_automation.keycloak.keycloak_realm_key: + name: ecdsa-custom + state: present + parent_id: master + provider_id: ecdsa-generated + auth_keycloak_url: http://localhost:8080 + auth_username: keycloak + auth_password: keycloak + auth_realm: master + config: + enabled: true + active: true + priority: 100 + algorithm: ES256 + elliptic_curve: P-256 + + - name: Create RSA signing key (auto-generated) + middleware_automation.keycloak.keycloak_realm_key: + name: rsa-auto + state: present + parent_id: master + provider_id: rsa-generated + auth_keycloak_url: http://localhost:8080 + auth_username: keycloak + auth_password: keycloak + auth_realm: master + config: + enabled: true + active: true + priority: 100 + algorithm: RS256 + key_size: 2048 + + - name: Remove default HMAC key + middleware_automation.keycloak.keycloak_realm_key: + name: hmac-generated + state: absent + parent_id: myrealm + provider_id: hmac-generated + auth_keycloak_url: http://localhost:8080 + auth_username: keycloak + auth_password: keycloak + auth_realm: master + config: + priority: 100 + + - name: Create RSA encryption key (auto-generated) + middleware_automation.keycloak.keycloak_realm_key: + name: rsa-enc-auto + state: present + parent_id: master + provider_id: rsa-enc-generated + auth_keycloak_url: http://localhost:8080 + auth_username: keycloak + auth_password: keycloak + auth_realm: master + config: + enabled: true + active: true + priority: 100 + algorithm: RSA-OAEP + key_size: 2048 + + - name: Create ECDH key exchange key (auto-generated) + middleware_automation.keycloak.keycloak_realm_key: + name: ecdh-custom + state: present + parent_id: master + provider_id: ecdh-generated + auth_keycloak_url: http://localhost:8080 + auth_username: keycloak + auth_password: keycloak + auth_realm: master + config: + enabled: true + active: true + priority: 100 + algorithm: ECDH_ES + elliptic_curve: P-256 + + - name: Create EdDSA signing key (auto-generated) + middleware_automation.keycloak.keycloak_realm_key: + name: eddsa-custom + state: present + parent_id: master + provider_id: eddsa-generated + auth_keycloak_url: http://localhost:8080 + auth_username: keycloak + auth_password: keycloak + auth_realm: master + config: + enabled: true + active: true + priority: 100 + elliptic_curve: Ed25519 + + - name: Import key from Java Keystore (always update passwords) + middleware_automation.keycloak.keycloak_realm_key: + name: jks-imported + state: present + parent_id: master + provider_id: java-keystore + auth_keycloak_url: http://localhost:8080 + auth_username: keycloak + auth_password: keycloak + auth_realm: master + # update_password: always is the default - passwords are always sent to Keycloak + config: + enabled: true + active: true + priority: 100 + algorithm: RS256 + keystore: /opt/keycloak/conf/keystore.jks + keystore_password: "{{ keystore_password }}" + key_alias: mykey + key_password: "{{ key_password }}" + + - name: Import key from Java Keystore (idempotent - only set password on create) + middleware_automation.keycloak.keycloak_realm_key: + name: jks-idempotent + state: present + parent_id: master + provider_id: java-keystore + auth_keycloak_url: http://localhost:8080 + auth_username: keycloak + auth_password: keycloak + auth_realm: master + update_password: on_create # Only send passwords when creating, preserve existing on update + config: + enabled: true + active: true + priority: 100 + algorithm: RS256 + keystore: /opt/keycloak/conf/keystore.jks + keystore_password: "{{ keystore_password }}" + key_alias: mykey + key_password: "{{ key_password }}" + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of the keycloak_realm_key after module execution.

+

Returned: on success

+
+
+

config

+ +

+ dictionary +

+
+

Realm key configuration.

+

Returned: when state=present

+

Sample: {"active": ["true"], "algorithm": ["RS256"], "enabled": ["true"], "priority": ["140"]}

+
+
+

id

+ +

+ string +

+
+

ID of the realm key.

+

Returned: when state=present

+

Sample: "5b7ec13f-99da-46ad-8326-ab4c73cf4ce4"

+
+
+

key_info

+ +

+ dictionary +

+
+

Cryptographic key metadata fetched from the realm keys endpoint.

+

Only returned for java-keystore provider when state=present and not in check mode.

+

This includes the key ID (kid) and certificate fingerprint, which can be used to detect if the actual cryptographic key changed.

+

Returned: when provider_id=java-keystore and state=present

+
+
+

certificate_fingerprint

+ +

+ string +

+
+

SHA256 fingerprint of the certificate in colon-separated hex format.

+

Returned: success

+

Sample: "A1:B2:C3:D4:E5:F6:..."

+
+
+

kid

+ +

+ string +

+
+

The key ID (kid) - unique identifier for the cryptographic key.

+

Returned: success

+

Sample: "bN7p5Nc_V2M7N_-mb5vVSRVPKq5qD_OuARInB9ofsJ0"

+
+
+

status

+ +

+ string +

+
+

The key status (ACTIVE, PASSIVE, DISABLED).

+

Returned: success

+

Sample: "ACTIVE"

+
+
+

valid_to

+ +

+ integer +

+
+

Certificate expiration timestamp in milliseconds since epoch.

+

Returned: success

+

Sample: 1801789047000

+
+
+

name

+ +

+ string +

+
+

Name of the realm key.

+

Returned: when state=present

+

Sample: "mykey"

+
+
+

parentId

+ +

+ string +

+
+

ID of the realm this key belongs to.

+

Returned: when state=present

+

Sample: "myrealm"

+
+
+

providerId

+ +

+ string +

+
+

The ID of the key provider.

+

Returned: when state=present

+

Sample: "rsa"

+
+
+

providerType

+ +

+ string +

+
+

The type of provider.

+

Returned: when state=present

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Samuli Seppänen (@mattock) +- Ivan Kokalović (@koke1997) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_realm_keys_metadata_info.rst.txt b/3.1.2/_sources/plugins/keycloak_realm_keys_metadata_info.rst.txt new file mode 100644 index 0000000..0a86ad0 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_realm_keys_metadata_info.rst.txt @@ -0,0 +1,562 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_realm_keys_metadata_info_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_realm_keys_metadata_info -- Allows obtaining Keycloak realm keys metadata using Keycloak API ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_realm_keys_metadata_info`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows you to get Keycloak realm keys metadata using the Keycloak REST API. +- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ `https://www.keycloak.org/docs\-api/latest/rest\-api/index.html `__. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

realm

+ +

+ string +

+
+

They Keycloak realm to fetch keys metadata.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_realm_keys_metadata_info_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_realm_keys_metadata_info_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + This action does not modify state. + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_realm_keys_metadata_info_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ ` \ :ansible-attribute-support-na:`N/A` + + This action does not modify state. + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Fetch Keys metadata + middleware_automation.keycloak.keycloak_realm_keys_metadata_info: + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + realm: MyCustomRealm + delegate_to: localhost + register: keycloak_keys_metadata + + - name: Write the Keycloak keys certificate into a file + ansible.builtin.copy: + dest: /tmp/keycloak.cert + content: | + {{ keys_metadata['keycloak_keys_metadata']['keys'] + | selectattr('algorithm', 'equalto', 'RS256') + | map(attribute='certificate') + | first + }} + delegate_to: localhost + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

keys_metadata

+ +

+ dictionary +

+
+

Representation of the realm keys metadata (see https://www.keycloak.org/docs-api/latest/rest-api/index.html#KeysMetadataRepresentation).

+

Returned: always

+
+
+

active

+ +

+ dictionary +

+
+

A mapping (that is, a dict) from key algorithms to UUIDs.

+

Returned: always

+
+
+

keys

+ +

+ list + / elements=dictionary +

+
+

A list of dicts providing detailed information on the keys.

+

Returned: always

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Thomas Bach (@thomasbach-dev) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_realm_localization.rst.txt b/3.1.2/_sources/plugins/keycloak_realm_localization.rst.txt new file mode 100644 index 0000000..11bd809 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_realm_localization.rst.txt @@ -0,0 +1,712 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_realm_localization_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_realm_localization -- Allows management of Keycloak realm localization overrides via the Keycloak API +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_realm_localization`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows you to manage per\-locale message overrides for a Keycloak realm using the Keycloak Admin REST API. +- Requires access via OpenID Connect; the connecting user/client must have sufficient privileges. +- The names of module options are snake\_cased versions of the names found in the Keycloak API. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

force

+ +

+ boolean +

+
+

If false, only the keys listed in the overrides are modified by this module. Any other pre-existing keys are ignored.

+

If true, all locale overrides are made to match configuration of this module. For example any keys missing from the overrides are removed regardless of state value.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

locale

+ +

+ string + / required +

+
+

Locale code for which the overrides apply (for example, en, fi, de).

+
+
+

overrides

+ +

+ list + / elements=dictionary +

+
+

List of overrides to ensure for the locale when state=present. Each item is a mapping with the record's overrides[].key and its overrides[].value.

+

Ignored when state=absent.

+

Default: []

+
+
+

key

+ +

+ string + / required +

+
+

The message key to override.

+
+
+

value

+ +

+ string +

+
+

The override value for the message key. If omitted, value defaults to an empty string.

+

Default: ""

+
+
+

parent_id

+ +

+ string + / required +

+
+

Name of the realm that owns the locale overrides.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

Desired state of localization overrides for the given locale.

+

On present, the set of overrides for the locale are made to match overrides. If force is true keys not listed in overrides are removed, and the listed keys are created or updated. If force is false keys not listed in overrides are ignored, and the listed keys are created or updated.

+

On absent, overrides for the locale is removed. If force is true, all keys are removed. If force is false, only the keys listed in overrides are removed.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_realm_localization_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_realm_localization_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_realm_localization_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + +See Also +-------- + +.. seealso:: + + :ref:`middleware\_automation.keycloak.keycloak\_realm ` + You can specify list of supported locales using :ansopt:`middleware\_automation.keycloak.keycloak\_realm#module:supported\_locales`. + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Replace all overrides for locale "en" (credentials auth) + middleware_automation.keycloak.keycloak_realm_localization: + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + parent_id: my-realm + locale: en + state: present + force: true + overrides: + - key: greeting + value: "Hello" + - key: farewell + value: "Bye" + delegate_to: localhost + + - name: Replace listed overrides for locale "en" (credentials auth) + middleware_automation.keycloak.keycloak_realm_localization: + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + parent_id: my-realm + locale: en + state: present + force: false + overrides: + - key: greeting + value: "Hello" + - key: farewell + value: "Bye" + delegate_to: localhost + + - name: Ensure only one override exists for locale "fi" (token auth) + middleware_automation.keycloak.keycloak_realm_localization: + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + token: TOKEN + parent_id: my-realm + locale: fi + state: present + force: true + overrides: + - key: app.title + value: "Sovellukseni" + delegate_to: localhost + + - name: Remove all overrides for locale "de" + middleware_automation.keycloak.keycloak_realm_localization: + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + parent_id: my-realm + locale: de + state: absent + force: true + delegate_to: localhost + + - name: Remove only the listed overrides for locale "de" + middleware_automation.keycloak.keycloak_realm_localization: + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + parent_id: my-realm + locale: de + state: absent + force: false + overrides: + - key: app.title + - key: foo + - key: bar + delegate_to: localhost + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Final state of localization overrides for the locale after module execution.

+

Contains the locale and the list of overrides as key/value items.

+

Returned: on success

+
+
+

locale

+ +

+ string +

+
+

The locale code affected.

+

Returned: success

+

Sample: "en"

+
+
+

overrides

+ +

+ list + / elements=dictionary +

+
+

The list of overrides that exist after execution.

+

Returned: success

+

Sample: [{"key": "greeting", "value": "Hello"}, {"key": "farewell", "value": "Bye"}]

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Jakub Danek (@danekja) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_realm_rolemapping.rst.txt b/3.1.2/_sources/plugins/keycloak_realm_rolemapping.rst.txt new file mode 100644 index 0000000..d747b80 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_realm_rolemapping.rst.txt @@ -0,0 +1,751 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_realm_rolemapping_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_realm_rolemapping -- Allows administration of Keycloak realm role mappings into groups with the Keycloak API ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_realm_rolemapping`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows you to add, remove or modify Keycloak realm role mappings into groups with the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin\-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles. +- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ `https://www.keycloak.org/docs\-api/18.0/rest\-api/index.html `__. +- Attributes are multi\-valued in the Keycloak API. All attributes are lists of individual values and are returned that way by this module. You may pass single values for attributes when calling the module, and this is translated into a list suitable for the API. +- When updating a group\_rolemapping, where possible provide the role ID to the module. This removes a lookup to the API to translate the name into the role ID. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

gid

+ +

+ string +

+
+

ID of the group to be mapped.

+

This parameter is not required for updating or deleting the rolemapping but providing it reduces the number of API calls required.

+
+
+

group_name

+ +

+ string +

+
+

Name of the group to be mapped.

+

This parameter is required (can be replaced by gid for less API call).

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

parents

+ +

+ list + / elements=dictionary +

+
+

List of parent groups for the group to handle sorted top to bottom.

+

Set this if your group is a subgroup and you do not provide the GID in gid.

+
+
+

id

+ +

+ string +

+
+

Identify parent by ID.

+

Needs less API calls than using parents[].name.

+

A deep parent chain can be started at any point when first given parent is given as ID.

+

Note that in principle both ID and name can be specified at the same time but current implementation only always use just one of them, with ID being preferred.

+
+
+

name

+ +

+ string +

+
+

Identify parent by name.

+

Needs more internal API calls than using parents[].id to map names to ID's under the hood.

+

When giving a parent chain with only names it must be complete up to the top.

+

Note that in principle both ID and name can be specified at the same time but current implementation only always use just one of them, with ID being preferred.

+
+
+

realm

+ +

+ string +

+
+

They Keycloak realm under which this role_representation resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

roles

+ +

+ list + / elements=dictionary +

+
+

Roles to be mapped to the group.

+
+
+

id

+ +

+ string +

+
+

The unique identifier for this role_representation.

+

This parameter is not required for updating or deleting a role_representation but providing it reduces the number of API calls required.

+
+
+

name

+ +

+ string +

+
+

Name of the role_representation.

+

This parameter is required only when creating or updating the role_representation.

+
+
+

state

+ +

+ string +

+
+

State of the realm_rolemapping.

+

On present, the realm_rolemapping is created if it does not yet exist, or updated with the parameters you provide.

+

On absent, the realm_rolemapping is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_realm_rolemapping_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_realm_rolemapping_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_realm_rolemapping_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Map a client role to a group, authentication with credentials + middleware_automation.keycloak.keycloak_realm_rolemapping: + realm: MyCustomRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + state: present + group_name: group1 + roles: + - name: role_name1 + id: role_id1 + - name: role_name2 + id: role_id2 + delegate_to: localhost + + - name: Map a client role to a group, authentication with token + middleware_automation.keycloak.keycloak_realm_rolemapping: + realm: MyCustomRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + token: TOKEN + state: present + group_name: group1 + roles: + - name: role_name1 + id: role_id1 + - name: role_name2 + id: role_id2 + delegate_to: localhost + + - name: Map a client role to a subgroup, authentication with token + middleware_automation.keycloak.keycloak_realm_rolemapping: + realm: MyCustomRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + token: TOKEN + state: present + group_name: subgroup1 + parents: + - name: parent-group + roles: + - name: role_name1 + id: role_id1 + - name: role_name2 + id: role_id2 + delegate_to: localhost + + - name: Unmap realm role from a group + middleware_automation.keycloak.keycloak_realm_rolemapping: + realm: MyCustomRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + state: absent + group_name: group1 + roles: + - name: role_name1 + id: role_id1 + - name: role_name2 + id: role_id2 + delegate_to: localhost + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of client role mapping after module execution.

+

The sample is truncated.

+

Returned: on success

+

Sample: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}

+
+
+

existing

+ +

+ dictionary +

+
+

Representation of existing client role mapping.

+

The sample is truncated.

+

Returned: always

+

Sample: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: "Role role1 assigned to group group1."

+
+
+

proposed

+ +

+ dictionary +

+
+

Representation of proposed client role mapping.

+

Returned: always

+

Sample: {"clientId": "test"}

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Gaëtan Daubresse (@Gaetan2907) +- Marius Huysamen (@mhuysamen) +- Alexander Groß (@agross) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_realm_users_info.rst.txt b/3.1.2/_sources/plugins/keycloak_realm_users_info.rst.txt new file mode 100644 index 0000000..155b994 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_realm_users_info.rst.txt @@ -0,0 +1,517 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_realm_users_info_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_realm_users_info -- Retrieve users from a Keycloak realm using the Keycloak API +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_realm_users_info`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.1.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module retrieves all users from a specified Keycloak realm using the Keycloak REST API. +- Access to the REST API is performed via OpenID Connect. The user and client used must have the necessary permissions. +- Authentication can be performed either with username/password or with a token. +- The names of module options are snake\_case versions of the camelCase ones found in the Keycloak API and its documentation at \ `https://www.keycloak.org/docs\-api/latest/rest\-api/index.html `__. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

realm

+ +

+ string +

+
+

The Keycloak realm from which users should be retrieved.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_realm_users_info_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_realm_users_info_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + This action does not modify state. + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_realm_users_info_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ ` \ :ansible-attribute-support-na:`N/A` + + This action does not modify state. + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: List all users in the "MyCustomRealm" realm using username/password authentication + middleware_automation.keycloak.keycloak_realm_users_info: + realm: MyCustomRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + delegate_to: localhost + + - name: List all users in the "MyCustomRealm" realm using a token + middleware_automation.keycloak.keycloak_realm_users_info: + realm: MyCustomRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + token: TOKEN + delegate_to: localhost + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + +

Key

Description

+
+

users

+ +

+ list + / elements=dictionary +

+
+

List of users in the specified realm.

+

Returned: always

+

Sample: [{"email": "user1@example.com", "id": "1234-5678-90", "username": "user1"}, {"email": "user2@example.com", "id": "2345-6789-01", "username": "user2"}]

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Felix Grzelka (@felix-grzelka) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_role.rst.txt b/3.1.2/_sources/plugins/keycloak_role.rst.txt new file mode 100644 index 0000000..3091c59 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_role.rst.txt @@ -0,0 +1,767 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_role_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_role -- Allows administration of Keycloak roles using Keycloak API ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_role`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows you to add, remove or modify Keycloak roles using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin\-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles. +- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ `https://www.keycloak.org/docs\-api/latest/rest\-api/index.html `__. +- Attributes are multi\-valued in the Keycloak API. All attributes are lists of individual values and are returned that way by this module. You may pass single values for attributes when calling the module, and this is translated into a list suitable for the API. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

attributes

+ +

+ dictionary +

+
+

A dict of key/value pairs to set as custom attributes for the role.

+

Values may be single values (for example a string) or a list of strings.

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

client_id

+ +

+ string +

+
+

If the role is a client role, the client ID under which it resides.

+

If this parameter is absent, the role is considered a realm role.

+
+
+

composite

+ +

+ boolean +

+
+

If true, the role is a composition of other realm and/or client role.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

composites

+ +

+ list + / elements=dictionary +

+
+

List of roles to include to the composite realm role.

+

If the composite role is a client role, the clientId (not ID of the client) must be specified.

+

Default: []

+
+
+
+

client_id

+ +

aliases: clientId

+

+ string +

+
+

Client ID if the role is a client role. Do not include this option for a REALM role.

+

Use the client ID you can see in the Keycloak console, not the technical ID of the client.

+
+
+

name

+ +

+ string + / required +

+
+

Name of the role. This can be the name of a REALM role or a client role.

+
+
+

state

+ +

+ string +

+
+

Create the composite if present, remove it if absent.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

description

+ +

+ string +

+
+

The role description.

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

name

+ +

+ string + / required +

+
+

Name of the role.

+

This parameter is required.

+
+
+

realm

+ +

+ string +

+
+

The Keycloak realm under which this role resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

State of the role.

+

On present, the role is created if it does not yet exist, or updated with the parameters you provide.

+

On absent, the role is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Create a Keycloak realm role, authentication with credentials + middleware_automation.keycloak.keycloak_role: + name: my-new-kc-role + realm: MyCustomRealm + state: present + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + delegate_to: localhost + + - name: Create a Keycloak realm role, authentication with token + middleware_automation.keycloak.keycloak_role: + name: my-new-kc-role + realm: MyCustomRealm + state: present + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + token: TOKEN + delegate_to: localhost + + - name: Create a Keycloak client role + middleware_automation.keycloak.keycloak_role: + name: my-new-kc-role + realm: MyCustomRealm + client_id: MyClient + state: present + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + delegate_to: localhost + + - name: Delete a Keycloak role + middleware_automation.keycloak.keycloak_role: + name: my-role-for-deletion + state: absent + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + delegate_to: localhost + + - name: Create a keycloak role with some custom attributes + middleware_automation.keycloak.keycloak_role: + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + name: my-new-role + attributes: + attrib1: value1 + attrib2: value2 + attrib3: + - with + - numerous + - individual + - list + - items + delegate_to: localhost + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of role after module execution (sample is truncated).

+

Returned: on success

+

Sample: {"attributes": {}, "clientRole": true, "composite": false, "containerId": "9f03eb61-a826-4771-a9fd-930e06d2d36a", "description": "My updated client test role", "id": "561703dd-0f38-45ff-9a5a-0c978f794547", "name": "myrole"}

+
+
+

existing

+ +

+ dictionary +

+
+

Representation of existing role.

+

Returned: always

+

Sample: {"attributes": {}, "clientRole": true, "composite": false, "containerId": "9f03eb61-a826-4771-a9fd-930e06d2d36a", "description": "My client test role", "id": "561703dd-0f38-45ff-9a5a-0c978f794547", "name": "myrole"}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: "Role myrole has been updated"

+
+
+

proposed

+ +

+ dictionary +

+
+

Representation of proposed role.

+

Returned: always

+

Sample: {"description": "My updated test description"}

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Laurent Paumier (@laurpaum) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_user.rst.txt b/3.1.2/_sources/plugins/keycloak_user.rst.txt new file mode 100644 index 0000000..6acdba7 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_user.rst.txt @@ -0,0 +1,1153 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_user_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_user -- Create and configure a user in Keycloak +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_user`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module creates, removes, or updates Keycloak users. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

access

+ +

+ dictionary +

+
+

List user access.

+
+
+

attributes

+ +

+ list + / elements=dictionary +

+
+

List of user attributes.

+
+
+

name

+ +

+ string +

+
+

Name of the attribute.

+
+
+

state

+ +

+ string +

+
+

Control whether the attribute must exists or not.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

values

+ +

+ list + / elements=string +

+
+

Values for the attribute as list.

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+

auth_username

+ +

+ string +

+
+

Username to authenticate for API access with.

+
+
+
+

client_consents

+ +

aliases: clientConsents

+

+ list + / elements=dictionary +

+
+

Client Authenticator Type.

+

Default: []

+
+
+
+
+
+

client_id

+ +

aliases: clientId

+

+ string + / required +

+
+

Client ID of the client role. Not the technical ID of the client.

+
+
+
+

roles

+ +

+ list + / elements=string + / required +

+
+

List of client roles to assign to the user.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

credentials

+ +

+ list + / elements=dictionary +

+
+

User credentials.

+

Default: []

+
+
+

temporary

+ +

+ boolean +

+
+

If true, the users are required to reset their credentials at next login.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

type

+ +

+ string + / required +

+
+

Credential type.

+
+
+

value

+ +

+ string + / required +

+
+

Value of the credential.

+
+
+
+

disableable_credential_types

+ +

aliases: disableableCredentialTypes

+

+ list + / elements=string +

+
+

List user Credential Type.

+

Default: []

+
+
+

email

+ +

+ string +

+
+

User email.

+
+
+
+

email_verified

+ +

aliases: emailVerified

+

+ boolean +

+
+

Set or reset the emailVerified flag of the user.

+

When email_verified_behavior=no_defaults, the default value of this option becomes null and that causes the module not to change any existing value for that attribute.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

email_verified_behavior

+ +

+ string +

+

added in middleware_automation.keycloak 3.0.0

+
+

The email_verified option used to have a default value. This caused problems when the user expects different behavior from keycloak by default.

+

The default value of this option is compatibility, which will ensure that the old default value for email_verified is used.

+

When set to no_defaults, the module will not change existing values of email_verified if no value is specified.

+

Choices:

+
    +
  • "compatibility" ← (default)

  • +
  • "no_defaults"

  • +
+ +
+
+

enabled

+ +

+ boolean +

+
+

Enabled user.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

federated_identities

+ +

aliases: federatedIdentities

+

+ list + / elements=string +

+
+

List of IDPs of user.

+

Default: []

+
+ + +

federation_link

+ +

aliases: federationLink

+

+ string +

+
+

Federation Link.

+
+
+
+

first_name

+ +

aliases: firstName

+

+ string +

+
+

The user's first name.

+
+
+

force

+ +

+ boolean +

+
+

If true, allows to remove user and recreate it.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

groups

+ +

+ list + / elements=dictionary +

+
+

List of groups for the user.

+

Groups can be referenced by their name, like staff, or their path, like /staff/engineering. The path syntax allows you to reference subgroups, which is not possible otherwise.

+

Using the path is possible since middleware_automation.keycloak 3.0.0.

+

Default: []

+
+
+

name

+ +

+ string +

+
+

Name of the group.

+
+
+

state

+ +

+ string +

+
+

Control whether the user must be member of this group or not.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

id

+ +

+ string +

+
+

ID of the user on the Keycloak server if known.

+
+
+
+

last_name

+ +

aliases: lastName

+

+ string +

+
+

The user's last name.

+
+
+

origin

+ +

+ string +

+
+

User origin.

+
+
+

realm

+ +

+ string +

+
+

The name of the realm in which is the client.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+
+

required_actions

+ +

aliases: requiredActions

+

+ list + / elements=string +

+
+

Set or reset a user's required actions.

+
+
+

self

+ +

+ string +

+
+

User self administration.

+
+
+
+

service_account_client_id

+ +

aliases: serviceAccountClientId

+

+ string +

+
+

Description of the client Application.

+
+
+

state

+ +

+ string +

+
+

Control whether the user should exists or not.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

username

+ +

+ string + / required +

+
+

Username for the user.

+
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_user_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_user_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_user_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + +Notes +----- + +.. note:: + - The module does not modify the user ID of an existing user. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Create a user user1 + middleware_automation.keycloak.keycloak_user: + auth_keycloak_url: http://localhost:8080 + auth_username: admin + auth_password: password + realm: master + username: user1 + firstName: user1 + lastName: user1 + email: user1 + enabled: true + emailVerified: false + credentials: + - type: password + value: password + temporary: false + attributes: + - name: attr1 + values: + - value1 + state: present + - name: attr2 + values: + - value2 + state: absent + groups: + - name: group1 + state: present + state: present + + - name: Re-create a User + middleware_automation.keycloak.keycloak_user: + auth_keycloak_url: http://localhost:8080 + auth_username: admin + auth_password: password + realm: master + username: user1 + firstName: user1 + lastName: user1 + email: user1 + enabled: true + emailVerified: false + credentials: + - type: password + value: password + temporary: false + attributes: + - name: attr1 + values: + - value1 + state: present + - name: attr2 + values: + - value2 + state: absent + groups: + - name: group1 + state: present + state: present + + - name: Re-create a User + middleware_automation.keycloak.keycloak_user: + auth_keycloak_url: http://localhost:8080 + auth_username: admin + auth_password: password + realm: master + username: user1 + firstName: user1 + lastName: user1 + email: user1 + enabled: true + emailVerified: false + credentials: + - type: password + value: password + temporary: false + attributes: + - name: attr1 + values: + - value1 + state: present + - name: attr2 + values: + - value2 + state: absent + groups: + - name: group1 + state: present + state: present + force: true + + - name: Remove User + middleware_automation.keycloak.keycloak_user: + auth_keycloak_url: http://localhost:8080 + auth_username: admin + auth_password: password + realm: master + username: user1 + state: absent + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of the user after module execution.

+

Returned: on success

+
+
+

existing

+ +

+ dictionary +

+
+

Representation of the existing user.

+

Returned: on success

+
+
+

proposed

+ +

+ dictionary +

+
+

Representation of the proposed user.

+

Returned: on success

+
+
+

user_created

+ +

+ boolean +

+
+

Indicates whether a user was created.

+

Returned: in success

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Philippe Gauthier (@elfelip) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_user_execute_actions_email.rst.txt b/3.1.2/_sources/plugins/keycloak_user_execute_actions_email.rst.txt new file mode 100644 index 0000000..c1783e9 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_user_execute_actions_email.rst.txt @@ -0,0 +1,631 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_user_execute_actions_email_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_user_execute_actions_email -- Send a Keycloak execute\-actions email to a user ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_user_execute_actions_email`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Triggers the Keycloak endpoint :literal:`execute\-actions\-email` for a user. This sends an email with one or more required actions the user must complete (for example resetting the password). +- If no :ansopt:`middleware\_automation.keycloak.keycloak\_user\_execute\_actions\_email#module:actions` list is provided, the default action :literal:`UPDATE\_PASSWORD` is used. +- You must supply either the user's :ansopt:`middleware\_automation.keycloak.keycloak\_user\_execute\_actions\_email#module:id` or :ansopt:`middleware\_automation.keycloak.keycloak\_user\_execute\_actions\_email#module:username`. Supplying only :literal:`username` causes an extra lookup call. +- This module always reports :ansretval:`changed=true` because sending an email is a side effect and cannot be made idempotent. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

actions

+ +

+ list + / elements=string +

+
+

List of required actions to include in the email.

+

Default: ["UPDATE_PASSWORD"]

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+

auth_username

+ +

+ string +

+
+

Username to authenticate for API access with.

+
+
+
+

client_id

+ +

aliases: clientId

+

+ string +

+
+

Optional client ID used for the redirect link.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

id

+ +

+ string +

+
+

The unique ID (UUID) of the user.

+

Mutually exclusive with username.

+
+
+

lifespan

+ +

+ integer +

+
+

Optional lifespan (in seconds) for the action token (supported on newer Keycloak versions). Forwarded as query parameter if provided.

+
+
+

realm

+ +

+ string +

+
+

The Keycloak realm where the user resides.

+

Default: "master"

+
+
+
+

redirect_uri

+ +

aliases: redirectUri

+

+ string +

+
+

Optional redirect URI. Must be valid for the given client if client_id is set.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

username

+ +

+ string +

+
+

Username of the user.

+

Mutually exclusive with id.

+
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_user_execute_actions_email_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_user_execute_actions_email_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_user_execute_actions_email_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-none:`none` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Password reset email (default action) with 1h lifespan + middleware_automation.keycloak.keycloak_user_execute_actions_email: + username: johndoe + realm: MyRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: ADMIN + auth_password: SECRET + lifespan: 3600 + delegate_to: localhost + + - name: Multiple required actions using token auth + middleware_automation.keycloak.keycloak_user_execute_actions_email: + username: johndoe + actions: + - UPDATE_PASSWORD + - VERIFY_EMAIL + realm: MyRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + token: TOKEN + delegate_to: localhost + + - name: Email by user id with redirect + middleware_automation.keycloak.keycloak_user_execute_actions_email: + id: 9d59aa76-2755-48c6-b1af-beb70a82c3cd + client_id: my-frontend + redirect_uri: https://app.example.com/post-actions + actions: + - UPDATE_PASSWORD + realm: MyRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: ADMIN + auth_password: SECRET + delegate_to: localhost + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

actions

+ +

+ list + / elements=string +

+
+

List of actions included in the email.

+

Returned: success

+
+
+

user_id

+ +

+ string +

+
+

The user ID the email was (or would be, in check mode) sent to.

+

Returned: success

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Marius Bertram (@mariusbertram) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_user_federation.rst.txt b/3.1.2/_sources/plugins/keycloak_user_federation.rst.txt new file mode 100644 index 0000000..00c7363 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_user_federation.rst.txt @@ -0,0 +1,1677 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_user_federation -- Allows administration of Keycloak user federations using Keycloak API ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_user_federation`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows you to add, remove or modify Keycloak user federations using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin\-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles. +- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ `https://www.keycloak.org/docs\-api/20.0.2/rest\-api/index.html `__. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

bind_credential_update_mode

+ +

+ string +

+
+

The value of the config parameter config.bindCredential is redacted in the Keycloak responses. Comparing the redacted value with the desired value always evaluates to not equal. This means the before and desired states are never equal if the parameter is set.

+

Set to always to include config.bindCredential in the comparison of before and desired state. Because of the redacted value returned by Keycloak the module always detects a change and make an update if a config.bindCredential value is set.

+

Set to only_indirect to exclude config.bindCredential when comparing the before state with the desired state. The value of config.bindCredential is only updated if there are other changes to the user federation that require an update.

+

Choices:

+
    +
  • "always" ← (default)

  • +
  • "only_indirect"

  • +
+ +
+
+

config

+ +

+ dictionary +

+
+

Dict specifying the configuration options for the provider; the contents differ depending on the value of provider_id. Examples are given below for ldap, kerberos and sssd. It is easiest to obtain valid config values by dumping an already-existing user federation configuration through check-mode in the existing field.

+

The value sssd has been supported since middleware_automation.keycloak 4.2.0.

+
+
+

allowKerberosAuthentication

+ +

+ boolean +

+
+

Enable/disable HTTP authentication of users with SPNEGO/Kerberos tokens. The data about authenticated users is provisioned from this LDAP server.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

allowPasswordAuthentication

+ +

+ boolean +

+
+

Enable/disable possibility of username/password authentication against Kerberos database.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

authType

+ +

+ string +

+
+

Type of the Authentication method used during LDAP Bind operation. It is used in most of the requests sent to the LDAP server.

+

Choices:

+
    +
  • "none" ← (default)

  • +
  • "simple"

  • +
+ +
+
+

batchSizeForSync

+ +

+ integer +

+
+

Count of LDAP users to be imported from LDAP to Keycloak within a single transaction.

+

Default: 1000

+
+
+

bindCredential

+ +

+ string +

+
+

Password of LDAP admin.

+
+
+

bindDn

+ +

+ string +

+
+

DN of LDAP user which is used by Keycloak to access LDAP server.

+
+
+

cachePolicy

+ +

+ string +

+
+

Cache Policy for this storage provider.

+

Choices:

+
    +
  • "DEFAULT" ← (default)

  • +
  • "EVICT_DAILY"

  • +
  • "EVICT_WEEKLY"

  • +
  • "MAX_LIFESPAN"

  • +
  • "NO_CACHE"

  • +
+ +
+
+

changedSyncPeriod

+ +

+ integer +

+
+

Period for synchronization of changed or newly created LDAP users in seconds.

+

Default: -1

+
+
+

connectionPooling

+ +

+ boolean +

+
+

Determines if Keycloak should use connection pooling for accessing LDAP server.

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

connectionPoolingAuthentication

+ +

+ string +

+
+

A list of space-separated authentication types of connections that may be pooled.

+

Choices:

+
    +
  • "none"

  • +
  • "simple"

  • +
  • "DIGEST-MD5"

  • +
+ +
+
+

connectionPoolingDebug

+ +

+ string +

+
+

A string that indicates the level of debug output to produce. Example valid values are fine (trace connection creation and removal) and all (all debugging information).

+
+
+

connectionPoolingInitSize

+ +

+ integer +

+
+

The number of connections per connection identity to create when initially creating a connection for the identity.

+
+
+

connectionPoolingMaxSize

+ +

+ integer +

+
+

The maximum number of connections per connection identity that can be maintained concurrently.

+
+
+

connectionPoolingPrefSize

+ +

+ integer +

+
+

The preferred number of connections per connection identity that should be maintained concurrently.

+
+
+

connectionPoolingProtocol

+ +

+ string +

+
+

A list of space-separated protocol types of connections that may be pooled. Valid types are plain and ssl.

+
+
+

connectionPoolingTimeout

+ +

+ integer +

+
+

The number of milliseconds that an idle connection may remain in the pool without being closed and removed from the pool.

+
+
+

connectionTimeout

+ +

+ integer +

+
+

LDAP Connection Timeout in milliseconds.

+
+
+

connectionUrl

+ +

+ string +

+
+

Connection URL to your LDAP server.

+
+
+

customUserSearchFilter

+ +

+ string +

+
+

Additional LDAP Filter for filtering searched users. Leave this empty if you do not need additional filter.

+
+
+

debug

+ +

+ boolean +

+
+

Enable/disable debug logging to standard output for Krb5LoginModule.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

editMode

+ +

+ string +

+
+

READ_ONLY is a read-only LDAP store. WRITABLE means data is synced back to LDAP on demand. UNSYNCED means user data is imported, but not synced back to LDAP.

+

Choices:

+
    +
  • "READ_ONLY"

  • +
  • "WRITABLE"

  • +
  • "UNSYNCED"

  • +
+ +
+
+

enabled

+ +

+ boolean +

+
+

Enable/disable this user federation.

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

evictionDay

+ +

+ string +

+
+

Day of the week the entry is set to become invalid on.

+
+
+

evictionHour

+ +

+ string +

+
+

Hour of day the entry is set to become invalid on.

+
+
+

evictionMinute

+ +

+ string +

+
+

Minute of day the entry is set to become invalid on.

+
+
+

fullSyncPeriod

+ +

+ integer +

+
+

Period for full synchronization in seconds.

+

Default: -1

+
+
+

importEnabled

+ +

+ boolean +

+
+

If true, LDAP users are imported into Keycloak DB and synced by the configured sync policies.

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

kerberosRealm

+ +

+ string +

+
+

Name of kerberos realm.

+
+
+

keyTab

+ +

+ string +

+
+

Location of Kerberos KeyTab file containing the credentials of server principal. For example /etc/krb5.keytab.

+
+
+

krbPrincipalAttribute

+ +

+ string +

+
+

Name of the LDAP attribute, which refers to Kerberos principal. This is used to lookup appropriate LDAP user after successful Kerberos/SPNEGO authentication in Keycloak. When this is empty, the LDAP user is looked up based on LDAP username corresponding to the first part of his Kerberos principal. For instance, for principal john@KEYCLOAK.ORG, it assumes that LDAP username is john.

+
+
+

maxLifespan

+ +

+ integer +

+
+

Max lifespan of cache entry in milliseconds.

+
+
+

pagination

+ +

+ boolean +

+
+

Does the LDAP server support pagination.

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

priority

+ +

+ integer +

+
+

Priority of provider when doing a user lookup. Lowest first.

+

Default: 0

+
+
+

rdnLDAPAttribute

+ +

+ string +

+
+

Name of LDAP attribute, which is used as RDN (top attribute) of typical user DN. Usually it is the same as Username LDAP attribute, however it is not required. For example for Active directory, it is common to use cn as RDN attribute when username attribute might be sAMAccountName.

+
+
+

readTimeout

+ +

+ integer +

+
+

LDAP Read Timeout in milliseconds. This timeout applies for LDAP read operations.

+
+
+

referral

+ +

+ string +

+
+

Specifies if LDAP referrals should be followed or ignored. Please note that enabling referrals can slow down authentication as it allows the LDAP server to decide which other LDAP servers to use. This could potentially include untrusted servers.

+

Choices:

+
    +
  • "ignore"

  • +
  • "follow"

  • +
+ +
+
+

searchScope

+ +

+ string +

+
+

For one level, the search applies only for users in the DNs specified by User DNs. For subtree, the search applies to the whole subtree. See LDAP documentation for more details.

+

Choices:

+
    +
  • "1" ← (default)

  • +
  • "2"

  • +
+ +
+
+

serverPrincipal

+ +

+ string +

+
+

Full name of server principal for HTTP service including server and domain name. For example HTTP/host.foo.org@FOO.ORG. Use * to accept any service principal in the KeyTab file.

+
+
+

startTls

+ +

+ boolean +

+
+

Encrypts the connection to LDAP using STARTTLS, which disables connection pooling.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

syncRegistrations

+ +

+ boolean +

+
+

Should newly created users be created within LDAP store? Priority effects which provider is chosen to sync the new user.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

trustEmail

+ +

+ boolean +

+
+

If enabled, email provided by this provider is not verified even if verification is enabled for the realm.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

updateProfileFirstLogin

+ +

+ boolean +

+
+

Update profile on first login.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

useKerberosForPasswordAuthentication

+ +

+ boolean +

+
+

Use Kerberos login module for authenticate username/password against Kerberos server instead of authenticating against LDAP server with Directory Service API.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

usePasswordModifyExtendedOp

+ +

+ boolean +

+
+

Use the LDAPv3 Password Modify Extended Operation (RFC-3062). The password modify extended operation usually requires that LDAP user already has password in the LDAP server. So when this is used with 'Sync Registrations', it can be good to add also 'Hardcoded LDAP attribute mapper' with randomly generated initial password.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

usernameLDAPAttribute

+ +

+ string +

+
+

Name of LDAP attribute, which is mapped as Keycloak username. For many LDAP server vendors it can be uid. For Active directory it can be sAMAccountName or cn. The attribute should be filled for all LDAP user records you want to import from LDAP to Keycloak.

+
+
+

userObjectClasses

+ +

+ string +

+
+

All values of LDAP objectClass attribute for users in LDAP divided by comma. For example inetOrgPerson, organizationalPerson. Newly created Keycloak users are written to LDAP with all those object classes and existing LDAP user records are found just if they contain all those object classes.

+
+
+

usersDn

+ +

+ string +

+
+

Full DN of LDAP tree where your users are. This DN is the parent of LDAP users.

+
+
+

useTruststoreSpi

+ +

+ string +

+
+

Specifies whether LDAP connection uses the truststore SPI with the truststore configured in standalone.xml/domain.xml. always means that it always uses it. never means that it does not use it. ldapsOnly means that it uses if your connection URL use ldaps.

+

Note even if standalone.xml/domain.xml is not configured, the default Java cacerts or certificate specified by javax.net.ssl.trustStore property is used.

+

Choices:

+
    +
  • "always"

  • +
  • "ldapsOnly" ← (default)

  • +
  • "never"

  • +
+ +
+
+

uuidLDAPAttribute

+ +

+ string +

+
+

Name of LDAP attribute, which is used as unique object identifier (UUID) for objects in LDAP. For many LDAP server vendors, it is entryUUID; however some are different. For example for Active directory it should be objectGUID. If your LDAP server does not support the notion of UUID, you can use any other attribute that is supposed to be unique among LDAP users in tree.

+
+
+

validatePasswordPolicy

+ +

+ boolean +

+
+

Determines if Keycloak should validate the password with the realm password policy before updating it.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

vendor

+ +

+ string +

+
+

LDAP vendor (provider).

+

Use short name. For instance, write rhds for "Red Hat Directory Server".

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

id

+ +

+ string +

+
+

The unique ID for this user federation. If left empty, the user federation is searched by its name.

+
+
+

mappers

+ +

+ list + / elements=dictionary +

+
+

A list of dicts defining mappers associated with this Identity Provider.

+
+
+

config

+ +

+ dictionary +

+
+

Dict specifying the configuration options for the mapper; the contents differ depending on the value of identityProviderMapper.

+
+
+

id

+ +

+ string +

+
+

Unique ID of this mapper.

+
+
+

name

+ +

+ string +

+
+

Name of the mapper. If no ID is given, the mapper is searched by name.

+
+
+

parentId

+ +

+ string +

+
+

Unique ID for the parent of this mapper. ID of the user federation is automatically used if left blank.

+
+
+

providerId

+ +

+ string +

+
+

The mapper type for this mapper (for instance user-attribute-ldap-mapper).

+
+
+

providerType

+ +

+ string +

+
+

Component type for this mapper.

+

Default: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"

+
+
+

name

+ +

+ string +

+
+

Display name of provider when linked in admin console.

+
+
+
+

parent_id

+ +

aliases: parentId

+

+ string +

+
+

Unique ID for the parent of this user federation. Realm ID is automatically used if left blank.

+
+
+
+

provider_id

+ +

aliases: providerId

+

+ string +

+
+

Provider for this user federation. Built-in providers are ldap, kerberos, and sssd. Custom user storage providers can also be used.

+
+
+
+

provider_type

+ +

aliases: providerType

+

+ string +

+
+

Component type for user federation (only supported value is org.keycloak.storage.UserStorageProvider).

+

Default: "org.keycloak.storage.UserStorageProvider"

+
+
+

realm

+ +

+ string +

+
+

The Keycloak realm under which this user federation resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

remove_unspecified_mappers

+ +

+ boolean +

+
+

Remove mappers that are not specified in the configuration for this federation.

+

Set to false to keep mappers that are not listed in mappers.

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

state

+ +

+ string +

+
+

State of the user federation.

+

On present, the user federation is created if it does not yet exist, or updated with the parameters you provide.

+

On absent, the user federation is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Create LDAP user federation + middleware_automation.keycloak.keycloak_user_federation: + auth_keycloak_url: https://keycloak.example.com + auth_realm: master + auth_username: admin + auth_password: password + realm: my-realm + name: my-ldap + state: present + provider_id: ldap + provider_type: org.keycloak.storage.UserStorageProvider + config: + priority: 0 + enabled: true + cachePolicy: DEFAULT + batchSizeForSync: 1000 + editMode: READ_ONLY + importEnabled: true + syncRegistrations: false + vendor: other + usernameLDAPAttribute: uid + rdnLDAPAttribute: uid + uuidLDAPAttribute: entryUUID + userObjectClasses: inetOrgPerson, organizationalPerson + connectionUrl: ldaps://ldap.example.com:636 + usersDn: ou=Users,dc=example,dc=com + authType: simple + bindDn: cn=directory reader + bindCredential: password + searchScope: 1 + validatePasswordPolicy: false + trustEmail: false + useTruststoreSpi: ldapsOnly + connectionPooling: true + pagination: true + allowKerberosAuthentication: false + debug: false + useKerberosForPasswordAuthentication: false + mappers: + - name: "full name" + providerId: "full-name-ldap-mapper" + providerType: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper" + config: + ldap.full.name.attribute: cn + read.only: true + write.only: false + + - name: Create Kerberos user federation + middleware_automation.keycloak.keycloak_user_federation: + auth_keycloak_url: https://keycloak.example.com + auth_realm: master + auth_username: admin + auth_password: password + realm: my-realm + name: my-kerberos + state: present + provider_id: kerberos + provider_type: org.keycloak.storage.UserStorageProvider + config: + priority: 0 + enabled: true + cachePolicy: DEFAULT + kerberosRealm: EXAMPLE.COM + serverPrincipal: HTTP/host.example.com@EXAMPLE.COM + keyTab: keytab + allowPasswordAuthentication: false + updateProfileFirstLogin: false + + - name: Create sssd user federation + middleware_automation.keycloak.keycloak_user_federation: + auth_keycloak_url: https://keycloak.example.com + auth_realm: master + auth_username: admin + auth_password: password + realm: my-realm + name: my-sssd + state: present + provider_id: sssd + provider_type: org.keycloak.storage.UserStorageProvider + config: + priority: 0 + enabled: true + cachePolicy: DEFAULT + + - name: Delete user federation + middleware_automation.keycloak.keycloak_user_federation: + auth_keycloak_url: https://keycloak.example.com + auth_realm: master + auth_username: admin + auth_password: password + realm: my-realm + name: my-federation + state: absent + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of user federation after module execution.

+

Returned: on success

+

Sample: {"config": {"allowPasswordAuthentication": "false", "cachePolicy": "DEFAULT", "enabled": "true", "kerberosRealm": "EXAMPLE.COM", "keyTab": "/etc/krb5.keytab", "priority": "0", "serverPrincipal": "HTTP/host.example.com@EXAMPLE.COM", "updateProfileFirstLogin": "false"}, "id": "cf52ae4f-4471-4435-a0cf-bb620cadc122", "mappers": [], "name": "kerberos", "parentId": "myrealm", "providerId": "kerberos", "providerType": "org.keycloak.storage.UserStorageProvider"}

+
+
+

existing

+ +

+ dictionary +

+
+

Representation of existing user federation.

+

Returned: always

+

Sample: {"config": {"allowKerberosAuthentication": "false", "authType": "simple", "batchSizeForSync": "1000", "bindCredential": "**********", "bindDn": "cn=directory reader", "cachePolicy": "DEFAULT", "changedSyncPeriod": "-1", "connectionPooling": "true", "connectionUrl": "ldaps://ldap.example.com:636", "debug": "false", "editMode": "READ_ONLY", "enabled": "true", "fullSyncPeriod": "-1", "importEnabled": "true", "pagination": "true", "priority": "0", "rdnLDAPAttribute": "uid", "searchScope": "1", "syncRegistrations": "false", "trustEmail": "false", "useKerberosForPasswordAuthentication": "false", "useTruststoreSpi": "ldapsOnly", "userObjectClasses": "inetOrgPerson, organizationalPerson", "usernameLDAPAttribute": "uid", "usersDn": "ou=Users,dc=example,dc=com", "uuidLDAPAttribute": "entryUUID", "validatePasswordPolicy": "false", "vendor": "other"}, "id": "01122837-9047-4ae4-8ca0-6e2e891a765f", "mappers": [{"config": {"always.read.value.from.ldap": "false", "is.mandatory.in.ldap": "false", "ldap.attribute": "mail", "read.only": "true", "user.model.attribute": "email"}, "id": "17d60ce2-2d44-4c2c-8b1f-1fba601b9a9f", "name": "email", "parentId": "01122837-9047-4ae4-8ca0-6e2e891a765f", "providerId": "user-attribute-ldap-mapper", "providerType": "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"}], "name": "myfed", "parentId": "myrealm", "providerId": "ldap", "providerType": "org.keycloak.storage.UserStorageProvider"}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: "No changes required to user federation 164bb483-c613-482e-80fe-7f1431308799."

+
+
+

proposed

+ +

+ dictionary +

+
+

Representation of proposed user federation.

+

Returned: always

+

Sample: {"config": {"allowKerberosAuthentication": "false", "authType": "simple", "batchSizeForSync": "1000", "bindCredential": "**********", "bindDn": "cn=directory reader", "cachePolicy": "DEFAULT", "connectionPooling": "true", "connectionUrl": "ldaps://ldap.example.com:636", "debug": "false", "editMode": "READ_ONLY", "enabled": "true", "importEnabled": "true", "pagination": "true", "priority": "0", "rdnLDAPAttribute": "uid", "searchScope": "1", "syncRegistrations": "false", "trustEmail": "false", "useKerberosForPasswordAuthentication": "false", "useTruststoreSpi": "ldapsOnly", "userObjectClasses": "inetOrgPerson, organizationalPerson", "usernameLDAPAttribute": "uid", "usersDn": "ou=Users,dc=example,dc=com", "uuidLDAPAttribute": "entryUUID", "validatePasswordPolicy": "false", "vendor": "other"}, "name": "ldap", "providerId": "ldap", "providerType": "org.keycloak.storage.UserStorageProvider"}

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Laurent Paumier (@laurpaum) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_user_rolemapping.rst.txt b/3.1.2/_sources/plugins/keycloak_user_rolemapping.rst.txt new file mode 100644 index 0000000..47e98c0 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_user_rolemapping.rst.txt @@ -0,0 +1,767 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_user_rolemapping_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_user_rolemapping -- Allows administration of Keycloak user\_rolemapping with the Keycloak API +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_user_rolemapping`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows you to add, remove or modify Keycloak user\_rolemapping with the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin\-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles. +- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ `https://www.keycloak.org/docs\-api/latest/rest\-api/index.html `__. +- Attributes are multi\-valued in the Keycloak API. All attributes are lists of individual values and are returned that way by this module. You may pass single values for attributes when calling the module, and this is translated into a list suitable for the API. +- When updating a user\_rolemapping, where possible provide the role ID to the module. This removes a lookup to the API to translate the name into the role ID. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

cid

+ +

+ string +

+
+

ID of the client whose role is to be mapped.

+

This parameter is not required for updating or deleting the rolemapping but providing it reduces the number of API calls required.

+

If neither cid nor client_id is specified, a realm role is mapped instead.

+
+
+

client_id

+ +

+ string +

+
+

Name of the client (different than cid) whose role is to be mapped.

+

This parameter is required if cid is not provided (can be replaced by cid to reduce the number of API calls that must be made).

+

If neither cid nor client_id is specified, a realm role is mapped instead.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

realm

+ +

+ string +

+
+

They Keycloak realm under which this role_representation resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

roles

+ +

+ list + / elements=dictionary +

+
+

Roles to be mapped to the user.

+
+
+

id

+ +

+ string +

+
+

The unique identifier for this role_representation.

+

This parameter is not required for updating or deleting a role_representation but providing it reduces the number of API calls required.

+
+
+

name

+ +

+ string +

+
+

Name of the role representation.

+

This parameter is required only when creating or updating the role_representation.

+
+
+

service_account_user_client_id

+ +

+ string +

+
+

Client ID of the service-account-user to be mapped.

+

This parameter is not required for updating or deleting the rolemapping but providing it reduces the number of API calls required.

+
+
+

state

+ +

+ string +

+
+

State of the user_rolemapping.

+

On present, the user_rolemapping is created if it does not yet exist, or updated with the parameters you provide.

+

On absent, the user_rolemapping is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

target_username

+ +

+ string +

+
+

Username of the user roles are mapped to.

+

This parameter is not required (can be replaced by uid for less API call).

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

uid

+ +

+ string +

+
+

ID of the user to be mapped.

+

This parameter is not required for updating or deleting the rolemapping but providing it reduces the number of API calls required.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_user_rolemapping_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_user_rolemapping_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_user_rolemapping_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Map a realm role to a user, authentication with credentials + middleware_automation.keycloak.keycloak_user_rolemapping: + realm: MyCustomRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + state: present + uid: user_uid + roles: + - name: role_name1 + id: role_id1 + - name: role_name2 + id: role_id2 + delegate_to: localhost + + - name: Map a client role to a user, authentication with credentials + middleware_automation.keycloak.keycloak_user_rolemapping: + realm: MyCustomRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + state: present + client_id: client1 + uid: user_uid + roles: + - name: role_name1 + id: role_id1 + - name: role_name2 + id: role_id2 + delegate_to: localhost + + - name: Map a client role to a service account user for a client, authentication with credentials + middleware_automation.keycloak.keycloak_user_rolemapping: + realm: MyCustomRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + state: present + client_id: client1 + service_account_user_client_id: clientIdOfServiceAccount + roles: + - name: role_name1 + id: role_id1 + - name: role_name2 + id: role_id2 + delegate_to: localhost + + - name: Map a client role to a user, authentication with token + middleware_automation.keycloak.keycloak_user_rolemapping: + realm: MyCustomRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + token: TOKEN + state: present + client_id: client1 + target_username: user1 + roles: + - name: role_name1 + id: role_id1 + - name: role_name2 + id: role_id2 + delegate_to: localhost + + - name: Unmap client role from a user + middleware_automation.keycloak.keycloak_user_rolemapping: + realm: MyCustomRealm + auth_client_id: admin-cli + auth_keycloak_url: https://auth.example.com + auth_realm: master + auth_username: USERNAME + auth_password: PASSWORD + state: absent + client_id: client1 + uid: 70e3ae72-96b6-11e6-9056-9737fd4d0764 + roles: + - name: role_name1 + id: role_id1 + - name: role_name2 + id: role_id2 + delegate_to: localhost + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of client role mapping after module execution.

+

The sample is truncated.

+

Returned: on success

+

Sample: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}

+
+
+

existing

+ +

+ dictionary +

+
+

Representation of existing client role mapping.

+

The sample is truncated.

+

Returned: always

+

Sample: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: "Role role1 assigned to user user1."

+
+
+

proposed

+ +

+ dictionary +

+
+

Representation of proposed client role mapping.

+

Returned: always

+

Sample: {"clientId": "test"}

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Dušan Marković (@bratwurzt) +- Ivan Kokalović (@koke1997) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/plugins/keycloak_userprofile.rst.txt b/3.1.2/_sources/plugins/keycloak_userprofile.rst.txt new file mode 100644 index 0000000..91305c3 --- /dev/null +++ b/3.1.2/_sources/plugins/keycloak_userprofile.rst.txt @@ -0,0 +1,1326 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.27.0 + +.. Anchors + +.. _ansible_collections.middleware_automation.keycloak.keycloak_userprofile_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +keycloak_userprofile -- Allows managing Keycloak User Profiles +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `middleware_automation.keycloak collection `_. + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`. + + To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_userprofile`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in middleware\_automation.keycloak 3.0.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This module allows you to create, update, or delete Keycloak User Profiles using the Keycloak API. You can also customize the "Unmanaged Attributes" with it. +- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ `https://www.keycloak.org/docs\-api/24.0.5/rest\-api/index.html `__. For compatibility reasons, the module also accepts the camelCase versions of the options. + + +.. Aliases + + +.. Requirements + + + + + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

config

+ +

+ dictionary +

+
+

The configuration of the User Profile Provider.

+
+
+
+

kc_user_profile_config

+ +

aliases: kcUserProfileConfig

+

+ list + / elements=dictionary +

+
+

Define a declarative User Profile. See EXAMPLES for more context.

+
+
+
+

attributes

+ +

+ list + / elements=dictionary +

+
+

A list of attributes to be included in the User Profile.

+
+
+
+

annotations

+ +

+ dictionary +

+
+

Annotations for the attribute.

+
+
+
+
+
+

display_name

+ +

aliases: displayName

+

+ string + / required +

+
+

The display name of the attribute.

+
+
+
+

group

+ +

+ string +

+
+

Specifies the User Profile group where this attribute is added.

+
+
+
+

multivalued

+ +

+ boolean +

+
+

Whether the attribute can have multiple values.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+
+

name

+ +

+ string + / required +

+
+

The name of the attribute.

+
+
+
+

permissions

+ +

+ dictionary +

+
+

The permissions for viewing and editing the attribute.

+
+
+
+

edit

+ +

+ list + / elements=string +

+
+

The roles that can edit the attribute.

+

Supported values are admin and user.

+

Default: ["admin", "user"]

+
+
+
+

view

+ +

+ list + / elements=string +

+
+

The roles that can view the attribute.

+

Supported values are admin and user.

+

Default: ["admin", "user"]

+
+
+
+

required

+ +

+ dictionary +

+
+

The roles that require this attribute.

+
+
+
+

roles

+ +

+ list + / elements=string +

+
+

The roles for which this attribute is required.

+

Supported values are admin and user.

+

Default: ["user"]

+
+
+
+

selector

+ +

+ dictionary +

+
+

Selector when the attribute should be added.

+
+
+
+

scopes

+ +

+ list + / elements=string +

+
+

Scopes to which the attribute should be added.

+
+
+
+

validations

+ +

+ dictionary +

+
+

The validations to be applied to the attribute.

+
+
+
+

double

+ +

+ dictionary +

+
+

The double validation for the attribute.

+
+
+
+

email

+ +

+ dictionary +

+
+

The email validation for the attribute.

+
+
+
+

integer

+ +

+ dictionary +

+
+

The integer validation for the attribute.

+
+
+
+
+
+

iso_date

+ +

aliases: isoDate

+

+ dictionary +

+
+

The iso-date validation for the attribute.

+
+
+
+

length

+ +

+ dictionary +

+
+

The length validation for the attribute.

+
+
+
+

max

+ +

+ integer + / required +

+
+

The maximum length of the attribute.

+
+
+
+

min

+ +

+ integer +

+
+

The minimum length of the attribute.

+
+
+
+
+
+

local_date

+ +

aliases: localDate

+

+ dictionary +

+
+

The local-date validation for the attribute.

+
+
+
+

multivalued

+ +

+ dictionary +

+
+

The multivalued validation for the attribute.

+
+
+
+

max

+ +

+ integer + / required +

+
+

The maximum amount of values of the attribute.

+
+
+
+

min

+ +

+ integer +

+
+

The minimum amount of values of the attribute.

+
+
+
+

options

+ +

+ dictionary +

+
+

Validation to ensure the attribute matches one of the provided options.

+
+
+
+

pattern

+ +

+ dictionary +

+
+

The pattern validation for the attribute using regular expressions.

+
+
+
+
+
+

person_name_prohibited_characters

+ +

aliases: personNameProhibitedCharacters

+

+ dictionary +

+
+

The prohibited characters validation for person name attributes.

+
+
+
+
+
+

up_username_not_idn_homograph

+ +

aliases: upUsernameNotIdnHomograph

+

+ dictionary +

+
+

The validation to prevent IDN homograph attacks in usernames.

+
+
+
+

uri

+ +

+ dictionary +

+
+

The URI validation for the attribute.

+
+
+
+
+
+

username_prohibited_characters

+ +

aliases: usernameProhibitedCharacters

+

+ dictionary +

+
+

The prohibited characters validation for the username attribute.

+
+
+
+

groups

+ +

+ list + / elements=dictionary +

+
+

A list of attribute groups to be included in the User Profile.

+
+
+
+

annotations

+ +

+ dictionary +

+
+

The annotations included in the group.

+
+
+
+
+
+

display_description

+ +

aliases: displayDescription

+

+ string +

+
+

The display description for the group.

+
+
+
+
+
+

display_header

+ +

aliases: displayHeader

+

+ string + / required +

+
+

The display header for the group.

+
+
+
+

name

+ +

+ string + / required +

+
+

The name of the group.

+
+
+
+
+
+

unmanaged_attribute_policy

+ +

aliases: unmanagedAttributePolicy

+

+ string +

+
+

Policy for unmanaged attributes.

+

Choices:

+
    +
  • "ENABLED"

  • +
  • "ADMIN_EDIT"

  • +
  • "ADMIN_VIEW"

  • +
+ +
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+
+
+

parent_id

+ +

aliases: parentId, realm

+

+ string + / required +

+
+

The parent ID of the realm key. In practice the ID (name) of the realm.

+
+
+
+

provider_id

+ +

aliases: providerId

+

+ string +

+
+

The name of the provider ID for the key (supported value is declarative-user-profile).

+

Choices:

+
    +
  • "declarative-user-profile" ← (default)

  • +
+ +
+
+
+

provider_type

+ +

aliases: providerType

+

+ string +

+
+

Component type for User Profile (only supported value is org.keycloak.userprofile.UserProfileProvider).

+

Choices:

+
    +
  • "org.keycloak.userprofile.UserProfileProvider" ← (default)

  • +
+ +
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

State of the User Profile provider.

+

On present, the User Profile provider is created if it does not yet exist, or updated with the parameters you provide.

+

On absent, the User Profile provider is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+ + + +.. Attributes + + +Attributes +---------- + +.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Attribute + - Support + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_userprofile_module__attribute-action_group: + + .. rst-class:: ansible-option-title + + **action_group** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` + + :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_userprofile_module__attribute-check_mode: + + .. rst-class:: ansible-option-title + + **check_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Can run in :literal:`check\_mode` and return changed status prediction without modifying target. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.middleware_automation.keycloak.keycloak_userprofile_module__attribute-diff_mode: + + .. rst-class:: ansible-option-title + + **diff_mode** + + .. raw:: html + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. + + + .. raw:: html + +
+ + + +.. Notes + +Notes +----- + +.. note:: + - Currently, only a single :ansval:`declarative\-user\-profile` entry is supported for :ansopt:`middleware\_automation.keycloak.keycloak\_userprofile#module:provider\_id` (design of the Keyckoak API). However, there can be multiple :ansopt:`middleware\_automation.keycloak.keycloak\_userprofile#module:config.kc\_user\_profile\_config[].attributes[]` entries. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: Create a Declarative User Profile with default settings + middleware_automation.keycloak.keycloak_userprofile: + state: present + parent_id: master + config: + kc_user_profile_config: + - attributes: + - name: username + displayName: ${username} + validations: + length: + min: 3 + max: 255 + username_prohibited_characters: {} + up_username_not_idn_homograph: {} + annotations: {} + permissions: + view: + - admin + - user + edit: [] + multivalued: false + - name: email + displayName: ${email} + validations: + email: {} + length: + max: 255 + annotations: {} + required: + roles: + - user + permissions: + view: + - admin + - user + edit: [] + multivalued: false + - name: firstName + displayName: ${firstName} + validations: + length: + max: 255 + person_name_prohibited_characters: {} + annotations: {} + required: + roles: + - user + permissions: + view: + - admin + - user + edit: [] + multivalued: false + - name: lastName + displayName: ${lastName} + validations: + length: + max: 255 + person_name_prohibited_characters: {} + annotations: {} + required: + roles: + - user + permissions: + view: + - admin + - user + edit: [] + multivalued: false + - name: testAttribute + displayName: ${testAttribute} + validations: + integer: + min: 0 + max: 255 + annotations: {} + required: + roles: + - user + permissions: + view: + - admin + - user + edit: [] + multivalued: false + groups: + - name: user-metadata + displayHeader: User metadata + displayDescription: Attributes, which refer to user metadata + annotations: {} + + - name: Delete a Keycloak User Profile Provider + keycloak_userprofile: + state: absent + parent_id: master + + # Unmanaged attributes are user attributes not explicitly defined in the User Profile + # configuration. By default, unmanaged attributes are "Disabled" and are not + # available from any context such as registration, account, and the + # administration console. By setting "Enabled", unmanaged attributes are fully + # recognized by the server and accessible through all contexts, useful if you are + # starting migrating an existing realm to the declarative User Profile + # and you don't have yet all user attributes defined in the User Profile configuration. + - name: Enable Unmanaged Attributes + middleware_automation.keycloak.keycloak_userprofile: + state: present + parent_id: master + config: + kc_user_profile_config: + - unmanagedAttributePolicy: ENABLED + + # By setting "Only administrators can write", unmanaged attributes can be managed + # only through the administration console and API, useful if you have already + # defined any custom attribute that can be managed by users but you are unsure + # about adding other attributes that should only be managed by administrators. + - name: Enable ADMIN_EDIT on Unmanaged Attributes + middleware_automation.keycloak.keycloak_userprofile: + state: present + parent_id: master + config: + kc_user_profile_config: + - unmanagedAttributePolicy: ADMIN_EDIT + + # By setting `Only administrators can view`, unmanaged attributes are read-only + # and only available through the administration console and API. + - name: Enable ADMIN_VIEW on Unmanaged Attributes + middleware_automation.keycloak.keycloak_userprofile: + state: present + parent_id: master + config: + kc_user_profile_config: + - unmanagedAttributePolicy: ADMIN_VIEW + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

data

+ +

+ dictionary +

+
+

The data returned by the Keycloak API.

+

Returned: when state is present

+
+
+

msg

+ +

+ string +

+
+

The output message generated by the module.

+

Returned: always

+

Sample: "UserProfileProvider created successfully"

+
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Eike Waldt (@yeoldegrove) + + +.. Extra links + + +.. Parsing errors diff --git a/3.1.2/_sources/releasing.md.txt b/3.1.2/_sources/releasing.md.txt new file mode 100644 index 0000000..537ba1e --- /dev/null +++ b/3.1.2/_sources/releasing.md.txt @@ -0,0 +1,61 @@ +# Collection Versioning Strategy + +Each supported collection maintained by Ansible follows Semantic Versioning 2.0.0 (https://semver.org/), for example: +Given a version number MAJOR.MINOR.PATCH, the following is incremented: + +MAJOR version: when making incompatible API changes (see Feature Release scenarios below for examples) + +MINOR version: when adding features or functionality in a backwards compatible manner, or updating testing matrix and/or metadata (deprecation) + +PATCH version: when adding backwards compatible bug fixes or security fixes (strict). + +Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format. + +The first version of a generally available supported collection on Ansible Automation Hub shall be version 1.0.0. NOTE: By default, all newly created collections may begin with a smaller default version of 0.1.0, and therefore a version of 1.0.0 should be explicitly stated by the collection maintainer. + +## New content is added to an existing collection + +Assuming the current release is 1.0.0, and a new module is ready to be added to the collection, the minor version would be incremented to 1.1.0. The change in the MINOR version indicates an additive change was made while maintaining backward compatibility for existing content within the collection. + + +## New feature to existing plugin or role within a collection (backwards compatible) + +Assuming the current release is 1.0.0, and new features for an existing module are ready for release . We would increment the MINOR version to 1.1.0. The change in the MINOR version indicates an additive change was made while maintaining backward compatibility for existing content within the collection. + + +## Bug fix or security fix to existing content within a collection + +Assuming the current release is 1.0.0 and a bug is fixed prior to the next minor release, the PATCH version would be incremented to 1.0.1. The patch indicates only a bug was fixed within a current version. The PATCH release does not contain new content, nor was functionality removed. Bug fixes may be included in a MINOR or MAJOR feature release if the timing allows, eliminating the need for a PATCH dedicated to the fix. + + +## Breaking change to any content within a collection + +Assuming the current release is 1.0.0, and a breaking change (API or module) is introduced for a user or developer. The MAJOR version would be incremented to 2.0.0. + +Examples of breaking changes within a collection may include but are not limited to: + + - Argspec changes for a module that require either inventory structure or playbook changes. + - A change in the shape of either the inbound or returned payload of a filter plugin. + - Changes to a connection plugin that require additional inventory parameters or ansible.cfg entries. + - New functionality added to a module that changes the outcome of that module as released in previous versions. + - The removal of plugins from a collection. + + +## Content removed from a collection + +Deleting a module or API is a breaking change. Please see the 'Breaking change' section for how to version this. + + +## A typographical error was fixed in the documentation for a collection + +A correction to the README would be considered a bug fix and the PATCH incremented. See 'Bug fix' above. + + +## Documentation added/removed/modified within a collection + +Only the PATCH version should be increased for a release that contains changes limited to revised documentation. + + +## Release automation + +New releases are triggered by annotated git tags named after semantic versioning. The automation publishes the built artifacts to ansible-galaxy and github releases page. diff --git a/3.1.2/_sources/roles/index.rst.txt b/3.1.2/_sources/roles/index.rst.txt new file mode 100644 index 0000000..cad570c --- /dev/null +++ b/3.1.2/_sources/roles/index.rst.txt @@ -0,0 +1,7 @@ +Role Index +========== + +.. toctree:: + keycloak + keycloak_quarkus + keycloak_realm diff --git a/3.1.2/_sources/roles/keycloak.md.txt b/3.1.2/_sources/roles/keycloak.md.txt new file mode 100644 index 0000000..f3c8d82 --- /dev/null +++ b/3.1.2/_sources/roles/keycloak.md.txt @@ -0,0 +1,216 @@ +keycloak +======== + +Install [keycloak](https://keycloak.org/) or [Red Hat Single Sign-On](https://access.redhat.com/products/red-hat-single-sign-on) server configurations. + + +Requirements +------------ + +This role requires the `python3-netaddr` library installed on the controller node. + +* to install via yum/dnf: `dnf install python3-netaddr` +* to install via apt: `apt install python3-netaddr` +* or via pip: `pip install netaddr==0.8.0` +* or via the collection: `pip install -r requirements.txt` + + +Dependencies +------------ + +The roles depends on: + +* [middleware_automation.common](https://github.com/ansible-middleware/common) +* [ansible-posix](https://docs.ansible.com/ansible/latest/collections/ansible/posix/index.html) + +To install all the dependencies via galaxy: + + ansible-galaxy collection install -r requirements.yml + + +Versions +-------- + +| RH-SSO VERSION | Release Date | Keycloak Version | EAP Version | Notes | +|:---------------|:------------------|:-----------------|:------------|:----------------| +|`7.5.0 GA` |September 20, 2021 |`15.0.2` | `7.4.6` |[Release Notes](https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.5/html/release_notes/index)| +|`7.6.0 GA` |June 30, 2022 |`18.0.3` | `7.4.6` |[Release Notes](https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.6/html-single/release_notes/index)| + + +Patching +-------- + +When variable `keycloak_rhsso_apply_patches` is `true` (default: `false`), the role will automatically apply the latest cumulative patch for the selected base version. + +| RH-SSO VERSION | Release Date | RH-SSO LATEST CP | Notes | +|:---------------|:------------------|:-----------------|:----------------| +|`7.5.0 GA` |January 20, 2022 |`7.5.3 GA` |[Release Notes](https://access.redhat.com/articles/6646321)| +|`7.6.0 GA` |November 11, 2022 |`7.6.1 GA` |[Release Notes](https://access.redhat.com/articles/6982711)| + + +Role Defaults +------------- + +* Service configuration + +| Variable | Description | Default | +|:---------|:------------|:---------| +|`keycloak_ha_enabled`| Enable auto configuration for database backend, clustering and remote caches on infinispan | `False` | +|`keycloak_ha_discovery`| Discovery protocol for HA cluster members | `JDBC_PING` if `keycloak_db_enabled` else `TCPPING` | +|`keycloak_db_enabled`| Enable auto configuration for database backend | `True` if `keycloak_ha_enabled` is True, else `False` | +|`keycloak_remote_cache_enabled`| Enable remote cache store when in clustered ha configurations | `True` if `keycloak_ha_enabled` else `False` | +|`keycloak_admin_user`| Administration console user account | `admin` | +|`keycloak_bind_address`| Address for binding service ports | `0.0.0.0` | +|`keycloak_management_port_bind_address`| Address for binding management ports | `127.0.0.1` | +|`keycloak_host`| hostname | `localhost` | +|`keycloak_http_port`| HTTP port | `8080` | +|`keycloak_https_port`| TLS HTTP port | `8443` | +|`keycloak_ajp_port`| AJP port | `8009` | +|`keycloak_jgroups_port`| jgroups cluster tcp port | `7600` | +|`keycloak_management_http_port`| Management port | `9990` | +|`keycloak_management_https_port`| TLS management port | `9993` | +|`keycloak_prefer_ipv4`| Prefer IPv4 stack and addresses for port binding | `true` | +|`keycloak_config_standalone_xml`| filename for configuration | `keycloak.xml` | +|`keycloak_service_user`| posix account username | `keycloak` | +|`keycloak_service_group`| posix account group | `keycloak` | +|`keycloak_service_restart_always`| systemd restart always behavior activation | `False` | +|`keycloak_service_restart_on_failure`| systemd restart on-failure behavior activation | `False` | +|`keycloak_service_startlimitintervalsec`| systemd StartLimitIntervalSec | `300` | +|`keycloak_service_startlimitburst`| systemd StartLimitBurst | `5` | +|`keycloak_service_restartsec`| systemd RestartSec | `10s` | +|`keycloak_service_pidfile`| pid file path for service | `/run/keycloak/keycloak.pid` | +|`keycloak_features` | List of `name`/`status` pairs of features (also known as profiles on RH-SSO) to `enable` or `disable`, example: `[ { name: 'docker', status: 'enabled' } ]` | `[]` +|`keycloak_jvm_package`| RHEL java package runtime | `java-1.8.0-openjdk-headless` | +|`keycloak_java_home`| `JAVA_HOME` of installed JRE, leave empty for using RPM path at `keycloak_jvm_package` | `None` | +|`keycloak_java_opts`| Additional JVM options | `-Xms1024m -Xmx2048m` | + + +* Install options + +| Variable | Description | Default | +|:---------|:------------|:---------| +|`keycloak_offline_install` | perform an offline install | `false`| +|`keycloak_download_url`| Download URL for keycloak | `https://github.com/keycloak/keycloak/releases/download//`| +|`keycloak_version`| keycloak.org package version | `18.0.2` | +|`keycloak_dest`| Installation root path | `/opt/keycloak` | +|`keycloak_download_url` | Download URL for keycloak | `https://github.com/keycloak/keycloak/releases/download/{{ keycloak_version }}/{{ keycloak_archive }}` | +|`keycloak_configure_firewalld` | Ensure firewalld is running and configure keycloak ports | `false` | + + +* Miscellaneous configuration + +| Variable | Description | Default | +|:---------|:------------|:--------| +|`keycloak_archive` | keycloak install archive filename | `keycloak-legacy-{{ keycloak_version }}.zip` | +|`keycloak_download_url_9x` | Download URL for keycloak (deprecated) | `https://downloads.jboss.org/keycloak/{{ keycloak_version }}/{{ keycloak_archive }}` | +|`keycloak_installdir` | Installation path | `{{ keycloak_dest }}/keycloak-{{ keycloak_version }}` | +|`keycloak_jboss_home` | Installation work directory | `{{ keycloak_rhsso_installdir }}` | +|`keycloak_jboss_port_offset` | Port offset for the JBoss socket binding | `0` | +|`keycloak_config_dir` | Path for configuration | `{{ keycloak_jboss_home }}/standalone/configuration` | +|`keycloak_config_path_to_standalone_xml` | Custom path for configuration | `{{ keycloak_jboss_home }}/standalone/configuration/{{ keycloak_config_standalone_xml }}` | +|`keycloak_config_override_template` | Path to custom template for standalone.xml configuration | `''` | +|`keycloak_auth_realm` | Name for rest authentication realm | `master` | +|`keycloak_auth_client` | Authentication client for configuration REST calls | `admin-cli` | +|`keycloak_force_install` | Remove pre-existing versions of service | `false` | +|`keycloak_url` | URL for configuration rest calls | `http://{{ keycloak_host }}:{{ keycloak_http_port + keycloak_jboss_port_offset }}` | +|`keycloak_management_url` | URL for management console rest calls | `http://{{ keycloak_host }}:{{ keycloak_management_http_port + keycloak_jboss_port_offset }}` | +|`keycloak_frontend_url_force` | Force backend requests to use the frontend URL | `false` | +|`keycloak_db_background_validation` | Enable background validation of database connection | `false` | +|`keycloak_db_background_validation_millis`| How frequently the connection pool is validated in the background | `10000` if background validation enabled | +|`keycloak_db_background_validate_on_match` | Enable validate on match for database connections | `false` | +|`keycloak_frontend_url` | frontend URL for keycloak endpoint | `http://localhost:8080/auth/` | +|`keycloak_log_target`| Set the destination of the keycloak log folder link | `/var/log/keycloak` | + + +Role Variables +-------------- + +The following are a set of _required_ variables for the role: + +| Variable | Description | +|:---------|:------------| +|`keycloak_admin_password`| Password for the administration console user account (minimum 12 characters) | +|`keycloak_frontend_url` | frontend URL for keycloak endpoint | `http://localhost:8080/auth/` | + + +The following parameters are _required_ only when `keycloak_ha_enabled` is true: + +| Variable | Description | Default | +|:---------|:------------|:--------| +|`keycloak_modcluster_enabled`| Enable configuration for modcluster subsystem | `True` if `keycloak_ha_enabled` is True, else `False` | +|`keycloak_modcluster_url` | _deprecated_ Host for the modcluster reverse proxy | `localhost` | +|`keycloak_modcluster_port` | _deprecated_ Port for the modcluster reverse proxy | `6666` | +|`keycloak_modcluster_urls` | List of {host,port} dicts for the modcluster reverse proxies | `[ { localhost:6666 } ]` | +|`keycloak_jdbc_engine` | backend database engine when db is enabled: [ postgres, mariadb, sqlserver ] | `postgres` | +|`keycloak_infinispan_url` | URL for the infinispan remote-cache server | `localhost:11122` | +|`keycloak_infinispan_user` | username for connecting to infinispan | `supervisor` | +|`keycloak_infinispan_pass` | password for connecting to infinispan | `supervisor` | +|`keycloak_infinispan_sasl_mechanism`| Authentication type | `SCRAM-SHA-512` | +|`keycloak_infinispan_use_ssl`| Enable hotrod TLS communication | `False` | +|`keycloak_infinispan_trust_store_path`| Path to truststore with infinispan server certificate | `/etc/pki/java/cacerts` | +|`keycloak_infinispan_trust_store_password`| Password for opening truststore | `changeit` | + + +The following parameters are _required_ only when `keycloak_db_enabled` is true: + +| Variable | Description | Default | +|:---------|:------------|:---------| +|`keycloak_jdbc_url` | URL for the postgres backend database | `jdbc:postgresql://localhost:5432/keycloak` | +|`keycloak_jdbc_driver_version`| Version for the JDBC driver to download | `9.4.1212` | +|`keycloak_db_user` | username for connecting to postgres | `keycloak-user` | +|`keycloak_db_pass` | password for connecting to postgres | `keycloak-pass` | + + +The following variables are _optional_: + +| Variable | Description | +|:---------|:------------| +|`keycloak_db_valid_conn_sql` | Override the default database connection validation query sql | +|`keycloak_admin_url` | Override the default administration endpoint URL | +|`keycloak_jgroups_subnet`| Override the subnet match for jgroups cluster formation; if not defined, it will be inferred from local machine route configuration | + +Example Playbook +----------------- + +* The following is an example playbook that makes use of the role to install keycloak from remote: + +```yaml +--- +- hosts: ... + vars: + keycloak_admin_password: "remembertochangeme" + roles: + - middleware_automation.keycloak.keycloak +``` + + +* The following example playbook makes use of the role to install keycloak from the controller node: + +```yaml +--- +- hosts: ... + collections: + - middleware_automation.keycloak + tasks: + - name: Include keycloak role + include_role: + name: keycloak + vars: + keycloak_admin_password: "remembertochangeme" + keycloak_offline_install: true + # This should be the filename of keycloak archive on Ansible node: keycloak-16.1.0.zip +``` + +License +------- + +Apache License 2.0 + + +Author Information +------------------ + +* [Ranabir Chakraborty](https://github.com/RanabirChakraborty) +* [Guido Grazioli](https://github.com/guidograzioli) +* [Romain Pelisse](https://github.com/rpelisse) +* [Pavan Kumar Motaparthi](https://github.com/motaparthipavankumar) diff --git a/3.1.2/_sources/roles/keycloak_quarkus.md.txt b/3.1.2/_sources/roles/keycloak_quarkus.md.txt new file mode 100644 index 0000000..9173c9f --- /dev/null +++ b/3.1.2/_sources/roles/keycloak_quarkus.md.txt @@ -0,0 +1,317 @@ +keycloak_quarkus +================ + +Install [keycloak](https://keycloak.org/) >= 20.0.0 (quarkus) server configurations. + + +Requirements +------------ + +This role requires the `python3-netaddr` and `lxml` library installed on the controller node. + +* to install via yum/dnf: `dnf install python3-netaddr python3-lxml` +* to install via apt: `apt install python3-netaddr python3-lxml` +* or via the collection: `pip install -r requirements.txt` + + +Dependencies +------------ + +The roles depends on: + +* [middleware_automation.common](https://github.com/ansible-middleware/common) +* [ansible-posix](https://docs.ansible.com/ansible/latest/collections/ansible/posix/index.html) + +To install all the dependencies via galaxy: + + ansible-galaxy collection install -r requirements.yml + +Role Defaults +------------- + +#### Installation options + +| Variable | Description | Default | +|:---------|:------------|:--------| +|`keycloak_quarkus_version`| keycloak.org package version | `26.7.3` | +|`keycloak_quarkus_offline_install` | Perform an offline install | `False`| +|`keycloak_quarkus_dest`| Installation root path | `/opt/keycloak` | +|`keycloak_quarkus_download_url` | Download URL for keycloak | `https://github.com/keycloak/keycloak/releases/download/{{ keycloak_quarkus_version }}/{{ keycloak_quarkus_archive }}` | +|`keycloak_quarkus_download_path`| Path local to controller for offline/download of install archives | `{{ lookup('env', 'PWD') }}` | + + +#### Service configuration + +| Variable | Description | Default | +|:---------|:------------|:--------| +|`keycloak_quarkus_bootstrap_admin_user`| Administration console user account | `admin` | +|`keycloak_quarkus_admin_user`| Deprecated, use `keycloak_quarkus_bootstrap_admin_user` instead. | | +|`keycloak_quarkus_bind_address`| Deprecated, use `keycloak_quarkus_http_host` instead | `0.0.0.0` | +|`keycloak_quarkus_host`| Deprecated, use `keycloak_quarkus_hostname` instead. | | +|`keycloak_quarkus_port`| Deprecated, use `keycloak_quarkus_hostname` instead. | | +|`keycloak_quarkus_path`| Deprecated, use `keycloak_quarkus_hostname` instead. | | +|`keycloak_quarkus_service_user`| Posix account username | `keycloak` | +|`keycloak_quarkus_service_group`| Posix account group | `keycloak` | +|`keycloak_quarkus_service_restart_always`| systemd restart always behavior activation | `False` | +|`keycloak_quarkus_service_restart_on_failure`| systemd restart on-failure behavior activation | `False` | +|`keycloak_quarkus_service_restartsec`| systemd RestartSec | `10s` | +|`keycloak_quarkus_jvm_package`| RHEL java package runtime | `java-21-openjdk-headless` | +|`keycloak_quarkus_java_home`| JAVA_HOME of installed JRE, leave empty for using specified keycloak_quarkus_jvm_package RPM path | `None` | +|`keycloak_quarkus_java_heap_opts`| Heap memory JVM setting (`JAVA_OPTS_KC_HEAP` when using Keycloak defaults) | `-Xms1024m -Xmx2048m` | +|`keycloak_quarkus_java_jvm_opts`| Optional extra JVM flags (`JAVA_OPTS_APPEND` with Keycloak defaults) | `""` | +|`keycloak_quarkus_java_opts_use_keycloak_defaults`| Let `kc.sh` apply upstream `JAVA_OPTS` (recommended) | `true` | +|`keycloak_quarkus_java_append_opts`| JGroups and extra JVM flags appended after Keycloak defaults | JGroups bind/external settings | +|`keycloak_quarkus_java_opts`| Full `JAVA_OPTS` when `keycloak_quarkus_java_opts_use_keycloak_defaults` is `false` | combined heap, JGroups, and `java_jvm_opts` | +|`keycloak_quarkus_additional_env_vars` | List of additional env variables of { key: str, value: str} to be put in sysconfig file, see https://www.keycloak.org/server/all-config | `[]` | +|`keycloak_quarkus_frontend_url`| Deprecated, use `keycloak_quarkus_hostname` instead. | | +|`keycloak_quarkus_admin_url`| Deprecated, use `keycloak_quarkus_hostname_admin` instead. | | +|`keycloak_quarkus_health_check_url`| Full URL for the health check endpoint, targets localhost | Composed from `keycloak_quarkus_http_enabled`, `keycloak_quarkus_http_port`/`keycloak_quarkus_https_port`, and `keycloak_quarkus_http_relative_path` | +|`keycloak_quarkus_health_check_url_path`| Path appended to the health check URL; ignored if keycloak_quarkus_health_check_url is set directly | `realms/{{ keycloak_quarkus_master_realm }}/.well-known/openid-configuration` | +|`keycloak_quarkus_proxy_headers`| Parse reverse proxy headers (`forwarded` or `xforwarded`) | `""` | +|`keycloak_quarkus_config_key_store_file`| Path to the configuration key store; only used if `keycloak_quarkus_config_key_store_password` is not empty | `{{ keycloak.home }}/conf/conf_store.p12` if `keycloak_quarkus_config_key_store_password != ''`, else `''` | +|`keycloak_quarkus_config_key_store_password`| Password of the configuration keystore; if non-empty, `keycloak_quarkus_db_pass` will be saved to the keystore at `keycloak_quarkus_config_key_store_file` instead of being written to the configuration file in clear text | `""` | +|`keycloak_quarkus_configure_firewalld` | Ensure firewalld is running and configure keycloak ports | `False` | +|`keycloak_quarkus_configure_iptables` | Ensure iptables is configured for keycloak ports | `False` | + + +#### High-availability + +| Variable | Description | Default | +|:---------|:------------|:--------| +|`keycloak_quarkus_ha_enabled`| Enable auto configuration for database backend, clustering and remote caches on infinispan | `False` | +|`keycloak_quarkus_ha_discovery`| Discovery protocol for HA cluster members | `JDBCPING` | +|`keycloak_quarkus_db_enabled`| Enable auto configuration for database backend | `True` if `keycloak_quarkus_ha_enabled` is True, else `False` | +|`keycloak_quarkus_jgroups_ip`| Host jgroups IP. If changing this variable you must make sure it is always set for all hosts in your cluster. | `{{ ansible_facts['default_ipv4']['address'] }}` | +|`keycloak_quarkus_jgroups_port`| jgroups cluster tcp port | `7800` | +|`keycloak_quarkus_systemd_wait_for_port` | Whether systemd unit should wait for keycloak port before returning | `{{ keycloak_quarkus_ha_enabled }}` | +|`keycloak_quarkus_systemd_wait_for_port_number`| Which port the systemd unit should wait for | `{{ keycloak_quarkus_https_port }}` | +|`keycloak_quarkus_systemd_wait_for_log` | Whether systemd unit should wait for service to be up in logs | `false` | +|`keycloak_quarkus_systemd_wait_for_timeout`| How long to wait for service to be alive (seconds) | `60` | +|`keycloak_quarkus_systemd_wait_for_delay`| Activation delay for service systemd unit (seconds) | `10` | +|`keycloak_quarkus_restart_strategy`| Strategy task file for restarting in HA (one of provided restart/['serial.yml','none.yml','serial_then_parallel.yml']) or path to file when providing custom strategy | `restart/serial.yml` | +|`keycloak_quarkus_restart_health_check`| Whether to wait for successful health check after restart | `true` | +|`keycloak_quarkus_restart_health_check_delay`| Seconds to let pass before starting health checks | `10` | +|`keycloak_quarkus_restart_health_check_retries`| Number of attempts for successful health check before failing | `25` | +|`keycloak_quarkus_validate_certs`| Whether to validate SSL certificates when performing health checks | `true` | +|`keycloak_quarkus_restart_pause`| Seconds to wait between restarts in HA strategy | `15` | + + +#### Hostname configuration + +| Variable | Description | Default | +|:---------|:------------|:--------| +|`keycloak_quarkus_hostname`| Address at which is the server exposed. Can be a full URL, or just a hostname. When only hostname is provided, scheme, port and context path are resolved from the request. | | +|`keycloak_quarkus_hostname_admin`| Set the base URL for accessing the administration console, including scheme, host, port and path | `` | +|`keycloak_quarkus_hostname_strict`| Disables dynamically resolving the hostname from request headers | `true` | +|`keycloak_quarkus_hostname_backchannel_dynamic`| Enables dynamic resolving of backchannel URLs, including hostname, scheme, port and context path. Set to true if your application accesses Keycloak via a private network. If set to true, hostname option needs to be specified as a full URL. | `false` | +|`keycloak_quarkus_hostname_strict_backchannel`| Deprecated, use (the inverted!)`keycloak_quarkus_hostname_backchannel_dynamic` instead. | | + + +#### HTTP(S) configuration +| Variable | Description | Default | +|:---------|:------------|:--------| +|`keycloak_quarkus_http_relative_path`| Set the path relative to / for serving resources. The path must start with a / | `/` | +|`keycloak_quarkus_http_host`| The http host, ie. the address used to bind the service | `0.0.0.0` | +|`keycloak_quarkus_http_port`| HTTP listening port | `8080` | +|`keycloak_quarkus_https_port`| TLS HTTP listening port | `8443` | +|`keycloak_quarkus_http_management_port`| Port of the management interface. Relevant only when something is exposed on the management interface - see the guide for details. | `9000` | +|`keycloak_quarkus_https_key_store_file`| The file path to the key store | `{{ keycloak.home }}/conf/key_store.p12` | +|`keycloak_quarkus_https_key_store_password`| Password for the key store | `""` | +|`keycloak_quarkus_https_trust_store_enabled`| Enable configuration of the https trust store | `False` | +|`keycloak_quarkus_https_trust_store_file`| The file path to the trust store | `{{ keycloak.home }}/conf/trust_store.p12` | +|`keycloak_quarkus_https_trust_store_password`| Password for the trust store | `""` | +|`keycloak_quarkus_https_key_file_enabled`| Enable listener on HTTPS port | `False` | +|`keycloak_quarkus_key_file_copy_enabled`| Enable copy of key file to target host | `False` | +|`keycloak_quarkus_key_content`| Content of the TLS private key. Use `"{{ lookup('file', 'server.key.pem') }}"` to lookup a file. | `""` | +|`keycloak_quarkus_key_file`| The file path to a private key in PEM format | `/etc/pki/tls/private/server.key.pem` | +|`keycloak_quarkus_cert_file_copy_enabled`| Enable copy of cert file to target host | `False`| +|`keycloak_quarkus_cert_file_src`| Set the source file path | `""` | +|`keycloak_quarkus_cert_file`| The file path to a server certificate or certificate chain in PEM format | `/etc/pki/tls/certs/server.crt.pem` | +|`keycloak_quarkus_https_key_store_enabled`| Enable configuration of HTTPS via a key store | `False` | +|`keycloak_quarkus_key_store_file`| Deprecated, use `keycloak_quarkus_https_key_store_file` instead. || +|`keycloak_quarkus_key_store_password`| Deprecated, use `keycloak_quarkus_https_key_store_password` instead.|| +|`keycloak_quarkus_http_relative_path` | Set the path relative to / for serving resources. The path must start with a / | `/` | +|`keycloak_quarkus_http_management_relative_path` | Set the path relative to / for serving resources from management interface. The path must start with a /. If not given, the value is inherited from HTTP options. Relevant only when something is exposed on the management interface - see the guide for details. | `/` | +|`keycloak_quarkus_http_enabled`| Enable listener on HTTP port | `True` | + + +#### Infinispan configuration + +| Variable | Description | Default | +| :------------------------------------------------- | :------------------------------ | :----------------------------------------------------------- | +| `keycloak_quarkus_cache_managed_infinispan_config` | Manage infinispan configuration | `"{{ keycloak_quarkus_version is version('26.4.0', '<') }}"` | +| `keycloak_quarkus_cache_infinispan_template` | Infinispan cache template file | `cache-ispn.xml` | + +As explained in the [official documentation](https://www.keycloak.org/server/caching#_modifying_cache_configuration_defaults), since version 26.4, it is recommended not to modify the XML configuration file but rather to configure the cache via the keycloak.properties file. By default, the role will no longer automatically deploy this file for versions higher than 26.4. + +For earlier versions, it is possible to override the given template to customize the cache using the `keycloak_quarkus_cache_infinispan_template` variable. + +#### Database configuration + +| Variable | Description | Default | +|:---------|:------------|:--------| +|`keycloak_quarkus_db_engine` | Database engine [mariadb,postres,mssql] | `postgres` | +|`keycloak_quarkus_db_user` | User for database connection | `keycloak-user` | +|`keycloak_quarkus_db_pass` | Password for database connection | `keycloak-pass` | +|`keycloak_quarkus_db_url` | JDBC URL for connecting to database | `jdbc:postgresql://localhost:5432/keycloak` | +|`keycloak_quarkus_db_driver_version` | Version for JDBC engine driver | `9.4.1212` | + + +#### Cache configuration + +| Variable | Description | Default | +|:---------|:------------|:--------| +|`keycloak_quarkus_cache_remote` | Whether to connect to remote cache infinispan server | `false` | +|`keycloak_quarkus_cache_remote_username` | Username for connecting to infinispan | `supervisor` | +|`keycloak_quarkus_cache_remote_password` | Password for connecting to infinispan | `supervisor` | +|`keycloak_quarkus_cache_remote_host` | Hostname for connecting to infinispan | `localhost` | +|`keycloak_quarkus_cache_remote_port`| Port for connecting to infinispan | `11222` | +|`keycloak_quarkus_cache_remote_sasl_mechanism` | Infinispan auth mechanism | `SCRAM-SHA-512` | +|`keycloak_quarkus_cache_remote_tls_enabled` | Whether infinispan uses TLS connection | `false` | +|`keycloak_quarkus_cache_embedded_properties` | Embedded cache properties | `` | + + +#### Logging configuration + +| Variable | Description | Default | +|:---------|:------------|:--------| +|`keycloak_quarkus_log`| Enable one or more log handlers in a comma-separated list | `file` | +|`keycloak_quarkus_log_level`| The log level of the root category or a comma-separated list of individual categories and their levels | `info` | +|`keycloak_quarkus_log_file`| Set the log file path and filename relative to keycloak home | `data/log/keycloak.log` | +|`keycloak_quarkus_log_format`| Set a format specific to file log entries | `%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n` | +|`keycloak_quarkus_log_target`| Set the destination of the keycloak log folder link | `/var/log/keycloak` | +|`keycloak_quarkus_log_max_file_size`| Set the maximum log file size before a log rotation happens; A size configuration option recognises string in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. If no suffix is given, assume bytes. | `10M` | +|`keycloak_quarkus_log_max_backup_index`| Set the maximum number of archived log files to keep | `10` | +|`keycloak_quarkus_log_file_suffix`| Set the log file handler rotation file suffix. When used, the file will be rotated based on its suffix; Note: If the suffix ends with `.zip` or `.gz`, the rotation file will also be compressed. | `.yyyy-MM-dd.zip` | + + +#### Miscellaneous configuration + +| Variable | Description | Default | +|:---------|:------------|:--------| +|`keycloak_quarkus_metrics_enabled`| Whether to enable metrics | `False` | +|`keycloak_quarkus_health_enabled`| If the server should expose health check endpoints on the management interface | `True` | +|`keycloak_quarkus_archive` | keycloak install archive filename | `keycloak-{{ keycloak_quarkus_version }}.zip` | +|`keycloak_quarkus_installdir` | Installation path | `{{ keycloak_quarkus_dest }}/keycloak-{{ keycloak_quarkus_version }}` | +|`keycloak_quarkus_home` | Installation work directory | `{{ keycloak_quarkus_installdir }}` | +|`keycloak_quarkus_config_dir` | Path for configuration | `{{ keycloak_quarkus_home }}/conf` | +|`keycloak_quarkus_master_realm` | Name for rest authentication realm | `master` | +|`keycloak_auth_client` | Authentication client for configuration REST calls | `admin-cli` | +|`keycloak_quarkus_force_install` | Remove pre-existing versions of service | `False` | +|`keycloak_quarkus_proxy_mode`| The proxy address forwarding mode if the server is behind a reverse proxy (deprecated) | `none` | +|`keycloak_quarkus_start_dev`| Whether to start the service in development mode (start-dev) | `False` | +|`keycloak_quarkus_transaction_xa_enabled`| Whether to use XA transactions | `True` | +|`keycloak_quarkus_spi_sticky_session_encoder_infinispan_should_attach_route`| If the route should be attached to cookies to reflect the node that owns a particular session. If false, route is not attached to cookies and we rely on the session affinity capabilities from reverse proxy | `True` | +|`keycloak_quarkus_show_deprecation_warnings`| Whether deprecation warnings should be shown | `True` | + + +#### Vault configuration + +| Variable | Description | Default | +|:---------|:------------|:--------| +|`keycloak_quarkus_ks_vault_enabled`| Whether to enable the vault SPI | `false` | +|`keycloak_quarkus_ks_vault_file`| The keystore path for the vault SPI | `{{ keycloak_quarkus_config_dir }}/keystore.p12` | +|`keycloak_quarkus_ks_vault_type`| Type of the keystore used for the vault SPI | `PKCS12` | + + +#### Configuring providers + +| Variable | Description | Default | +|:---------|:------------|:--------| +|`keycloak_quarkus_providers`| List of provider definitions; see below | `[]` | + +Providers support different sources: + +* `url`: http download for providers not requiring authentication +* `maven`: maven download for providers hosted publicly on Apache Maven Central or private Maven repositories like Github Maven requiring authentication +* `local_path`: static providers to be uploaded + +Provider definition: + +```yaml +keycloak_quarkus_providers: + - id: http-client # required; "{{ id }}.jar" identifies the file name on RHBK + spi: connections # required if neither url, local_path nor maven are specified; required for setting properties + default: true # optional, whether to set default for spi, default false + restart: true # optional, whether to rebuild config and restart the service after deploying, default true + url: https://.../.../custom_spi.jar # optional, url for download via http + local_path: my_theme_spi.jar # optional, path on local controller for SPI to be uploaded + remote: true # optional, whether to copy from localhost or remotely, see https://docs.ansible.com/ansible/latest/collections/ansible/builtin/copy_module.html#parameter-remote_src, default false + maven: # optional, for download using maven + repository_url: https://maven.pkg.github.com/OWNER/REPOSITORY # optional, maven repo url + group_id: my.group # optional, maven group id + artifact_id: artifact # optional, maven artifact id + version: 24.0.5 # optional, defaults to latest + username: user # optional, cf. https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#authenticating-to-github-packages + password: pat # optional, provide a PAT for accessing Github's Apache Maven registry + properties: # optional, list of key-values + - key: default-connection-pool-size + value: 10 + checksum: sha256:D98291AC[...]B6DC7B97 # optional, checksum used to verify integrity: + # for `url` SPIs, use format: :, cf. ; + # for `local_path` SPIs, use SHA1 format + # for `maven` SPIs, this field is ignored since maven has integrity verification methods enabled by default +``` + +the definition above will generate the following build command: + +``` +bin/kc.sh build --spi-connections-provider=http-client --spi-connections-http-client-default-connection-pool-size=10 +``` + + +#### Configuring policies + +| Variable | Description | Default | +|:---------|:------------|:--------| +|`keycloak_quarkus_policies`| List of policy definitions; see below | `[]` | + +Provider definition: + +```yaml +keycloak_quarkus_policies: + - name: john-the-ripper.txt # required, resulting file name + url: https://github.com/danielmiessler/SecLists/raw/master/Passwords/Software/john-the-ripper.txt # required, url for download + type: password-blacklists # optional, defaults to `password-blacklists`; supported values: [`password-blacklists`] +``` + + +Role Variables +-------------- + +| Variable | Description | Required | +|:---------|:------------|----------| +|`keycloak_quarkus_bootstrap_admin_password`| Password of console admin account | `yes` | +|`keycloak_quarkus_admin_pass`| Deprecated, use `keycloak_quarkus_bootstrap_admin_password` instead. | | +|`keycloak_quarkus_ks_vault_pass`| The password for accessing the keystore vault SPI | `no` | +|`keycloak_quarkus_alternate_download_url`| Alternate location with optional authentication for downloading RHBK | `no` | +|`keycloak_quarkus_download_user`| Optional username for http authentication | `no*` | +|`keycloak_quarkus_download_pass`| Optional password for http authentication | `no*` | +|`keycloak_quarkus_download_validate_certs`| Whether to validate certs for URL `keycloak_quarkus_alternate_download_url` | `no` | +|`keycloak_quarkus_jdbc_download_user`| Optional username for http authentication | `no*` | +|`keycloak_quarkus_jdbc_download_pass`| Optional password for http authentication | `no*` | +|`keycloak_quarkus_jdbc_download_validate_certs`| Whether to validate certs for URL `keycloak_quarkus_download_validate_certs` | `no` | + +`*` username/password authentication credentials must be both declared or both undefined + + +Role custom facts +----------------- + +The role uses the following [custom facts](https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_vars_facts.html#adding-custom-facts) found in `/etc/ansible/facts.d/keycloak.fact` (and thus identified by the `ansible_local.keycloak.` prefix): + +| Variable | Description | +|:---------|:------------| +|`general.bootstrapped` | A custom fact indicating whether this role has been used for bootstrapping keycloak on the respective host before; set to `false` (e.g., when starting off with a new, empty database) ensures that the initial admin user as defined by `keycloak_quarkus_bootstrap_admin_user[_password]` gets created | + +License +------- + +Apache License 2.0 + + +Author Information +------------------ + +* [Ranabir Chakraborty](https://github.com/RanabirChakraborty) +* [Guido Grazioli](https://github.com/guidograzioli) diff --git a/3.1.2/_sources/roles/keycloak_realm.md.txt b/3.1.2/_sources/roles/keycloak_realm.md.txt new file mode 100644 index 0000000..c7b9c3a --- /dev/null +++ b/3.1.2/_sources/roles/keycloak_realm.md.txt @@ -0,0 +1,197 @@ +keycloak_realm +============== + + +Create realms and clients in [keycloak](https://keycloak.org/) or [Red Hat Single Sign-On](https://access.redhat.com/products/red-hat-single-sign-on) services. + + +Role Defaults +------------- + +| Variable | Description | Default | +|:---------|:------------|:--------| +|`keycloak_realm_admin_user`| Administration console user account | `admin` | +|`keycloak_realm_host`| hostname | `localhost` | +|`keycloak_realm_context`| Context path for rest calls (set to `/auth` for legacy WildFly-based Keycloak) | `` | +|`keycloak_realm_http_port`| HTTP port | `8080` | +|`keycloak_realm_https_port`| TLS HTTP port | `8443` | +|`keycloak_realm_auth_realm`| Name of the main authentication realm | `master` | +|`keycloak_realm_management_http_port`| Management port | `9990` | +|`keycloak_realm_auth_client`| Authentication client for configuration REST calls | `admin-cli` | +|`keycloak_realm_client_public`| Configure a public realm client | `True` | +|`keycloak_realm_client_web_origins`| Web origins for realm client | `/*` | +|`keycloak_realm_url`| URL for configuration rest calls | `http://{{ keycloak_realm_host }}:{{ keycloak_realm_http_port }}` | +|`keycloak_realm_management_url`| URL for management console rest calls | `http://{{ keycloak_realm_host }}:{{ keycloak_realm_management_http_port }}` | + + +Role Variables +-------------- + +The following are a set of _required_ variables for the role: + +| Variable | Description | +|:---------|:------------| +|`keycloak_realm_realm` | Name of the realm to be created | +|`keycloak_realm_admin_password`| Password for the administration console user account | + + +The following variables are available for creating clients: + +| Variable | Description | Default | +|:---------|:------------|:---------| +|`keycloak_realm_clients` | List of _client_ declarations for the realm | `[]` | +|`keycloak_realm_client_default_roles` | List of default role name for clients | `[]` | +|`keycloak_realm_client_users` | List of user/role mappings for a client | `[]` | + + +The following variables are available for creating user federation: + +| Variable | Description | Default | +|:---------|:------------|:---------| +|`keycloak_realm_user_federation` | List of _keycloak_user_federation_ for the realm | `[]` | + + +Variable formats +---------------- + +* `keycloak_realm_user_federation`, a list of: + +```yaml + - realm: + name: + provider_id: + provider_type: + config: + mappers: +``` + +Refer to [docs](https://docs.ansible.com/ansible/latest/collections/community/general/keycloak_user_federation_module.html) for information on supported variables. + + +* `keycloak_realm_clients`, a list of: + +```yaml + - name: + id: + client_id: + secret: + roles: + realm: + public_client: + web_origins: + users: +``` + +`name` and either `id` or `client_id` are required. + + +* `keycloak_realm_client_users`, a list of: + +```yaml + - username: + password: + firstName: + lastName: + email: + client_roles: +``` + +* Client user/role mappings, a list of: + +```yaml + - client: + role: + realm: +``` + +For a comprehensive example, refer to the [playbook](../../playbooks/keycloak_realm.yml). + + +Related Modules +--------------- + +For features not covered by this role, the collection provides dedicated modules: + +| Module | What It Manages | +|:-------|:----------------| +| `keycloak_client_scope` | Client scopes and protocol mappers — see [example playbook](../../playbooks/keycloak_client_scope.yml) | +| `keycloak_authentication_flow` | Authentication flows and execution steps — see [example playbook](../../playbooks/keycloak_authentication_flow.yml) | +| `keycloak_client` | Clients (also used internally by this role) | +| `keycloak_role` | Realm and client roles | +| `keycloak_realm_user_federation` | User federations such as LDAP (also used internally by this role) | + + +Example Playbook +---------------- + +The following is an example playbook that makes use of the role to create a realm in keycloak. + +```yaml +--- +- hosts: ... + collections: + - middleware_automation.keycloak + tasks: + - name: Include keycloak role + include_role: + name: keycloak_realm + vars: + keycloak_admin_password: "changeme" + keycloak_realm: TestRealm + keycloak_clients: [...] +``` + +The following example uses the `keycloak_client_scope` module to create a client scope with protocol mappers: + +```yaml +- name: Create client scope + middleware_automation.keycloak.keycloak_client_scope: + auth_keycloak_url: http://localhost:8080 + auth_realm: master + auth_username: admin + auth_password: changeme + realm: TestRealm + name: my-scope + protocol_mappers: + - name: email + protocolMapper: oidc-usermodel-attribute-mapper + config: + user.attribute: email + claim.name: email + id.token.claim: "true" + access.token.claim: "true" + state: present +``` + +The following example uses the `keycloak_authentication_flow` module to create a custom authentication flow: + +```yaml +- name: Create authentication flow + middleware_automation.keycloak.keycloak_authentication_flow: + auth_keycloak_url: http://localhost:8080 + auth_realm: master + auth_username: admin + auth_password: changeme + realm: TestRealm + alias: my-browser-flow + executions: + - provider_id: auth-cookie + requirement: ALTERNATIVE + - provider_id: auth-password + requirement: REQUIRED + state: present +``` + + +License +------- + +Apache License 2.0 + + +Author Information +------------------ + +* [Ranabir Chakraborty](https://github.com/RanabirChakraborty) +* [Guido Grazioli](https://github.com/guidograzioli) +* [Romain Pelisse](https://github.com/rpelisse) diff --git a/3.1.2/_sources/testing.md.txt b/3.1.2/_sources/testing.md.txt new file mode 100644 index 0000000..8e773ea --- /dev/null +++ b/3.1.2/_sources/testing.md.txt @@ -0,0 +1,23 @@ +# Testing + +## Continuous integration + +The collection is tested with a [molecule](https://github.com/ansible-community/molecule) setup covering the included roles and verifying correct installation and idempotency. +In order to run the molecule tests locally with python 3.9 available, after cloning the repository: +The test scenarios are available on the source code repository each on his own subdirectory under [molecule/](https://github.com/ansible-middleware/keycloak/molecule). + + +## Test playbooks + +Sample playbooks are provided in the `playbooks/` directory; to run the playbooks locally (requires a rhel system with python 3.9+, ansible, and systemd) the steps are as follows: + +``` +# setup environment as in developing +# create inventory for localhost +cat << EOF > inventory +[keycloak] +localhost ansible_connection=local +EOF +# run the playbook +ansible-playbook -i inventory playbooks/keycloak.yml +``` diff --git a/3.1.2/_static/_sphinx_javascript_frameworks_compat.js b/3.1.2/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 0000000..8141580 --- /dev/null +++ b/3.1.2/_static/_sphinx_javascript_frameworks_compat.js @@ -0,0 +1,123 @@ +/* Compatability shim for jQuery and underscores.js. + * + * Copyright Sphinx contributors + * Released under the two clause BSD licence + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} diff --git a/3.1.2/_static/antsibull-minimal.css b/3.1.2/_static/antsibull-minimal.css new file mode 100644 index 0000000..5d0aa07 --- /dev/null +++ b/3.1.2/_static/antsibull-minimal.css @@ -0,0 +1,4 @@ +@charset "UTF-8"; +/* Copyright (c) Ansible and contributors */ +/* GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) */ +:root{--antsibull-links-background: #5bbdbf;--antsibull-links-background-active: #91d9db;--antsibull-links-focus-outline: #204748;--antsibull-links-text: #fff;--antsibull-table-background-header: #6ab0de;--antsibull-table-background-even: #e7f2fa;--antsibull-table-background-odd: #fff;--antsibull-table-border: #000;--antsibull-narrowtable-background: #e7f2fa;--antsibull-option-type: purple;--antsibull-option-elements: purple;--antsibull-option-required: red;--antsibull-option-version-added: #006400;--antsibull-option-aliases: #006400;--antsibull-option-default: blue;--antsibull-option-sample: blue;--antsibull-option-sample-header: #000;--antsibull-attribute-support-none: red;--antsibull-attribute-support-partial: #a5a500;--antsibull-attribute-support-full: green;--antsibull-attribute-support-na: inherit;--antsibull-deprecation-border: #000;--antsibull-deprecation-background: #eee;--antsibull-deprecation-color: #000}.ansible-links{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-align:center;-webkit-align-items:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:start;-webkit-justify-content:flex-start;-ms-flex-pack:start;justify-content:flex-start;-webkit-flex-wrap:wrap;-ms-flex-wrap:wrap;flex-wrap:wrap}.ansible-links>*{margin:2px 4px!important}.ansible-links>li{list-style:none!important}.ansible-links>li>p{display:inline}.ansible-links a{display:block;padding:4px 12px;cursor:pointer;border-radius:3px;background-color:var(--antsibull-links-background);color:var(--antsibull-links-text)}.ansible-links a:active,.ansible-links a:focus,.ansible-links a:hover{background-color:var(--antsibull-links-background-active)}.ansible-links a:focus{outline:3px solid var(--antsibull-links-focus-outline)}table.documentation-table{border-bottom:1px solid var(--antsibull-table-border);border-right:1px solid var(--antsibull-table-border)}table.documentation-table th{background-color:var(--antsibull-table-background-header)}table.documentation-table td,table.documentation-table th{padding:4px;border-left:1px solid var(--antsibull-table-border);border-top:1px solid var(--antsibull-table-border)}table.documentation-table td.elbow-placeholder{border-top:0;width:30px;min-width:30px}table.documentation-table td{vertical-align:top}table.documentation-table td:first-child{white-space:nowrap}table.documentation-table tr .ansibleOptionLink{display:inline-block}table.documentation-table tr .ansibleOptionLink:after{content:"🔗";opacity:0}table.documentation-table tr:hover .ansibleOptionLink:after{opacity:1}table.documentation-table tr:nth-child(odd){background-color:var(--antsibull-table-background-odd)}table.documentation-table tr:nth-child(2n){background-color:var(--antsibull-table-background-even)}table.ansible-option-table{display:table;border-color:var(--antsibull-table-border)!important;height:1px}table.ansible-option-table tr{height:100%}table.ansible-option-table td,table.ansible-option-table th{border-color:var(--antsibull-table-border)!important;border-bottom:none!important;vertical-align:top!important}table.ansible-option-table th>p{font-size:medium!important}table.ansible-option-table thead tr{background-color:var(--antsibull-table-background-header)}table.ansible-option-table tbody .row-odd td{background-color:var(--antsibull-table-background-odd)!important}table.ansible-option-table tbody .row-even td{background-color:var(--antsibull-table-background-even)!important}table.ansible-option-table ul>li>p{margin:0!important}table.ansible-option-table ul>li>div[class^=highlight]{margin-bottom:4px!important}table.ansible-option-table p.ansible-option-title{display:inline}table.ansible-option-table .ansible-option-type-line{font-size:small;margin-bottom:0}table.ansible-option-table .ansible-option-type{color:var(--antsibull-option-type)}table.ansible-option-table .ansible-option-elements{color:var(--antsibull-option-elements)}table.ansible-option-table .ansible-option-required{color:var(--antsibull-option-required)}table.ansible-option-table .ansible-option-versionadded{font-size:small;color:var(--antsibull-option-version-added)}table.ansible-option-table .ansible-option-aliases{color:var(--antsibull-option-aliases);white-space:normal}table.ansible-option-table .ansible-option-line{margin-top:8px}table.ansible-option-table .ansible-option-choices-default-mark,table.ansible-option-table .ansible-option-default,table.ansible-option-table .ansible-option-default-bold{color:var(--antsibull-option-default)}table.ansible-option-table .ansible-option-sample{color:var(--antsibull-option-sample);word-wrap:break-word;word-break:break-all}table.ansible-option-table .ansible-option-sample-bold{color:var(--antsibull-option-sample-header)}table.ansible-option-table .ansible-attribute-support-none{color:var(--antsibull-attribute-support-none)}table.ansible-option-table .ansible-attribute-support-partial{color:var(--antsibull-attribute-support-partial)}table.ansible-option-table .ansible-attribute-support-full{color:var(--antsibull-attribute-support-full)}table.ansible-option-table .ansible-attribute-support-na{color:var(--antsibull-attribute-support-na)}table.ansible-option-table .ansibleOptionLink{display:inline-block}table.ansible-option-table .ansibleOptionLink:after{content:"🔗";opacity:0}table.ansible-option-table p{margin:0 0 8px}table.ansible-option-table tr:hover .ansibleOptionLink:after{opacity:1}table.ansible-option-table td{padding:0!important;white-space:normal}table.ansible-option-table td>div.ansible-option-cell{padding:8px 16px;border-top:1px solid var(--antsibull-table-border)}table.ansible-option-table td:first-child{height:inherit;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;-webkit-flex-direction:row;-ms-flex-direction:row;flex-direction:row}table.ansible-option-table td:first-child>div.ansible-option-cell{height:inherit;-webkit-box-flex:1;-webkit-flex:1 0 auto;-ms-flex:1 0 auto;flex:1 0 auto;white-space:nowrap;max-width:100%}table.ansible-option-table .ansible-option-indent{margin-left:2em;border-right:1px solid var(--antsibull-table-border)}table.ansible-option-table .ansible-attribute-support-label{display:none}@media (max-width:1200px){table.ansible-option-table{display:block;height:unset;border:none!important}table.ansible-option-table thead{display:none}table.ansible-option-table tbody,table.ansible-option-table td,table.ansible-option-table tr{display:block;border:none!important}table.ansible-option-table tbody .row-even td,table.ansible-option-table tbody .row-odd td{background-color:unset!important}table.ansible-option-table td>div.ansible-option-cell{border-top:none}table.ansible-option-table td:first-child>div.ansible-option-cell{background-color:var(--antsibull-narrowtable-background)!important}table.ansible-option-table td:not(:first-child){display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;-webkit-flex-direction:row;-ms-flex-direction:row;flex-direction:row}table.ansible-option-table td:not(:first-child)>div.ansible-option-cell{margin-left:1em}table.ansible-option-table .ansible-option-indent,table.ansible-option-table .ansible-option-indent-desc{margin-left:1em;border:none;border-right:solid 3px var(--antsibull-narrowtable-background)}table.ansible-option-table .ansible-attribute-support-label{display:unset}}.ansible-version-added{font-style:italic}.ansible-option a.reference.external,.ansible-option a.reference.external:hover,.ansible-option a.reference.internal,.ansible-option a.reference.internal:hover,.ansible-option-value a.reference.external,.ansible-option-value a.reference.external:hover,.ansible-option-value a.reference.internal,.ansible-option-value a.reference.internal:hover,.ansible-return-value a.reference.external,.ansible-return-value a.reference.external:hover,.ansible-return-value a.reference.internal,.ansible-return-value a.reference.internal:hover{color:unset}.ansible-deprecation-marker{border-radius:1em;border:2px solid var(--antsibull-deprecation-border);background-color:var(--antsibull-deprecation-background);color:var(--antsibull-deprecation-color);padding:.2em .4em} \ No newline at end of file diff --git a/3.1.2/_static/base-stemmer.js b/3.1.2/_static/base-stemmer.js new file mode 100644 index 0000000..e6fa0c4 --- /dev/null +++ b/3.1.2/_static/base-stemmer.js @@ -0,0 +1,476 @@ +// @ts-check + +/**@constructor*/ +BaseStemmer = function() { + /** @protected */ + this.current = ''; + this.cursor = 0; + this.limit = 0; + this.limit_backward = 0; + this.bra = 0; + this.ket = 0; + + /** + * @param {string} value + */ + this.setCurrent = function(value) { + this.current = value; + this.cursor = 0; + this.limit = this.current.length; + this.limit_backward = 0; + this.bra = this.cursor; + this.ket = this.limit; + }; + + /** + * @return {string} + */ + this.getCurrent = function() { + return this.current; + }; + + /** + * @param {BaseStemmer} other + */ + this.copy_from = function(other) { + /** @protected */ + this.current = other.current; + this.cursor = other.cursor; + this.limit = other.limit; + this.limit_backward = other.limit_backward; + this.bra = other.bra; + this.ket = other.ket; + }; + + /** + * @param {number[]} s + * @param {number} min + * @param {number} max + * @return {boolean} + */ + this.in_grouping = function(s, min, max) { + /** @protected */ + if (this.cursor >= this.limit) return false; + var ch = this.current.charCodeAt(this.cursor); + if (ch > max || ch < min) return false; + ch -= min; + if ((s[ch >>> 3] & (0x1 << (ch & 0x7))) == 0) return false; + this.cursor++; + return true; + }; + + /** + * @param {number[]} s + * @param {number} min + * @param {number} max + * @return {boolean} + */ + this.go_in_grouping = function(s, min, max) { + /** @protected */ + while (this.cursor < this.limit) { + var ch = this.current.charCodeAt(this.cursor); + if (ch > max || ch < min) + return true; + ch -= min; + if ((s[ch >>> 3] & (0x1 << (ch & 0x7))) == 0) + return true; + this.cursor++; + } + return false; + }; + + /** + * @param {number[]} s + * @param {number} min + * @param {number} max + * @return {boolean} + */ + this.in_grouping_b = function(s, min, max) { + /** @protected */ + if (this.cursor <= this.limit_backward) return false; + var ch = this.current.charCodeAt(this.cursor - 1); + if (ch > max || ch < min) return false; + ch -= min; + if ((s[ch >>> 3] & (0x1 << (ch & 0x7))) == 0) return false; + this.cursor--; + return true; + }; + + /** + * @param {number[]} s + * @param {number} min + * @param {number} max + * @return {boolean} + */ + this.go_in_grouping_b = function(s, min, max) { + /** @protected */ + while (this.cursor > this.limit_backward) { + var ch = this.current.charCodeAt(this.cursor - 1); + if (ch > max || ch < min) return true; + ch -= min; + if ((s[ch >>> 3] & (0x1 << (ch & 0x7))) == 0) return true; + this.cursor--; + } + return false; + }; + + /** + * @param {number[]} s + * @param {number} min + * @param {number} max + * @return {boolean} + */ + this.out_grouping = function(s, min, max) { + /** @protected */ + if (this.cursor >= this.limit) return false; + var ch = this.current.charCodeAt(this.cursor); + if (ch > max || ch < min) { + this.cursor++; + return true; + } + ch -= min; + if ((s[ch >>> 3] & (0X1 << (ch & 0x7))) == 0) { + this.cursor++; + return true; + } + return false; + }; + + /** + * @param {number[]} s + * @param {number} min + * @param {number} max + * @return {boolean} + */ + this.go_out_grouping = function(s, min, max) { + /** @protected */ + while (this.cursor < this.limit) { + var ch = this.current.charCodeAt(this.cursor); + if (ch <= max && ch >= min) { + ch -= min; + if ((s[ch >>> 3] & (0X1 << (ch & 0x7))) != 0) { + return true; + } + } + this.cursor++; + } + return false; + }; + + /** + * @param {number[]} s + * @param {number} min + * @param {number} max + * @return {boolean} + */ + this.out_grouping_b = function(s, min, max) { + /** @protected */ + if (this.cursor <= this.limit_backward) return false; + var ch = this.current.charCodeAt(this.cursor - 1); + if (ch > max || ch < min) { + this.cursor--; + return true; + } + ch -= min; + if ((s[ch >>> 3] & (0x1 << (ch & 0x7))) == 0) { + this.cursor--; + return true; + } + return false; + }; + + /** + * @param {number[]} s + * @param {number} min + * @param {number} max + * @return {boolean} + */ + this.go_out_grouping_b = function(s, min, max) { + /** @protected */ + while (this.cursor > this.limit_backward) { + var ch = this.current.charCodeAt(this.cursor - 1); + if (ch <= max && ch >= min) { + ch -= min; + if ((s[ch >>> 3] & (0x1 << (ch & 0x7))) != 0) { + return true; + } + } + this.cursor--; + } + return false; + }; + + /** + * @param {string} s + * @return {boolean} + */ + this.eq_s = function(s) + { + /** @protected */ + if (this.limit - this.cursor < s.length) return false; + if (this.current.slice(this.cursor, this.cursor + s.length) != s) + { + return false; + } + this.cursor += s.length; + return true; + }; + + /** + * @param {string} s + * @return {boolean} + */ + this.eq_s_b = function(s) + { + /** @protected */ + if (this.cursor - this.limit_backward < s.length) return false; + if (this.current.slice(this.cursor - s.length, this.cursor) != s) + { + return false; + } + this.cursor -= s.length; + return true; + }; + + /** + * @param {Among[]} v + * @return {number} + */ + this.find_among = function(v) + { + /** @protected */ + var i = 0; + var j = v.length; + + var c = this.cursor; + var l = this.limit; + + var common_i = 0; + var common_j = 0; + + var first_key_inspected = false; + + while (true) + { + var k = i + ((j - i) >>> 1); + var diff = 0; + var common = common_i < common_j ? common_i : common_j; // smaller + // w[0]: string, w[1]: substring_i, w[2]: result, w[3]: function (optional) + var w = v[k]; + var i2; + for (i2 = common; i2 < w[0].length; i2++) + { + if (c + common == l) + { + diff = -1; + break; + } + diff = this.current.charCodeAt(c + common) - w[0].charCodeAt(i2); + if (diff != 0) break; + common++; + } + if (diff < 0) + { + j = k; + common_j = common; + } + else + { + i = k; + common_i = common; + } + if (j - i <= 1) + { + if (i > 0) break; // v->s has been inspected + if (j == i) break; // only one item in v + + // - but now we need to go round once more to get + // v->s inspected. This looks messy, but is actually + // the optimal approach. + + if (first_key_inspected) break; + first_key_inspected = true; + } + } + do { + var w = v[i]; + if (common_i >= w[0].length) + { + this.cursor = c + w[0].length; + if (w.length < 4) return w[2]; + var res = w[3](this); + this.cursor = c + w[0].length; + if (res) return w[2]; + } + i = w[1]; + } while (i >= 0); + return 0; + }; + + // find_among_b is for backwards processing. Same comments apply + /** + * @param {Among[]} v + * @return {number} + */ + this.find_among_b = function(v) + { + /** @protected */ + var i = 0; + var j = v.length + + var c = this.cursor; + var lb = this.limit_backward; + + var common_i = 0; + var common_j = 0; + + var first_key_inspected = false; + + while (true) + { + var k = i + ((j - i) >> 1); + var diff = 0; + var common = common_i < common_j ? common_i : common_j; + var w = v[k]; + var i2; + for (i2 = w[0].length - 1 - common; i2 >= 0; i2--) + { + if (c - common == lb) + { + diff = -1; + break; + } + diff = this.current.charCodeAt(c - 1 - common) - w[0].charCodeAt(i2); + if (diff != 0) break; + common++; + } + if (diff < 0) + { + j = k; + common_j = common; + } + else + { + i = k; + common_i = common; + } + if (j - i <= 1) + { + if (i > 0) break; + if (j == i) break; + if (first_key_inspected) break; + first_key_inspected = true; + } + } + do { + var w = v[i]; + if (common_i >= w[0].length) + { + this.cursor = c - w[0].length; + if (w.length < 4) return w[2]; + var res = w[3](this); + this.cursor = c - w[0].length; + if (res) return w[2]; + } + i = w[1]; + } while (i >= 0); + return 0; + }; + + /* to replace chars between c_bra and c_ket in this.current by the + * chars in s. + */ + /** + * @param {number} c_bra + * @param {number} c_ket + * @param {string} s + * @return {number} + */ + this.replace_s = function(c_bra, c_ket, s) + { + /** @protected */ + var adjustment = s.length - (c_ket - c_bra); + this.current = this.current.slice(0, c_bra) + s + this.current.slice(c_ket); + this.limit += adjustment; + if (this.cursor >= c_ket) this.cursor += adjustment; + else if (this.cursor > c_bra) this.cursor = c_bra; + return adjustment; + }; + + /** + * @return {boolean} + */ + this.slice_check = function() + { + /** @protected */ + if (this.bra < 0 || + this.bra > this.ket || + this.ket > this.limit || + this.limit > this.current.length) + { + return false; + } + return true; + }; + + /** + * @param {number} c_bra + * @return {boolean} + */ + this.slice_from = function(s) + { + /** @protected */ + var result = false; + if (this.slice_check()) + { + this.replace_s(this.bra, this.ket, s); + result = true; + } + return result; + }; + + /** + * @return {boolean} + */ + this.slice_del = function() + { + /** @protected */ + return this.slice_from(""); + }; + + /** + * @param {number} c_bra + * @param {number} c_ket + * @param {string} s + */ + this.insert = function(c_bra, c_ket, s) + { + /** @protected */ + var adjustment = this.replace_s(c_bra, c_ket, s); + if (c_bra <= this.bra) this.bra += adjustment; + if (c_bra <= this.ket) this.ket += adjustment; + }; + + /** + * @return {string} + */ + this.slice_to = function() + { + /** @protected */ + var result = ''; + if (this.slice_check()) + { + result = this.current.slice(this.bra, this.ket); + } + return result; + }; + + /** + * @return {string} + */ + this.assign_to = function() + { + /** @protected */ + return this.current.slice(0, this.limit); + }; +}; diff --git a/3.1.2/_static/basic.css b/3.1.2/_static/basic.css new file mode 100644 index 0000000..4738b2e --- /dev/null +++ b/3.1.2/_static/basic.css @@ -0,0 +1,906 @@ +/* + * Sphinx stylesheet -- basic theme. + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin-top: 10px; +} + +ul.search li { + padding: 5px 0; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/3.1.2/_static/css/badge_only.css b/3.1.2/_static/css/badge_only.css new file mode 100644 index 0000000..88ba55b --- /dev/null +++ b/3.1.2/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions .rst-other-versions .rtd-current-item{font-weight:700}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}#flyout-search-form{padding:6px} \ No newline at end of file diff --git a/3.1.2/_static/css/fonts/Roboto-Slab-Bold.woff b/3.1.2/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 0000000..6cb6000 Binary files /dev/null and b/3.1.2/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/3.1.2/_static/css/fonts/Roboto-Slab-Bold.woff2 b/3.1.2/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 0000000..7059e23 Binary files /dev/null and b/3.1.2/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/3.1.2/_static/css/fonts/Roboto-Slab-Regular.woff b/3.1.2/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 0000000..f815f63 Binary files /dev/null and b/3.1.2/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/3.1.2/_static/css/fonts/Roboto-Slab-Regular.woff2 b/3.1.2/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 0000000..f2c76e5 Binary files /dev/null and b/3.1.2/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/3.1.2/_static/css/fonts/fontawesome-webfont.eot b/3.1.2/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 0000000..e9f60ca Binary files /dev/null and b/3.1.2/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/3.1.2/_static/css/fonts/fontawesome-webfont.svg b/3.1.2/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 0000000..855c845 --- /dev/null +++ b/3.1.2/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/3.1.2/_static/css/fonts/fontawesome-webfont.ttf b/3.1.2/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 0000000..35acda2 Binary files /dev/null and b/3.1.2/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/3.1.2/_static/css/fonts/fontawesome-webfont.woff b/3.1.2/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 0000000..400014a Binary files /dev/null and b/3.1.2/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/3.1.2/_static/css/fonts/fontawesome-webfont.woff2 b/3.1.2/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 0000000..4d13fc6 Binary files /dev/null and b/3.1.2/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/3.1.2/_static/css/fonts/lato-bold-italic.woff b/3.1.2/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 0000000..88ad05b Binary files /dev/null and b/3.1.2/_static/css/fonts/lato-bold-italic.woff differ diff --git a/3.1.2/_static/css/fonts/lato-bold-italic.woff2 b/3.1.2/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 0000000..c4e3d80 Binary files /dev/null and b/3.1.2/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/3.1.2/_static/css/fonts/lato-bold.woff b/3.1.2/_static/css/fonts/lato-bold.woff new file mode 100644 index 0000000..c6dff51 Binary files /dev/null and b/3.1.2/_static/css/fonts/lato-bold.woff differ diff --git a/3.1.2/_static/css/fonts/lato-bold.woff2 b/3.1.2/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 0000000..bb19504 Binary files /dev/null and b/3.1.2/_static/css/fonts/lato-bold.woff2 differ diff --git a/3.1.2/_static/css/fonts/lato-normal-italic.woff b/3.1.2/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 0000000..76114bc Binary files /dev/null and b/3.1.2/_static/css/fonts/lato-normal-italic.woff differ diff --git a/3.1.2/_static/css/fonts/lato-normal-italic.woff2 b/3.1.2/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 0000000..3404f37 Binary files /dev/null and b/3.1.2/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/3.1.2/_static/css/fonts/lato-normal.woff b/3.1.2/_static/css/fonts/lato-normal.woff new file mode 100644 index 0000000..ae1307f Binary files /dev/null and b/3.1.2/_static/css/fonts/lato-normal.woff differ diff --git a/3.1.2/_static/css/fonts/lato-normal.woff2 b/3.1.2/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 0000000..3bf9843 Binary files /dev/null and b/3.1.2/_static/css/fonts/lato-normal.woff2 differ diff --git a/3.1.2/_static/css/theme.css b/3.1.2/_static/css/theme.css new file mode 100644 index 0000000..a88467c --- /dev/null +++ b/3.1.2/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search .wy-dropdown>aactive,.wy-side-nav-search .wy-dropdown>afocus,.wy-side-nav-search>a:hover,.wy-side-nav-search>aactive,.wy-side-nav-search>afocus{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon,.wy-side-nav-search>a.icon{display:block}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.switch-menus{position:relative;display:block;margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-side-nav-search>div.switch-menus>div.language-switch,.wy-side-nav-search>div.switch-menus>div.version-switch{display:inline-block;padding:.2em}.wy-side-nav-search>div.switch-menus>div.language-switch select,.wy-side-nav-search>div.switch-menus>div.version-switch select{display:inline-block;margin-right:-2rem;padding-right:2rem;max-width:240px;text-align-last:center;background:none;border:none;border-radius:0;box-shadow:none;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-size:1em;font-weight:400;color:hsla(0,0%,100%,.3);cursor:pointer;appearance:none;-webkit-appearance:none;-moz-appearance:none}.wy-side-nav-search>div.switch-menus>div.language-switch select:active,.wy-side-nav-search>div.switch-menus>div.language-switch select:focus,.wy-side-nav-search>div.switch-menus>div.language-switch select:hover,.wy-side-nav-search>div.switch-menus>div.version-switch select:active,.wy-side-nav-search>div.switch-menus>div.version-switch select:focus,.wy-side-nav-search>div.switch-menus>div.version-switch select:hover{background:hsla(0,0%,100%,.1);color:hsla(0,0%,100%,.5)}.wy-side-nav-search>div.switch-menus>div.language-switch select option,.wy-side-nav-search>div.switch-menus>div.version-switch select option{color:#000}.wy-side-nav-search>div.switch-menus>div.language-switch:has(>select):after,.wy-side-nav-search>div.switch-menus>div.version-switch:has(>select):after{display:inline-block;width:1.5em;height:100%;padding:.1em;content:"\f0d7";font-size:1em;line-height:1.2em;font-family:FontAwesome;text-align:center;pointer-events:none;box-sizing:border-box}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions .rst-other-versions .rtd-current-item{font-weight:700}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}#flyout-search-form{padding:6px}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%;float:none;margin-left:0}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/3.1.2/_static/doctools.js b/3.1.2/_static/doctools.js new file mode 100644 index 0000000..807cdb1 --- /dev/null +++ b/3.1.2/_static/doctools.js @@ -0,0 +1,150 @@ +/* + * Base JavaScript utilities for all Sphinx HTML documentation. + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})`, + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)), + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS + && !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) + return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/3.1.2/_static/documentation_options.js b/3.1.2/_static/documentation_options.js new file mode 100644 index 0000000..7e4c114 --- /dev/null +++ b/3.1.2/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/3.1.2/_static/english-stemmer.js b/3.1.2/_static/english-stemmer.js new file mode 100644 index 0000000..056760e --- /dev/null +++ b/3.1.2/_static/english-stemmer.js @@ -0,0 +1,1066 @@ +// Generated from english.sbl by Snowball 3.0.1 - https://snowballstem.org/ + +/**@constructor*/ +var EnglishStemmer = function() { + var base = new BaseStemmer(); + + /** @const */ var a_0 = [ + ["arsen", -1, -1], + ["commun", -1, -1], + ["emerg", -1, -1], + ["gener", -1, -1], + ["later", -1, -1], + ["organ", -1, -1], + ["past", -1, -1], + ["univers", -1, -1] + ]; + + /** @const */ var a_1 = [ + ["'", -1, 1], + ["'s'", 0, 1], + ["'s", -1, 1] + ]; + + /** @const */ var a_2 = [ + ["ied", -1, 2], + ["s", -1, 3], + ["ies", 1, 2], + ["sses", 1, 1], + ["ss", 1, -1], + ["us", 1, -1] + ]; + + /** @const */ var a_3 = [ + ["succ", -1, 1], + ["proc", -1, 1], + ["exc", -1, 1] + ]; + + /** @const */ var a_4 = [ + ["even", -1, 2], + ["cann", -1, 2], + ["inn", -1, 2], + ["earr", -1, 2], + ["herr", -1, 2], + ["out", -1, 2], + ["y", -1, 1] + ]; + + /** @const */ var a_5 = [ + ["", -1, -1], + ["ed", 0, 2], + ["eed", 1, 1], + ["ing", 0, 3], + ["edly", 0, 2], + ["eedly", 4, 1], + ["ingly", 0, 2] + ]; + + /** @const */ var a_6 = [ + ["", -1, 3], + ["bb", 0, 2], + ["dd", 0, 2], + ["ff", 0, 2], + ["gg", 0, 2], + ["bl", 0, 1], + ["mm", 0, 2], + ["nn", 0, 2], + ["pp", 0, 2], + ["rr", 0, 2], + ["at", 0, 1], + ["tt", 0, 2], + ["iz", 0, 1] + ]; + + /** @const */ var a_7 = [ + ["anci", -1, 3], + ["enci", -1, 2], + ["ogi", -1, 14], + ["li", -1, 16], + ["bli", 3, 12], + ["abli", 4, 4], + ["alli", 3, 8], + ["fulli", 3, 9], + ["lessli", 3, 15], + ["ousli", 3, 10], + ["entli", 3, 5], + ["aliti", -1, 8], + ["biliti", -1, 12], + ["iviti", -1, 11], + ["tional", -1, 1], + ["ational", 14, 7], + ["alism", -1, 8], + ["ation", -1, 7], + ["ization", 17, 6], + ["izer", -1, 6], + ["ator", -1, 7], + ["iveness", -1, 11], + ["fulness", -1, 9], + ["ousness", -1, 10], + ["ogist", -1, 13] + ]; + + /** @const */ var a_8 = [ + ["icate", -1, 4], + ["ative", -1, 6], + ["alize", -1, 3], + ["iciti", -1, 4], + ["ical", -1, 4], + ["tional", -1, 1], + ["ational", 5, 2], + ["ful", -1, 5], + ["ness", -1, 5] + ]; + + /** @const */ var a_9 = [ + ["ic", -1, 1], + ["ance", -1, 1], + ["ence", -1, 1], + ["able", -1, 1], + ["ible", -1, 1], + ["ate", -1, 1], + ["ive", -1, 1], + ["ize", -1, 1], + ["iti", -1, 1], + ["al", -1, 1], + ["ism", -1, 1], + ["ion", -1, 2], + ["er", -1, 1], + ["ous", -1, 1], + ["ant", -1, 1], + ["ent", -1, 1], + ["ment", 15, 1], + ["ement", 16, 1] + ]; + + /** @const */ var a_10 = [ + ["e", -1, 1], + ["l", -1, 2] + ]; + + /** @const */ var a_11 = [ + ["andes", -1, -1], + ["atlas", -1, -1], + ["bias", -1, -1], + ["cosmos", -1, -1], + ["early", -1, 5], + ["gently", -1, 3], + ["howe", -1, -1], + ["idly", -1, 2], + ["news", -1, -1], + ["only", -1, 6], + ["singly", -1, 7], + ["skies", -1, 1], + ["sky", -1, -1], + ["ugly", -1, 4] + ]; + + /** @const */ var /** Array */ g_aeo = [17, 64]; + + /** @const */ var /** Array */ g_v = [17, 65, 16, 1]; + + /** @const */ var /** Array */ g_v_WXY = [1, 17, 65, 208, 1]; + + /** @const */ var /** Array */ g_valid_LI = [55, 141, 2]; + + var /** boolean */ B_Y_found = false; + var /** number */ I_p2 = 0; + var /** number */ I_p1 = 0; + + + /** @return {boolean} */ + function r_prelude() { + B_Y_found = false; + /** @const */ var /** number */ v_1 = base.cursor; + lab0: { + base.bra = base.cursor; + if (!(base.eq_s("'"))) + { + break lab0; + } + base.ket = base.cursor; + if (!base.slice_del()) + { + return false; + } + } + base.cursor = v_1; + /** @const */ var /** number */ v_2 = base.cursor; + lab1: { + base.bra = base.cursor; + if (!(base.eq_s("y"))) + { + break lab1; + } + base.ket = base.cursor; + if (!base.slice_from("Y")) + { + return false; + } + B_Y_found = true; + } + base.cursor = v_2; + /** @const */ var /** number */ v_3 = base.cursor; + lab2: { + while(true) + { + /** @const */ var /** number */ v_4 = base.cursor; + lab3: { + golab4: while(true) + { + /** @const */ var /** number */ v_5 = base.cursor; + lab5: { + if (!(base.in_grouping(g_v, 97, 121))) + { + break lab5; + } + base.bra = base.cursor; + if (!(base.eq_s("y"))) + { + break lab5; + } + base.ket = base.cursor; + base.cursor = v_5; + break golab4; + } + base.cursor = v_5; + if (base.cursor >= base.limit) + { + break lab3; + } + base.cursor++; + } + if (!base.slice_from("Y")) + { + return false; + } + B_Y_found = true; + continue; + } + base.cursor = v_4; + break; + } + } + base.cursor = v_3; + return true; + }; + + /** @return {boolean} */ + function r_mark_regions() { + I_p1 = base.limit; + I_p2 = base.limit; + /** @const */ var /** number */ v_1 = base.cursor; + lab0: { + lab1: { + /** @const */ var /** number */ v_2 = base.cursor; + lab2: { + if (base.find_among(a_0) == 0) + { + break lab2; + } + break lab1; + } + base.cursor = v_2; + if (!base.go_out_grouping(g_v, 97, 121)) + { + break lab0; + } + base.cursor++; + if (!base.go_in_grouping(g_v, 97, 121)) + { + break lab0; + } + base.cursor++; + } + I_p1 = base.cursor; + if (!base.go_out_grouping(g_v, 97, 121)) + { + break lab0; + } + base.cursor++; + if (!base.go_in_grouping(g_v, 97, 121)) + { + break lab0; + } + base.cursor++; + I_p2 = base.cursor; + } + base.cursor = v_1; + return true; + }; + + /** @return {boolean} */ + function r_shortv() { + lab0: { + /** @const */ var /** number */ v_1 = base.limit - base.cursor; + lab1: { + if (!(base.out_grouping_b(g_v_WXY, 89, 121))) + { + break lab1; + } + if (!(base.in_grouping_b(g_v, 97, 121))) + { + break lab1; + } + if (!(base.out_grouping_b(g_v, 97, 121))) + { + break lab1; + } + break lab0; + } + base.cursor = base.limit - v_1; + lab2: { + if (!(base.out_grouping_b(g_v, 97, 121))) + { + break lab2; + } + if (!(base.in_grouping_b(g_v, 97, 121))) + { + break lab2; + } + if (base.cursor > base.limit_backward) + { + break lab2; + } + break lab0; + } + base.cursor = base.limit - v_1; + if (!(base.eq_s_b("past"))) + { + return false; + } + } + return true; + }; + + /** @return {boolean} */ + function r_R1() { + return I_p1 <= base.cursor; + }; + + /** @return {boolean} */ + function r_R2() { + return I_p2 <= base.cursor; + }; + + /** @return {boolean} */ + function r_Step_1a() { + var /** number */ among_var; + /** @const */ var /** number */ v_1 = base.limit - base.cursor; + lab0: { + base.ket = base.cursor; + if (base.find_among_b(a_1) == 0) + { + base.cursor = base.limit - v_1; + break lab0; + } + base.bra = base.cursor; + if (!base.slice_del()) + { + return false; + } + } + base.ket = base.cursor; + among_var = base.find_among_b(a_2); + if (among_var == 0) + { + return false; + } + base.bra = base.cursor; + switch (among_var) { + case 1: + if (!base.slice_from("ss")) + { + return false; + } + break; + case 2: + lab1: { + /** @const */ var /** number */ v_2 = base.limit - base.cursor; + lab2: { + { + /** @const */ var /** number */ c1 = base.cursor - 2; + if (c1 < base.limit_backward) + { + break lab2; + } + base.cursor = c1; + } + if (!base.slice_from("i")) + { + return false; + } + break lab1; + } + base.cursor = base.limit - v_2; + if (!base.slice_from("ie")) + { + return false; + } + } + break; + case 3: + if (base.cursor <= base.limit_backward) + { + return false; + } + base.cursor--; + if (!base.go_out_grouping_b(g_v, 97, 121)) + { + return false; + } + base.cursor--; + if (!base.slice_del()) + { + return false; + } + break; + } + return true; + }; + + /** @return {boolean} */ + function r_Step_1b() { + var /** number */ among_var; + base.ket = base.cursor; + among_var = base.find_among_b(a_5); + base.bra = base.cursor; + lab0: { + /** @const */ var /** number */ v_1 = base.limit - base.cursor; + lab1: { + switch (among_var) { + case 1: + /** @const */ var /** number */ v_2 = base.limit - base.cursor; + lab2: { + lab3: { + /** @const */ var /** number */ v_3 = base.limit - base.cursor; + lab4: { + if (base.find_among_b(a_3) == 0) + { + break lab4; + } + if (base.cursor > base.limit_backward) + { + break lab4; + } + break lab3; + } + base.cursor = base.limit - v_3; + if (!r_R1()) + { + break lab2; + } + if (!base.slice_from("ee")) + { + return false; + } + } + } + base.cursor = base.limit - v_2; + break; + case 2: + break lab1; + case 3: + among_var = base.find_among_b(a_4); + if (among_var == 0) + { + break lab1; + } + switch (among_var) { + case 1: + /** @const */ var /** number */ v_4 = base.limit - base.cursor; + if (!(base.out_grouping_b(g_v, 97, 121))) + { + break lab1; + } + if (base.cursor > base.limit_backward) + { + break lab1; + } + base.cursor = base.limit - v_4; + base.bra = base.cursor; + if (!base.slice_from("ie")) + { + return false; + } + break; + case 2: + if (base.cursor > base.limit_backward) + { + break lab1; + } + break; + } + break; + } + break lab0; + } + base.cursor = base.limit - v_1; + /** @const */ var /** number */ v_5 = base.limit - base.cursor; + if (!base.go_out_grouping_b(g_v, 97, 121)) + { + return false; + } + base.cursor--; + base.cursor = base.limit - v_5; + if (!base.slice_del()) + { + return false; + } + base.ket = base.cursor; + base.bra = base.cursor; + /** @const */ var /** number */ v_6 = base.limit - base.cursor; + among_var = base.find_among_b(a_6); + switch (among_var) { + case 1: + if (!base.slice_from("e")) + { + return false; + } + return false; + case 2: + { + /** @const */ var /** number */ v_7 = base.limit - base.cursor; + lab5: { + if (!(base.in_grouping_b(g_aeo, 97, 111))) + { + break lab5; + } + if (base.cursor > base.limit_backward) + { + break lab5; + } + return false; + } + base.cursor = base.limit - v_7; + } + break; + case 3: + if (base.cursor != I_p1) + { + return false; + } + /** @const */ var /** number */ v_8 = base.limit - base.cursor; + if (!r_shortv()) + { + return false; + } + base.cursor = base.limit - v_8; + if (!base.slice_from("e")) + { + return false; + } + return false; + } + base.cursor = base.limit - v_6; + base.ket = base.cursor; + if (base.cursor <= base.limit_backward) + { + return false; + } + base.cursor--; + base.bra = base.cursor; + if (!base.slice_del()) + { + return false; + } + } + return true; + }; + + /** @return {boolean} */ + function r_Step_1c() { + base.ket = base.cursor; + lab0: { + /** @const */ var /** number */ v_1 = base.limit - base.cursor; + lab1: { + if (!(base.eq_s_b("y"))) + { + break lab1; + } + break lab0; + } + base.cursor = base.limit - v_1; + if (!(base.eq_s_b("Y"))) + { + return false; + } + } + base.bra = base.cursor; + if (!(base.out_grouping_b(g_v, 97, 121))) + { + return false; + } + lab2: { + if (base.cursor > base.limit_backward) + { + break lab2; + } + return false; + } + if (!base.slice_from("i")) + { + return false; + } + return true; + }; + + /** @return {boolean} */ + function r_Step_2() { + var /** number */ among_var; + base.ket = base.cursor; + among_var = base.find_among_b(a_7); + if (among_var == 0) + { + return false; + } + base.bra = base.cursor; + if (!r_R1()) + { + return false; + } + switch (among_var) { + case 1: + if (!base.slice_from("tion")) + { + return false; + } + break; + case 2: + if (!base.slice_from("ence")) + { + return false; + } + break; + case 3: + if (!base.slice_from("ance")) + { + return false; + } + break; + case 4: + if (!base.slice_from("able")) + { + return false; + } + break; + case 5: + if (!base.slice_from("ent")) + { + return false; + } + break; + case 6: + if (!base.slice_from("ize")) + { + return false; + } + break; + case 7: + if (!base.slice_from("ate")) + { + return false; + } + break; + case 8: + if (!base.slice_from("al")) + { + return false; + } + break; + case 9: + if (!base.slice_from("ful")) + { + return false; + } + break; + case 10: + if (!base.slice_from("ous")) + { + return false; + } + break; + case 11: + if (!base.slice_from("ive")) + { + return false; + } + break; + case 12: + if (!base.slice_from("ble")) + { + return false; + } + break; + case 13: + if (!base.slice_from("og")) + { + return false; + } + break; + case 14: + if (!(base.eq_s_b("l"))) + { + return false; + } + if (!base.slice_from("og")) + { + return false; + } + break; + case 15: + if (!base.slice_from("less")) + { + return false; + } + break; + case 16: + if (!(base.in_grouping_b(g_valid_LI, 99, 116))) + { + return false; + } + if (!base.slice_del()) + { + return false; + } + break; + } + return true; + }; + + /** @return {boolean} */ + function r_Step_3() { + var /** number */ among_var; + base.ket = base.cursor; + among_var = base.find_among_b(a_8); + if (among_var == 0) + { + return false; + } + base.bra = base.cursor; + if (!r_R1()) + { + return false; + } + switch (among_var) { + case 1: + if (!base.slice_from("tion")) + { + return false; + } + break; + case 2: + if (!base.slice_from("ate")) + { + return false; + } + break; + case 3: + if (!base.slice_from("al")) + { + return false; + } + break; + case 4: + if (!base.slice_from("ic")) + { + return false; + } + break; + case 5: + if (!base.slice_del()) + { + return false; + } + break; + case 6: + if (!r_R2()) + { + return false; + } + if (!base.slice_del()) + { + return false; + } + break; + } + return true; + }; + + /** @return {boolean} */ + function r_Step_4() { + var /** number */ among_var; + base.ket = base.cursor; + among_var = base.find_among_b(a_9); + if (among_var == 0) + { + return false; + } + base.bra = base.cursor; + if (!r_R2()) + { + return false; + } + switch (among_var) { + case 1: + if (!base.slice_del()) + { + return false; + } + break; + case 2: + lab0: { + /** @const */ var /** number */ v_1 = base.limit - base.cursor; + lab1: { + if (!(base.eq_s_b("s"))) + { + break lab1; + } + break lab0; + } + base.cursor = base.limit - v_1; + if (!(base.eq_s_b("t"))) + { + return false; + } + } + if (!base.slice_del()) + { + return false; + } + break; + } + return true; + }; + + /** @return {boolean} */ + function r_Step_5() { + var /** number */ among_var; + base.ket = base.cursor; + among_var = base.find_among_b(a_10); + if (among_var == 0) + { + return false; + } + base.bra = base.cursor; + switch (among_var) { + case 1: + lab0: { + lab1: { + if (!r_R2()) + { + break lab1; + } + break lab0; + } + if (!r_R1()) + { + return false; + } + { + /** @const */ var /** number */ v_1 = base.limit - base.cursor; + lab2: { + if (!r_shortv()) + { + break lab2; + } + return false; + } + base.cursor = base.limit - v_1; + } + } + if (!base.slice_del()) + { + return false; + } + break; + case 2: + if (!r_R2()) + { + return false; + } + if (!(base.eq_s_b("l"))) + { + return false; + } + if (!base.slice_del()) + { + return false; + } + break; + } + return true; + }; + + /** @return {boolean} */ + function r_exception1() { + var /** number */ among_var; + base.bra = base.cursor; + among_var = base.find_among(a_11); + if (among_var == 0) + { + return false; + } + base.ket = base.cursor; + if (base.cursor < base.limit) + { + return false; + } + switch (among_var) { + case 1: + if (!base.slice_from("sky")) + { + return false; + } + break; + case 2: + if (!base.slice_from("idl")) + { + return false; + } + break; + case 3: + if (!base.slice_from("gentl")) + { + return false; + } + break; + case 4: + if (!base.slice_from("ugli")) + { + return false; + } + break; + case 5: + if (!base.slice_from("earli")) + { + return false; + } + break; + case 6: + if (!base.slice_from("onli")) + { + return false; + } + break; + case 7: + if (!base.slice_from("singl")) + { + return false; + } + break; + } + return true; + }; + + /** @return {boolean} */ + function r_postlude() { + if (!B_Y_found) + { + return false; + } + while(true) + { + /** @const */ var /** number */ v_1 = base.cursor; + lab0: { + golab1: while(true) + { + /** @const */ var /** number */ v_2 = base.cursor; + lab2: { + base.bra = base.cursor; + if (!(base.eq_s("Y"))) + { + break lab2; + } + base.ket = base.cursor; + base.cursor = v_2; + break golab1; + } + base.cursor = v_2; + if (base.cursor >= base.limit) + { + break lab0; + } + base.cursor++; + } + if (!base.slice_from("y")) + { + return false; + } + continue; + } + base.cursor = v_1; + break; + } + return true; + }; + + this.stem = /** @return {boolean} */ function() { + lab0: { + /** @const */ var /** number */ v_1 = base.cursor; + lab1: { + if (!r_exception1()) + { + break lab1; + } + break lab0; + } + base.cursor = v_1; + lab2: { + { + /** @const */ var /** number */ v_2 = base.cursor; + lab3: { + { + /** @const */ var /** number */ c1 = base.cursor + 3; + if (c1 > base.limit) + { + break lab3; + } + base.cursor = c1; + } + break lab2; + } + base.cursor = v_2; + } + break lab0; + } + base.cursor = v_1; + r_prelude(); + r_mark_regions(); + base.limit_backward = base.cursor; base.cursor = base.limit; + /** @const */ var /** number */ v_3 = base.limit - base.cursor; + r_Step_1a(); + base.cursor = base.limit - v_3; + /** @const */ var /** number */ v_4 = base.limit - base.cursor; + r_Step_1b(); + base.cursor = base.limit - v_4; + /** @const */ var /** number */ v_5 = base.limit - base.cursor; + r_Step_1c(); + base.cursor = base.limit - v_5; + /** @const */ var /** number */ v_6 = base.limit - base.cursor; + r_Step_2(); + base.cursor = base.limit - v_6; + /** @const */ var /** number */ v_7 = base.limit - base.cursor; + r_Step_3(); + base.cursor = base.limit - v_7; + /** @const */ var /** number */ v_8 = base.limit - base.cursor; + r_Step_4(); + base.cursor = base.limit - v_8; + /** @const */ var /** number */ v_9 = base.limit - base.cursor; + r_Step_5(); + base.cursor = base.limit - v_9; + base.cursor = base.limit_backward; + /** @const */ var /** number */ v_10 = base.cursor; + r_postlude(); + base.cursor = v_10; + } + return true; + }; + + /**@return{string}*/ + this['stemWord'] = function(/**string*/word) { + base.setCurrent(word); + this.stem(); + return base.getCurrent(); + }; +}; diff --git a/3.1.2/_static/file.png b/3.1.2/_static/file.png new file mode 100644 index 0000000..a858a41 Binary files /dev/null and b/3.1.2/_static/file.png differ diff --git a/3.1.2/_static/fonts/Lato/lato-bold.eot b/3.1.2/_static/fonts/Lato/lato-bold.eot new file mode 100644 index 0000000..3361183 Binary files /dev/null and b/3.1.2/_static/fonts/Lato/lato-bold.eot differ diff --git a/3.1.2/_static/fonts/Lato/lato-bold.ttf b/3.1.2/_static/fonts/Lato/lato-bold.ttf new file mode 100644 index 0000000..29f691d Binary files /dev/null and b/3.1.2/_static/fonts/Lato/lato-bold.ttf differ diff --git a/3.1.2/_static/fonts/Lato/lato-bold.woff b/3.1.2/_static/fonts/Lato/lato-bold.woff new file mode 100644 index 0000000..c6dff51 Binary files /dev/null and b/3.1.2/_static/fonts/Lato/lato-bold.woff differ diff --git a/3.1.2/_static/fonts/Lato/lato-bold.woff2 b/3.1.2/_static/fonts/Lato/lato-bold.woff2 new file mode 100644 index 0000000..bb19504 Binary files /dev/null and b/3.1.2/_static/fonts/Lato/lato-bold.woff2 differ diff --git a/3.1.2/_static/fonts/Lato/lato-bolditalic.eot b/3.1.2/_static/fonts/Lato/lato-bolditalic.eot new file mode 100644 index 0000000..3d41549 Binary files /dev/null and b/3.1.2/_static/fonts/Lato/lato-bolditalic.eot differ diff --git a/3.1.2/_static/fonts/Lato/lato-bolditalic.ttf b/3.1.2/_static/fonts/Lato/lato-bolditalic.ttf new file mode 100644 index 0000000..f402040 Binary files /dev/null and b/3.1.2/_static/fonts/Lato/lato-bolditalic.ttf differ diff --git a/3.1.2/_static/fonts/Lato/lato-bolditalic.woff b/3.1.2/_static/fonts/Lato/lato-bolditalic.woff new file mode 100644 index 0000000..88ad05b Binary files /dev/null and b/3.1.2/_static/fonts/Lato/lato-bolditalic.woff differ diff --git a/3.1.2/_static/fonts/Lato/lato-bolditalic.woff2 b/3.1.2/_static/fonts/Lato/lato-bolditalic.woff2 new file mode 100644 index 0000000..c4e3d80 Binary files /dev/null and b/3.1.2/_static/fonts/Lato/lato-bolditalic.woff2 differ diff --git a/3.1.2/_static/fonts/Lato/lato-italic.eot b/3.1.2/_static/fonts/Lato/lato-italic.eot new file mode 100644 index 0000000..3f82642 Binary files /dev/null and b/3.1.2/_static/fonts/Lato/lato-italic.eot differ diff --git a/3.1.2/_static/fonts/Lato/lato-italic.ttf b/3.1.2/_static/fonts/Lato/lato-italic.ttf new file mode 100644 index 0000000..b4bfc9b Binary files /dev/null and b/3.1.2/_static/fonts/Lato/lato-italic.ttf differ diff --git a/3.1.2/_static/fonts/Lato/lato-italic.woff b/3.1.2/_static/fonts/Lato/lato-italic.woff new file mode 100644 index 0000000..76114bc Binary files /dev/null and b/3.1.2/_static/fonts/Lato/lato-italic.woff differ diff --git a/3.1.2/_static/fonts/Lato/lato-italic.woff2 b/3.1.2/_static/fonts/Lato/lato-italic.woff2 new file mode 100644 index 0000000..3404f37 Binary files /dev/null and b/3.1.2/_static/fonts/Lato/lato-italic.woff2 differ diff --git a/3.1.2/_static/fonts/Lato/lato-regular.eot b/3.1.2/_static/fonts/Lato/lato-regular.eot new file mode 100644 index 0000000..11e3f2a Binary files /dev/null and b/3.1.2/_static/fonts/Lato/lato-regular.eot differ diff --git a/3.1.2/_static/fonts/Lato/lato-regular.ttf b/3.1.2/_static/fonts/Lato/lato-regular.ttf new file mode 100644 index 0000000..74decd9 Binary files /dev/null and b/3.1.2/_static/fonts/Lato/lato-regular.ttf differ diff --git a/3.1.2/_static/fonts/Lato/lato-regular.woff b/3.1.2/_static/fonts/Lato/lato-regular.woff new file mode 100644 index 0000000..ae1307f Binary files /dev/null and b/3.1.2/_static/fonts/Lato/lato-regular.woff differ diff --git a/3.1.2/_static/fonts/Lato/lato-regular.woff2 b/3.1.2/_static/fonts/Lato/lato-regular.woff2 new file mode 100644 index 0000000..3bf9843 Binary files /dev/null and b/3.1.2/_static/fonts/Lato/lato-regular.woff2 differ diff --git a/3.1.2/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot b/3.1.2/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot new file mode 100644 index 0000000..79dc8ef Binary files /dev/null and b/3.1.2/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot differ diff --git a/3.1.2/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf b/3.1.2/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf new file mode 100644 index 0000000..df5d1df Binary files /dev/null and b/3.1.2/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf differ diff --git a/3.1.2/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff b/3.1.2/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff new file mode 100644 index 0000000..6cb6000 Binary files /dev/null and b/3.1.2/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff differ diff --git a/3.1.2/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 b/3.1.2/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 new file mode 100644 index 0000000..7059e23 Binary files /dev/null and b/3.1.2/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 differ diff --git a/3.1.2/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot b/3.1.2/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot new file mode 100644 index 0000000..2f7ca78 Binary files /dev/null and b/3.1.2/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot differ diff --git a/3.1.2/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf b/3.1.2/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf new file mode 100644 index 0000000..eb52a79 Binary files /dev/null and b/3.1.2/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf differ diff --git a/3.1.2/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff b/3.1.2/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff new file mode 100644 index 0000000..f815f63 Binary files /dev/null and b/3.1.2/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff differ diff --git a/3.1.2/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 b/3.1.2/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 new file mode 100644 index 0000000..f2c76e5 Binary files /dev/null and b/3.1.2/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 differ diff --git a/3.1.2/_static/jquery.js b/3.1.2/_static/jquery.js new file mode 100644 index 0000000..c4c6022 --- /dev/null +++ b/3.1.2/_static/jquery.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0"),n("table.docutils.footnote").wrap("
"),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(''),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}if(t.length>0){$(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded","false"),t.addClass("current").attr("aria-expanded","true"),t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded","true");for(let n=1;n<=10;n++)t.closest("li.toctree-l"+n).addClass("current").attr("aria-expanded","true");t[0].scrollIntoView()}}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current").attr("aria-expanded","false"),e.siblings().find("li.current").removeClass("current").attr("aria-expanded","false");var t=e.find("> ul li");t.length&&(t.removeClass("current").attr("aria-expanded","false"),e.toggleClass("current").attr("aria-expanded",(function(n,e){return"true"==e?"false":"true"})))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t a.language.name.localeCompare(b.language.name)); + + const languagesHTML = ` +
+
Languages
+ ${languages + .map( + (translation) => ` +
+ ${translation.language.code} +
+ `, + ) + .join("\n")} +
+ `; + return languagesHTML; + } + + function renderVersions(config) { + if (!config.versions.active.length) { + return ""; + } + const versionsHTML = ` +
+
Versions
+ ${config.versions.active + .map( + (version) => ` +
+ ${version.slug} +
+ `, + ) + .join("\n")} +
+ `; + return versionsHTML; + } + + function renderDownloads(config) { + if (!Object.keys(config.versions.current.downloads).length) { + return ""; + } + const downloadsNameDisplay = { + pdf: "PDF", + epub: "Epub", + htmlzip: "HTML", + }; + + const downloadsHTML = ` +
+
Downloads
+ ${Object.entries(config.versions.current.downloads) + .map( + ([name, url]) => ` +
+ ${downloadsNameDisplay[name]} +
+ `, + ) + .join("\n")} +
+ `; + return downloadsHTML; + } + + document.addEventListener("readthedocs-addons-data-ready", function (event) { + const config = event.detail.data(); + + const flyout = ` +
+ + Read the Docs + v: ${config.versions.current.slug} + + +
+
+ ${renderLanguages(config)} + ${renderVersions(config)} + ${renderDownloads(config)} +
+
On Read the Docs
+
+ Project Home +
+
+ Builds +
+
+ Downloads +
+
+
+
Search
+
+
+ +
+
+
+
+ + Hosted by Read the Docs + +
+
+ `; + + // Inject the generated flyout into the body HTML element. + document.body.insertAdjacentHTML("beforeend", flyout); + + // Trigger the Read the Docs Addons Search modal when clicking on the "Search docs" input from inside the flyout. + document + .querySelector("#flyout-search-form") + .addEventListener("focusin", () => { + const event = new CustomEvent("readthedocs-search-show"); + document.dispatchEvent(event); + }); + }) +} + +if (themeLanguageSelector || themeVersionSelector) { + function onSelectorSwitch(event) { + const option = event.target.selectedIndex; + const item = event.target.options[option]; + window.location.href = item.dataset.url; + } + + document.addEventListener("readthedocs-addons-data-ready", function (event) { + const config = event.detail.data(); + + const versionSwitch = document.querySelector( + "div.switch-menus > div.version-switch", + ); + if (themeVersionSelector) { + let versions = config.versions.active; + if (config.versions.current.hidden || config.versions.current.type === "external") { + versions.unshift(config.versions.current); + } + const versionSelect = ` + + `; + + versionSwitch.innerHTML = versionSelect; + versionSwitch.firstElementChild.addEventListener("change", onSelectorSwitch); + } + + const languageSwitch = document.querySelector( + "div.switch-menus > div.language-switch", + ); + + if (themeLanguageSelector) { + if (config.projects.translations.length) { + // Add the current language to the options on the selector + let languages = config.projects.translations.concat( + config.projects.current, + ); + languages = languages.sort((a, b) => + a.language.name.localeCompare(b.language.name), + ); + + const languageSelect = ` + + `; + + languageSwitch.innerHTML = languageSelect; + languageSwitch.firstElementChild.addEventListener("change", onSelectorSwitch); + } + else { + languageSwitch.remove(); + } + } + }); +} + +document.addEventListener("readthedocs-addons-data-ready", function (event) { + // Trigger the Read the Docs Addons Search modal when clicking on "Search docs" input from the topnav. + document + .querySelector("[role='search'] input") + .addEventListener("focusin", () => { + const event = new CustomEvent("readthedocs-search-show"); + document.dispatchEvent(event); + }); +}); \ No newline at end of file diff --git a/3.1.2/_static/language_data.js b/3.1.2/_static/language_data.js new file mode 100644 index 0000000..5776786 --- /dev/null +++ b/3.1.2/_static/language_data.js @@ -0,0 +1,13 @@ +/* + * This script contains the language-specific data used by searchtools.js, + * namely the set of stopwords, stemmer, scorer and splitter. + */ + +const stopwords = new Set(["a", "about", "above", "after", "again", "against", "all", "am", "an", "and", "any", "are", "aren't", "as", "at", "be", "because", "been", "before", "being", "below", "between", "both", "but", "by", "can't", "cannot", "could", "couldn't", "did", "didn't", "do", "does", "doesn't", "doing", "don't", "down", "during", "each", "few", "for", "from", "further", "had", "hadn't", "has", "hasn't", "have", "haven't", "having", "he", "he'd", "he'll", "he's", "her", "here", "here's", "hers", "herself", "him", "himself", "his", "how", "how's", "i", "i'd", "i'll", "i'm", "i've", "if", "in", "into", "is", "isn't", "it", "it's", "its", "itself", "let's", "me", "more", "most", "mustn't", "my", "myself", "no", "nor", "not", "of", "off", "on", "once", "only", "or", "other", "ought", "our", "ours", "ourselves", "out", "over", "own", "same", "shan't", "she", "she'd", "she'll", "she's", "should", "shouldn't", "so", "some", "such", "than", "that", "that's", "the", "their", "theirs", "them", "themselves", "then", "there", "there's", "these", "they", "they'd", "they'll", "they're", "they've", "this", "those", "through", "to", "too", "under", "until", "up", "very", "was", "wasn't", "we", "we'd", "we'll", "we're", "we've", "were", "weren't", "what", "what's", "when", "when's", "where", "where's", "which", "while", "who", "who's", "whom", "why", "why's", "with", "won't", "would", "wouldn't", "you", "you'd", "you'll", "you're", "you've", "your", "yours", "yourself", "yourselves"]); +window.stopwords = stopwords; // Export to global scope + + +/* Non-minified versions are copied as separate JavaScript files, if available */ +BaseStemmer=function(){this.current="",this.cursor=0,this.limit=0,this.limit_backward=0,this.bra=0,this.ket=0,this.setCurrent=function(t){this.current=t,this.cursor=0,this.limit=this.current.length,this.limit_backward=0,this.bra=this.cursor,this.ket=this.limit},this.getCurrent=function(){return this.current},this.copy_from=function(t){this.current=t.current,this.cursor=t.cursor,this.limit=t.limit,this.limit_backward=t.limit_backward,this.bra=t.bra,this.ket=t.ket},this.in_grouping=function(t,r,i){return!(this.cursor>=this.limit||i<(i=this.current.charCodeAt(this.cursor))||i>>3]&1<<(7&i))||(this.cursor++,0))},this.go_in_grouping=function(t,r,i){for(;this.cursor>>3]&1<<(7&s)))return!0;this.cursor++}return!1},this.in_grouping_b=function(t,r,i){return!(this.cursor<=this.limit_backward||i<(i=this.current.charCodeAt(this.cursor-1))||i>>3]&1<<(7&i))||(this.cursor--,0))},this.go_in_grouping_b=function(t,r,i){for(;this.cursor>this.limit_backward;){var s=this.current.charCodeAt(this.cursor-1);if(i>>3]&1<<(7&s)))return!0;this.cursor--}return!1},this.out_grouping=function(t,r,i){return!(this.cursor>=this.limit)&&(i<(i=this.current.charCodeAt(this.cursor))||i>>3]&1<<(7&i)))&&(this.cursor++,!0)},this.go_out_grouping=function(t,r,i){for(;this.cursor>>3]&1<<(7&s)))return!0;this.cursor++}return!1},this.out_grouping_b=function(t,r,i){return!(this.cursor<=this.limit_backward)&&(i<(i=this.current.charCodeAt(this.cursor-1))||i>>3]&1<<(7&i)))&&(this.cursor--,!0)},this.go_out_grouping_b=function(t,r,i){for(;this.cursor>this.limit_backward;){var s=this.current.charCodeAt(this.cursor-1);if(s<=i&&r<=s&&0!=(t[(s-=r)>>>3]&1<<(7&s)))return!0;this.cursor--}return!1},this.eq_s=function(t){return!(this.limit-this.cursor>>1),o=0,a=e=(l=t[r])[0].length){if(this.cursor=s+l[0].length,l.length<4)return l[2];var g=l[3](this);if(this.cursor=s+l[0].length,g)return l[2]}}while(0<=(r=l[1]));return 0},this.find_among_b=function(t){for(var r=0,i=t.length,s=this.cursor,h=this.limit_backward,e=0,n=0,c=!1;;){for(var u,o=r+(i-r>>1),a=0,l=e=(u=t[r])[0].length){if(this.cursor=s-u[0].length,u.length<4)return u[2];var g=u[3](this);if(this.cursor=s-u[0].length,g)return u[2]}}while(0<=(r=u[1]));return 0},this.replace_s=function(t,r,i){var s=i.length-(r-t);return this.current=this.current.slice(0,t)+i+this.current.slice(r),this.limit+=s,this.cursor>=r?this.cursor+=s:this.cursor>t&&(this.cursor=t),s},this.slice_check=function(){return!(this.bra<0||this.bra>this.ket||this.ket>this.limit||this.limit>this.current.length)},this.slice_from=function(t){var r=!1;return this.slice_check()&&(this.replace_s(this.bra,this.ket,t),r=!0),r},this.slice_del=function(){return this.slice_from("")},this.insert=function(t,r,i){r=this.replace_s(t,r,i);t<=this.bra&&(this.bra+=r),t<=this.ket&&(this.ket+=r)},this.slice_to=function(){var t="";return t=this.slice_check()?this.current.slice(this.bra,this.ket):t},this.assign_to=function(){return this.current.slice(0,this.limit)}}; +var EnglishStemmer=function(){var a=new BaseStemmer,c=[["arsen",-1,-1],["commun",-1,-1],["emerg",-1,-1],["gener",-1,-1],["later",-1,-1],["organ",-1,-1],["past",-1,-1],["univers",-1,-1]],o=[["'",-1,1],["'s'",0,1],["'s",-1,1]],u=[["ied",-1,2],["s",-1,3],["ies",1,2],["sses",1,1],["ss",1,-1],["us",1,-1]],t=[["succ",-1,1],["proc",-1,1],["exc",-1,1]],l=[["even",-1,2],["cann",-1,2],["inn",-1,2],["earr",-1,2],["herr",-1,2],["out",-1,2],["y",-1,1]],n=[["",-1,-1],["ed",0,2],["eed",1,1],["ing",0,3],["edly",0,2],["eedly",4,1],["ingly",0,2]],f=[["",-1,3],["bb",0,2],["dd",0,2],["ff",0,2],["gg",0,2],["bl",0,1],["mm",0,2],["nn",0,2],["pp",0,2],["rr",0,2],["at",0,1],["tt",0,2],["iz",0,1]],_=[["anci",-1,3],["enci",-1,2],["ogi",-1,14],["li",-1,16],["bli",3,12],["abli",4,4],["alli",3,8],["fulli",3,9],["lessli",3,15],["ousli",3,10],["entli",3,5],["aliti",-1,8],["biliti",-1,12],["iviti",-1,11],["tional",-1,1],["ational",14,7],["alism",-1,8],["ation",-1,7],["ization",17,6],["izer",-1,6],["ator",-1,7],["iveness",-1,11],["fulness",-1,9],["ousness",-1,10],["ogist",-1,13]],m=[["icate",-1,4],["ative",-1,6],["alize",-1,3],["iciti",-1,4],["ical",-1,4],["tional",-1,1],["ational",5,2],["ful",-1,5],["ness",-1,5]],b=[["ic",-1,1],["ance",-1,1],["ence",-1,1],["able",-1,1],["ible",-1,1],["ate",-1,1],["ive",-1,1],["ize",-1,1],["iti",-1,1],["al",-1,1],["ism",-1,1],["ion",-1,2],["er",-1,1],["ous",-1,1],["ant",-1,1],["ent",-1,1],["ment",15,1],["ement",16,1]],k=[["e",-1,1],["l",-1,2]],g=[["andes",-1,-1],["atlas",-1,-1],["bias",-1,-1],["cosmos",-1,-1],["early",-1,5],["gently",-1,3],["howe",-1,-1],["idly",-1,2],["news",-1,-1],["only",-1,6],["singly",-1,7],["skies",-1,1],["sky",-1,-1],["ugly",-1,4]],d=[17,64],v=[17,65,16,1],i=[1,17,65,208,1],w=[55,141,2],p=!1,y=0,h=0;function q(){var r=a.limit-a.cursor;return!!(a.out_grouping_b(i,89,121)&&a.in_grouping_b(v,97,121)&&a.out_grouping_b(v,97,121)||(a.cursor=a.limit-r,a.out_grouping_b(v,97,121)&&a.in_grouping_b(v,97,121)&&!(a.cursor>a.limit_backward))||(a.cursor=a.limit-r,a.eq_s_b("past")))}function z(){return h<=a.cursor}function Y(){return y<=a.cursor}this.stem=function(){var r=a.cursor;if(!(()=>{var r;if(a.bra=a.cursor,0!=(r=a.find_among(g))&&(a.ket=a.cursor,!(a.cursora.limit)a.cursor=i;else{a.cursor=e,a.cursor=r,(()=>{p=!1;var r=a.cursor;if(a.bra=a.cursor,!a.eq_s("'")||(a.ket=a.cursor,a.slice_del())){a.cursor=r;r=a.cursor;if(a.bra=a.cursor,a.eq_s("y")){if(a.ket=a.cursor,!a.slice_from("Y"))return;p=!0}a.cursor=r;for(r=a.cursor;;){var i=a.cursor;r:{for(;;){var e=a.cursor;if(a.in_grouping(v,97,121)&&(a.bra=a.cursor,a.eq_s("y"))){a.ket=a.cursor,a.cursor=e;break}if(a.cursor=e,a.cursor>=a.limit)break r;a.cursor++}if(!a.slice_from("Y"))return;p=!0;continue}a.cursor=i;break}a.cursor=r}})(),h=a.limit,y=a.limit;i=a.cursor;r:{var s=a.cursor;if(0==a.find_among(c)){if(a.cursor=s,!a.go_out_grouping(v,97,121))break r;if(a.cursor++,!a.go_in_grouping(v,97,121))break r;a.cursor++}h=a.cursor,a.go_out_grouping(v,97,121)&&(a.cursor++,a.go_in_grouping(v,97,121))&&(a.cursor++,y=a.cursor)}a.cursor=i,a.limit_backward=a.cursor,a.cursor=a.limit;var e=a.limit-a.cursor,r=((()=>{var r=a.limit-a.cursor;if(a.ket=a.cursor,0==a.find_among_b(o))a.cursor=a.limit-r;else if(a.bra=a.cursor,!a.slice_del())return;if(a.ket=a.cursor,0!=(r=a.find_among_b(u)))switch(a.bra=a.cursor,r){case 1:if(a.slice_from("ss"))break;return;case 2:r:{var i=a.limit-a.cursor,e=a.cursor-2;if(!(e{a.ket=a.cursor,o=a.find_among_b(n),a.bra=a.cursor;r:{var r=a.limit-a.cursor;i:{switch(o){case 1:var i=a.limit-a.cursor;e:{var e=a.limit-a.cursor;if(0==a.find_among_b(t)||a.cursor>a.limit_backward){if(a.cursor=a.limit-e,!z())break e;if(!a.slice_from("ee"))return}}a.cursor=a.limit-i;break;case 2:break i;case 3:if(0==(o=a.find_among_b(l)))break i;switch(o){case 1:var s=a.limit-a.cursor;if(!a.out_grouping_b(v,97,121))break i;if(a.cursor>a.limit_backward)break i;if(a.cursor=a.limit-s,a.bra=a.cursor,a.slice_from("ie"))break;return;case 2:if(a.cursor>a.limit_backward)break i}}break r}a.cursor=a.limit-r;var c=a.limit-a.cursor;if(!a.go_out_grouping_b(v,97,121))return;if(a.cursor--,a.cursor=a.limit-c,!a.slice_del())return;a.ket=a.cursor,a.bra=a.cursor;var o,c=a.limit-a.cursor;switch(o=a.find_among_b(f)){case 1:return a.slice_from("e");case 2:var u=a.limit-a.cursor;if(a.in_grouping_b(d,97,111)&&!(a.cursor>a.limit_backward))return;a.cursor=a.limit-u;break;case 3:return a.cursor!=h||(u=a.limit-a.cursor,q()&&(a.cursor=a.limit-u,a.slice_from("e")))}if(a.cursor=a.limit-c,a.ket=a.cursor,a.cursor<=a.limit_backward)return;if(a.cursor--,a.bra=a.cursor,!a.slice_del())return}})(),a.cursor=a.limit-r,a.limit-a.cursor),r=(a.ket=a.cursor,e=a.limit-a.cursor,(a.eq_s_b("y")||(a.cursor=a.limit-e,a.eq_s_b("Y")))&&(a.bra=a.cursor,a.out_grouping_b(v,97,121))&&a.cursor>a.limit_backward&&a.slice_from("i"),a.cursor=a.limit-i,a.limit-a.cursor),e=((()=>{var r;if(a.ket=a.cursor,0!=(r=a.find_among_b(_))&&(a.bra=a.cursor,z()))switch(r){case 1:if(a.slice_from("tion"))break;return;case 2:if(a.slice_from("ence"))break;return;case 3:if(a.slice_from("ance"))break;return;case 4:if(a.slice_from("able"))break;return;case 5:if(a.slice_from("ent"))break;return;case 6:if(a.slice_from("ize"))break;return;case 7:if(a.slice_from("ate"))break;return;case 8:if(a.slice_from("al"))break;return;case 9:if(a.slice_from("ful"))break;return;case 10:if(a.slice_from("ous"))break;return;case 11:if(a.slice_from("ive"))break;return;case 12:if(a.slice_from("ble"))break;return;case 13:if(a.slice_from("og"))break;return;case 14:if(!a.eq_s_b("l"))return;if(a.slice_from("og"))break;return;case 15:if(a.slice_from("less"))break;return;case 16:if(!a.in_grouping_b(w,99,116))return;if(a.slice_del())break}})(),a.cursor=a.limit-r,a.limit-a.cursor),i=((()=>{var r;if(a.ket=a.cursor,0!=(r=a.find_among_b(m))&&(a.bra=a.cursor,z()))switch(r){case 1:if(a.slice_from("tion"))break;return;case 2:if(a.slice_from("ate"))break;return;case 3:if(a.slice_from("al"))break;return;case 4:if(a.slice_from("ic"))break;return;case 5:if(a.slice_del())break;return;case 6:if(!Y())return;if(a.slice_del())break}})(),a.cursor=a.limit-e,a.limit-a.cursor),r=((()=>{var r;if(a.ket=a.cursor,0!=(r=a.find_among_b(b))&&(a.bra=a.cursor,Y()))switch(r){case 1:if(a.slice_del())break;return;case 2:var i=a.limit-a.cursor;if(!a.eq_s_b("s")&&(a.cursor=a.limit-i,!a.eq_s_b("t")))return;if(a.slice_del())break}})(),a.cursor=a.limit-i,a.limit-a.cursor),e=((()=>{var r;if(a.ket=a.cursor,0!=(r=a.find_among_b(k)))switch(a.bra=a.cursor,r){case 1:if(!Y()){if(!z())return;var i=a.limit-a.cursor;if(q())return;a.cursor=a.limit-i}if(a.slice_del())break;return;case 2:if(!Y())return;if(!a.eq_s_b("l"))return;if(a.slice_del())break}})(),a.cursor=a.limit-r,a.cursor=a.limit_backward,a.cursor);(()=>{if(p)for(;;){var r=a.cursor;r:{for(;;){var i=a.cursor;if(a.bra=a.cursor,a.eq_s("Y")){a.ket=a.cursor,a.cursor=i;break}if(a.cursor=i,a.cursor>=a.limit)break r;a.cursor++}if(a.slice_from("y"))continue;return}a.cursor=r;break}})(),a.cursor=e}}return!0},this.stemWord=function(r){return a.setCurrent(r),this.stem(),a.getCurrent()}}; +window.Stemmer = EnglishStemmer; diff --git a/3.1.2/_static/minus.png b/3.1.2/_static/minus.png new file mode 100644 index 0000000..d96755f Binary files /dev/null and b/3.1.2/_static/minus.png differ diff --git a/3.1.2/_static/plus.png b/3.1.2/_static/plus.png new file mode 100644 index 0000000..7107cec Binary files /dev/null and b/3.1.2/_static/plus.png differ diff --git a/3.1.2/_static/pygments.css b/3.1.2/_static/pygments.css new file mode 100644 index 0000000..fe39d08 --- /dev/null +++ b/3.1.2/_static/pygments.css @@ -0,0 +1,81 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc; border: 1px solid #edff00; padding-top: 2px; border-radius: 3px; display: block } +.highlight { background: #f8f8f8; } +.highlight .c { color: #6A737D; font-style: italic } /* Comment */ +.highlight .err { color: #A61717; background-color: #E3D2D2; border: 1px solid #F00 } /* Error */ +.highlight .k { color: #007020; font-weight: bold } /* Keyword */ +.highlight .l { color: #032F62 } /* Literal */ +.highlight .n { color: #333 } /* Name */ +.highlight .o { color: #666; font-weight: bold } /* Operator */ +.highlight .p { font-weight: bold } /* Punctuation */ +.highlight .ch { color: #6A737D; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #6A737D; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #007020 } /* Comment.Preproc */ +.highlight .cpf { color: #6A737D; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #6A737D; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #999; font-weight: bold; font-style: italic; background-color: #FFF0F0 } /* Comment.Special */ +.highlight .gd { color: #A00000; background-color: #FDD } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .gr { color: #A00 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #00A000; background-color: #DFD } /* Generic.Inserted */ +.highlight .go { color: #333 } /* Generic.Output */ +.highlight .gp { color: #C65D09; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0040D0 } /* Generic.Traceback */ +.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #007020; font-weight: bold } /* Keyword.Pseudo */ +.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #902000; font-weight: bold } /* Keyword.Type */ +.highlight .ld { color: #032F62 } /* Literal.Date */ +.highlight .m { color: #208050 } /* Literal.Number */ +.highlight .s { color: #4070A0 } /* Literal.String */ +.highlight .na { color: #008080 } /* Name.Attribute */ +.highlight .nb { color: #0086B3 } /* Name.Builtin */ +.highlight .nc { color: #458; font-weight: bold } /* Name.Class */ +.highlight .no { color: #008080 } /* Name.Constant */ +.highlight .nd { color: #555; font-weight: bold } /* Name.Decorator */ +.highlight .ni { color: #800080; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #900; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #900; font-weight: bold } /* Name.Function */ +.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */ +.highlight .nn { color: #555; font-weight: bold } /* Name.Namespace */ +.highlight .nx { color: #333 } /* Name.Other */ +.highlight .py { color: #333 } /* Name.Property */ +.highlight .nt { color: #22863A; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #9960B5; font-weight: bold } /* Name.Variable */ +.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */ +.highlight .pm { font-weight: bold } /* Punctuation.Marker */ +.highlight .w { color: #BBB } /* Text.Whitespace */ +.highlight .mb { color: #099 } /* Literal.Number.Bin */ +.highlight .mf { color: #099 } /* Literal.Number.Float */ +.highlight .mh { color: #099 } /* Literal.Number.Hex */ +.highlight .mi { color: #099 } /* Literal.Number.Integer */ +.highlight .mo { color: #099 } /* Literal.Number.Oct */ +.highlight .sa { color: #D14 } /* Literal.String.Affix */ +.highlight .sb { color: #D14 } /* Literal.String.Backtick */ +.highlight .sc { color: #D14 } /* Literal.String.Char */ +.highlight .dl { color: #D14 } /* Literal.String.Delimiter */ +.highlight .sd { color: #D14; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #D14 } /* Literal.String.Double */ +.highlight .se { color: #D14; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #D14 } /* Literal.String.Heredoc */ +.highlight .si { color: #D14; font-style: italic } /* Literal.String.Interpol */ +.highlight .sx { color: #D14 } /* Literal.String.Other */ +.highlight .sr { color: #009926 } /* Literal.String.Regex */ +.highlight .s1 { color: #D14 } /* Literal.String.Single */ +.highlight .ss { color: #990073 } /* Literal.String.Symbol */ +.highlight .bp { color: #999 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #06287E; font-weight: bold } /* Name.Function.Magic */ +.highlight .vc { color: #008080; font-weight: bold } /* Name.Variable.Class */ +.highlight .vg { color: #008080; font-weight: bold } /* Name.Variable.Global */ +.highlight .vi { color: #008080; font-weight: bold } /* Name.Variable.Instance */ +.highlight .vm { color: #BB60D5; font-weight: bold } /* Name.Variable.Magic */ +.highlight .il { color: #099 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/3.1.2/_static/searchtools.js b/3.1.2/_static/searchtools.js new file mode 100644 index 0000000..e29b1c7 --- /dev/null +++ b/3.1.2/_static/searchtools.js @@ -0,0 +1,693 @@ +/* + * Sphinx JavaScript utilities for the full-text search. + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename, kind] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +// Global search result kind enum, used by themes to style search results. +// prettier-ignore +class SearchResultKind { + static get index() { return "index"; } + static get object() { return "object"; } + static get text() { return "text"; } + static get title() { return "title"; } +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _escapeHTML = (text) => { + return text + .replaceAll("&", "&") + .replaceAll("<", "<") + .replaceAll(">", ">") + .replaceAll('"', """) + .replaceAll("'", "'"); +}; + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename, kind] = item; + + let listItem = document.createElement("li"); + // Add a class representing the item's type: + // can be used by a theme's CSS selector for styling + // See SearchResultKind for the class names. + listItem.classList.add(`kind-${kind}`); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = _escapeHTML(title); + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + ` (${_escapeHTML(descr)})`; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) + // SPHINX_HIGHLIGHT_ENABLED is set in sphinx_highlight.js + highlightTerms.forEach((term) => + _highlightText(listItem, term, "highlighted"), + ); + } else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms, anchor), + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) + // SPHINX_HIGHLIGHT_ENABLED is set in sphinx_highlight.js + highlightTerms.forEach((term) => + _highlightText(listItem, term, "highlighted"), + ); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories.", + ); + else + Search.status.innerText = Documentation.ngettext( + "Search finished, found one page matching the search query.", + "Search finished, found ${resultCount} pages matching the search query.", + resultCount, + ).replace("${resultCount}", resultCount); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5, + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; +// Helper function used by query() to order search results. +// Each input is an array of [docname, title, anchor, descr, score, filename, kind]. +// Order the results by score (in opposite order of appearance, since the +// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically. +const _orderResultsByScoreThenName = (a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => + query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter((term) => term); // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString, anchor) => { + const htmlElement = new DOMParser().parseFromString( + htmlString, + "text/html", + ); + for (const removalQuery of [".headerlink", "script", "style"]) { + htmlElement.querySelectorAll(removalQuery).forEach((el) => { + el.remove(); + }); + } + if (anchor) { + const anchorContent = htmlElement.querySelector( + `[role="main"] ${anchor}`, + ); + if (anchorContent) return anchorContent.textContent; + + console.warn( + `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.`, + ); + } + + // if anchor not specified or not found, fall back to main content + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent) return docContent.textContent; + + console.warn( + "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template.", + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.setAttribute("role", "list"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + _parseQuery: (query) => { + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords set is from language_data.js + if (stopwords.has(queryTermLower) || queryTerm.match(/^\d+$/)) return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { + // SPHINX_HIGHLIGHT_ENABLED is set in sphinx_highlight.js + localStorage.setItem( + "sphinx_highlight_terms", + [...highlightTerms].join(" "), + ); + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + return [query, searchTerms, excludedTerms, highlightTerms, objectTerms]; + }, + + /** + * execute search (requires search index to be loaded) + */ + _performSearch: ( + query, + searchTerms, + excludedTerms, + highlightTerms, + objectTerms, + ) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // Collect multiple result groups to be sorted separately and then ordered. + // Each is an array of [docname, title, anchor, descr, score, filename, kind]. + const normalResults = []; + const nonMainIndexResults = []; + + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase().trim(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if ( + title.toLowerCase().trim().includes(queryLower) + && queryLower.length >= title.length / 2 + ) { + for (const [file, id] of foundTitles) { + const score = Math.round( + (Scorer.title * queryLower.length) / title.length, + ); + const boost = titles[file] === title ? 1 : 0; // add a boost for document titles + normalResults.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score + boost, + filenames[file], + SearchResultKind.title, + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && queryLower.length >= entry.length / 2) { + for (const [file, id, isMain] of foundEntries) { + const score = Math.round((100 * queryLower.length) / entry.length); + const result = [ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + SearchResultKind.index, + ]; + if (isMain) { + normalResults.push(result); + } else { + nonMainIndexResults.push(result); + } + } + } + } + + // lookup as object + objectTerms.forEach((term) => + normalResults.push(...Search.performObjectSearch(term, objectTerms)), + ); + + // lookup as search terms in fulltext + normalResults.push( + ...Search.performTermsSearch(searchTerms, excludedTerms), + ); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) { + normalResults.forEach((item) => (item[4] = Scorer.score(item))); + nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item))); + } + + // Sort each group of results by score and then alphabetically by name. + normalResults.sort(_orderResultsByScoreThenName); + nonMainIndexResults.sort(_orderResultsByScoreThenName); + + // Combine the result groups in (reverse) order. + // Non-main index entries are typically arbitrary cross-references, + // so display them after other results. + let results = [...nonMainIndexResults, ...normalResults]; + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result + .slice(0, 4) + .concat([result[5]]) + .map((v) => String(v)) + .join(","); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + return results.reverse(); + }, + + query: (query) => { + const [ + searchQuery, + searchTerms, + excludedTerms, + highlightTerms, + objectTerms, + ] = Search._parseQuery(query); + const results = Search._performSearch( + searchQuery, + searchTerms, + excludedTerms, + highlightTerms, + objectTerms, + ); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4]; + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + SearchResultKind.object, + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => objectSearchCallback(prefix, array)), + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + // find documents, if any, containing the query word in their text/title term indices + // use Object.hasOwnProperty to avoid mismatching against prototype properties + const arr = [ + { + files: terms.hasOwnProperty(word) ? terms[word] : undefined, + score: Scorer.term, + }, + { + files: titleTerms.hasOwnProperty(word) ? titleTerms[word] : undefined, + score: Scorer.title, + }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + if (!terms.hasOwnProperty(word)) { + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + } + if (!titleTerms.hasOwnProperty(word)) { + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: titleTerms[term], score: Scorer.partialTitle }); + }); + } + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, new Map()); + const fileScores = scoreMap.get(file); + fileScores.set(word, record.score); + }); + }); + + // create the mapping + files.forEach((file) => { + if (!fileMap.has(file)) fileMap.set(file, [word]); + else if (fileMap.get(file).indexOf(word) === -1) + fileMap.get(file).push(word); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2, + ).length; + if ( + wordList.length !== searchTerms.size + && wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file + || titleTerms[term] === file + || (terms[term] || []).includes(file) + || (titleTerms[term] || []).includes(file), + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file).get(w))); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + SearchResultKind.text, + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords, anchor) => { + const text = Search.htmlToText(htmlText, anchor); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = + top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/3.1.2/_static/sphinx_highlight.js b/3.1.2/_static/sphinx_highlight.js new file mode 100644 index 0000000..a74e103 --- /dev/null +++ b/3.1.2/_static/sphinx_highlight.js @@ -0,0 +1,159 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true; + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 + && !parent.classList.contains(className) + && !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore(span, parent.insertBefore(rest, node.nextSibling)); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect", + ); + const bbox = parent.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute("class", className); + addItems.push({ parent: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target), + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms"); + // Update history only if '?highlight' is present; otherwise it + // clears text fragments (not set in window.location by the browser) + if (url.searchParams.has("highlight")) { + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + } + + // get individual terms from highlight string + const terms = highlight + .toLowerCase() + .split(/\s+/) + .filter((x) => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '", + ), + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms"); + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) + return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) + return; + if ( + DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + && event.key === "Escape" + ) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/3.1.2/developing.html b/3.1.2/developing.html new file mode 100644 index 0000000..115fe7f --- /dev/null +++ b/3.1.2/developing.html @@ -0,0 +1,183 @@ + + + + + + + + + Developing — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Developing

+
+

Build and install locally

+

Clone the repository, checkout the tag you want to build, or pick the main branch for the development version; then:

+
ansible-galaxy collection build .
+ansible-galaxy collection install middleware_automation-keycloak-*.tar.gz
+
+
+
+
+

Development environment

+

Make sure your development machine has available:

+
    +
  • python 3.11+

  • +
  • virtualenv

  • +
  • docker (or podman)

  • +
+

In order to run setup the development environment and run the molecule tests locally, after cloning the repository:

+
# create new virtualenv using python 3
+virtualenv $PATH_TO_DEV_VIRTUALENV
+# activate the virtual env
+source $PATH_TO_DEV_VIRTUALENV/bin/activate
+# install ansible and tools onto the virtualenv
+pip install yamllint 'molecule>=6.0' 'molecule-plugins[docker]' 'ansible-core>=2.16' ansible-lint
+# install collection dependencies
+ansible-galaxy collection install -r requirements.yml
+# install python dependencies
+pip install -r requirements.txt molecule/requirements.txt
+# execute the tests (replace --all with -s subdirectory to run a single test)
+molecule test --all
+
+
+
+
+
+

Contributor’s Guidelines

+
    +
  • All YAML files named with .yml extension

  • +
  • Use spaces around jinja variables. {{ var }} over {{var}}

  • +
  • Variables that are internal to the role should be lowercase and start with the role name

  • +
  • Keep roles self contained - Roles should avoid including tasks from other roles when possible

  • +
  • Plays should do nothing more than include a list of roles, except where pre_tasks and post_tasks are required, when possible

  • +
  • Separators - Use valid names, ie. underscores (e.g. my_role my_playbook) not dashes (my-role)

  • +
  • Paths - When defining paths, do not include trailing slashes (e.g. my_path: /foo not my_path: /foo/); when concatenating paths, follow the same convention (e.g. {{ my_path }}/bar not {{ my_path }}bar)

  • +
  • Indentation - Use 2 spaces for each indent

  • +
  • vars/ vs defaults/ - internal or interpolated variables that don’t need to change or be overridden by user go in vars/, those that a user would likely override, go under defaults/ directory

  • +
  • All role arguments have a specification in meta/argument_specs.yml

  • +
  • All playbooks/roles should be focused on compatibility with Ansible Automation Platform

  • +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/genindex.html b/3.1.2/genindex.html new file mode 100644 index 0000000..d24e718 --- /dev/null +++ b/3.1.2/genindex.html @@ -0,0 +1,127 @@ + + + + + + + + Index — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Index

+ +
+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/index.html b/3.1.2/index.html new file mode 100644 index 0000000..8f9ed8a --- /dev/null +++ b/3.1.2/index.html @@ -0,0 +1,278 @@ + + + + + + + + + Welcome to Keycloak Collection documentation — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Welcome to Keycloak Collection documentation

+
+

User documentation

+ +
+ + +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/objects.inv b/3.1.2/objects.inv new file mode 100644 index 0000000..be6f2f2 Binary files /dev/null and b/3.1.2/objects.inv differ diff --git a/3.1.2/plugins/index.html b/3.1.2/plugins/index.html new file mode 100644 index 0000000..d69c7a6 --- /dev/null +++ b/3.1.2/plugins/index.html @@ -0,0 +1,576 @@ + + + + + + + + + Plugin Index — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Plugin Index

+
+

modules plugins

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_authentication.html b/3.1.2/plugins/keycloak_authentication.html new file mode 100644 index 0000000..377291a --- /dev/null +++ b/3.1.2/plugins/keycloak_authentication.html @@ -0,0 +1,792 @@ + + + + + + + + + + keycloak_authentication – Configure authentication in Keycloak — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

keycloak_authentication – Configure authentication in Keycloak

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_authentication.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module actually can only make a copy of an existing authentication flow, add an execution to it and configure it.

  • +
  • It can also delete the flow.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

alias

+ +

+ string + / required +

+
+

Alias for the authentication flow.

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

authenticationExecutions

+ +

+ list + / elements=dictionary +

+
+

Configuration structure for the executions.

+
+
+

authenticationConfig

+ +

+ dictionary +

+
+

Describe the config of the authentication.

+
+
+

displayName

+ +

+ string +

+
+

Name of the execution or subflow to create or update.

+
+
+

flowAlias

+ +

+ string +

+
+

Alias of parent flow.

+
+
+

index

+ +

+ integer +

+
+

Priority order of the execution.

+
+
+

providerId

+ +

+ string +

+
+

providerID for the new flow when not copied from an existing flow.

+
+
+

requirement

+ +

+ string +

+
+

Control status of the subflow or execution.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

subFlowType

+ +

+ string +

+
+

For new subflows, optionally specify the type.

+

Is only used at creation.

+

Choices:

+
    +
  • "basic-flow" ← (default)

  • +
  • "form-flow"

  • +
+ +
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

copyFrom

+ +

+ string +

+
+

flowAlias of the authentication flow to use for the copy.

+
+
+

description

+ +

+ string +

+
+

Description of the flow.

+
+
+

force

+ +

+ boolean +

+
+

If true, allows to remove the authentication flow and recreate it.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

providerId

+ +

+ string +

+
+

providerId for the new flow when not copied from an existing flow.

+

Choices:

+
    +
  • "basic-flow"

  • +
  • "client-flow"

  • +
+ +
+
+

realm

+ +

+ string + / required +

+
+

The name of the realm in which is the authentication.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

Control if the authentication flow must exists or not.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: full

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Create an authentication flow from first broker login and add an execution to it.
+  middleware_automation.keycloak.keycloak_authentication:
+    auth_keycloak_url: http://localhost:8080
+    auth_realm: master
+    auth_username: admin
+    auth_password: password
+    realm: master
+    alias: "Copy of first broker login"
+    copyFrom: "first broker login"
+    authenticationExecutions:
+      - providerId: "test-execution1"
+        requirement: "REQUIRED"
+        authenticationConfig:
+          alias: "test.execution1.property"
+          config:
+          test1.property: "value"
+      - providerId: "test-execution2"
+        requirement: "REQUIRED"
+        authenticationConfig:
+          alias: "test.execution2.property"
+          config:
+          test2.property: "value"
+    state: present
+
+- name: Re-create the authentication flow
+  middleware_automation.keycloak.keycloak_authentication:
+    auth_keycloak_url: http://localhost:8080
+    auth_realm: master
+    auth_username: admin
+    auth_password: password
+    realm: master
+    alias: "Copy of first broker login"
+    copyFrom: "first broker login"
+    authenticationExecutions:
+      - providerId: "test-provisioning"
+        requirement: "REQUIRED"
+        authenticationConfig:
+          alias: "test.provisioning.property"
+          config:
+          test.provisioning.property: "value"
+    state: present
+    force: true
+
+- name: Create an authentication flow with subflow containing an execution.
+  middleware_automation.keycloak.keycloak_authentication:
+    auth_keycloak_url: http://localhost:8080
+    auth_realm: master
+    auth_username: admin
+    auth_password: password
+    realm: master
+    alias: "Copy of first broker login"
+    copyFrom: "first broker login"
+    authenticationExecutions:
+      - providerId: "test-execution1"
+        requirement: "REQUIRED"
+      - displayName: "New Subflow"
+        requirement: "REQUIRED"
+      - providerId: "auth-cookie"
+        requirement: "REQUIRED"
+        flowAlias: "New Sublow"
+    state: present
+
+- name: Remove authentication.
+  middleware_automation.keycloak.keycloak_authentication:
+    auth_keycloak_url: http://localhost:8080
+    auth_realm: master
+    auth_username: admin
+    auth_password: password
+    realm: master
+    alias: "Copy of first broker login"
+    state: absent
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of the authentication after module execution.

+

Returned: on success

+

Sample: {"alias": "Copy of first broker login", "authenticationExecutions": [{"alias": "review profile config", "authenticationConfig": {"alias": "review profile config", "config": {"update.profile.on.first.login": "missing"}, "id": "6f09e4fb-aad4-496a-b873-7fa9779df6d7"}, "configurable": true, "displayName": "Review Profile", "id": "8f77dab8-2008-416f-989e-88b09ccf0b4c", "index": 0, "level": 0, "providerId": "idp-review-profile", "requirement": "REQUIRED", "requirementChoices": ["REQUIRED", "ALTERNATIVE", "DISABLED"]}], "builtIn": false, "description": "Actions taken after first broker login with identity provider account, which is not yet linked to any Keycloak account", "id": "bc228863-5887-4297-b898-4d988f8eaa5c", "providerId": "basic-flow", "topLevel": true}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+
+

Authors

+
    +
  • Philippe Gauthier (@elfelip)

  • +
  • Gaëtan Daubresse (@Gaetan2907)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_authentication_flow.html b/3.1.2/plugins/keycloak_authentication_flow.html new file mode 100644 index 0000000..fc8f056 --- /dev/null +++ b/3.1.2/plugins/keycloak_authentication_flow.html @@ -0,0 +1,690 @@ + + + + + + + + + + keycloak_authentication_flow – Allows administration of Keycloak authentication flows via Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • + View page source +
  • +
+
+
+
+
+ +
+

keycloak_authentication_flow – Allows administration of Keycloak authentication flows via Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_authentication_flow.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows you to add, remove or modify Keycloak authentication flows via the Keycloak REST API. It requires access to the REST API via OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.

  • +
  • This module supports creating new top-level authentication flows, copying existing flows, and adding execution steps to a flow.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

alias

+ +

+ string + / required +

+
+

Alias (name) of the authentication flow.

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+
+

copy_from

+ +

aliases: copyFrom

+

+ string +

+
+

If set, the new flow is created as a copy of the flow with this alias.

+

Cannot be used together with executions.

+
+
+

description

+ +

+ string +

+
+

Description of the authentication flow.

+

Default: ""

+
+
+

executions

+ +

+ list + / elements=dictionary +

+
+

A list of executions (authenticator steps) to add to the flow.

+

Each execution is a dict with keys provider_id (or providerId) and requirement.

+

Executions are only added when the flow is first created.

+

Default: []

+
+
+
+

provider_id

+ +

aliases: providerId

+

+ string + / required +

+
+

The authenticator provider ID (e.g. auth-cookie, auth-password, auth-otp-form).

+
+
+

requirement

+ +

+ string + / required +

+
+

The requirement level for this execution.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+
+

provider_id

+ +

aliases: providerId

+

+ string +

+
+

The provider ID for the flow.

+

Default: "basic-flow"

+
+
+

realm

+ +

+ string +

+
+

The Keycloak realm under which this authentication flow resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

State of the authentication flow.

+

On present, the flow will be created if it does not yet exist.

+

On absent, the flow will be removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: full

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Create an authentication flow with executions
+  middleware_automation.keycloak.keycloak_authentication_flow:
+    auth_keycloak_url: http://localhost:8080
+    auth_realm: master
+    auth_username: admin
+    auth_password: password
+    realm: TestRealm
+    alias: my-browser-flow
+    description: "Custom browser flow"
+    provider_id: basic-flow
+    executions:
+      - provider_id: auth-cookie
+        requirement: ALTERNATIVE
+      - provider_id: auth-password
+        requirement: REQUIRED
+      - provider_id: auth-otp-form
+        requirement: ALTERNATIVE
+    state: present
+  delegate_to: localhost
+
+- name: Create an authentication flow by copying an existing one
+  middleware_automation.keycloak.keycloak_authentication_flow:
+    auth_keycloak_url: http://localhost:8080
+    auth_realm: master
+    auth_username: admin
+    auth_password: password
+    realm: TestRealm
+    alias: my-copy-of-browser
+    copy_from: browser
+    state: present
+  delegate_to: localhost
+
+- name: Create a flow using token authentication
+  middleware_automation.keycloak.keycloak_authentication_flow:
+    auth_keycloak_url: http://localhost:8080
+    token: MY_TOKEN
+    realm: TestRealm
+    alias: my-flow
+    state: present
+  delegate_to: localhost
+
+- name: Delete an authentication flow
+  middleware_automation.keycloak.keycloak_authentication_flow:
+    auth_keycloak_url: http://localhost:8080
+    auth_realm: master
+    auth_username: admin
+    auth_password: password
+    realm: TestRealm
+    alias: my-browser-flow
+    state: absent
+  delegate_to: localhost
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of the authentication flow after module execution.

+

Returned: on success

+

Sample: {"alias": "my-browser-flow", "builtIn": false, "id": "uuid-here", "providerId": "basic-flow", "topLevel": true}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: "Authentication flow my-browser-flow has been created"

+
+

Authors

+
    +
  • Paulo Menon (@paulomenon)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_authentication_required_actions.html b/3.1.2/plugins/keycloak_authentication_required_actions.html new file mode 100644 index 0000000..99736c7 --- /dev/null +++ b/3.1.2/plugins/keycloak_authentication_required_actions.html @@ -0,0 +1,785 @@ + + + + + + + + + + keycloak_authentication_required_actions – Allows administration of Keycloak authentication required actions — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • + View page source +
  • +
+
+
+
+
+ +
+

keycloak_authentication_required_actions – Allows administration of Keycloak authentication required actions

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_authentication_required_actions.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module can register, update and delete required actions.

  • +
  • It also filters out any duplicate required actions by their alias. The first occurrence is preserved.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

realm

+ +

+ string + / required +

+
+

The name of the realm in which are the authentication required actions.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

required_actions

+ +

+ list + / elements=dictionary +

+
+

Authentication required action.

+
+
+

alias

+ +

+ string + / required +

+
+

Unique name of the required action.

+
+
+

config

+ +

+ dictionary +

+
+

Configuration for the required action.

+
+
+

defaultAction

+ +

+ boolean +

+
+

Indicates whether new users have the required action assigned to them.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

enabled

+ +

+ boolean +

+
+

Indicates, if the required action is enabled or not.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

name

+ +

+ string +

+
+

Displayed name of the required action. Required for registration.

+
+
+

priority

+ +

+ integer +

+
+

Priority of the required action.

+
+
+

providerId

+ +

+ string +

+
+

Provider ID of the required action. Required for registration.

+
+
+

state

+ +

+ string + / required +

+
+

Control if the realm authentication required actions are going to be registered/updated (present) or deleted (absent).

+

Choices:

+
    +
  • "absent"

  • +
  • "present"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: full

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Register a new required action.
+  middleware_automation.keycloak.keycloak_authentication_required_actions:
+    auth_client_id: "admin-cli"
+    auth_keycloak_url: "http://localhost:8080"
+    auth_password: "password"
+    auth_realm: "master"
+    auth_username: "admin"
+    realm: "master"
+    required_actions:
+      - alias: "TERMS_AND_CONDITIONS"
+        name: "Terms and conditions"
+        providerId: "TERMS_AND_CONDITIONS"
+        enabled: true
+    state: "present"
+
+- name: Update the newly registered required action.
+  middleware_automation.keycloak.keycloak_authentication_required_actions:
+    auth_client_id: "admin-cli"
+    auth_keycloak_url: "http://localhost:8080"
+    auth_password: "password"
+    auth_realm: "master"
+    auth_username: "admin"
+    realm: "master"
+    required_actions:
+      - alias: "TERMS_AND_CONDITIONS"
+        enabled: false
+    state: "present"
+
+- name: Delete the updated registered required action.
+  middleware_automation.keycloak.keycloak_authentication_required_actions:
+    auth_client_id: "admin-cli"
+    auth_keycloak_url: "http://localhost:8080"
+    auth_password: "password"
+    auth_realm: "master"
+    auth_username: "admin"
+    realm: "master"
+    required_actions:
+      - alias: "TERMS_AND_CONDITIONS"
+    state: "absent"
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ complex +

+
+

Representation of the authentication required actions after module execution.

+

Returned: on success

+
+
+

alias

+ +

+ string +

+
+

Unique name of the required action.

+

Returned: success

+

Sample: "test-provider-id"

+
+
+

config

+ +

+ dictionary +

+
+

Configuration for the required action.

+

Returned: success

+

Sample: {}

+
+
+

defaultAction

+ +

+ boolean +

+
+

Indicates whether new users have the required action assigned to them.

+

Returned: success

+

Sample: false

+
+
+

enabled

+ +

+ boolean +

+
+

Indicates, if the required action is enabled or not.

+

Returned: success

+

Sample: false

+
+
+

name

+ +

+ string +

+
+

Displayed name of the required action. Required for registration.

+

Returned: success

+

Sample: "Test provider ID"

+
+
+

priority

+ +

+ integer +

+
+

Priority of the required action.

+

Returned: success

+

Sample: 90

+
+
+

providerId

+ +

+ string +

+
+

Provider ID of the required action. Required for registration.

+

Returned: success

+

Sample: "test-provider-id"

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+
+

Authors

+
    +
  • Skrekulko (@Skrekulko)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_authentication_v2.html b/3.1.2/plugins/keycloak_authentication_v2.html new file mode 100644 index 0000000..65217cc --- /dev/null +++ b/3.1.2/plugins/keycloak_authentication_v2.html @@ -0,0 +1,1981 @@ + + + + + + + + + + keycloak_authentication_v2 – Configure authentication flows in Keycloak in an idempotent and safe manner. — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • + View page source +
  • +
+
+
+
+
+ +
+

keycloak_authentication_v2 – Configure authentication flows in Keycloak in an idempotent and safe manner.

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_authentication_v2.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows the creation, deletion, and modification of Keycloak authentication flows using the Keycloak REST API.

  • +
  • Rather than modifying an existing flow in place, the module re-creates the flow using the Safe Swap mechanism described below.

  • +
  • Safe Swap mechanism - When an authentication flow needs to be updated, the module never modifies the existing flow in place. Instead it follows a multi-step swap procedure to ensure the flow is never left in an intermediate or unsafe state during the update. This is especially important when the flow is actively bound to a realm binding, a client override, or as an identity-provider login-flow or post-flow, because a partially-updated flow could inadvertently allow unauthorised access.

  • +
  • The Safe Swap mechanism is as follows. 1. A new flow is created under a temporary name (the original alias plus a configurable suffix, for example myflow_tmp_for_swap). 2. All executions and their configurations are added to the new temporary flow. 3. If the existing flow is currently bound to a realm or a client, all bindings are redirected to the new temporary flow. This ensures continuity and avoids any gap in active authentication coverage. 4. The old flow is deleted. 5. The temporary flow is renamed to the original alias, restoring the expected name.

  • +
  • Handling pre-existing temporary swap flows - If a temporary swap flow already exists (for example, from a previously interrupted run), the module can optionally delete it before proceeding. This behaviour is controlled by the force_temporary_swap_flow_deletion option. If the option is false and a temporary flow already exists, the module will fail to prevent accidental data loss.

  • +
  • Idempotency - If the existing flow already matches the desired configuration, no changes are made. The module compares a normalised representation of the existing flow against the desired state before deciding whether to trigger the Safe Swap procedure.

  • +
  • A depth of 10 sub-flows is supported.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

alias

+ +

+ string + / required +

+
+

The name of the authentication flow.

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

authenticationExecutions

+ +

+ list + / elements=dictionary +

+
+

The desired execution configuration for the flow.

+

Executions at root level.

+
+
+

authenticationConfig

+ +

+ dictionary +

+
+

The configuration for the execution.

+
+
+

alias

+ +

+ string + / required +

+
+

Name of the execution config.

+
+
+

config

+ +

+ dictionary + / required +

+
+

Options for the execution config.

+
+
+

authenticationExecutions

+ +

+ list + / elements=dictionary +

+
+

The execution configuration for executions within the sub-flow.

+

Executions at sub level 1.

+
+
+

authenticationConfig

+ +

+ dictionary +

+
+

The configuration for the execution.

+
+
+

alias

+ +

+ string + / required +

+
+

Name of the execution config.

+
+
+

config

+ +

+ dictionary + / required +

+
+

Options for the execution config.

+
+
+

authenticationExecutions

+ +

+ list + / elements=dictionary +

+
+

The execution configuration for executions within the sub-flow.

+

Executions at sub level 2.

+
+
+

authenticationConfig

+ +

+ dictionary +

+
+

The configuration for the execution.

+
+
+

alias

+ +

+ string + / required +

+
+

Name of the execution config.

+
+
+

config

+ +

+ dictionary + / required +

+
+

Options for the execution config.

+
+
+

authenticationExecutions

+ +

+ list + / elements=dictionary +

+
+

The execution configuration for executions within the sub-flow.

+

Executions at sub level 3.

+
+
+

authenticationConfig

+ +

+ dictionary +

+
+

The configuration for the execution.

+
+
+

alias

+ +

+ string + / required +

+
+

Name of the execution config.

+
+
+

config

+ +

+ dictionary + / required +

+
+

Options for the execution config.

+
+
+

authenticationExecutions

+ +

+ list + / elements=dictionary +

+
+

The execution configuration for executions within the sub-flow.

+

Executions at sub level 4.

+
+
+

authenticationConfig

+ +

+ dictionary +

+
+

The configuration for the execution.

+
+
+

alias

+ +

+ string + / required +

+
+

Name of the execution config.

+
+
+

config

+ +

+ dictionary + / required +

+
+

Options for the execution config.

+
+
+

authenticationExecutions

+ +

+ list + / elements=dictionary +

+
+

The execution configuration for executions within the sub-flow.

+

Executions at sub level 5.

+
+
+

authenticationConfig

+ +

+ dictionary +

+
+

The configuration for the execution.

+
+
+

alias

+ +

+ string + / required +

+
+

Name of the execution config.

+
+
+

config

+ +

+ dictionary + / required +

+
+

Options for the execution config.

+
+
+

authenticationExecutions

+ +

+ list + / elements=dictionary +

+
+

The execution configuration for executions within the sub-flow.

+

Executions at sub level 6.

+
+
+

authenticationConfig

+ +

+ dictionary +

+
+

The configuration for the execution.

+
+
+

alias

+ +

+ string + / required +

+
+

Name of the execution config.

+
+
+

config

+ +

+ dictionary + / required +

+
+

Options for the execution config.

+
+
+

authenticationExecutions

+ +

+ list + / elements=dictionary +

+
+

The execution configuration for executions within the sub-flow.

+

Executions at sub level 7.

+
+
+

authenticationConfig

+ +

+ dictionary +

+
+

The configuration for the execution.

+
+
+

alias

+ +

+ string + / required +

+
+

Name of the execution config.

+
+
+

config

+ +

+ dictionary + / required +

+
+

Options for the execution config.

+
+
+

authenticationExecutions

+ +

+ list + / elements=dictionary +

+
+

The execution configuration for executions within the sub-flow.

+

Executions at sub level 8.

+
+
+

authenticationConfig

+ +

+ dictionary +

+
+

The configuration for the execution.

+
+
+

alias

+ +

+ string + / required +

+
+

Name of the execution config.

+
+
+

config

+ +

+ dictionary + / required +

+
+

Options for the execution config.

+
+
+

authenticationExecutions

+ +

+ list + / elements=dictionary +

+
+

The execution configuration for executions within the sub-flow.

+

Executions at sub level 9.

+
+
+

authenticationConfig

+ +

+ dictionary +

+
+

The configuration for the execution.

+
+
+

alias

+ +

+ string + / required +

+
+

Name of the execution config.

+
+
+

config

+ +

+ dictionary + / required +

+
+

Options for the execution config.

+
+
+

authenticationExecutions

+ +

+ list + / elements=dictionary +

+
+

The execution configuration for executions within the sub-flow.

+

Executions at sub level 10 (last sub level).

+
+
+

authenticationConfig

+ +

+ dictionary +

+
+

The configuration for the execution.

+
+
+

alias

+ +

+ string + / required +

+
+

Name of the execution config.

+
+
+

config

+ +

+ dictionary + / required +

+
+

Options for the execution config.

+
+
+

providerId

+ +

+ string + / required +

+
+

The providerId of the execution.

+
+
+

requirement

+ +

+ string + / required +

+
+

The requirement status of the execution or sub-flow.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

providerId

+ +

+ string +

+
+

The providerId of the execution.

+
+
+

requirement

+ +

+ string + / required +

+
+

The requirement status of the execution or sub-flow.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

subFlow

+ +

+ string +

+
+

The name of the sub-flow.

+
+
+

subFlowType

+ +

+ string +

+
+

The type of the sub-flow.

+

Choices:

+
    +
  • "basic-flow" ← (default)

  • +
  • "form-flow"

  • +
+ +
+
+

providerId

+ +

+ string +

+
+

The providerId of the execution.

+
+
+

requirement

+ +

+ string + / required +

+
+

The requirement status of the execution or sub-flow.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

subFlow

+ +

+ string +

+
+

The name of the sub-flow.

+
+
+

subFlowType

+ +

+ string +

+
+

The type of the sub-flow.

+

Choices:

+
    +
  • "basic-flow" ← (default)

  • +
  • "form-flow"

  • +
+ +
+
+

providerId

+ +

+ string +

+
+

The providerId of the execution.

+
+
+

requirement

+ +

+ string + / required +

+
+

The requirement status of the execution or sub-flow.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

subFlow

+ +

+ string +

+
+

The name of the sub-flow.

+
+
+

subFlowType

+ +

+ string +

+
+

The type of the sub-flow.

+

Choices:

+
    +
  • "basic-flow" ← (default)

  • +
  • "form-flow"

  • +
+ +
+
+

providerId

+ +

+ string +

+
+

The providerId of the execution.

+
+
+

requirement

+ +

+ string + / required +

+
+

The requirement status of the execution or sub-flow.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

subFlow

+ +

+ string +

+
+

The name of the sub-flow.

+
+
+

subFlowType

+ +

+ string +

+
+

The type of the sub-flow.

+

Choices:

+
    +
  • "basic-flow" ← (default)

  • +
  • "form-flow"

  • +
+ +
+
+

providerId

+ +

+ string +

+
+

The providerId of the execution.

+
+
+

requirement

+ +

+ string + / required +

+
+

The requirement status of the execution or sub-flow.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

subFlow

+ +

+ string +

+
+

The name of the sub-flow.

+
+
+

subFlowType

+ +

+ string +

+
+

The type of the sub-flow.

+

Choices:

+
    +
  • "basic-flow" ← (default)

  • +
  • "form-flow"

  • +
+ +
+
+

providerId

+ +

+ string +

+
+

The providerId of the execution.

+
+
+

requirement

+ +

+ string + / required +

+
+

The requirement status of the execution or sub-flow.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

subFlow

+ +

+ string +

+
+

The name of the sub-flow.

+
+
+

subFlowType

+ +

+ string +

+
+

The type of the sub-flow.

+

Choices:

+
    +
  • "basic-flow" ← (default)

  • +
  • "form-flow"

  • +
+ +
+
+

providerId

+ +

+ string +

+
+

The providerId of the execution.

+
+
+

requirement

+ +

+ string + / required +

+
+

The requirement status of the execution or sub-flow.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

subFlow

+ +

+ string +

+
+

The name of the sub-flow.

+
+
+

subFlowType

+ +

+ string +

+
+

The type of the sub-flow.

+

Choices:

+
    +
  • "basic-flow" ← (default)

  • +
  • "form-flow"

  • +
+ +
+
+

providerId

+ +

+ string +

+
+

The providerId of the execution.

+
+
+

requirement

+ +

+ string + / required +

+
+

The requirement status of the execution or sub-flow.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

subFlow

+ +

+ string +

+
+

The name of the sub-flow.

+
+
+

subFlowType

+ +

+ string +

+
+

The type of the sub-flow.

+

Choices:

+
    +
  • "basic-flow" ← (default)

  • +
  • "form-flow"

  • +
+ +
+
+

providerId

+ +

+ string +

+
+

The providerId of the execution.

+
+
+

requirement

+ +

+ string + / required +

+
+

The requirement status of the execution or sub-flow.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

subFlow

+ +

+ string +

+
+

The name of the sub-flow.

+
+
+

subFlowType

+ +

+ string +

+
+

The type of the sub-flow.

+

Choices:

+
    +
  • "basic-flow" ← (default)

  • +
  • "form-flow"

  • +
+ +
+
+

providerId

+ +

+ string +

+
+

The providerId of the execution.

+
+
+

requirement

+ +

+ string + / required +

+
+

The requirement status of the execution or sub-flow.

+

Choices:

+
    +
  • "REQUIRED"

  • +
  • "ALTERNATIVE"

  • +
  • "DISABLED"

  • +
  • "CONDITIONAL"

  • +
+ +
+
+

subFlow

+ +

+ string +

+
+

The name of the sub-flow.

+
+
+

subFlowType

+ +

+ string +

+
+

The type of the sub-flow.

+

Choices:

+
    +
  • "basic-flow" ← (default)

  • +
  • "form-flow"

  • +
+ +
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

description

+ +

+ string +

+
+

A human-readable description of the flow.

+
+
+

force_temporary_swap_flow_deletion

+ +

+ boolean +

+
+

If true, any pre-existing temporary swap flow (identified by the original alias plus temporary_swap_flow_suffix) is deleted before the Safe Swap procedure begins.

+

Set this to false to cause the module to fail instead of silently removing a pre-existing temporary flow, for example to avoid accidental data loss after an interrupted run.

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

providerId

+ +

+ string +

+
+

The providerId for the new flow.

+

Choices:

+
    +
  • "basic-flow" ← (default)

  • +
  • "client-flow"

  • +
+ +
+
+

realm

+ +

+ string + / required +

+
+

The name of the realm in which the authentication flow resides.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

Whether the authentication flow should exist or not.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

temporary_swap_flow_suffix

+ +

+ string +

+
+

The suffix appended to the alias of the temporary flow created during a Safe Swap update.

+

The temporary flow exists only for the duration of the swap procedure and is renamed to the original alias once all bindings have been successfully transferred.

+

Default: "_tmp_for_swap"

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: full

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Create or modify the 'My Login Flow'.
+  middleware_automation.keycloak.keycloak_authentication_v2:
+    auth_keycloak_url: http://localhost:8080
+    auth_realm: master
+    auth_username: admin
+    auth_password: password
+    realm: master
+    alias: My Login Flow
+    authenticationExecutions:
+      - providerId: idp-review-profile
+        requirement: REQUIRED
+        authenticationConfig:
+          alias: My Login Flow - review profile config
+          config:
+            update.profile.on.first.login: "missing"
+      - subFlow: My Login Flow - User creation or linking
+        requirement: REQUIRED
+        authenticationExecutions:
+          - providerId: idp-create-user-if-unique
+            requirement: ALTERNATIVE
+            authenticationConfig:
+              alias: My Login Flow - create unique user config
+              config:
+                require.password.update.after.registration: "true"
+          - providerId: auth-cookie
+            requirement: REQUIRED
+          - subFlow: My Login Flow - Handle Existing Account
+            requirement: ALTERNATIVE
+            authenticationExecutions:
+              - providerId: idp-confirm-link
+                requirement: REQUIRED
+      - providerId: auth-cookie
+        requirement: DISABLED
+    state: present
+
+- name: Remove an authentication flow.
+  middleware_automation.keycloak.keycloak_authentication_v2:
+    auth_keycloak_url: http://localhost:8080
+    auth_realm: master
+    auth_username: admin
+    auth_password: password
+    realm: master
+    alias: My Login Flow
+    state: absent
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of the authentication flow after module execution.

+

Returned: on success

+

Sample: {"alias": "My Login Flow", "authenticationExecutions": [{"alias": "review profile config", "authenticationConfig": {"alias": "review profile config", "config": {"update.profile.on.first.login": "missing"}, "id": "6f09e4fb-aad4-496a-b873-7fa9779df6d7"}, "configurable": true, "displayName": "Review Profile", "id": "8f77dab8-2008-416f-989e-88b09ccf0b4c", "index": 0, "level": 0, "providerId": "idp-review-profile", "requirement": "REQUIRED", "requirementChoices": ["REQUIRED", "ALTERNATIVE", "DISABLED"]}], "builtIn": false, "description": "Actions taken after first broker login with identity provider account, which is not yet linked to any Keycloak account", "id": "bc228863-5887-4297-b898-4d988f8eaa5c", "providerId": "basic-flow", "topLevel": true}

+
+

Authors

+
    +
  • Thomas Bargetz (@thomasbargetz)

  • +
  • Nils Bergmann (@NilsBergmann)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_authz_authorization_scope.html b/3.1.2/plugins/keycloak_authz_authorization_scope.html new file mode 100644 index 0000000..ccd89b0 --- /dev/null +++ b/3.1.2/plugins/keycloak_authz_authorization_scope.html @@ -0,0 +1,650 @@ + + + + + + + + + + keycloak_authz_authorization_scope – Allows administration of Keycloak client authorization scopes using Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • + View page source +
  • +
+
+
+
+
+ +
+

keycloak_authz_authorization_scope – Allows administration of Keycloak client authorization scopes using Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_authz_authorization_scope.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows the administration of Keycloak client Authorization Scopes using the Keycloak REST API. Authorization Scopes are only available if a client has Authorization enabled.

  • +
  • This module requires access to the REST API using OpenID Connect; the user connecting and the realm being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate realm definition with the scope tailored to your needs and a user having the expected roles.

  • +
  • The names of module options are snake_cased versions of the camelCase options used by Keycloak. The Authorization Services paths and payloads have not officially been documented by the Keycloak project. https://www.puppeteers.net/blog/keycloak-authorization-services-rest-api-paths-and-payload/.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

client_id

+ +

+ string + / required +

+
+

The clientId of the Keycloak client that should have the authorization scope.

+

This is usually a human-readable name of the Keycloak client.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

display_name

+ +

+ string +

+
+

The display name of the authorization scope.

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

icon_uri

+ +

+ string +

+
+

The icon URI for the authorization scope.

+
+
+

name

+ +

+ string + / required +

+
+

Name of the authorization scope to create.

+
+
+

realm

+ +

+ string + / required +

+
+

The name of the Keycloak realm the Keycloak client is in.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

State of the authorization scope.

+

On present, the authorization scope is created (or updated if it exists already).

+

On absent, the authorization scope is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: full

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Manage Keycloak file:delete authorization scope
+  keycloak_authz_authorization_scope:
+    name: file:delete
+    state: present
+    display_name: File delete
+    client_id: myclient
+    realm: myrealm
+    auth_keycloak_url: http://localhost:8080
+    auth_username: keycloak
+    auth_password: keycloak
+    auth_realm: master
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ complex +

+
+

Representation of the authorization scope after module execution.

+

Returned: on success

+
+
+

display_name

+ +

+ string +

+
+

Display name of the authorization scope.

+

Returned: when state=present

+

Sample: "File delete"

+
+
+

icon_uri

+ +

+ string +

+
+

Icon URI for the authorization scope.

+

Returned: when state=present

+

Sample: "http://localhost/icon.png"

+
+
+

id

+ +

+ string +

+
+

ID of the authorization scope.

+

Returned: when state=present

+

Sample: "a6ab1cf2-1001-40ec-9f39-48f23b6a0a41"

+
+
+

name

+ +

+ string +

+
+

Name of the authorization scope.

+

Returned: when state=present

+

Sample: "file:delete"

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+
+

Authors

+
    +
  • Samuli Seppänen (@mattock)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_authz_custom_policy.html b/3.1.2/plugins/keycloak_authz_custom_policy.html new file mode 100644 index 0000000..1999ce0 --- /dev/null +++ b/3.1.2/plugins/keycloak_authz_custom_policy.html @@ -0,0 +1,609 @@ + + + + + + + + + + keycloak_authz_custom_policy – Allows administration of Keycloak client custom Javascript policies using Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • + View page source +
  • +
+
+
+
+
+ +
+

keycloak_authz_custom_policy – Allows administration of Keycloak client custom Javascript policies using Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_authz_custom_policy.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows the administration of Keycloak client custom Javascript using the Keycloak REST API. Custom Javascript policies are only available if a client has Authorization enabled and if they have been deployed to the Keycloak server as JAR files.

  • +
  • This module requires access to the REST API using OpenID Connect; the user connecting and the realm being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate realm definition with the scope tailored to your needs and a user having the expected roles.

  • +
  • The names of module options are snake_cased versions of the camelCase options used by Keycloak. The Authorization Services paths and payloads have not officially been documented by the Keycloak project. https://www.puppeteers.net/blog/keycloak-authorization-services-rest-api-paths-and-payload/.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

client_id

+ +

+ string + / required +

+
+

The clientId of the Keycloak client that should have the custom policy attached to it.

+

This is usually a human-readable name of the Keycloak client.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

name

+ +

+ string + / required +

+
+

Name of the custom policy to create.

+
+
+

policy_type

+ +

+ string + / required +

+
+

The type of the policy. This must match the name of the custom policy deployed to the server.

+

Multiple policies pointing to the same policy type can be created, but their names have to differ.

+
+
+

realm

+ +

+ string + / required +

+
+

The name of the Keycloak realm the Keycloak client is in.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

State of the custom policy.

+

On present, the custom policy is created (or updated if it exists already).

+

On absent, the custom policy is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: none

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Manage Keycloak custom authorization policy
+  middleware_automation.keycloak.keycloak_authz_custom_policy:
+    name: OnlyOwner
+    state: present
+    policy_type: script-policy.js
+    client_id: myclient
+    realm: myrealm
+    auth_keycloak_url: http://localhost:8080
+    auth_username: keycloak
+    auth_password: keycloak
+    auth_realm: master
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of the custom policy after module execution.

+

Returned: on success

+
+
+

name

+ +

+ string +

+
+

Name of the custom policy.

+

Returned: when state=present

+

Sample: "file:delete"

+
+
+

policy_type

+ +

+ string +

+
+

Type of custom policy.

+

Returned: when state=present

+

Sample: "File delete"

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+
+

Authors

+
    +
  • Samuli Seppänen (@mattock)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_authz_permission.html b/3.1.2/plugins/keycloak_authz_permission.html new file mode 100644 index 0000000..0a18b6f --- /dev/null +++ b/3.1.2/plugins/keycloak_authz_permission.html @@ -0,0 +1,828 @@ + + + + + + + + + + keycloak_authz_permission – Allows administration of Keycloak client authorization permissions using Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • + View page source +
  • +
+
+
+
+
+ +
+

keycloak_authz_permission – Allows administration of Keycloak client authorization permissions using Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_authz_permission.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows the administration of Keycloak client authorization permissions using the Keycloak REST API. Authorization permissions are only available if a client has Authorization enabled.

  • +
  • There are some peculiarities in JSON paths and payloads for authorization permissions. In particular POST and PUT operations are targeted at permission endpoints, whereas GET requests go to policies endpoint. To make matters more interesting the JSON responses from GET requests return data in a different format than what is expected for POST and PUT. The end result is that it is not possible to detect changes to things like policies, scopes or resources - at least not without a large number of additional API calls. Therefore this module always updates authorization permissions instead of attempting to determine if changes are truly needed.

  • +
  • This module requires access to the REST API using OpenID Connect; the user connecting and the realm being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate realm definition with the scope tailored to your needs and a user having the expected roles.

  • +
  • The names of module options are snake_cased versions of the camelCase options used by Keycloak. The Authorization Services paths and payloads have not officially been documented by the Keycloak project. https://www.puppeteers.net/blog/keycloak-authorization-services-rest-api-paths-and-payload/.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

client_id

+ +

+ string + / required +

+
+

The clientId of the keycloak client that should have the authorization scope.

+

This is usually a human-readable name of the Keycloak client.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

decision_strategy

+ +

+ string +

+
+

The decision strategy to use with this permission.

+

Choices:

+
    +
  • "UNANIMOUS" ← (default)

  • +
  • "AFFIRMATIVE"

  • +
  • "CONSENSUS"

  • +
+ +
+
+

description

+ +

+ string +

+
+

The description of the authorization permission.

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

name

+ +

+ string + / required +

+
+

Name of the authorization permission to create.

+
+
+

permission_type

+ +

+ string + / required +

+
+

The type of authorization permission.

+

On scope create a scope-based permission.

+

On resource create a resource-based permission.

+

Choices:

+
    +
  • "resource"

  • +
  • "scope"

  • +
+ +
+
+

policies

+ +

+ list + / elements=string +

+
+

Policy names to attach to this permission.

+

Default: []

+
+
+

realm

+ +

+ string + / required +

+
+

The name of the Keycloak realm the Keycloak client is in.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

resources

+ +

+ list + / elements=string +

+
+

Resource names to attach to this permission.

+

Scope-based permissions can only include one resource.

+

Resource-based permissions can include multiple resources.

+

Default: []

+
+
+

scopes

+ +

+ list + / elements=string +

+
+

Scope names to attach to this permission.

+

Resource-based permissions cannot have scopes attached to them.

+

Default: []

+
+
+

state

+ +

+ string +

+
+

State of the authorization permission.

+

On present, the authorization permission is created (or updated if it exists already).

+

On absent, the authorization permission is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: none

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Manage scope-based Keycloak authorization permission
+  middleware_automation.keycloak.keycloak_authz_permission:
+    name: ScopePermission
+    state: present
+    description: Scope permission
+    permission_type: scope
+    scopes:
+      - file:delete
+    policies:
+      - Default Policy
+    client_id: myclient
+    realm: myrealm
+    auth_keycloak_url: http://localhost:8080
+    auth_username: keycloak
+    auth_password: keycloak
+    auth_realm: master
+
+- name: Manage resource-based Keycloak authorization permission
+  middleware_automation.keycloak.keycloak_authz_permission:
+    name: ResourcePermission
+    state: present
+    description: Resource permission
+    permission_type: resource
+    resources:
+      - Default Resource
+    policies:
+      - Default Policy
+    client_id: myclient
+    realm: myrealm
+    auth_keycloak_url: http://localhost:8080
+    auth_username: keycloak
+    auth_password: keycloak
+    auth_realm: master
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ complex +

+
+

Representation of the authorization permission after module execution.

+

Returned: on success

+
+
+

decisionStrategy

+ +

+ string +

+
+

The decision strategy to use.

+

Returned: when state=present

+

Sample: "UNANIMOUS"

+
+
+

description

+ +

+ string +

+
+

Description of the authorization permission.

+

Returned: when state=present

+

Sample: "Resource Permission"

+
+
+

id

+ +

+ string +

+
+

ID of the authorization permission.

+

Returned: when state=present

+

Sample: "9da05cd2-b273-4354-bbd8-0c133918a454"

+
+
+

logic

+ +

+ string +

+
+

The logic used for the permission (part of the payload, but has a fixed value).

+

Returned: when state=present

+

Sample: "POSITIVE"

+
+
+

name

+ +

+ string +

+
+

Name of the authorization permission.

+

Returned: when state=present

+

Sample: "ResourcePermission"

+
+
+

policies

+ +

+ list + / elements=string +

+
+

IDs of policies attached to this permission.

+

Returned: when state=present

+

Sample: ["9da05cd2-b273-4354-bbd8-0c133918a454"]

+
+
+

resources

+ +

+ list + / elements=string +

+
+

IDs of resources attached to this permission.

+

Returned: when state=present

+

Sample: ["49e052ff-100d-4b79-a9dd-52669ed3c11d"]

+
+
+

scopes

+ +

+ list + / elements=string +

+
+

IDs of scopes attached to this permission.

+

Returned: when state=present

+

Sample: ["9da05cd2-b273-4354-bbd8-0c133918a454"]

+
+
+

type

+ +

+ string +

+
+

Type of the authorization permission.

+

Returned: when state=present

+

Sample: "resource"

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+
+

Authors

+
    +
  • Samuli Seppänen (@mattock)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_authz_permission_info.html b/3.1.2/plugins/keycloak_authz_permission_info.html new file mode 100644 index 0000000..f573c3c --- /dev/null +++ b/3.1.2/plugins/keycloak_authz_permission_info.html @@ -0,0 +1,648 @@ + + + + + + + + + + keycloak_authz_permission_info – Query Keycloak client authorization permissions information — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

keycloak_authz_permission_info – Query Keycloak client authorization permissions information

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_authz_permission_info.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows querying information about Keycloak client authorization permissions from the resources endpoint using the Keycloak REST API. Authorization permissions are only available if a client has Authorization enabled.

  • +
  • This module requires access to the REST API using OpenID Connect; the user connecting and the realm being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate realm definition with the scope tailored to your needs and a user having the expected roles.

  • +
  • The names of module options are snake_cased versions of the camelCase options used by Keycloak. The Authorization Services paths and payloads have not officially been documented by the Keycloak project. https://www.puppeteers.net/blog/keycloak-authorization-services-rest-api-paths-and-payload/.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

client_id

+ +

+ string + / required +

+
+

The clientId of the keycloak client that should have the authorization scope.

+

This is usually a human-readable name of the Keycloak client.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

name

+ +

+ string + / required +

+
+

Name of the authorization permission to create.

+
+
+

realm

+ +

+ string + / required +

+
+

The name of the Keycloak realm the Keycloak client is in.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

This action does not modify state.

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: N/A

+

This action does not modify state.

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Query Keycloak authorization permission
+  middleware_automation.keycloak.keycloak_authz_permission_info:
+    name: ScopePermission
+    client_id: myclient
+    realm: myrealm
+    auth_keycloak_url: http://localhost:8080
+    auth_username: keycloak
+    auth_password: keycloak
+    auth_realm: master
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+
+
+

queried_state

+ +

+ complex +

+
+

State of the resource (a policy) as seen by Keycloak.

+

Returned: on success

+
+
+

config

+ +

+ dictionary +

+
+

Configuration of the permission (empty in all observed cases).

+

Returned: success

+

Sample: {}

+
+
+

decisionStrategy

+ +

+ string +

+
+

The decision strategy.

+

Returned: success

+

Sample: "UNANIMOUS"

+
+
+

description

+ +

+ string +

+
+

Description of the authorization permission.

+

Returned: success

+

Sample: "Resource Permission"

+
+
+

id

+ +

+ string +

+
+

ID of the authorization permission.

+

Returned: success

+

Sample: "9da05cd2-b273-4354-bbd8-0c133918a454"

+
+
+

logic

+ +

+ string +

+
+

The logic used for the permission (part of the payload, but has a fixed value).

+

Returned: success

+

Sample: "POSITIVE"

+
+
+

name

+ +

+ string +

+
+

Name of the authorization permission.

+

Returned: success

+

Sample: "ResourcePermission"

+
+
+

type

+ +

+ string +

+
+

Type of the authorization permission.

+

Returned: success

+

Sample: "resource"

+
+

Authors

+
    +
  • Samuli Seppänen (@mattock)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_client.html b/3.1.2/plugins/keycloak_client.html new file mode 100644 index 0000000..7bfb9bc --- /dev/null +++ b/3.1.2/plugins/keycloak_client.html @@ -0,0 +1,1985 @@ + + + + + + + + + + keycloak_client – Allows administration of Keycloak clients using Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

keycloak_client – Allows administration of Keycloak clients using Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_client.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows the administration of Keycloak clients using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.

  • +
  • The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at https://www.keycloak.org/docs-api/latest/rest-api/index.html. Aliases are provided so camelCased versions can be used as well.

  • +
  • The Keycloak API does not always sanity check inputs, for example you can set SAML-specific settings on an OpenID Connect client for instance and the other way around. Be careful. If you do not specify a setting, usually a sensible default is chosen.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+
+

admin_url

+ +

aliases: adminUrl

+

+ string +

+
+

URL to the admin interface of the client. This is adminUrl in the Keycloak REST API.

+
+
+
+

always_display_in_console

+ +

aliases: alwaysDisplayInConsole

+

+ boolean +

+
+

Whether or not to display this client in account console, even if the user does not have an active session.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

attributes

+ +

+ dictionary +

+
+

A dict of further attributes for this client. This can contain various configuration settings; an example is given in the examples section. While an exhaustive list of permissible options is not available; possible options as of Keycloak 3.4 are listed below. The Keycloak API does not validate whether a given option is appropriate for the protocol used; if specified anyway, Keycloak does not use it.

+
+
+

jwks.url

+ +

+ string +

+
+

For OpenID-Connect clients, URL where client keys in JWK are stored.

+
+
+

jwt.credential.certificate

+ +

+ string +

+
+

For OpenID-Connect clients, client certificate for validating JWT issued by client and signed by its key, base64-encoded.

+
+
+

request.object.signature.alg

+ +

+ string +

+
+

For OpenID-Connect clients, JWA algorithm which the client needs to use when sending OIDC request object. One of any, none, RS256.

+
+
+

saml.authnstatement

+ +

+ string +

+
+

For SAML clients, boolean specifying whether or not a statement containing method and timestamp should be included in the login response.

+
+
+

saml.client.signature

+ +

+ string +

+
+

For SAML clients, boolean specifying whether a client signature is required and validated.

+
+
+

saml.encrypt

+ +

+ string +

+
+

Boolean specifying whether SAML assertions should be encrypted with the client's public key.

+
+
+

saml.force.post.binding

+ +

+ string +

+
+

For SAML clients, boolean specifying whether always to use POST binding for responses.

+
+
+

saml.onetimeuse.condition

+ +

+ string +

+
+

For SAML clients, boolean specifying whether a OneTimeUse condition should be included in login responses.

+
+
+

saml.server.signature

+ +

+ string +

+
+

Boolean specifying whether SAML documents should be signed by the realm.

+
+
+

saml.server.signature.keyinfo.ext

+ +

+ string +

+
+

For SAML clients, boolean specifying whether REDIRECT signing key lookup should be optimized through inclusion of the signing key ID in the SAML Extensions element.

+
+
+

saml.signature.algorithm

+ +

+ string +

+
+

Signature algorithm used to sign SAML documents. One of RSA_SHA256, RSA_SHA1, RSA_SHA512, or DSA_SHA1.

+
+
+

saml.signing.certificate

+ +

+ string +

+
+

SAML signing key certificate, base64-encoded.

+
+
+

saml.signing.private.key

+ +

+ string +

+
+

SAML signing key private key, base64-encoded.

+
+
+

saml_assertion_consumer_url_post

+ +

+ string +

+
+

SAML POST Binding URL for the client's assertion consumer service (login responses).

+
+
+

saml_assertion_consumer_url_redirect

+ +

+ string +

+
+

SAML Redirect Binding URL for the client's assertion consumer service (login responses).

+
+
+

saml_force_name_id_format

+ +

+ string +

+
+

For SAML clients, Boolean specifying whether to ignore requested NameID subject format and using the configured one instead.

+
+
+

saml_name_id_format

+ +

+ string +

+
+

For SAML clients, the NameID format to use (one of username, email, transient, or persistent).

+
+
+

saml_signature_canonicalization_method

+ +

+ string +

+
+

SAML signature canonicalization method. This is one of four values, namely http://www.w3.org/2001/10/xml-exc-c14n# for EXCLUSIVE, http://www.w3.org/2001/10/xml-exc-c14n#WithComments for EXCLUSIVE_WITH_COMMENTS, http://www.w3.org/TR/2001/REC-xml-c14n-20010315 for INCLUSIVE, and http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments for INCLUSIVE_WITH_COMMENTS.

+
+
+

saml_single_logout_service_url_post

+ +

+ string +

+
+

SAML POST binding URL for the client's single logout service.

+
+
+

saml_single_logout_service_url_redirect

+ +

+ string +

+
+

SAML redirect binding URL for the client's single logout service.

+
+
+

use.jwks.url

+ +

+ string +

+
+

For OpenID-Connect clients, boolean specifying whether to use a JWKS URL to obtain client public keys.

+
+
+

user.info.response.signature.alg

+ +

+ string +

+
+

For OpenID-Connect clients, JWA algorithm for signed UserInfo-endpoint responses. One of RS256 or unsigned.

+
+
+

x509.allow.regex.pattern.comparison

+ +

+ boolean +

+
+

For OpenID-Connect clients, boolean specifying whether to allow x509.subjectdn as regular expression.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

x509.subjectdn

+ +

+ string +

+
+

For OpenID-Connect clients, subject which is used to authenticate the client.

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+
+

authentication_flow_binding_overrides

+ +

aliases: authenticationFlowBindingOverrides

+

+ dictionary +

+
+

Override realm authentication flow bindings.

+
+
+
+

browser

+ +

+ string +

+
+

Flow ID of the browser authentication flow.

+

authentication_flow_binding_overrides.browser and authentication_flow_binding_overrides.browser_name are mutually exclusive.

+
+
+
+
+
+

browser_name

+ +

aliases: browserName

+

+ string +

+
+

Flow name of the browser authentication flow.

+

authentication_flow_binding_overrides.browser and authentication_flow_binding_overrides.browser_name are mutually exclusive.

+
+
+
+
+
+

direct_grant

+ +

aliases: directGrant

+

+ string +

+
+

Flow ID of the direct grant authentication flow.

+

authentication_flow_binding_overrides.direct_grant and authentication_flow_binding_overrides.direct_grant_name are mutually exclusive.

+
+
+
+
+
+

direct_grant_name

+ +

aliases: directGrantName

+

+ string +

+
+

Flow name of the direct grant authentication flow.

+

authentication_flow_binding_overrides.direct_grant and authentication_flow_binding_overrides.direct_grant_name are mutually exclusive.

+
+
+
+

authorization_services_enabled

+ +

aliases: authorizationServicesEnabled

+

+ boolean +

+
+

Are authorization services enabled for this client or not (OpenID connect). This is authorizationServicesEnabled in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

authorization_settings

+ +

aliases: authorizationSettings

+

+ dictionary +

+
+

A data structure defining the authorization settings for this client. For reference, please see the Keycloak API docs at https://www.keycloak.org/docs-api/latest/rest-api/index.html#_resourceserverrepresentation. This is authorizationSettings in the Keycloak REST API.

+
+
+
+

backchannel_logout_url

+ +

aliases: backchannelLogoutUrl

+

+ string +

+
+

URL that will cause the client to log itself out when a logout request is sent to this realm.

+

This is stored as backchannel.logout.url in the client attributes.

+
+
+
+

base_url

+ +

aliases: baseUrl

+

+ string +

+
+

Default URL to use when the auth server needs to redirect or link back to the client This is baseUrl in the Keycloak REST API.

+
+
+
+

bearer_only

+ +

aliases: bearerOnly

+

+ boolean +

+
+

The access type of this client is bearer-only. This is bearerOnly in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

client_authenticator_type

+ +

aliases: clientAuthenticatorType

+

+ string +

+
+

How do clients authenticate with the auth server? Either client-secret, client-jwt, or client-x509 can be chosen. When using client-secret, the module parameter secret can set it, for client-jwt, you can use the keys use.jwks.url, jwks.url, and jwt.credential.certificate in the attributes module parameter to configure its behavior. For client-x509 you can use the keys x509.allow.regex.pattern.comparison and x509.subjectdn in the attributes module parameter to configure which certificate(s) to accept.

+

This is clientAuthenticatorType in the Keycloak REST API.

+

Choices:

+
    +
  • "client-secret"

  • +
  • "client-jwt"

  • +
  • "client-x509"

  • +
+ +
+
+
+

client_id

+ +

aliases: clientId

+

+ string +

+
+

Client ID of client to be worked on. This is usually an alphanumeric name chosen by you. Either this or id is required. If you specify both, id takes precedence. This is clientId in the Keycloak REST API.

+
+
+
+

client_scopes_behavior

+ +

aliases: clientScopesBehavior

+

+ string +

+
+

Determine how default_client_scopes and optional_client_scopes behave when updating an existing client.

+

ignore: Do not change the client scopes of an existing client. This is the default for backward compatibility.

+

patch: Add missing scopes, do not remove any missing scopes.

+

idempotent: Make the client scopes exactly as specified, adding and removing scopes as needed.

+

Choices:

+
    +
  • "ignore" ← (default)

  • +
  • "patch"

  • +
  • "idempotent"

  • +
+ +
+
+
+

client_template

+ +

aliases: clientTemplate

+

+ string +

+
+

Client template to use for this client. If it does not exist this field is silently dropped. This is clientTemplate in the Keycloak REST API.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+ +
+

consent_required

+ +

aliases: consentRequired

+

+ boolean +

+
+

If enabled, users have to consent to client access. This is consentRequired in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

default_client_scopes

+ +

aliases: defaultClientScopes

+

+ list + / elements=string +

+
+

List of default client scopes.

+

See client_scopes_behavior for how this behaves when updating an existing client.

+
+
+
+

default_roles

+ +

aliases: defaultRoles

+

+ list + / elements=string +

+
+

List of default roles for this client. If the client roles referenced do not exist yet, they are created. This is defaultRoles in the Keycloak REST API.

+
+
+

description

+ +

+ string +

+
+

Description of the client in Keycloak.

+
+
+
+

direct_access_grants_enabled

+ +

aliases: directAccessGrantsEnabled

+

+ boolean +

+
+

Are direct access grants enabled for this client or not (OpenID connect). This is directAccessGrantsEnabled in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

enabled

+ +

+ boolean +

+
+

Is this client enabled or not?

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

frontchannel_logout

+ +

aliases: frontchannelLogout

+

+ boolean +

+
+

Is frontchannel logout enabled for this client or not. This is frontchannelLogout in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

full_scope_allowed

+ +

aliases: fullScopeAllowed

+

+ boolean +

+
+

Is the "Full Scope Allowed" feature set for this client or not. This is fullScopeAllowed in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

id

+ +

+ string +

+
+

ID of client to be worked on. This is usually an UUID. Either this or client_id is required. If you specify both, this takes precedence.

+
+
+
+

implicit_flow_enabled

+ +

aliases: implicitFlowEnabled

+

+ boolean +

+
+

Enable implicit flow for this client or not (OpenID connect). This is implicitFlowEnabled in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

name

+ +

+ string +

+
+

Name of the client (this is not the same as client_id).

+
+
+
+

node_re_registration_timeout

+ +

aliases: nodeReRegistrationTimeout

+

+ integer +

+
+

Cluster node re-registration timeout for this client. This is nodeReRegistrationTimeout in the Keycloak REST API.

+
+
+
+

not_before

+ +

aliases: notBefore

+

+ integer +

+
+

Revoke any tokens issued before this date for this client (this is a UNIX timestamp). This is notBefore in the Keycloak REST API.

+
+
+
+

optional_client_scopes

+ +

aliases: optionalClientScopes

+

+ list + / elements=string +

+
+

List of optional client scopes.

+

See client_scopes_behavior for how this behaves when updating an existing client.

+
+
+

protocol

+ +

+ string +

+
+

Type of client.

+

At creation only, default value is openid-connect if protocol is omitted.

+

The docker-v2 value was added in middleware_automation.keycloak 8.6.0.

+

Choices:

+
    +
  • "openid-connect"

  • +
  • "saml"

  • +
  • "docker-v2"

  • +
+ +
+
+
+

protocol_mappers

+ +

aliases: protocolMappers

+

+ list + / elements=dictionary +

+
+

A list of dicts defining protocol mappers for this client. This is protocolMappers in the Keycloak REST API.

+
+
+
+

config

+ +

+ dictionary +

+
+

Dict specifying the configuration options for the protocol mapper; the contents differ depending on the value of protocol_mappers[].protocolMapper and are not documented other than by the source of the mappers and its parent class(es). An example is given below. It is easiest to obtain valid config values by dumping an already-existing protocol mapper configuration through check-mode in the existing field.

+
+
+
+

consentRequired

+ +

+ boolean +

+
+

Specifies whether a user needs to provide consent to a client for this mapper to be active.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

consentText

+ +

+ string +

+
+

The human-readable name of the consent the user is presented to accept.

+
+
+
+

id

+ +

+ string +

+
+

Usually a UUID specifying the internal ID of this protocol mapper instance.

+
+
+
+

name

+ +

+ string +

+
+

The name of this protocol mapper.

+
+
+
+

protocol

+ +

+ string +

+
+

This specifies for which protocol this protocol mapper is active.

+

Choices:

+
    +
  • "openid-connect"

  • +
  • "saml"

  • +
  • "docker-v2"

  • +
+ +
+
+
+

protocolMapper

+ +

+ string +

+
+

The Keycloak-internal name of the type of this protocol-mapper. While an exhaustive list is impossible to provide since this may be extended through SPIs by the user of Keycloak, by default Keycloak as of 3.4 ships with at least:

+

docker-v2-allow-all-mapper.

+

oidc-address-mapper.

+

oidc-full-name-mapper.

+

oidc-group-membership-mapper.

+

oidc-hardcoded-claim-mapper.

+

oidc-hardcoded-role-mapper.

+

oidc-role-name-mapper.

+

oidc-script-based-protocol-mapper.

+

oidc-sha256-pairwise-sub-mapper.

+

oidc-usermodel-attribute-mapper.

+

oidc-usermodel-client-role-mapper.

+

oidc-usermodel-property-mapper.

+

oidc-usermodel-realm-role-mapper.

+

oidc-usersessionmodel-note-mapper.

+

saml-group-membership-mapper.

+

saml-hardcode-attribute-mapper.

+

saml-hardcode-role-mapper.

+

saml-role-list-mapper.

+

saml-role-name-mapper.

+

saml-user-attribute-mapper.

+

saml-user-property-mapper.

+

saml-user-session-note-mapper.

+

An exhaustive list of available mappers on your installation can be obtained on the admin console by going to Server Info -> Providers and looking under 'protocol-mapper'.

+
+
+
+

public_client

+ +

aliases: publicClient

+

+ boolean +

+
+

Is the access type for this client public or not. This is publicClient in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

realm

+ +

+ string +

+
+

The realm to create the client in.

+

Default: "master"

+
+
+
+

redirect_uris

+ +

aliases: redirectUris

+

+ list + / elements=string +

+
+

Acceptable redirect URIs for this client. This is redirectUris in the Keycloak REST API.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+
+

registered_nodes

+ +

aliases: registeredNodes

+

+ dictionary +

+
+

Dict of registered cluster nodes (with nodename as the key and last registration time as the value). This is registeredNodes in the Keycloak REST API.

+
+
+
+

registration_access_token

+ +

aliases: registrationAccessToken

+

+ string +

+
+

The registration access token provides access for clients to the client registration service. This is registrationAccessToken in the Keycloak REST API.

+
+
+
+

root_url

+ +

aliases: rootUrl

+

+ string +

+
+

Root URL appended to relative URLs for this client. This is rootUrl in the Keycloak REST API.

+
+
+

secret

+ +

+ string +

+
+

When using client_authenticator_type=client-secret (the default), you can specify a secret here (otherwise one is generated if it does not exit). If changing this secret, the module does not register a change currently (but the changed secret is saved).

+
+
+
+

service_accounts_enabled

+ +

aliases: serviceAccountsEnabled

+

+ boolean +

+
+

Are service accounts enabled for this client or not (OpenID connect). This is serviceAccountsEnabled in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

standard_flow_enabled

+ +

aliases: standardFlowEnabled

+

+ boolean +

+
+

Enable standard flow for this client or not (OpenID connect). This is standardFlowEnabled in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

state

+ +

+ string +

+
+

State of the client.

+

On present, the client are created (or updated if it exists already).

+

On absent, the client are removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+
+

surrogate_auth_required

+ +

aliases: surrogateAuthRequired

+

+ boolean +

+
+

Whether or not surrogate auth is required. This is surrogateAuthRequired in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+
+

use_template_config

+ +

aliases: useTemplateConfig

+

+ boolean +

+
+

Whether or not to use configuration from the client_template. This is useTemplateConfig in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

use_template_mappers

+ +

aliases: useTemplateMappers

+

+ boolean +

+
+

Whether or not to use mapper configuration from the client_template. This is useTemplateMappers in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

use_template_scope

+ +

aliases: useTemplateScope

+

+ boolean +

+
+

Whether or not to use scope configuration from the client_template. This is useTemplateScope in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

valid_post_logout_redirect_uris

+ +

aliases: postLogoutRedirectUris

+

+ list + / elements=string +

+
+

Valid post logout redirect URIs for this client.

+

This is stored as post.logout.redirect.uris in the client attributes.

+

Use + as a single list element to allow all redirect URIs.

+
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+
+

web_origins

+ +

aliases: webOrigins

+

+ list + / elements=string +

+
+

List of allowed CORS origins. This is webOrigins in the Keycloak REST API.

+
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: full

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Create or update Keycloak client (minimal example), authentication with credentials
+  middleware_automation.keycloak.keycloak_client:
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    client_id: test
+    state: present
+  delegate_to: localhost
+
+
+- name: Create or update Keycloak client (minimal example), authentication with token
+  middleware_automation.keycloak.keycloak_client:
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    token: TOKEN
+    client_id: test
+    state: present
+  delegate_to: localhost
+
+
+- name: Delete a Keycloak client
+  middleware_automation.keycloak.keycloak_client:
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    client_id: test
+    state: absent
+  delegate_to: localhost
+
+
+- name: Create or update a Keycloak client (minimal example), with x509 authentication
+  middleware_automation.keycloak.keycloak_client:
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    realm: master
+    state: present
+    client_id: test
+    client_authenticator_type: client-x509
+    attributes:
+      x509.subjectdn: "CN=client"
+      x509.allow.regex.pattern.comparison: false
+
+
+- name: Create or update a Keycloak client (with all the bells and whistles)
+  middleware_automation.keycloak.keycloak_client:
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    state: present
+    realm: master
+    client_id: test
+    id: d8b127a3-31f6-44c8-a7e4-4ab9a3e78d95
+    name: this_is_a_test
+    description: Description of this wonderful client
+    root_url: https://www.example.com/
+    admin_url: https://www.example.com/admin_url
+    base_url: basepath
+    enabled: true
+    client_authenticator_type: client-secret
+    secret: REALLYWELLKEPTSECRET
+    redirect_uris:
+      - https://www.example.com/*
+      - http://localhost:8888/
+    web_origins:
+      - https://www.example.com/*
+    not_before: 1507825725
+    bearer_only: false
+    consent_required: false
+    standard_flow_enabled: true
+    implicit_flow_enabled: false
+    direct_access_grants_enabled: false
+    service_accounts_enabled: false
+    authorization_services_enabled: false
+    public_client: false
+    frontchannel_logout: false
+    protocol: openid-connect
+    full_scope_allowed: false
+    node_re_registration_timeout: -1
+    client_template: test
+    use_template_config: false
+    use_template_scope: false
+    use_template_mappers: false
+    always_display_in_console: true
+    registered_nodes:
+      node01.example.com: 1507828202
+    registration_access_token: eyJWT_TOKEN
+    surrogate_auth_required: false
+    default_roles:
+      - test01
+      - test02
+    authentication_flow_binding_overrides:
+      browser: 4c90336b-bf1d-4b87-916d-3677ba4e5fbb
+    protocol_mappers:
+      - config:
+          access.token.claim: true
+          claim.name: "family_name"
+          id.token.claim: true
+          jsonType.label: String
+          user.attribute: lastName
+          userinfo.token.claim: true
+        consentRequired: true
+        consentText: "${familyName}"
+        name: family name
+        protocol: openid-connect
+        protocolMapper: oidc-usermodel-property-mapper
+      - config:
+          attribute.name: Role
+          attribute.nameformat: Basic
+          single: false
+        consentRequired: false
+        name: role list
+        protocol: saml
+        protocolMapper: saml-role-list-mapper
+    attributes:
+      saml.authnstatement: true
+      saml.client.signature: true
+      saml.force.post.binding: true
+      saml.server.signature: true
+      saml.signature.algorithm: RSA_SHA256
+      saml.signing.certificate: CERTIFICATEHERE
+      saml.signing.private.key: PRIVATEKEYHERE
+      saml_force_name_id_format: false
+      saml_name_id_format: username
+      saml_signature_canonicalization_method: "http://www.w3.org/2001/10/xml-exc-c14n#"
+      user.info.response.signature.alg: RS256
+      request.object.signature.alg: RS256
+      use.jwks.url: true
+      jwks.url: JWKS_URL_FOR_CLIENT_AUTH_JWT
+      jwt.credential.certificate: JWT_CREDENTIAL_CERTIFICATE_FOR_CLIENT_AUTH
+  delegate_to: localhost
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of client after module execution (sample is truncated).

+

Returned: on success

+

Sample: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}

+
+
+

existing

+ +

+ dictionary +

+
+

Representation of existing client (sample is truncated).

+

Returned: always

+

Sample: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: "Client testclient has been updated"

+
+
+

proposed

+ +

+ dictionary +

+
+

Representation of proposed client.

+

Returned: always

+

Sample: {"clientId": "test"}

+
+

Authors

+
    +
  • Eike Frost (@eikef)

  • +
  • Ivan Kokalović (@koke1997)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_client_rolemapping.html b/3.1.2/plugins/keycloak_client_rolemapping.html new file mode 100644 index 0000000..a6a7f18 --- /dev/null +++ b/3.1.2/plugins/keycloak_client_rolemapping.html @@ -0,0 +1,774 @@ + + + + + + + + + + keycloak_client_rolemapping – Allows administration of Keycloak client_rolemapping with the Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • + View page source +
  • +
+
+
+
+
+ +
+

keycloak_client_rolemapping – Allows administration of Keycloak client_rolemapping with the Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_client_rolemapping.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows you to add, remove or modify Keycloak client_rolemapping with the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.

  • +
  • The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at https://www.keycloak.org/docs-api/latest/rest-api/index.html.

  • +
  • Attributes are multi-valued in the Keycloak API. All attributes are lists of individual values and are returned that way by this module. You may pass single values for attributes when calling the module, and this is translated into a list suitable for the API.

  • +
  • When updating a client_rolemapping, where possible provide the role ID to the module. This removes a lookup to the API to translate the name into the role ID.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

cid

+ +

+ string +

+
+

ID of the client to be mapped.

+

This parameter is not required for updating or deleting the rolemapping but providing it reduces the number of API calls required.

+
+
+

client_id

+ +

+ string +

+
+

Name of the client to be mapped (different than cid).

+

This parameter is required (can be replaced by cid for less API call).

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

gid

+ +

+ string +

+
+

ID of the group to be mapped.

+

This parameter is not required for updating or deleting the rolemapping but providing it reduces the number of API calls required.

+
+
+

group_name

+ +

+ string +

+
+

Name of the group to be mapped.

+

This parameter is required (can be replaced by gid for less API call).

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

parents

+ +

+ list + / elements=dictionary +

+
+

List of parent groups for the group to handle sorted top to bottom.

+

Set this if your group is a subgroup and you do not provide the GID in gid.

+
+
+

id

+ +

+ string +

+
+

Identify parent by ID.

+

Needs less API calls than using parents[].name.

+

A deep parent chain can be started at any point when first given parent is given as ID.

+

Note that in principle both ID and name can be specified at the same time but current implementation only always use just one of them, with ID being preferred.

+
+
+

name

+ +

+ string +

+
+

Identify parent by name.

+

Needs more internal API calls than using parents[].id to map names to ID's under the hood.

+

When giving a parent chain with only names it must be complete up to the top.

+

Note that in principle both ID and name can be specified at the same time but current implementation only always use just one of them, with ID being preferred.

+
+
+

realm

+ +

+ string +

+
+

They Keycloak realm under which this role_representation resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

roles

+ +

+ list + / elements=dictionary +

+
+

Roles to be mapped to the group.

+
+
+

id

+ +

+ string +

+
+

The unique identifier for this role_representation.

+

This parameter is not required for updating or deleting a role_representation but providing it reduces the number of API calls required.

+
+
+

name

+ +

+ string +

+
+

Name of the role_representation.

+

This parameter is required only when creating or updating the role_representation.

+
+
+

state

+ +

+ string +

+
+

State of the client_rolemapping.

+

On present, the client_rolemapping is created if it does not yet exist, or updated with the parameters you provide.

+

On absent, the client_rolemapping is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: full

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Map a client role to a group, authentication with credentials
+  middleware_automation.keycloak.keycloak_client_rolemapping:
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    state: present
+    client_id: client1
+    group_name: group1
+    roles:
+      - name: role_name1
+        id: role_id1
+      - name: role_name2
+        id: role_id2
+  delegate_to: localhost
+
+- name: Map a client role to a group, authentication with token
+  middleware_automation.keycloak.keycloak_client_rolemapping:
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    token: TOKEN
+    state: present
+    client_id: client1
+    group_name: group1
+    roles:
+      - name: role_name1
+        id: role_id1
+      - name: role_name2
+        id: role_id2
+  delegate_to: localhost
+
+- name: Map a client role to a subgroup, authentication with token
+  middleware_automation.keycloak.keycloak_client_rolemapping:
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    token: TOKEN
+    state: present
+    client_id: client1
+    group_name: subgroup1
+    parents:
+      - name: parent-group
+    roles:
+      - name: role_name1
+        id: role_id1
+      - name: role_name2
+        id: role_id2
+  delegate_to: localhost
+
+- name: Unmap client role from a group
+  middleware_automation.keycloak.keycloak_client_rolemapping:
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    state: absent
+    client_id: client1
+    group_name: group1
+    roles:
+      - name: role_name1
+        id: role_id1
+      - name: role_name2
+        id: role_id2
+  delegate_to: localhost
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of client role mapping after module execution.

+

The sample is truncated.

+

Returned: on success

+

Sample: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}

+
+
+

existing

+ +

+ dictionary +

+
+

Representation of existing client role mapping.

+

The sample is truncated.

+

Returned: always

+

Sample: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: "Role role1 assigned to group group1."

+
+
+

proposed

+ +

+ dictionary +

+
+

Representation of proposed client role mapping.

+

Returned: always

+

Sample: {"clientId": "test"}

+
+

Authors

+
    +
  • Gaëtan Daubresse (@Gaetan2907)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_client_rolescope.html b/3.1.2/plugins/keycloak_client_rolescope.html new file mode 100644 index 0000000..1cb3d03 --- /dev/null +++ b/3.1.2/plugins/keycloak_client_rolescope.html @@ -0,0 +1,608 @@ + + + + + + + + + + keycloak_client_rolescope – Allows administration of Keycloak client roles scope to restrict the usage of certain roles to a other specific client applications — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • + View page source +
  • +
+
+
+
+
+ +
+

keycloak_client_rolescope – Allows administration of Keycloak client roles scope to restrict the usage of certain roles to a other specific client applications

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_client_rolescope.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows you to add or remove Keycloak roles from clients scope using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.

  • +
  • Client target_client_id must have full_scope_allowed set to false.

  • +
  • Attributes are multi-valued in the Keycloak API. All attributes are lists of individual values and are returned that way by this module. You may pass single values for attributes when calling the module, and this is translated into a list suitable for the API.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

realm

+ +

+ string +

+
+

The Keycloak realm under which clients resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

role_names

+ +

+ list + / elements=string + / required +

+
+

Names of roles to manipulate.

+

If role_owner_client_id is present, all roles must be under this client.

+

If role_owner_client_id is absent, all roles must be under the realm.

+
+
+

role_owner_client_id

+ +

+ string +

+
+

If the role_names are client role, the client ID under which it resides.

+

If this parameter is absent, the roles are considered a realm role.

+
+
+

state

+ +

+ string +

+
+

State of the role mapping.

+

On present, all roles in role_names are mapped if not exist yet.

+

On absent, all roles mapping in role_names are removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

target_client_id

+ +

+ string + / required +

+
+

Roles provided in role_names while be added to this client scope.

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: full

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Add roles to public client scope
+  middleware_automation.keycloak.keycloak_client_rolescope:
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    realm: MyCustomRealm
+    target_client_id: frontend-client-public
+    role_owner_client_id: backend-client-private
+    role_names:
+      - backend-role-admin
+      - backend-role-user
+
+- name: Remove roles from public client scope
+  middleware_automation.keycloak.keycloak_client_rolescope:
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    realm: MyCustomRealm
+    target_client_id: frontend-client-public
+    role_owner_client_id: backend-client-private
+    role_names:
+      - backend-role-admin
+    state: absent
+
+- name: Add realm roles to public client scope
+  middleware_automation.keycloak.keycloak_client_rolescope:
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    realm: MyCustomRealm
+    target_client_id: frontend-client-public
+    role_names:
+      - realm-role-admin
+      - realm-role-user
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ list + / elements=dictionary +

+
+

Representation of role role scope after module execution.

+

Returned: on success

+

Sample: [{"clientRole": false, "composite": false, "containerId": "MyCustomRealm", "id": "47293104-59a6-46f0-b460-2e9e3c9c424c", "name": "backend-role-admin"}, {"clientRole": false, "composite": false, "containerId": "MyCustomRealm", "id": "39c62a6d-542c-4715-92d2-41021eb33967", "name": "backend-role-user"}]

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: "Client role scope for frontend-client-public has been updated"

+
+

Authors

+
    +
  • Andre Desrosiers (@desand01)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_client_scope.html b/3.1.2/plugins/keycloak_client_scope.html new file mode 100644 index 0000000..8b01b08 --- /dev/null +++ b/3.1.2/plugins/keycloak_client_scope.html @@ -0,0 +1,708 @@ + + + + + + + + + + keycloak_client_scope – Allows administration of Keycloak client scopes via Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

keycloak_client_scope – Allows administration of Keycloak client scopes via Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_client_scope.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows you to add, remove or modify Keycloak client scopes via the Keycloak REST API. It requires access to the REST API via OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.

  • +
  • This module also supports managing protocol mappers within a client scope.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

attributes

+ +

+ dictionary +

+
+

A dict of key/value pairs to set as attributes for the client scope.

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

description

+ +

+ string +

+
+

Description of the client scope.

+

Default: ""

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

name

+ +

+ string + / required +

+
+

Name of the client scope.

+
+
+

protocol

+ +

+ string +

+
+

The protocol associated with the client scope.

+

Choices:

+
    +
  • "openid-connect" ← (default)

  • +
  • "saml"

  • +
+ +
+
+
+

protocol_mappers

+ +

aliases: protocolMappers

+

+ list + / elements=dictionary +

+
+

A list of protocol mappers to associate with the client scope.

+

Each mapper is a dict with the keys name, protocol, protocolMapper, and config.

+

Default: []

+
+
+
+

config

+ +

+ dictionary + / required +

+
+

Configuration for the protocol mapper.

+
+
+
+

name

+ +

+ string + / required +

+
+

Name of the protocol mapper.

+
+
+
+

protocol

+ +

+ string +

+
+

Protocol for the mapper.

+

Default: "openid-connect"

+
+
+
+
+
+

protocolMapper

+ +

aliases: protocol_mapper_type

+

+ string + / required +

+
+

The mapper type (e.g. oidc-usermodel-attribute-mapper, oidc-audience-mapper).

+
+
+

realm

+ +

+ string +

+
+

The Keycloak realm under which this client scope resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

State of the client scope.

+

On present, the client scope will be created if it does not yet exist, or updated with the parameters you provide.

+

On absent, the client scope will be removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: full

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Create a client scope with protocol mappers
+  middleware_automation.keycloak.keycloak_client_scope:
+    auth_keycloak_url: http://localhost:8080
+    auth_realm: master
+    auth_username: admin
+    auth_password: password
+    realm: TestRealm
+    name: my-client-scope
+    description: "A custom client scope"
+    protocol: openid-connect
+    protocol_mappers:
+      - name: email
+        protocol: openid-connect
+        protocolMapper: oidc-usermodel-attribute-mapper
+        config:
+          user.attribute: email
+          claim.name: email
+          jsonType.label: String
+          id.token.claim: "true"
+          access.token.claim: "true"
+          userinfo.token.claim: "true"
+    state: present
+  delegate_to: localhost
+
+- name: Create a client scope using token authentication
+  middleware_automation.keycloak.keycloak_client_scope:
+    auth_keycloak_url: http://localhost:8080
+    token: MY_TOKEN
+    realm: TestRealm
+    name: my-scope
+    state: present
+  delegate_to: localhost
+
+- name: Delete a client scope
+  middleware_automation.keycloak.keycloak_client_scope:
+    auth_keycloak_url: http://localhost:8080
+    auth_realm: master
+    auth_username: admin
+    auth_password: password
+    realm: TestRealm
+    name: my-client-scope
+    state: absent
+  delegate_to: localhost
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of the client scope after module execution.

+

Returned: on success

+

Sample: {"description": "A custom scope", "id": "uuid-here", "name": "my-scope", "protocol": "openid-connect"}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: "Client scope my-scope has been created"

+
+

Authors

+
    +
  • Paulo Menon (@paulomenon)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_client_scope_rolemappings.html b/3.1.2/plugins/keycloak_client_scope_rolemappings.html new file mode 100644 index 0000000..746b4ad --- /dev/null +++ b/3.1.2/plugins/keycloak_client_scope_rolemappings.html @@ -0,0 +1,592 @@ + + + + + + + + + + keycloak_client_scope_rolemappings – Allows administration of Keycloak client scope scope mappings to restrict the usage of certain roles to specific client scopes — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • + View page source +
  • +
+
+
+
+
+ +
+

keycloak_client_scope_rolemappings – Allows administration of Keycloak client scope scope mappings to restrict the usage of certain roles to specific client scopes

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_client_scope_rolemappings.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows you to add or remove Keycloak roles from client scopes using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.

  • +
  • Attributes are multi-valued in the Keycloak API. All attributes are lists of individual values and are returned that way by this module. You may pass single values for attributes when calling the module, and this is translated into a list suitable for the API.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

client_id

+ +

+ string +

+
+

If the role_names are client roles, the client ID under which it resides.

+

If this parameter is absent, the roles are considered realm roles.

+
+
+

client_scope_id

+ +

+ string + / required +

+
+

Roles provided in role_names will be added to this client scope.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

realm

+ +

+ string +

+
+

The Keycloak realm under which clients resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

role_names

+ +

+ list + / elements=string + / required +

+
+

Names of roles to add.

+

If client_id is present, all roles must be under this client.

+

If client_id is absent, all roles must be under the realm.

+
+
+

state

+ +

+ string +

+
+

State of the role mapping.

+

On present, all roles in role_names are mapped if not exist yet.

+

On absent, all roles mapping in role_names are removed if they exist.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: full

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Add roles to client scope
+  middleware_automation.keycloak.keycloak_client_scope_rolemappings:
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    realm: MyCustomRealm
+    client_id: frontend-client-public
+    client_scope_id: frontend-client-scope
+    role_names:
+      - backend-role-admin
+      - backend-role-user
+
+- name: Remove roles from client scope
+  middleware_automation.keycloak.keycloak_client_scope_rolemappings:
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    realm: MyCustomRealm
+    client_id: frontend-client-public
+    client_scope_id: frontend-client-scope
+    role_names:
+      - backend-role-admin
+    state: absent
+
+- name: Add realm roles to client scope
+  middleware_automation.keycloak.keycloak_client_scope_rolemappings:
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    realm: MyCustomRealm
+    client_scope_id: frontend-client-scope
+    role_names:
+      - realm-role-admin
+      - realm-role-user
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ list + / elements=dictionary +

+
+

Representation of client scope scope mappings after module execution.

+

Returned: on success

+

Sample: [{"clientRole": false, "composite": false, "containerId": "77f9bd4e-13a6-451e-9c72-ee6997299c1f", "description": "User role", "id": "9e155ef7-86f5-4def-b507-581ce7b87013", "name": "realm-role-user"}, {"clientRole": false, "composite": false, "containerId": "77f9bd4e-13a6-451e-9c72-ee6997299c1f", "description": "Admin role", "id": "9e155ef7-86f5-4def-b507-581ce7b87013", "name": "realm-role-admin"}]

+
+

Authors

+
    +
  • Felix Grzelka (@felix-grzelka)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_client_scope_type.html b/3.1.2/plugins/keycloak_client_scope_type.html new file mode 100644 index 0000000..d09b430 --- /dev/null +++ b/3.1.2/plugins/keycloak_client_scope_type.html @@ -0,0 +1,598 @@ + + + + + + + + + + keycloak_client_scope_type – Set the type of a client scope in a realm or client using the Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • + View page source +
  • +
+
+
+
+
+ +
+

keycloak_client_scope_type – Set the type of a client scope in a realm or client using the Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_client_scope_type.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows you to set the type (optional, default) of client scopes using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+
+

client_id

+ +

aliases: clientId

+

+ string +

+
+

The client_id of the client. If not set the client scope types are set as a default for the realm.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

default_client_scopes

+ +

+ list + / elements=string +

+
+

Client scopes that should be of type default.

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

optional_client_scopes

+ +

+ list + / elements=string +

+
+

Client scopes that should be of type optional.

+
+
+

realm

+ +

+ string +

+
+

The Keycloak realm.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: full

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Set default client scopes on realm level
+  middleware_automation.keycloak.keycloak_client_scope_type:
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    realm: "MyCustomRealm"
+    default_client_scopes: ['profile', 'roles']
+  delegate_to: localhost
+
+
+- name: Set default and optional client scopes on client level with token auth
+  middleware_automation.keycloak.keycloak_client_scope_type:
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    token: TOKEN
+    realm: "MyCustomRealm"
+    client_id: "MyCustomClient"
+    default_client_scopes: ['profile', 'roles']
+    optional_client_scopes: ['phone']
+  delegate_to: localhost
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of client scopes after module execution.

+

The sample is truncated.

+

Returned: on success

+

Sample: {"default_client_scopes": ["profile", "role"], "optional_client_scopes": []}

+
+
+

existing

+ +

+ dictionary +

+
+

Representation of client scopes before module execution.

+

Returned: always

+

Sample: {"default_client_scopes": ["profile", "role"], "optional_client_scopes": ["phone"]}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: ""

+
+
+

proposed

+ +

+ dictionary +

+
+

Representation of proposed client scope types mapping.

+

Returned: always

+

Sample: {"default_client_scopes": ["profile", "role"], "optional_client_scopes": []}

+
+

Authors

+
    +
  • Simon Pahl (@simonpahl)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_clientsecret_info.html b/3.1.2/plugins/keycloak_clientsecret_info.html new file mode 100644 index 0000000..245c7c6 --- /dev/null +++ b/3.1.2/plugins/keycloak_clientsecret_info.html @@ -0,0 +1,606 @@ + + + + + + + + + + keycloak_clientsecret_info – Retrieve client secret using Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

keycloak_clientsecret_info – Retrieve client secret using Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_clientsecret_info.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows you to get a Keycloak client secret using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.

  • +
  • When retrieving a new client secret, where possible provide the client’s id (not client_id) to the module. This removes a lookup to the API to translate the client_id into the client ID.

  • +
  • Note that this module returns the client secret. To avoid this showing up in the logs, please add no_log: true to the task.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+
+

client_id

+ +

aliases: clientId

+

+ string +

+
+

The client_id of the client. Passing this instead of id results in an extra API call.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

id

+ +

+ string +

+
+

The unique identifier for this client.

+

This parameter is not required for getting or generating a client secret but providing it reduces the number of API calls required.

+
+
+

realm

+ +

+ string +

+
+

They Keycloak realm under which this client resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

This action does not modify state.

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: N/A

+

This action does not modify state.

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Get a Keycloak client secret, authentication with credentials
+  middleware_automation.keycloak.keycloak_clientsecret_info:
+    id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd'
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+  delegate_to: localhost
+  no_log: true
+
+- name: Get a new Keycloak client secret, authentication with token
+  middleware_automation.keycloak.keycloak_clientsecret_info:
+    id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd'
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    token: TOKEN
+  delegate_to: localhost
+  no_log: true
+
+- name: Get a new Keycloak client secret, passing client_id instead of id
+  middleware_automation.keycloak.keycloak_clientsecret_info:
+    client_id: 'myClientId'
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    token: TOKEN
+  delegate_to: localhost
+  no_log: true
+
+- name: Get a new Keycloak client secret, authentication with auth_client_id and auth_client_secret
+  middleware_automation.keycloak.keycloak_clientsecret_info:
+    id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd'
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_client_secret: SECRET
+    auth_keycloak_url: https://auth.example.com
+  delegate_to: localhost
+  no_log: true
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

clientsecret_info

+ +

+ complex +

+
+

Representation of the client secret.

+

Returned: on success

+
+
+

type

+ +

+ string +

+
+

Credential type.

+

Returned: always

+

Sample: "secret"

+
+
+

value

+ +

+ string +

+
+

Client secret.

+

Returned: always

+

Sample: "cUGnX1EIeTtPPAkcyGMv0ncyqDPu68P1"

+
+
+

msg

+ +

+ string +

+
+

Textual description of whether we succeeded or failed.

+

Returned: always

+
+

Authors

+
    +
  • Fynn Chen (@fynncfchen)

  • +
  • John Cant (@johncant)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_clientsecret_regenerate.html b/3.1.2/plugins/keycloak_clientsecret_regenerate.html new file mode 100644 index 0000000..4d8600a --- /dev/null +++ b/3.1.2/plugins/keycloak_clientsecret_regenerate.html @@ -0,0 +1,604 @@ + + + + + + + + + + keycloak_clientsecret_regenerate – Regenerate Keycloak client secret using Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

keycloak_clientsecret_regenerate – Regenerate Keycloak client secret using Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_clientsecret_regenerate.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows you to regenerate a Keycloak client secret using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.

  • +
  • When regenerating a client secret, where possible provide the client’s ID (not client_id) to the module. This removes a lookup to the API to translate the client_id into the client ID.

  • +
  • Note that this module returns the client secret. To avoid this showing up in the logs, please add no_log: true to the task.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+
+

client_id

+ +

aliases: clientId

+

+ string +

+
+

The client_id of the client. Passing this instead of ID results in an extra API call.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

id

+ +

+ string +

+
+

The unique identifier for this client.

+

This parameter is not required for getting or generating a client secret but providing it reduces the number of API calls required.

+
+
+

realm

+ +

+ string +

+
+

They Keycloak realm under which this client resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: none

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Regenerate a Keycloak client secret, authentication with credentials
+  middleware_automation.keycloak.keycloak_clientsecret_regenerate:
+    id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd'
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+  delegate_to: localhost
+  no_log: true
+
+- name: Regenerate a Keycloak client secret, authentication with token
+  middleware_automation.keycloak.keycloak_clientsecret_regenerate:
+    id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd'
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    token: TOKEN
+  delegate_to: localhost
+  no_log: true
+
+- name: Regenerate a Keycloak client secret, passing client_id instead of id
+  middleware_automation.keycloak.keycloak_clientsecret_info:
+    client_id: 'myClientId'
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    token: TOKEN
+  delegate_to: localhost
+  no_log: true
+
+- name: Regenerate a new Keycloak client secret, authentication with auth_client_id and auth_client_secret
+  middleware_automation.keycloak.keycloak_clientsecret_regenerate:
+    id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd'
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_client_secret: SECRET
+    auth_keycloak_url: https://auth.example.com
+  delegate_to: localhost
+  no_log: true
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ complex +

+
+

Representation of the client credential after module execution.

+

Returned: on success

+
+
+

type

+ +

+ string +

+
+

Credential type.

+

Returned: always

+

Sample: "secret"

+
+
+

value

+ +

+ string +

+
+

Client secret.

+

Returned: always

+

Sample: "cUGnX1EIeTtPPAkcyGMv0ncyqDPu68P1"

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+
+

Authors

+
    +
  • Fynn Chen (@fynncfchen)

  • +
  • John Cant (@johncant)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_clienttemplate.html b/3.1.2/plugins/keycloak_clienttemplate.html new file mode 100644 index 0000000..d84a448 --- /dev/null +++ b/3.1.2/plugins/keycloak_clienttemplate.html @@ -0,0 +1,858 @@ + + + + + + + + + + keycloak_clienttemplate – Allows administration of Keycloak client templates using Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

keycloak_clienttemplate – Allows administration of Keycloak client templates using Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_clienttemplate.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows the administration of Keycloak client templates using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.

  • +
  • The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at https://www.keycloak.org/docs-api/latest/rest-api/index.html.

  • +
  • The Keycloak API does not always enforce for only sensible settings to be used -- you can set SAML-specific settings on an OpenID Connect client for instance and the other way around. Be careful. If you do not specify a setting, usually a sensible default is chosen.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

attributes

+ +

+ dictionary +

+
+

A dict of further attributes for this client template. This can contain various configuration settings, though in the default installation of Keycloak as of 3.4, none are documented or known, so this is usually empty.

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

description

+ +

+ string +

+
+

Description of the client template in Keycloak.

+
+
+

full_scope_allowed

+ +

+ boolean +

+
+

Is the "Full Scope Allowed" feature set for this client template or not. This is fullScopeAllowed in the Keycloak REST API.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

id

+ +

+ string +

+
+

ID of client template to be worked on. This is usually a UUID.

+
+
+

name

+ +

+ string +

+
+

Name of the client template.

+
+
+

protocol

+ +

+ string +

+
+

Type of client template.

+

The docker-v2 value was added in middleware_automation.keycloak 8.6.0.

+

Choices:

+
    +
  • "openid-connect"

  • +
  • "saml"

  • +
  • "docker-v2"

  • +
+ +
+
+

protocol_mappers

+ +

+ list + / elements=dictionary +

+
+

A list of dicts defining protocol mappers for this client template. This is protocolMappers in the Keycloak REST API.

+
+
+

config

+ +

+ dictionary +

+
+

Dict specifying the configuration options for the protocol mapper; the contents differ depending on the value of protocol_mappers[].protocolMapper and are not documented other than by the source of the mappers and its parent class(es). An example is given below. It is easiest to obtain valid config values by dumping an already-existing protocol mapper configuration through check-mode in the existing field.

+
+
+

consentRequired

+ +

+ boolean +

+
+

Specifies whether a user needs to provide consent to a client for this mapper to be active.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

consentText

+ +

+ string +

+
+

The human-readable name of the consent the user is presented to accept.

+
+
+

id

+ +

+ string +

+
+

Usually a UUID specifying the internal ID of this protocol mapper instance.

+
+
+

name

+ +

+ string +

+
+

The name of this protocol mapper.

+
+
+

protocol

+ +

+ string +

+
+

This specifies for which protocol this protocol mapper is active.

+

Choices:

+
    +
  • "openid-connect"

  • +
  • "saml"

  • +
  • "docker-v2"

  • +
+ +
+
+

protocolMapper

+ +

+ string +

+
+

The Keycloak-internal name of the type of this protocol-mapper. While an exhaustive list is impossible to provide since this may be extended through SPIs by the user of Keycloak, by default Keycloak as of 3.4 ships with at least:

+

docker-v2-allow-all-mapper.

+

oidc-address-mapper.

+

oidc-full-name-mapper.

+

oidc-group-membership-mapper.

+

oidc-hardcoded-claim-mapper.

+

oidc-hardcoded-role-mapper.

+

oidc-role-name-mapper.

+

oidc-script-based-protocol-mapper.

+

oidc-sha256-pairwise-sub-mapper.

+

oidc-usermodel-attribute-mapper.

+

oidc-usermodel-client-role-mapper.

+

oidc-usermodel-property-mapper.

+

oidc-usermodel-realm-role-mapper.

+

oidc-usersessionmodel-note-mapper.

+

saml-group-membership-mapper.

+

saml-hardcode-attribute-mapper.

+

saml-hardcode-role-mapper.

+

saml-role-list-mapper.

+

saml-role-name-mapper.

+

saml-user-attribute-mapper.

+

saml-user-property-mapper.

+

saml-user-session-note-mapper.

+

An exhaustive list of available mappers on your installation can be obtained on the admin console by going to Server Info -> Providers and looking under 'protocol-mapper'.

+
+
+

realm

+ +

+ string +

+
+

Realm this client template is found in.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

State of the client template.

+

On present, the client template is created (or updated if it exists already).

+

On absent, the client template is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: full

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Notes

+
+

Note

+
    +
  • The Keycloak REST API defines further fields (namely bearerOnly, consentRequired, standardFlowEnabled, implicitFlowEnabled, directAccessGrantsEnabled, serviceAccountsEnabled, publicClient, and frontchannelLogout) which, while available with keycloak_client, do not have any effect on Keycloak client-templates and are discarded if supplied with an API request changing client-templates. As such, they are not available through this module.

  • +
+
+
+
+

Examples

+
- name: Create or update Keycloak client template (minimal), authentication with credentials
+  middleware_automation.keycloak.keycloak_client:
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    realm: master
+    name: this_is_a_test
+  delegate_to: localhost
+
+- name: Create or update Keycloak client template (minimal), authentication with token
+  middleware_automation.keycloak.keycloak_clienttemplate:
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    token: TOKEN
+    realm: master
+    name: this_is_a_test
+  delegate_to: localhost
+
+- name: Delete Keycloak client template
+  middleware_automation.keycloak.keycloak_client:
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    realm: master
+    state: absent
+    name: test01
+  delegate_to: localhost
+
+- name: Create or update Keycloak client template (with a protocol mapper)
+  middleware_automation.keycloak.keycloak_client:
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    realm: master
+    name: this_is_a_test
+    protocol_mappers:
+      - config:
+          access.token.claim: true
+          claim.name: "family_name"
+          id.token.claim: true
+          jsonType.label: String
+          user.attribute: lastName
+          userinfo.token.claim: true
+        consentRequired: true
+        consentText: "${familyName}"
+        name: family name
+        protocol: openid-connect
+        protocolMapper: oidc-usermodel-property-mapper
+    full_scope_allowed: false
+    id: bce6f5e9-d7d3-4955-817e-c5b7f8d65b3f
+  delegate_to: localhost
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of client template after module execution (sample is truncated).

+

Returned: on success

+

Sample: {"description": "test01", "fullScopeAllowed": false, "id": "9c3712ab-decd-481e-954f-76da7b006e5f", "name": "test01", "protocol": "saml"}

+
+
+

existing

+ +

+ dictionary +

+
+

Representation of existing client template (sample is truncated).

+

Returned: always

+

Sample: {"description": "test01", "fullScopeAllowed": false, "id": "9c3712ab-decd-481e-954f-76da7b006e5f", "name": "test01", "protocol": "saml"}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: "Client template testclient has been updated"

+
+
+

proposed

+ +

+ dictionary +

+
+

Representation of proposed client template.

+

Returned: always

+

Sample: {"name": "test01"}

+
+

Authors

+
    +
  • Eike Frost (@eikef)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_component.html b/3.1.2/plugins/keycloak_component.html new file mode 100644 index 0000000..d9825cb --- /dev/null +++ b/3.1.2/plugins/keycloak_component.html @@ -0,0 +1,669 @@ + + + + + + + + + + keycloak_component – Allows administration of Keycloak components using Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

keycloak_component – Allows administration of Keycloak components using Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_component.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows the administration of Keycloak components using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the realm being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate realm definition with the scope tailored to your needs and a user having the expected roles.

  • +
  • The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at https://www.keycloak.org/docs-api/latest/rest-api/index.html. Aliases are provided so camelCased versions can be used as well.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

config

+ +

+ dictionary +

+
+

Configuration properties for the provider.

+

Contents vary depending on the provider type.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

name

+ +

+ string + / required +

+
+

Name of the component to create.

+
+
+

parent_id

+ +

+ string + / required +

+
+

The parent_id of the component. In practice the ID (name) of the realm.

+
+
+

provider_id

+ +

+ string + / required +

+
+

The name of the "provider ID" for the key.

+
+
+

provider_type

+ +

+ string + / required +

+
+

The name of the "provider type" for the key. That is, org.keycloak.storage.UserStorageProvider, org.keycloak.userprofile.UserProfileProvider, ...

+

See https://www.keycloak.org/docs/latest/server_development/index.html#_providers.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

State of the Keycloak component.

+

On present, the component is created (or updated if it exists already).

+

On absent, the component is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: full

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Manage Keycloak User Storage Provider
+  middleware_automation.keycloak.keycloak_component:
+    auth_keycloak_url: http://localhost:8080
+    auth_username: keycloak
+    auth_password: keycloak
+    auth_realm: master
+    name: my storage provider
+    state: present
+    parent_id: some_realm
+    provider_id: my storage
+    provider_type: "org.keycloak.storage.UserStorageProvider"
+    config:
+      myCustomKey: "my_custom_key"
+      cachePolicy: "NO_CACHE"
+      enabled: true
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of the keycloak_component after module execution.

+

Returned: on success

+
+
+

config

+ +

+ dictionary +

+
+

Component configuration.

+

Returned: success

+
+
+

id

+ +

+ string +

+
+

ID of the component.

+

Returned: when state=present

+

Sample: "5b7ec13f-99da-46ad-8326-ab4c73cf4ce4"

+
+
+

name

+ +

+ string +

+
+

Name of the component.

+

Returned: when state=present

+

Sample: "mykey"

+
+
+

parentId

+ +

+ string +

+
+

ID of the realm this key belongs to.

+

Returned: when state=present

+

Sample: "myrealm"

+
+
+

providerId

+ +

+ string +

+
+

The ID of the key provider.

+

Returned: when state=present

+

Sample: "rsa"

+
+
+

providerType

+ +

+ string +

+
+

The type of provider.

+

Returned: when state=present

+
+

Authors

+
    +
  • Björn Bösel (@fivetide)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_component_info.html b/3.1.2/plugins/keycloak_component_info.html new file mode 100644 index 0000000..5ab632f --- /dev/null +++ b/3.1.2/plugins/keycloak_component_info.html @@ -0,0 +1,566 @@ + + + + + + + + + + keycloak_component_info – Retrieve component info in Keycloak — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

keycloak_component_info – Retrieve component info in Keycloak

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_component_info.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module retrieve information on component from Keycloak.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

name

+ +

+ string +

+
+

Name of the Component.

+
+
+

parent_id

+ +

+ string +

+
+

Container ID of the components.

+
+
+

provider_type

+ +

+ string +

+
+

Provider type of components.

+

Examples: org.keycloak.storage.UserStorageProvider, org.keycloak.services.clientregistration.policy.ClientRegistrationPolicy, org.keycloak.keys.KeyProvider, org.keycloak.userprofile.UserProfileProvider, org.keycloak.storage.ldap.mappers.LDAPStorageMapper.

+
+
+

realm

+ +

+ string + / required +

+
+

The name of the realm.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

This action does not modify state.

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: N/A

+

This action does not modify state.

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Retrive info of a UserStorageProvider named myldap
+  middleware_automation.keycloak.keycloak_component_info:
+    auth_keycloak_url: http://localhost:8080
+    auth_username: admin
+    auth_password: password
+    auth_realm: master
+    realm: myrealm
+    name: myldap
+    provider_type: org.keycloak.storage.UserStorageProvider
+
+- name: Retrive key info component
+  middleware_automation.keycloak.keycloak_component_info:
+    auth_keycloak_url: http://localhost:8080
+    auth_username: admin
+    auth_password: password
+    auth_realm: master
+    realm: myrealm
+    name: rsa-enc-generated
+    provider_type: org.keycloak.keys.KeyProvider
+
+- name: Retrive all component from realm master
+  middleware_automation.keycloak.keycloak_component_info:
+    auth_keycloak_url: http://localhost:8080
+    auth_username: admin
+    auth_password: password
+    auth_realm: master
+    realm: myrealm
+
+- name: Retrive all sub components of parent component filter by type
+  middleware_automation.keycloak.keycloak_component_info:
+    auth_keycloak_url: http://localhost:8080
+    auth_username: admin
+    auth_password: password
+    auth_realm: master
+    realm: myrealm
+    parent_id: "075ef2fa-19fc-4a6d-bf4c-249f57365fd2"
+    provider_type: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + +

Key

Description

+
+

components

+ +

+ list + / elements=dictionary +

+
+

JSON representation of components.

+

Returned: always

+
+

Authors

+
    +
  • Andre Desrosiers (@desand01)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_group.html b/3.1.2/plugins/keycloak_group.html new file mode 100644 index 0000000..a4a12a3 --- /dev/null +++ b/3.1.2/plugins/keycloak_group.html @@ -0,0 +1,911 @@ + + + + + + + + + + keycloak_group – Allows administration of Keycloak groups using Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

keycloak_group – Allows administration of Keycloak groups using Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_group.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows you to add, remove or modify Keycloak groups using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.

  • +
  • The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at https://www.keycloak.org/docs-api/20.0.2/rest-api/index.html.

  • +
  • Attributes are multi-valued in the Keycloak API. All attributes are lists of individual values and are returned that way by this module. You may pass single values for attributes when calling the module, and this is translated into a list suitable for the API.

  • +
  • When updating a group, where possible provide the group ID to the module. This removes a lookup to the API to translate the name into the group ID.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

attributes

+ +

+ dictionary +

+
+

A dict of key/value pairs to set as custom attributes for the group.

+

Values may be single values (for example a string) or a list of strings.

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

description

+ +

+ string +

+
+

Description of the group.

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

id

+ +

+ string +

+
+

The unique identifier for this group.

+

This parameter is not required for updating or deleting a group but providing it reduces the number of API calls required.

+
+
+

name

+ +

+ string +

+
+

Name of the group.

+

This parameter is required only when creating or updating the group.

+
+
+

parents

+ +

+ list + / elements=dictionary +

+
+

List of parent groups for the group to handle sorted top to bottom.

+

Set this to create a group as a subgroup of another group or groups (parents) or when accessing an existing subgroup by name.

+

Not necessary to set when accessing an existing subgroup by its ID because in that case the group can be directly queried without necessarily knowing its parent(s).

+
+
+

id

+ +

+ string +

+
+

Identify parent by ID.

+

Needs less API calls than using parents[].name.

+

A deep parent chain can be started at any point when first given parent is given as ID.

+

Note that in principle both ID and name can be specified at the same time but current implementation only always use just one of them, with ID being preferred.

+
+
+

name

+ +

+ string +

+
+

Identify parent by name.

+

Needs more internal API calls than using parents[].id to map names to ID's under the hood.

+

When giving a parent chain with only names it must be complete up to the top.

+

Note that in principle both ID and name can be specified at the same time but current implementation only always use just one of them, with ID being preferred.

+
+
+

realm

+ +

+ string +

+
+

They Keycloak realm under which this group resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

State of the group.

+

On present, the group is created if it does not yet exist, or updated with the parameters you provide.

+

On absent, the group is removed if it exists. Be aware that absenting a group with subgroups automatically deletes all its subgroups too.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: full

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Notes

+
+

Note

+
    +
  • Presently, the end_state.realmRoles, end_state.clientRoles, and end_state.access attributes returned by the Keycloak API are read-only for groups. This limitation will be removed in a later version of this module.

  • +
+
+
+
+

Examples

+
- name: Create a Keycloak group, authentication with credentials
+  middleware_automation.keycloak.keycloak_group:
+    name: my-new-kc-group
+    realm: MyCustomRealm
+    state: present
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+  register: result_new_kcgrp
+  delegate_to: localhost
+
+- name: Create a Keycloak group, authentication with token
+  middleware_automation.keycloak.keycloak_group:
+    name: my-new-kc-group
+    realm: MyCustomRealm
+    state: present
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    token: TOKEN
+  delegate_to: localhost
+
+- name: Delete a keycloak group
+  middleware_automation.keycloak.keycloak_group:
+    id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd'
+    state: absent
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+  delegate_to: localhost
+
+- name: Delete a Keycloak group based on name
+  middleware_automation.keycloak.keycloak_group:
+    name: my-group-for-deletion
+    state: absent
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+  delegate_to: localhost
+
+- name: Update the name of a Keycloak group
+  middleware_automation.keycloak.keycloak_group:
+    id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd'
+    name: an-updated-kc-group-name
+    state: present
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+  delegate_to: localhost
+
+- name: Create a keycloak group with some custom attributes
+  middleware_automation.keycloak.keycloak_group:
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    name: my-new_group
+    attributes:
+      attrib1: value1
+      attrib2: value2
+      attrib3:
+        - with
+        - numerous
+        - individual
+        - list
+        - items
+  delegate_to: localhost
+
+- name: Create a Keycloak subgroup of a base group (using parent name)
+  middleware_automation.keycloak.keycloak_group:
+    name: my-new-kc-group-sub
+    realm: MyCustomRealm
+    state: present
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    parents:
+      - name: my-new-kc-group
+  register: result_new_kcgrp_sub
+  delegate_to: localhost
+
+- name: Create a Keycloak subgroup of a base group (using parent id)
+  middleware_automation.keycloak.keycloak_group:
+    name: my-new-kc-group-sub2
+    realm: MyCustomRealm
+    state: present
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    parents:
+      - id: "{{ result_new_kcgrp.end_state.id }}"
+  delegate_to: localhost
+
+- name: Create a Keycloak subgroup of a subgroup (using parent names)
+  middleware_automation.keycloak.keycloak_group:
+    name: my-new-kc-group-sub-sub
+    realm: MyCustomRealm
+    state: present
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    parents:
+      - name: my-new-kc-group
+      - name: my-new-kc-group-sub
+  delegate_to: localhost
+
+- name: Create a Keycloak subgroup of a subgroup (using direct parent id)
+  middleware_automation.keycloak.keycloak_group:
+    name: my-new-kc-group-sub-sub
+    realm: MyCustomRealm
+    state: present
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    parents:
+      - id: "{{ result_new_kcgrp_sub.end_state.id }}"
+  delegate_to: localhost
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ complex +

+
+

Representation of the group after module execution (sample is truncated).

+

Returned: on success

+
+
+

access

+ +

+ dictionary +

+
+

A dict describing the accesses you have to this group based on the credentials used.

+

Returned: always

+

Sample: {"manage": true, "manageMembership": true, "view": true}

+
+
+

attributes

+ +

+ dictionary +

+
+

Attributes applied to this group.

+

Returned: always

+

Sample: {"attr1": ["val1", "val2", "val3"]}

+
+
+

clientRoles

+ +

+ list + / elements=string +

+
+

A list of client-level roles granted to this group.

+

Returned: always

+

Sample: []

+
+
+

description

+ +

+ string +

+
+

A description of the group as string.

+

Returned: when present

+

Sample: "An example group description"

+
+
+

id

+ +

+ string +

+
+

GUID that identifies the group.

+

Returned: always

+

Sample: "23f38145-3195-462c-97e7-97041ccea73e"

+
+
+

name

+ +

+ string +

+
+

Name of the group.

+

Returned: always

+

Sample: "grp-test-123"

+
+
+

path

+ +

+ string +

+
+

URI path to the group.

+

Returned: always

+

Sample: "/grp-test-123"

+
+
+

realmRoles

+ +

+ list + / elements=string +

+
+

An array of the realm-level roles granted to this group.

+

Returned: always

+

Sample: []

+
+
+

subGroups

+ +

+ list + / elements=string +

+
+

A list of groups that are children of this group. These groups have the same parameters as documented here.

+

Returned: always

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+
+

Authors

+
    +
  • Adam Goossens (@adamgoossens)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_identity_provider.html b/3.1.2/plugins/keycloak_identity_provider.html new file mode 100644 index 0000000..8e15892 --- /dev/null +++ b/3.1.2/plugins/keycloak_identity_provider.html @@ -0,0 +1,1305 @@ + + + + + + + + + + keycloak_identity_provider – Allows administration of Keycloak identity providers using Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • + View page source +
  • +
+
+
+
+
+ +
+

keycloak_identity_provider – Allows administration of Keycloak identity providers using Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_identity_provider.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows you to add, remove or modify Keycloak identity providers using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.

  • +
  • The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at https://www.keycloak.org/docs-api/15.0/rest-api/index.html.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+
+

add_read_token_role_on_create

+ +

aliases: addReadTokenRoleOnCreate

+

+ boolean +

+
+

Enable/disable whether new users can read any stored tokens. This assigns the broker.read-token role.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

alias

+ +

+ string + / required +

+
+

The alias uniquely identifies an identity provider and it is also used to build the redirect URI.

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+
+

authenticate_by_default

+ +

aliases: authenticateByDefault

+

+ boolean +

+
+

Specifies if this identity provider should be used by default for authentication even before displaying login screen.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

config

+ +

+ dictionary +

+
+

Dict specifying the configuration options for the provider; the contents differ depending on the value of provider_id. Examples are given below for oidc and saml. It is easiest to obtain valid config values by dumping an already-existing identity provider configuration through check-mode in the existing field.

+
+
+

authorizationUrl

+ +

+ string +

+
+

The Authorization URL.

+
+
+

backchannelSupported

+ +

+ string +

+
+

Does the external IDP support backchannel logout?

+
+
+

clientAuthMethod

+ +

+ string +

+
+

The client authentication method.

+
+
+

clientId

+ +

+ string +

+
+

The client or client identifier registered within the identity provider.

+
+
+

clientSecret

+ +

+ string +

+
+

The client or client secret registered within the identity provider.

+
+
+

defaultScope

+ +

+ string +

+
+

The scopes to be sent when asking for authorization.

+
+
+

doNotStoreUsers

+ +

+ boolean +

+
+

If true, users authenticating through this identity provider will not be stored in the Keycloak database.

+

This requires the transient-users feature to be enabled on the Keycloak server (available since Keycloak 23).

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

entityId

+ +

+ string +

+
+

The Entity ID that is used to uniquely identify this SAML Service Provider.

+
+
+

fromUrl

+ +

+ string +

+
+

IDP well-known OpenID Connect configuration URL.

+

Support only provider_id=oidc.

+

config.fromUrl is mutually exclusive with config.userInfoUrl, config.authorizationUrl, config.tokenUrl, config.logoutUrl, config.issuer and config.jwksUrl.

+
+
+
+

gui_order

+ +

aliases: guiOrder

+

+ integer +

+
+

Number defining order of the provider in GUI (for example, on Login page).

+
+
+

issuer

+ +

+ string +

+
+

The issuer identifier for the issuer of the response. If not provided, no validation is performed.

+
+
+

jwksUrl

+ +

+ string +

+
+

URL where identity provider keys in JWK format are stored. See JWK specification for more details.

+
+
+

logoutUrl

+ +

+ string +

+
+

End session endpoint to use to logout user from external IDP.

+
+
+

nameIDPolicyFormat

+ +

+ string +

+
+

Specifies the URI reference corresponding to a name identifier format.

+
+
+

principalType

+ +

+ string +

+
+

Way to identify and track external users from the assertion.

+
+
+

singleLogoutServiceUrl

+ +

+ string +

+
+

The URL that must be used to send logout requests.

+
+
+

singleSignOnServiceUrl

+ +

+ string +

+
+

The URL that must be used to send authentication requests (SAML AuthnRequest).

+
+
+
+

sync_mode

+ +

aliases: syncMode

+

+ string +

+
+

Default sync mode for all mappers. The sync mode determines when user data is synced using the mappers.

+
+
+

tokenUrl

+ +

+ string +

+
+

The Token URL.

+
+
+

useJwksUrl

+ +

+ boolean +

+
+

If true, identity provider public keys are downloaded from given JWKS URL.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

userInfoUrl

+ +

+ string +

+
+

The User Info URL.

+
+
+

validateSignature

+ +

+ boolean +

+
+

Enable/disable signature validation of external IDP signatures.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+
+

display_name

+ +

aliases: displayName

+

+ string +

+
+

Friendly name for identity provider.

+
+
+

enabled

+ +

+ boolean +

+
+

Enable/disable this identity provider.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

first_broker_login_flow_alias

+ +

aliases: firstBrokerLoginFlowAlias

+

+ string +

+
+

Alias of authentication flow, which is triggered after first login with this identity provider.

+
+
+
+
+

hide_on_login

+ +

aliases: hideOnLogin, hide_on_login_page

+

+ boolean +

+
+

If hidden, login with this provider is possible only if requested explicitly, for example using the kc_idp_hint parameter.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+ +
+

link_only

+ +

aliases: linkOnly

+

+ boolean +

+
+

If true, users cannot log in through this provider. They can only link to this provider. This is useful if you do not want to allow login from the provider, but want to integrate with a provider.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

mappers

+ +

+ list + / elements=dictionary +

+
+

A list of dicts defining mappers associated with this Identity Provider.

+
+
+

config

+ +

+ dictionary +

+
+

Dict specifying the configuration options for the mapper; the contents differ depending on the value of mappers[].identityProviderMapper.

+
+
+

id

+ +

+ string +

+
+

Unique ID of this mapper.

+
+
+

identityProviderAlias

+ +

+ string +

+
+

Alias of the identity provider for this mapper.

+
+
+

identityProviderMapper

+ +

+ string +

+
+

Type of mapper.

+
+
+

name

+ +

+ string +

+
+

Name of the mapper.

+
+
+
+

post_broker_login_flow_alias

+ +

aliases: postBrokerLoginFlowAlias

+

+ string +

+
+

Alias of authentication flow, which is triggered after each login with this identity provider.

+
+
+
+

provider_id

+ +

aliases: providerId

+

+ string +

+
+

Protocol used by this provider (supported values are oidc or saml).

+
+
+

realm

+ +

+ string +

+
+

The Keycloak realm under which this identity provider resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

State of the identity provider.

+

On present, the identity provider is created if it does not yet exist, or updated with the parameters you provide.

+

On absent, the identity provider is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+
+

store_token

+ +

aliases: storeToken

+

+ boolean +

+
+

Enable/disable whether tokens must be stored after authenticating users.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+
+

trust_email

+ +

aliases: trustEmail

+

+ boolean +

+
+

If enabled, email provided by this provider is not verified even if verification is enabled for the realm.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: full

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Create OIDC identity provider, authentication with credentials
+  middleware_automation.keycloak.keycloak_identity_provider:
+    state: present
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: admin
+    auth_password: admin
+    realm: myrealm
+    alias: oidc-idp
+    display_name: OpenID Connect IdP
+    enabled: true
+    provider_id: oidc
+    config:
+      issuer: https://idp.example.com
+      authorizationUrl: https://idp.example.com
+      tokenUrl: https://idp.example.com/token
+      userInfoUrl: https://idp.example.com/userinfo
+      clientAuthMethod: client_secret_post
+      clientId: my-client
+      clientSecret: secret
+      syncMode: FORCE
+    mappers:
+      - name: first_name
+        identityProviderMapper: oidc-user-attribute-idp-mapper
+        config:
+          claim: first_name
+          user.attribute: first_name
+          syncMode: INHERIT
+      - name: last_name
+        identityProviderMapper: oidc-user-attribute-idp-mapper
+        config:
+          claim: last_name
+          user.attribute: last_name
+          syncMode: INHERIT
+
+- name: Create OIDC identity provider, with well-known configuration URL
+  middleware_automation.keycloak.keycloak_identity_provider:
+    state: present
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: admin
+    auth_password: admin
+    realm: myrealm
+    alias: oidc-idp
+    display_name: OpenID Connect IdP
+    enabled: true
+    provider_id: oidc
+    config:
+      fromUrl: https://the-idp.example.com/realms/idprealm/.well-known/openid-configuration
+      clientAuthMethod: client_secret_post
+      clientId: my-client
+      clientSecret: secret
+
+- name: Create SAML identity provider, authentication with credentials
+  middleware_automation.keycloak.keycloak_identity_provider:
+    state: present
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: admin
+    auth_password: admin
+    realm: myrealm
+    alias: saml-idp
+    display_name: SAML IdP
+    enabled: true
+    provider_id: saml
+    config:
+      entityId: https://auth.example.com/realms/myrealm
+      singleSignOnServiceUrl: https://idp.example.com/login
+      wantAuthnRequestsSigned: true
+      wantAssertionsSigned: true
+    mappers:
+      - name: roles
+        identityProviderMapper: saml-user-attribute-idp-mapper
+        config:
+          user.attribute: roles
+          attribute.friendly.name: User Roles
+          attribute.name: roles
+          syncMode: INHERIT
+
+- name: Create OIDC identity provider with transient users (do not store users in database)
+  middleware_automation.keycloak.keycloak_identity_provider:
+    state: present
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: admin
+    auth_password: admin
+    realm: myrealm
+    alias: oidc-idp
+    display_name: OpenID Connect IdP
+    enabled: true
+    provider_id: oidc
+    config:
+      fromUrl: https://the-idp.example.com/realms/idprealm/.well-known/openid-configuration
+      clientAuthMethod: client_secret_post
+      clientId: my-client
+      clientSecret: secret
+      doNotStoreUsers: true
+
+- name: Create OIDC identity provider, authentication with credentials and advanced claim to group
+  middleware_automation.keycloak.keycloak_identity_provider:
+    state: present
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: admin
+    auth_password: admin
+    realm: myrealm
+    alias: oidc-idp
+    display_name: OpenID Connect IdP
+    enabled: true
+    provider_id: oidc
+    config:
+      issuer: https://idp.example.com
+      authorizationUrl: https://idp.example.com
+      tokenUrl: https://idp.example.com/token
+      userInfoUrl: https://idp.example.com/userinfo
+      clientAuthMethod: client_secret_post
+      clientId: my-client
+      clientSecret: secret
+      syncMode: FORCE
+    mappers:
+      - name: group_name
+        identityProviderMapper: oidc-advanced-group-idp-mapper
+        config:
+          claims: '[{"key":"my_key","value":"my_value"}]'
+          group: group_name
+          syncMode: INHERIT
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of identity provider after module execution.

+

Returned: on success

+

Sample: {"addReadTokenRoleOnCreate": false, "alias": "my-idp", "authenticateByDefault": false, "config": {"authorizationUrl": "https://idp.example.com", "clientAuthMethod": "client_secret_post", "clientId": "my-client", "clientSecret": "**********", "issuer": "https://idp.example.com", "tokenUrl": "https://idp.example.com/token", "userInfoUrl": "https://idp.example.com/userinfo"}, "displayName": "OpenID Connect IdP", "enabled": true, "firstBrokerLoginFlowAlias": "first broker login", "internalId": "4d28d7e3-1b80-45bb-8a30-5822bf55aa1c", "linkOnly": false, "providerId": "oidc", "storeToken": false, "trustEmail": false}

+
+
+

existing

+ +

+ dictionary +

+
+

Representation of existing identity provider.

+

Returned: always

+

Sample: {"addReadTokenRoleOnCreate": false, "alias": "my-idp", "authenticateByDefault": false, "config": {"authorizationUrl": "https://old.example.com", "clientAuthMethod": "client_secret_post", "clientId": "my-client", "clientSecret": "**********", "issuer": "https://old.example.com", "syncMode": "FORCE", "tokenUrl": "https://old.example.com/token", "userInfoUrl": "https://old.example.com/userinfo"}, "displayName": "OpenID Connect IdP", "enabled": true, "firstBrokerLoginFlowAlias": "first broker login", "internalId": "4d28d7e3-1b80-45bb-8a30-5822bf55aa1c", "linkOnly": false, "providerId": "oidc", "storeToken": false, "trustEmail": false}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: "Identity provider my-idp has been created"

+
+
+

proposed

+ +

+ dictionary +

+
+

Representation of proposed identity provider.

+

Returned: always

+

Sample: {"config": {"authorizationUrl": "https://idp.example.com", "clientAuthMethod": "client_secret_post", "clientId": "my-client", "clientSecret": "secret", "issuer": "https://idp.example.com", "tokenUrl": "https://idp.example.com/token", "userInfoUrl": "https://idp.example.com/userinfo"}, "displayName": "OpenID Connect IdP", "providerId": "oidc"}

+
+

Authors

+
    +
  • Laurent Paumier (@laurpaum)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_organization.html b/3.1.2/plugins/keycloak_organization.html new file mode 100644 index 0000000..a85144a --- /dev/null +++ b/3.1.2/plugins/keycloak_organization.html @@ -0,0 +1,827 @@ + + + + + + + + + + keycloak_organization – Allows administration of Keycloak organizations using Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

keycloak_organization – Allows administration of Keycloak organizations using Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_organization.

+
+

New in middleware_automation.keycloak 3.1.0

+ +
+

Synopsis

+
    +
  • This module allows you to add, remove or modify Keycloak organizations using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.

  • +
  • The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at https://www.keycloak.org/docs-api/latest/rest-api/index.html.

  • +
  • Attributes are multi-valued in the Keycloak API. All attributes are lists of individual values and are returned that way by this module. You may pass single values for attributes when calling the module, and this is translated into a list suitable for the API.

  • +
  • Organizations are available in Keycloak 26 and later. The realm must have organizations enabled (organizations_enabled=true in the middleware_automation.keycloak.keycloak_realm module) before this module can be used.

  • +
  • When updating an organization, where possible provide the organization ID to the module. This removes a lookup to the API to translate the name into the organization ID.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

alias

+ +

+ string +

+
+

URL-friendly alias for the organization.

+

If not provided during creation, defaults to the organization name if URL-safe.

+

The alias is immutable once set and cannot be changed on update.

+
+
+

attributes

+ +

+ dictionary +

+
+

A dict of key/value pairs to set as custom attributes for the organization.

+

Values may be single values (for example a string) or a list of strings.

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

description

+ +

+ string +

+
+

Description of the organization.

+
+
+

domains

+ +

+ list + / elements=dictionary +

+
+

List of internet domains associated with the organization.

+

A domain name can only belong to one organization within a realm.

+
+
+

name

+ +

+ string + / required +

+
+

The domain name (e.g. example.com).

+
+
+

verified

+ +

+ boolean +

+
+

Whether the domain has been verified.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

enabled

+ +

+ boolean +

+
+

Whether the organization is enabled.

+

Disabled organizations block member authentication.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

id

+ +

+ string +

+
+

The unique identifier for this organization.

+

This parameter is not required for updating or deleting an organization but providing it reduces the number of API calls required.

+
+
+

name

+ +

+ string +

+
+

Name of the organization.

+

This parameter is required when creating a new organization.

+
+
+

realm

+ +

+ string +

+
+

The Keycloak realm under which this organization resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

State of the organization.

+

On present, the organization is created if it does not yet exist, or updated with the parameters you provide.

+

On absent, the organization is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.1.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: full

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Create a Keycloak organization
+  middleware_automation.keycloak.keycloak_organization:
+    name: my-org
+    description: My Organization
+    enabled: true
+    realm: MyRealm
+    state: present
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+  delegate_to: localhost
+
+- name: Create a Keycloak organization with domains
+  middleware_automation.keycloak.keycloak_organization:
+    name: acme-corp
+    description: Acme Corporation
+    enabled: true
+    domains:
+      - name: acme.com
+      - name: acme.org
+        verified: true
+    realm: MyRealm
+    state: present
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+  delegate_to: localhost
+
+- name: Update a Keycloak organization
+  middleware_automation.keycloak.keycloak_organization:
+    name: my-org
+    description: Updated description
+    realm: MyRealm
+    state: present
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+  delegate_to: localhost
+
+- name: Delete a Keycloak organization
+  middleware_automation.keycloak.keycloak_organization:
+    name: my-org
+    state: absent
+    realm: MyRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+  delegate_to: localhost
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ complex +

+
+

Representation of the organization after module execution.

+

Returned: on success

+
+
+

alias

+ +

+ string +

+
+

URL-friendly alias of the organization.

+

Returned: always

+

Sample: "my-org"

+
+
+

attributes

+ +

+ dictionary +

+
+

Attributes applied to this organization.

+

Returned: always

+

Sample: {"attr1": ["val1", "val2"]}

+
+
+

description

+ +

+ string +

+
+

Description of the organization.

+

Returned: always

+

Sample: "My Organization"

+
+
+

domains

+ +

+ list + / elements=string +

+
+

Domains associated with the organization.

+

Returned: always

+

Sample: [{"name": "example.com", "verified": false}]

+
+
+

enabled

+ +

+ boolean +

+
+

Whether the organization is enabled.

+

Returned: always

+

Sample: true

+
+
+

id

+ +

+ string +

+
+

GUID that identifies the organization.

+

Returned: always

+

Sample: "23f38145-3195-462c-97e7-97041ccea73e"

+
+
+

name

+ +

+ string +

+
+

Name of the organization.

+

Returned: always

+

Sample: "my-org"

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+
+

Authors

+
    +
  • Chris Brown (@chribro)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_organization_info.html b/3.1.2/plugins/keycloak_organization_info.html new file mode 100644 index 0000000..4514fca --- /dev/null +++ b/3.1.2/plugins/keycloak_organization_info.html @@ -0,0 +1,550 @@ + + + + + + + + + + keycloak_organization_info – Retrieve organization info in Keycloak — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

keycloak_organization_info – Retrieve organization info in Keycloak

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_organization_info.

+
+

New in middleware_automation.keycloak 3.1.0

+ +
+

Synopsis

+
    +
  • This module retrieves information on organizations from Keycloak.

  • +
  • Organizations are available in Keycloak 26 and later. The realm must have organizations enabled before this module can be used.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

exact

+ +

+ boolean +

+
+

Whether the search should be an exact match.

+

Only relevant when name is provided.

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

name

+ +

+ string +

+
+

Name of the organization to search for.

+

If not provided, all organizations in the realm are returned.

+
+
+

realm

+ +

+ string + / required +

+
+

The name of the realm.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.1.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

This action does not modify state.

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: N/A

+

This action does not modify state.

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Retrieve a specific organization by name
+  middleware_automation.keycloak.keycloak_organization_info:
+    auth_keycloak_url: https://auth.example.com
+    auth_username: admin
+    auth_password: password
+    auth_realm: master
+    realm: MyRealm
+    name: my-org
+
+- name: List all organizations in a realm
+  middleware_automation.keycloak.keycloak_organization_info:
+    auth_keycloak_url: https://auth.example.com
+    auth_username: admin
+    auth_password: password
+    auth_realm: master
+    realm: MyRealm
+
+- name: Search organizations by partial name
+  middleware_automation.keycloak.keycloak_organization_info:
+    auth_keycloak_url: https://auth.example.com
+    auth_username: admin
+    auth_password: password
+    auth_realm: master
+    realm: MyRealm
+    name: acme
+    exact: false
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + +

Key

Description

+
+

organizations

+ +

+ list + / elements=dictionary +

+
+

JSON representation of organizations.

+

Returned: always

+
+

Authors

+
    +
  • Chris Brown (@chribro)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_realm.html b/3.1.2/plugins/keycloak_realm.html new file mode 100644 index 0000000..396d271 --- /dev/null +++ b/3.1.2/plugins/keycloak_realm.html @@ -0,0 +1,2418 @@ + + + + + + + + + + keycloak_realm – Allows administration of Keycloak realm using Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

keycloak_realm – Allows administration of Keycloak realm using Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_realm.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows the administration of Keycloak realm using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the realm being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate realm definition with the scope tailored to your needs and a user having the expected roles.

  • +
  • The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at https://www.keycloak.org/docs-api/latest/rest-api/index.html. Aliases are provided so camelCased versions can be used as well.

  • +
  • The Keycloak API does not always sanity check inputs, for example you can set SAML-specific settings on an OpenID Connect client for instance and also the other way around. Be careful. If you do not specify a setting, usually a sensible default is chosen.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+
+

access_code_lifespan

+ +

aliases: accessCodeLifespan

+

+ integer +

+
+

The realm access code lifespan.

+
+
+
+

access_code_lifespan_login

+ +

aliases: accessCodeLifespanLogin

+

+ integer +

+
+

The realm access code lifespan login.

+
+
+
+

access_code_lifespan_user_action

+ +

aliases: accessCodeLifespanUserAction

+

+ integer +

+
+

The realm access code lifespan user action.

+
+
+
+

access_token_lifespan

+ +

aliases: accessTokenLifespan

+

+ integer +

+
+

The realm access token lifespan.

+
+
+
+

access_token_lifespan_for_implicit_flow

+ +

aliases: accessTokenLifespanForImplicitFlow

+

+ integer +

+
+

The realm access token lifespan for implicit flow.

+
+
+
+

account_theme

+ +

aliases: accountTheme

+

+ string +

+
+

The realm account theme.

+
+
+
+

action_token_generated_by_admin_lifespan

+ +

aliases: actionTokenGeneratedByAdminLifespan

+

+ integer +

+
+

The realm action token generated by admin lifespan.

+
+
+
+

action_token_generated_by_user_lifespan

+ +

aliases: actionTokenGeneratedByUserLifespan

+

+ integer +

+
+

The realm action token generated by user lifespan.

+
+
+
+

admin_events_details_enabled

+ +

aliases: adminEventsDetailsEnabled

+

+ boolean +

+
+

The realm admin events details enabled.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

admin_events_enabled

+ +

aliases: adminEventsEnabled

+

+ boolean +

+
+

The realm admin events enabled.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

admin_permissions_enabled

+ +

aliases: adminPermissionsEnabled

+

+ boolean +

+
+

The realm admin permissions enabled.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

admin_theme

+ +

aliases: adminTheme

+

+ string +

+
+

The realm admin theme.

+
+
+

attributes

+ +

+ dictionary +

+
+

The realm attributes.

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+
+

browser_flow

+ +

aliases: browserFlow

+

+ string +

+
+

The realm browser flow.

+
+
+
+

browser_security_headers

+ +

aliases: browserSecurityHeaders

+

+ dictionary +

+
+

The realm browser security headers.

+
+
+
+

brute_force_protected

+ +

aliases: bruteForceProtected

+

+ boolean +

+
+

The realm brute force protected.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

brute_force_strategy

+ +

aliases: bruteForceStrategy

+

+ string +

+
+

The realm brute force strategy.

+

Choices:

+
    +
  • "LINEAR"

  • +
  • "MULTIPLE"

  • +
+ +
+
+
+

client_authentication_flow

+ +

aliases: clientAuthenticationFlow

+

+ string +

+
+

The realm client authentication flow.

+
+
+
+

client_offline_session_idle_timeout

+ +

aliases: clientOfflineSessionIdleTimeout

+

+ integer +

+
+

All Clients inherit from this setting, time an offline session is allowed to be idle before it expires.

+
+
+
+

client_offline_session_max_lifespan

+ +

aliases: clientOfflineSessionMaxLifespan

+

+ integer +

+
+

All Clients inherit from this setting, max time before an offline session is expired regardless of activity.

+
+
+
+

client_scope_mappings

+ +

aliases: clientScopeMappings

+

+ dictionary +

+
+

The realm client scope mappings.

+
+
+
+

client_session_idle_timeout

+ +

aliases: clientSessionIdleTimeout

+

+ integer +

+
+

All Clients inherit from this setting, time a session is allowed to be idle before it expires.

+
+
+
+

client_session_max_lifespan

+ +

aliases: clientSessionMaxLifespan

+

+ integer +

+
+

All Clients inherit from this setting, max time before a session is expired.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+
+

default_default_client_scopes

+ +

aliases: defaultDefaultClientScopes

+

+ list + / elements=string +

+
+

The realm default default client scopes.

+
+
+
+

default_groups

+ +

aliases: defaultGroups

+

+ list + / elements=string +

+
+

The realm default groups.

+
+
+
+

default_locale

+ +

aliases: defaultLocale

+

+ string +

+
+

The realm default locale.

+
+
+
+

default_optional_client_scopes

+ +

aliases: defaultOptionalClientScopes

+

+ list + / elements=string +

+
+

The realm default optional client scopes.

+
+
+
+

default_roles

+ +

aliases: defaultRoles

+

+ list + / elements=string +

+
+

The realm default roles.

+
+
+
+

default_signature_algorithm

+ +

aliases: defaultSignatureAlgorithm

+

+ string +

+
+

The realm default signature algorithm.

+
+
+
+

direct_grant_flow

+ +

aliases: directGrantFlow

+

+ string +

+
+

The realm direct grant flow.

+
+
+
+

display_name

+ +

aliases: displayName

+

+ string +

+
+

The realm display name.

+
+
+
+

display_name_html

+ +

aliases: displayNameHtml

+

+ string +

+
+

The realm display name HTML.

+
+
+
+

docker_authentication_flow

+ +

aliases: dockerAuthenticationFlow

+

+ string +

+
+

The realm docker authentication flow.

+
+
+
+

duplicate_emails_allowed

+ +

aliases: duplicateEmailsAllowed

+

+ boolean +

+
+

The realm duplicate emails allowed option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

edit_username_allowed

+ +

aliases: editUsernameAllowed

+

+ boolean +

+
+

The realm edit username allowed option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

email_theme

+ +

aliases: emailTheme

+

+ string +

+
+

The realm email theme.

+
+
+

enabled

+ +

+ boolean +

+
+

The realm enabled option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

enabled_event_types

+ +

aliases: enabledEventTypes

+

+ list + / elements=string +

+
+

The realm enabled event types.

+
+
+
+

events_enabled

+ +

aliases: eventsEnabled

+

+ boolean +

+
+

Enables or disables login events for this realm.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

events_expiration

+ +

aliases: eventsExpiration

+

+ integer +

+
+

The realm events expiration.

+
+
+
+

events_listeners

+ +

aliases: eventsListeners

+

+ list + / elements=string +

+
+

The realm events listeners.

+
+
+
+

failure_factor

+ +

aliases: failureFactor

+

+ integer +

+
+

The realm failure factor.

+
+
+
+

first_broker_login_flow

+ +

aliases: firstBrokerLoginFlow

+

+ string +

+
+

The realm first broker login flow.

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

id

+ +

+ string +

+
+

The realm to create.

+
+
+
+

internationalization_enabled

+ +

aliases: internationalizationEnabled

+

+ boolean +

+
+

The realm internationalization enabled option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

localization_texts

+ +

aliases: localizationTexts

+

+ dictionary +

+
+

The custom localization texts for a realm.

+
+
+
+

login_theme

+ +

aliases: loginTheme

+

+ string +

+
+

The realm login theme.

+
+
+
+

login_with_email_allowed

+ +

aliases: loginWithEmailAllowed

+

+ boolean +

+
+

The realm login with email allowed option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

max_delta_time_seconds

+ +

aliases: maxDeltaTimeSeconds

+

+ integer +

+
+

The realm max delta time in seconds.

+
+
+
+

max_failure_wait_seconds

+ +

aliases: maxFailureWaitSeconds

+

+ integer +

+
+

The realm max failure wait in seconds.

+
+
+
+

max_secondary_auth_failures

+ +

aliases: maxSecondaryAuthFailures

+

+ integer +

+
+

The realm max secondary authentication failures (used with brute force detection for secondary auth mechanisms).

+
+
+
+

max_temporary_lockouts

+ +

aliases: maxTemporaryLockouts

+

+ integer +

+
+

The realm max temporary lockouts.

+
+
+
+

minimum_quick_login_wait_seconds

+ +

aliases: minimumQuickLoginWaitSeconds

+

+ integer +

+
+

The realm minimum quick login wait in seconds.

+
+
+
+

not_before

+ +

aliases: notBefore

+

+ integer +

+
+

The realm not before.

+
+
+
+

oauth2_device_code_lifespan

+ +

aliases: oauth2DeviceCodeLifespan

+

+ integer +

+
+

Max time before the device code and user code are expired.

+
+
+
+

oauth2_device_polling_interval

+ +

aliases: oauth2DevicePollingInterval

+

+ integer +

+
+

The minimum amount of time in seconds that the client should wait between polling requests to the token endpoint.

+
+
+
+

offline_session_idle_timeout

+ +

aliases: offlineSessionIdleTimeout

+

+ integer +

+
+

The realm offline session idle timeout.

+
+
+
+

offline_session_max_lifespan

+ +

aliases: offlineSessionMaxLifespan

+

+ integer +

+
+

The realm offline session max lifespan.

+
+
+
+

offline_session_max_lifespan_enabled

+ +

aliases: offlineSessionMaxLifespanEnabled

+

+ boolean +

+
+

The realm offline session max lifespan enabled option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

organizations_enabled

+ +

aliases: organizationsEnabled

+

+ boolean +

+
+

Enables support for experimental organization feature.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

otp_policy_algorithm

+ +

aliases: otpPolicyAlgorithm

+

+ string +

+
+

The realm otp policy algorithm.

+
+
+
+

otp_policy_digits

+ +

aliases: otpPolicyDigits

+

+ integer +

+
+

The realm otp policy digits.

+
+
+
+

otp_policy_initial_counter

+ +

aliases: otpPolicyInitialCounter

+

+ integer +

+
+

The realm otp policy initial counter.

+
+
+
+

otp_policy_look_ahead_window

+ +

aliases: otpPolicyLookAheadWindow

+

+ integer +

+
+

The realm otp policy look ahead window.

+
+
+
+

otp_policy_period

+ +

aliases: otpPolicyPeriod

+

+ integer +

+
+

The realm otp policy period.

+
+
+
+

otp_policy_type

+ +

aliases: otpPolicyType

+

+ string +

+
+

The realm otp policy type.

+
+
+
+

otp_supported_applications

+ +

aliases: otpSupportedApplications

+

+ list + / elements=string +

+
+

The realm otp supported applications.

+
+
+
+

password_policy

+ +

aliases: passwordPolicy

+

+ string +

+
+

The realm password policy.

+
+
+
+

permanent_lockout

+ +

aliases: permanentLockout

+

+ boolean +

+
+

The realm permanent lockout.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

prune_undefined_realm_attributes

+ +

aliases: pruneUndefinedRealmAttributes

+

+ boolean +

+
+

If True all realm attributes which are not defined in the attributes dict will be deleted

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+
+

quick_login_check_milli_seconds

+ +

aliases: quickLoginCheckMilliSeconds

+

+ integer +

+
+

The realm quick login check in milliseconds.

+
+
+

realm

+ +

+ string +

+
+

The realm name.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+
+

refresh_token_max_reuse

+ +

aliases: refreshTokenMaxReuse

+

+ integer +

+
+

The realm refresh token max reuse.

+
+
+
+

registration_allowed

+ +

aliases: registrationAllowed

+

+ boolean +

+
+

The realm registration allowed option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

registration_email_as_username

+ +

aliases: registrationEmailAsUsername

+

+ boolean +

+
+

The realm registration email as username option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

registration_flow

+ +

aliases: registrationFlow

+

+ string +

+
+

The realm registration flow.

+
+
+
+

remember_me

+ +

aliases: rememberMe

+

+ boolean +

+
+

The realm remember me option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

reset_credentials_flow

+ +

aliases: resetCredentialsFlow

+

+ string +

+
+

The realm reset credentials flow.

+
+
+
+

reset_password_allowed

+ +

aliases: resetPasswordAllowed

+

+ boolean +

+
+

The realm reset password allowed option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

revoke_refresh_token

+ +

aliases: revokeRefreshToken

+

+ boolean +

+
+

The realm revoke refresh token option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

smtp_server

+ +

aliases: smtpServer

+

+ dictionary +

+
+

The realm smtp server.

+
+
+
+

ssl_required

+ +

aliases: sslRequired

+

+ string +

+
+

The realm ssl required option.

+

Choices:

+
    +
  • "all"

  • +
  • "external"

  • +
  • "none"

  • +
+ +
+
+
+

sso_session_idle_timeout

+ +

aliases: ssoSessionIdleTimeout

+

+ integer +

+
+

The realm sso session idle timeout.

+
+
+
+

sso_session_idle_timeout_remember_me

+ +

aliases: ssoSessionIdleTimeoutRememberMe

+

+ integer +

+
+

The realm sso session idle timeout remember me.

+
+
+
+

sso_session_max_lifespan

+ +

aliases: ssoSessionMaxLifespan

+

+ integer +

+
+

The realm sso session max lifespan.

+
+
+
+

sso_session_max_lifespan_remember_me

+ +

aliases: ssoSessionMaxLifespanRememberMe

+

+ integer +

+
+

The realm sso session max lifespan remember me.

+
+
+

state

+ +

+ string +

+
+

State of the realm.

+

On present, the realm is created (or updated if it exists already).

+

On absent, the realm is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+
+

supported_locales

+ +

aliases: supportedLocales

+

+ list + / elements=string +

+
+

The realm supported locales.

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+
+

user_managed_access_allowed

+ +

aliases: userManagedAccessAllowed

+

+ boolean +

+
+

The realm user managed access allowed option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+
+

verify_email

+ +

aliases: verifyEmail

+

+ boolean +

+
+

The realm verify email option.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

wait_increment_seconds

+ +

aliases: waitIncrementSeconds

+

+ integer +

+
+

The realm wait increment in seconds.

+
+
+
+

web_authn_policy_acceptable_aaguids

+ +

aliases: webAuthnPolicyAcceptableAaguids

+

+ list + / elements=string +

+
+

List of acceptable AAGUIDs for WebAuthn authenticators.

+
+
+
+

web_authn_policy_attestation_conveyance_preference

+ +

aliases: webAuthnPolicyAttestationConveyancePreference

+

+ string +

+
+

Attestation conveyance preference for WebAuthn.

+
+
+
+

web_authn_policy_authenticator_attachment

+ +

aliases: webAuthnPolicyAuthenticatorAttachment

+

+ string +

+
+

Authenticator attachment preference for WebAuthn authenticators.

+
+
+
+

web_authn_policy_avoid_same_authenticator_register

+ +

aliases: webAuthnPolicyAvoidSameAuthenticatorRegister

+

+ boolean +

+
+

Avoid registering the same authenticator multiple times.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

web_authn_policy_create_timeout

+ +

aliases: webAuthnPolicyCreateTimeout

+

+ integer +

+
+

Timeout for WebAuthn credential creation (ms).

+
+
+
+

web_authn_policy_extra_origins

+ +

aliases: webAuthnPolicyExtraOrigins

+

+ list + / elements=string +

+
+

Additional acceptable origins for WebAuthn requests.

+
+
+
+

web_authn_policy_passwordless_acceptable_aaguids

+ +

aliases: webAuthnPolicyPasswordlessAcceptableAaguids

+

+ list + / elements=string +

+
+

List of acceptable AAGUIDs for WebAuthn passwordless authenticators.

+
+
+
+

web_authn_policy_passwordless_attestation_conveyance_preference

+ +

aliases: webAuthnPolicyPasswordlessAttestationConveyancePreference

+

+ string +

+
+

Attestation conveyance preference for WebAuthn passwordless.

+
+
+
+

web_authn_policy_passwordless_authenticator_attachment

+ +

aliases: webAuthnPolicyPasswordlessAuthenticatorAttachment

+

+ string +

+
+

Authenticator attachment for WebAuthn passwordless.

+
+
+
+

web_authn_policy_passwordless_avoid_same_authenticator_register

+ +

aliases: webAuthnPolicyPasswordlessAvoidSameAuthenticatorRegister

+

+ boolean +

+
+

Avoid registering the same authenticator multiple times for passwordless.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

web_authn_policy_passwordless_create_timeout

+ +

aliases: webAuthnPolicyPasswordlessCreateTimeout

+

+ integer +

+
+

Timeout for WebAuthn passwordless credential creation (ms).

+
+
+
+

web_authn_policy_passwordless_extra_origins

+ +

aliases: webAuthnPolicyPasswordlessExtraOrigins

+

+ list + / elements=string +

+
+

Additional acceptable origins for WebAuthn passwordless requests.

+
+
+
+

web_authn_policy_passwordless_passkeys_enabled

+ +

aliases: webAuthnPolicyPasswordlessPasskeysEnabled

+

+ boolean +

+
+

Enable passkeys (conditional UI) authentication in the username forms.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

web_authn_policy_passwordless_require_resident_key

+ +

aliases: webAuthnPolicyPasswordlessRequireResidentKey

+

+ string +

+
+

Whether resident keys are required for WebAuthn passwordless (Yes/No/not specified).

+
+
+
+

web_authn_policy_passwordless_rp_entity_name

+ +

aliases: webAuthnPolicyPasswordlessRpEntityName

+

+ string +

+
+

WebAuthn Passwordless Relying Party Entity Name.

+
+
+
+

web_authn_policy_passwordless_rp_id

+ +

aliases: webAuthnPolicyPasswordlessRpId

+

+ string +

+
+

WebAuthn Passwordless Relying Party ID (domain).

+
+
+
+

web_authn_policy_passwordless_signature_algorithms

+ +

aliases: webAuthnPolicyPasswordlessSignatureAlgorithms

+

+ list + / elements=string +

+
+

List of acceptable WebAuthn signature algorithms for passwordless.

+
+
+
+

web_authn_policy_passwordless_user_verification_requirement

+ +

aliases: webAuthnPolicyPasswordlessUserVerificationRequirement

+

+ string +

+
+

User verification requirement for WebAuthn passwordless.

+
+
+
+

web_authn_policy_require_resident_key

+ +

aliases: webAuthnPolicyRequireResidentKey

+

+ string +

+
+

Whether resident keys are required for WebAuthn (Yes/No/not specified).

+
+
+
+

web_authn_policy_rp_entity_name

+ +

aliases: webAuthnPolicyRpEntityName

+

+ string +

+
+

WebAuthn Relying Party Entity Name.

+
+
+
+

web_authn_policy_rp_id

+ +

aliases: webAuthnPolicyRpId

+

+ string +

+
+

WebAuthn Relying Party ID (domain). Empty string means use request host.

+
+
+
+

web_authn_policy_signature_algorithms

+ +

aliases: webAuthnPolicySignatureAlgorithms

+

+ list + / elements=string +

+
+

List of acceptable WebAuthn signature algorithms.

+
+
+
+

web_authn_policy_user_verification_requirement

+ +

aliases: webAuthnPolicyUserVerificationRequirement

+

+ string +

+
+

User verification requirement for WebAuthn.

+
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: full

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Create or update Keycloak realm (minimal example)
+  middleware_automation.keycloak.keycloak_realm:
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    realm: unique_realm_name
+    state: present
+
+- name: Delete a Keycloak realm
+  middleware_automation.keycloak.keycloak_realm:
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    realm: unique_realm_name
+    state: absent
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of realm after module execution (sample is truncated).

+

Returned: on success

+

Sample: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}

+
+
+

existing

+ +

+ dictionary +

+
+

Representation of existing realm (sample is truncated).

+

Returned: always

+

Sample: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: "Realm testrealm has been updated"

+
+
+

proposed

+ +

+ dictionary +

+
+

Representation of proposed realm.

+

Returned: always

+

Sample: {"realm": "test"}

+
+

Authors

+
    +
  • Christophe Gilles (@kris2kris)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_realm_info.html b/3.1.2/plugins/keycloak_realm_info.html new file mode 100644 index 0000000..915a74b --- /dev/null +++ b/3.1.2/plugins/keycloak_realm_info.html @@ -0,0 +1,432 @@ + + + + + + + + + + keycloak_realm_info – Allows obtaining Keycloak realm public information using Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

keycloak_realm_info – Allows obtaining Keycloak realm public information using Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_realm_info.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows you to get Keycloak realm public information using the Keycloak REST API.

  • +
  • The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at https://www.keycloak.org/docs-api/latest/rest-api/index.html.

  • +
  • Attributes are multi-valued in the Keycloak API. All attributes are lists of individual values and are returned that way by this module. You may pass single values for attributes when calling the module, and this is translated into a list suitable for the API.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+

realm

+ +

+ string +

+
+

They Keycloak realm ID.

+

Default: "master"

+
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

check_mode

+

Support: full

+

This action does not modify state.

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: N/A

+

This action does not modify state.

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Get a Keycloak public key
+  middleware_automation.keycloak.keycloak_realm_info:
+    realm: MyCustomRealm
+    auth_keycloak_url: https://auth.example.com
+  delegate_to: localhost
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+
+
+

realm_info

+ +

+ dictionary +

+
+

Representation of the realm public information.

+

Returned: always

+
+
+

account-service

+ +

+ string +

+
+

Account console URL.

+

Returned: always

+

Sample: "https://auth.example.com/realms/MyRealm/account"

+
+
+

public_key

+ +

+ string +

+
+

Public key of the realm.

+

Returned: always

+

Sample: "MIIBIjANBgkqhkiG9w0BAQEFAAO..."

+
+
+

realm

+ +

+ string +

+
+

Realm ID.

+

Returned: always

+

Sample: "MyRealm"

+
+
+

token-service

+ +

+ string +

+
+

Token endpoint URL.

+

Returned: always

+

Sample: "https://auth.example.com/realms/MyRealm/protocol/openid-connect"

+
+
+

tokens-not-before

+ +

+ integer +

+
+

The token not before.

+

Returned: always

+

Sample: 0

+
+

Authors

+
    +
  • Fynn Chen (@fynncfchen)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_realm_key.html b/3.1.2/plugins/keycloak_realm_key.html new file mode 100644 index 0000000..ae89361 --- /dev/null +++ b/3.1.2/plugins/keycloak_realm_key.html @@ -0,0 +1,1257 @@ + + + + + + + + + + keycloak_realm_key – Allows administration of Keycloak realm keys using Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

keycloak_realm_key – Allows administration of Keycloak realm keys using Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_realm_key.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows the administration of Keycloak realm keys using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the realm being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate realm definition with the scope tailored to your needs and a user having the expected roles.

  • +
  • The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at https://www.keycloak.org/docs-api/latest/rest-api/index.html. Aliases are provided so camelCased versions can be used as well.

  • +
  • This module is unable to detect changes to the actual cryptographic key after importing it. However, if some other property is changed alongside the cryptographic key, then the key also changes as a side-effect, as the JSON payload needs to include the private key. This can be considered either a bug or a feature, as the alternative would be to always update the realm key whether it has changed or not.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

config

+ +

+ dictionary +

+
+

Dict specifying the key and its properties.

+
+
+

active

+ +

+ boolean +

+
+

Whether they key is active or inactive. Not to be confused with the state of the Ansible resource managed by the state parameter.

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

algorithm

+ +

+ string +

+
+

Key algorithm.

+

The values RS384, RS512, PS256, PS384, PS512, RSA1_5, RSA-OAEP, RSA-OAEP-256 have been added in middleware_automation.keycloak 8.2.0.

+

The values HS256, HS384, HS512 (for HMAC), ES256, ES384, ES512 (for ECDSA), and AES have been added in middleware_automation.keycloak 12.4.0.

+

The values ECDH_ES, ECDH_ES_A128KW, ECDH_ES_A192KW, ECDH_ES_A256KW (for ECDH key exchange), and Ed25519, Ed448 (for EdDSA signing) have been added in middleware_automation.keycloak 12.4.0.

+

For provider_id=rsa, provider_id=rsa-generated, and provider_id=java-keystore, defaults to RS256.

+

For provider_id=rsa-enc and provider_id=rsa-enc-generated, must be one of RSA1_5, RSA-OAEP, RSA-OAEP-256 (required, no default).

+

For provider_id=hmac-generated, must be one of HS256, HS384, HS512 (required, no default).

+

For provider_id=ecdsa-generated, must be one of ES256, ES384, ES512 (required, no default).

+

For provider_id=ecdh-generated, must be one of ECDH_ES, ECDH_ES_A128KW, ECDH_ES_A192KW, ECDH_ES_A256KW (required, no default).

+

For provider_id=eddsa-generated, this option is not used (the algorithm is determined by config.elliptic_curve).

+

For provider_id=aes-generated, this option is not used (AES is always used).

+

Choices:

+
    +
  • "RS256" ← (default)

  • +
  • "RS384"

  • +
  • "RS512"

  • +
  • "PS256"

  • +
  • "PS384"

  • +
  • "PS512"

  • +
  • "RSA1_5"

  • +
  • "RSA-OAEP"

  • +
  • "RSA-OAEP-256"

  • +
  • "HS256"

  • +
  • "HS384"

  • +
  • "HS512"

  • +
  • "ES256"

  • +
  • "ES384"

  • +
  • "ES512"

  • +
  • "AES"

  • +
  • "ECDH_ES"

  • +
  • "ECDH_ES_A128KW"

  • +
  • "ECDH_ES_A192KW"

  • +
  • "ECDH_ES_A256KW"

  • +
  • "Ed25519"

  • +
  • "Ed448"

  • +
+ +
+
+

certificate

+ +

+ string +

+
+

A certificate signed with the private key as an ASCII string. Contents of the key must match config.algorithm and provider_id.

+

If you want Keycloak to automatically generate a certificate using your private key then set this to an empty string.

+

Required when provider_id is rsa or rsa-enc. Not used for auto-generated providers.

+
+
+

elliptic_curve

+ +

+ string +

+
+

The elliptic curve to use for ECDSA, ECDH, or EdDSA keys.

+

For provider_id=ecdsa-generated and provider_id=ecdh-generated, valid values are P-256, P-384, P-521. Default is P-256.

+

For provider_id=eddsa-generated, valid values are Ed25519, Ed448. Default is Ed25519.

+

Choices:

+
    +
  • "P-256"

  • +
  • "P-384"

  • +
  • "P-521"

  • +
  • "Ed25519"

  • +
  • "Ed448"

  • +
+ +
+
+

enabled

+ +

+ boolean +

+
+

Whether the key is enabled or disabled. Not to be confused with the state of the Ansible resource managed by the state parameter.

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

key_alias

+ +

+ string +

+
+

Alias of the key within the keystore.

+

Required when provider_id=java-keystore.

+
+
+

key_password

+ +

+ string +

+
+

Password for the key within the keystore.

+

If not specified, the config.keystore_password is used.

+

Only applicable to provider_id=java-keystore.

+
+
+

key_size

+ +

+ integer +

+
+

The size of the generated key in bits.

+

Only applicable to provider_id=rsa-generated and provider_id=rsa-enc-generated.

+

Valid values are 1024, 2048, 4096. Default is 2048.

+
+
+

keystore

+ +

+ string +

+
+

Path to the Java Keystore file on the Keycloak server filesystem.

+

Required when provider_id=java-keystore.

+
+
+

keystore_password

+ +

+ string +

+
+

Password for the Java Keystore.

+

Required when provider_id=java-keystore.

+
+
+

priority

+ +

+ integer + / required +

+
+

The priority of the key.

+
+
+

private_key

+ +

+ string +

+
+

The private key as an ASCII string. Contents of the key must match config.algorithm and provider_id.

+

Please note that the module cannot detect whether the private key specified differs from the current state's private key. Use force=true to force the module to update the private key if you expect it to be updated.

+

Required when provider_id is rsa or rsa-enc. Not used for auto-generated providers.

+
+
+

secret_size

+ +

+ integer +

+
+

The size of the generated secret key in bytes.

+

Only applicable to provider_id=hmac-generated and provider_id=aes-generated.

+

Valid values are 16, 24, 32, 64, 128, 256, 512.

+

Default is 64 for HMAC, 16 for AES.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

force

+ +

+ boolean +

+
+

Enforce the state of the private key and certificate. This is not automatically the case as this module is unable to determine the current state of the private key and thus cannot trigger an update based on an actual divergence. That said, a private key update may happen even if force is false as a side-effect of other changes.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

name

+ +

+ string + / required +

+
+

Name of the realm key to create.

+
+
+

parent_id

+ +

+ string + / required +

+
+

The parent_id of the realm key. In practice the name of the realm.

+
+
+

provider_id

+ +

+ string +

+
+

The name of the "provider ID" for the key.

+

The value rsa-enc has been added in middleware_automation.keycloak 8.2.0.

+

The value java-keystore has been added in middleware_automation.keycloak 12.4.0. This provider imports keys from a Java Keystore (JKS or PKCS12) file located on the Keycloak server filesystem.

+

The values rsa-generated, hmac-generated, aes-generated, and ecdsa-generated have been added in middleware_automation.keycloak 3.0.0. These are auto-generated key providers where Keycloak manages the key material.

+

The values rsa-enc-generated, ecdh-generated, and eddsa-generated have been added in middleware_automation.keycloak 3.0.0. These correspond to the auto-generated key providers available in Keycloak 26.

+

Choices:

+
    +
  • "rsa" ← (default)

  • +
  • "rsa-enc"

  • +
  • "java-keystore"

  • +
  • "rsa-generated"

  • +
  • "rsa-enc-generated"

  • +
  • "hmac-generated"

  • +
  • "aes-generated"

  • +
  • "ecdsa-generated"

  • +
  • "ecdh-generated"

  • +
  • "eddsa-generated"

  • +
+ +
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

State of the keycloak realm key.

+

On present, the realm key is created (or updated if it exists already).

+

On absent, the realm key is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

update_password

+ +

+ string +

+
+

Controls when passwords are sent to Keycloak for java-keystore provider.

+

always - Always send passwords. Keycloak will update the component even if passwords have not changed. Use when you need to ensure passwords are updated.

+

on_create - Only send passwords when creating a new component. When updating an existing component, send the masked value to preserve existing passwords. This makes the module idempotent for password fields.

+

This is necessary because Keycloak masks passwords in API responses (returns **********), making comparison impossible.

+

Has no effect for providers other than java-keystore.

+

Choices:

+
    +
  • "always" ← (default)

  • +
  • "on_create"

  • +
+ +
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: partial

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Notes

+
+

Note

+
    +
  • Current value of the private key cannot be fetched from Keycloak. Therefore comparing its desired state to the current state is not possible.

  • +
  • If config.certificate is not explicitly provided it is dynamically created by Keycloak. Therefore comparing the current state of the certificate to the desired state (which may be empty) is not possible.

  • +
  • Due to the private key and certificate options the module is not fully idempotent. You can use force=true to force the module to ensure updating if you know that the private key might have changed.

  • +
  • For auto-generated providers (rsa-generated, rsa-enc-generated, hmac-generated, aes-generated, ecdsa-generated, ecdh-generated, eddsa-generated), Keycloak manages the key material automatically. The config.private_key and config.certificate options are not used.

  • +
  • For java-keystore provider, the config.keystore_password and config.key_password values are returned masked by Keycloak. Therefore comparing their current state to the desired state is not possible. Use update_password=on_create for idempotent playbooks, or use update_password=always (default) if you need to ensure passwords are updated.

  • +
+
+
+
+

Examples

+
- name: Manage Keycloak realm key (certificate autogenerated by Keycloak)
+  middleware_automation.keycloak.keycloak_realm_key:
+    name: custom
+    state: present
+    parent_id: master
+    provider_id: rsa
+    auth_keycloak_url: http://localhost:8080
+    auth_username: keycloak
+    auth_password: keycloak
+    auth_realm: master
+    config:
+      private_key: "{{ private_key }}"
+      certificate: ""
+      enabled: true
+      active: true
+      priority: 120
+      algorithm: RS256
+
+- name: Manage Keycloak realm key and certificate
+  middleware_automation.keycloak.keycloak_realm_key:
+    name: custom
+    state: present
+    parent_id: master
+    provider_id: rsa
+    auth_keycloak_url: http://localhost:8080
+    auth_username: keycloak
+    auth_password: keycloak
+    auth_realm: master
+    config:
+      private_key: "{{ private_key }}"
+      certificate: "{{ certificate }}"
+      enabled: true
+      active: true
+      priority: 120
+      algorithm: RS256
+
+- name: Create HMAC signing key (auto-generated)
+  middleware_automation.keycloak.keycloak_realm_key:
+    name: hmac-custom
+    state: present
+    parent_id: master
+    provider_id: hmac-generated
+    auth_keycloak_url: http://localhost:8080
+    auth_username: keycloak
+    auth_password: keycloak
+    auth_realm: master
+    config:
+      enabled: true
+      active: true
+      priority: 100
+      algorithm: HS256
+      secret_size: 64
+
+- name: Create AES encryption key (auto-generated)
+  middleware_automation.keycloak.keycloak_realm_key:
+    name: aes-custom
+    state: present
+    parent_id: master
+    provider_id: aes-generated
+    auth_keycloak_url: http://localhost:8080
+    auth_username: keycloak
+    auth_password: keycloak
+    auth_realm: master
+    config:
+      enabled: true
+      active: true
+      priority: 100
+      secret_size: 16
+
+- name: Create ECDSA signing key (auto-generated)
+  middleware_automation.keycloak.keycloak_realm_key:
+    name: ecdsa-custom
+    state: present
+    parent_id: master
+    provider_id: ecdsa-generated
+    auth_keycloak_url: http://localhost:8080
+    auth_username: keycloak
+    auth_password: keycloak
+    auth_realm: master
+    config:
+      enabled: true
+      active: true
+      priority: 100
+      algorithm: ES256
+      elliptic_curve: P-256
+
+- name: Create RSA signing key (auto-generated)
+  middleware_automation.keycloak.keycloak_realm_key:
+    name: rsa-auto
+    state: present
+    parent_id: master
+    provider_id: rsa-generated
+    auth_keycloak_url: http://localhost:8080
+    auth_username: keycloak
+    auth_password: keycloak
+    auth_realm: master
+    config:
+      enabled: true
+      active: true
+      priority: 100
+      algorithm: RS256
+      key_size: 2048
+
+- name: Remove default HMAC key
+  middleware_automation.keycloak.keycloak_realm_key:
+    name: hmac-generated
+    state: absent
+    parent_id: myrealm
+    provider_id: hmac-generated
+    auth_keycloak_url: http://localhost:8080
+    auth_username: keycloak
+    auth_password: keycloak
+    auth_realm: master
+    config:
+      priority: 100
+
+- name: Create RSA encryption key (auto-generated)
+  middleware_automation.keycloak.keycloak_realm_key:
+    name: rsa-enc-auto
+    state: present
+    parent_id: master
+    provider_id: rsa-enc-generated
+    auth_keycloak_url: http://localhost:8080
+    auth_username: keycloak
+    auth_password: keycloak
+    auth_realm: master
+    config:
+      enabled: true
+      active: true
+      priority: 100
+      algorithm: RSA-OAEP
+      key_size: 2048
+
+- name: Create ECDH key exchange key (auto-generated)
+  middleware_automation.keycloak.keycloak_realm_key:
+    name: ecdh-custom
+    state: present
+    parent_id: master
+    provider_id: ecdh-generated
+    auth_keycloak_url: http://localhost:8080
+    auth_username: keycloak
+    auth_password: keycloak
+    auth_realm: master
+    config:
+      enabled: true
+      active: true
+      priority: 100
+      algorithm: ECDH_ES
+      elliptic_curve: P-256
+
+- name: Create EdDSA signing key (auto-generated)
+  middleware_automation.keycloak.keycloak_realm_key:
+    name: eddsa-custom
+    state: present
+    parent_id: master
+    provider_id: eddsa-generated
+    auth_keycloak_url: http://localhost:8080
+    auth_username: keycloak
+    auth_password: keycloak
+    auth_realm: master
+    config:
+      enabled: true
+      active: true
+      priority: 100
+      elliptic_curve: Ed25519
+
+- name: Import key from Java Keystore (always update passwords)
+  middleware_automation.keycloak.keycloak_realm_key:
+    name: jks-imported
+    state: present
+    parent_id: master
+    provider_id: java-keystore
+    auth_keycloak_url: http://localhost:8080
+    auth_username: keycloak
+    auth_password: keycloak
+    auth_realm: master
+    # update_password: always is the default - passwords are always sent to Keycloak
+    config:
+      enabled: true
+      active: true
+      priority: 100
+      algorithm: RS256
+      keystore: /opt/keycloak/conf/keystore.jks
+      keystore_password: "{{ keystore_password }}"
+      key_alias: mykey
+      key_password: "{{ key_password }}"
+
+- name: Import key from Java Keystore (idempotent - only set password on create)
+  middleware_automation.keycloak.keycloak_realm_key:
+    name: jks-idempotent
+    state: present
+    parent_id: master
+    provider_id: java-keystore
+    auth_keycloak_url: http://localhost:8080
+    auth_username: keycloak
+    auth_password: keycloak
+    auth_realm: master
+    update_password: on_create  # Only send passwords when creating, preserve existing on update
+    config:
+      enabled: true
+      active: true
+      priority: 100
+      algorithm: RS256
+      keystore: /opt/keycloak/conf/keystore.jks
+      keystore_password: "{{ keystore_password }}"
+      key_alias: mykey
+      key_password: "{{ key_password }}"
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of the keycloak_realm_key after module execution.

+

Returned: on success

+
+
+

config

+ +

+ dictionary +

+
+

Realm key configuration.

+

Returned: when state=present

+

Sample: {"active": ["true"], "algorithm": ["RS256"], "enabled": ["true"], "priority": ["140"]}

+
+
+

id

+ +

+ string +

+
+

ID of the realm key.

+

Returned: when state=present

+

Sample: "5b7ec13f-99da-46ad-8326-ab4c73cf4ce4"

+
+
+

key_info

+ +

+ dictionary +

+
+

Cryptographic key metadata fetched from the realm keys endpoint.

+

Only returned for java-keystore provider when state=present and not in check mode.

+

This includes the key ID (kid) and certificate fingerprint, which can be used to detect if the actual cryptographic key changed.

+

Returned: when provider_id=java-keystore and state=present

+
+
+

certificate_fingerprint

+ +

+ string +

+
+

SHA256 fingerprint of the certificate in colon-separated hex format.

+

Returned: success

+

Sample: "A1:B2:C3:D4:E5:F6:..."

+
+
+

kid

+ +

+ string +

+
+

The key ID (kid) - unique identifier for the cryptographic key.

+

Returned: success

+

Sample: "bN7p5Nc_V2M7N_-mb5vVSRVPKq5qD_OuARInB9ofsJ0"

+
+
+

status

+ +

+ string +

+
+

The key status (ACTIVE, PASSIVE, DISABLED).

+

Returned: success

+

Sample: "ACTIVE"

+
+
+

valid_to

+ +

+ integer +

+
+

Certificate expiration timestamp in milliseconds since epoch.

+

Returned: success

+

Sample: 1801789047000

+
+
+

name

+ +

+ string +

+
+

Name of the realm key.

+

Returned: when state=present

+

Sample: "mykey"

+
+
+

parentId

+ +

+ string +

+
+

ID of the realm this key belongs to.

+

Returned: when state=present

+

Sample: "myrealm"

+
+
+

providerId

+ +

+ string +

+
+

The ID of the key provider.

+

Returned: when state=present

+

Sample: "rsa"

+
+
+

providerType

+ +

+ string +

+
+

The type of provider.

+

Returned: when state=present

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+
+

Authors

+
    +
  • Samuli Seppänen (@mattock)

  • +
  • Ivan Kokalović (@koke1997)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_realm_keys_metadata_info.html b/3.1.2/plugins/keycloak_realm_keys_metadata_info.html new file mode 100644 index 0000000..4d31f21 --- /dev/null +++ b/3.1.2/plugins/keycloak_realm_keys_metadata_info.html @@ -0,0 +1,553 @@ + + + + + + + + + + keycloak_realm_keys_metadata_info – Allows obtaining Keycloak realm keys metadata using Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • + View page source +
  • +
+
+
+
+
+ +
+

keycloak_realm_keys_metadata_info – Allows obtaining Keycloak realm keys metadata using Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_realm_keys_metadata_info.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+ +
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

realm

+ +

+ string +

+
+

They Keycloak realm to fetch keys metadata.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

This action does not modify state.

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: N/A

+

This action does not modify state.

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Fetch Keys metadata
+  middleware_automation.keycloak.keycloak_realm_keys_metadata_info:
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    realm: MyCustomRealm
+  delegate_to: localhost
+  register: keycloak_keys_metadata
+
+- name: Write the Keycloak keys certificate into a file
+  ansible.builtin.copy:
+    dest: /tmp/keycloak.cert
+    content: |
+      {{ keys_metadata['keycloak_keys_metadata']['keys']
+      | selectattr('algorithm', 'equalto', 'RS256')
+      | map(attribute='certificate')
+      | first
+      }}
+  delegate_to: localhost
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

keys_metadata

+ +

+ dictionary +

+
+

Representation of the realm keys metadata (see https://www.keycloak.org/docs-api/latest/rest-api/index.html#KeysMetadataRepresentation).

+

Returned: always

+
+
+

active

+ +

+ dictionary +

+
+

A mapping (that is, a dict) from key algorithms to UUIDs.

+

Returned: always

+
+
+

keys

+ +

+ list + / elements=dictionary +

+
+

A list of dicts providing detailed information on the keys.

+

Returned: always

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+
+

Authors

+
    +
  • Thomas Bach (@thomasbach-dev)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_realm_localization.html b/3.1.2/plugins/keycloak_realm_localization.html new file mode 100644 index 0000000..4db6c95 --- /dev/null +++ b/3.1.2/plugins/keycloak_realm_localization.html @@ -0,0 +1,711 @@ + + + + + + + + + + keycloak_realm_localization – Allows management of Keycloak realm localization overrides via the Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • + View page source +
  • +
+
+
+
+
+ +
+

keycloak_realm_localization – Allows management of Keycloak realm localization overrides via the Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_realm_localization.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows you to manage per-locale message overrides for a Keycloak realm using the Keycloak Admin REST API.

  • +
  • Requires access via OpenID Connect; the connecting user/client must have sufficient privileges.

  • +
  • The names of module options are snake_cased versions of the names found in the Keycloak API.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

force

+ +

+ boolean +

+
+

If false, only the keys listed in the overrides are modified by this module. Any other pre-existing keys are ignored.

+

If true, all locale overrides are made to match configuration of this module. For example any keys missing from the overrides are removed regardless of state value.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

locale

+ +

+ string + / required +

+
+

Locale code for which the overrides apply (for example, en, fi, de).

+
+
+

overrides

+ +

+ list + / elements=dictionary +

+
+

List of overrides to ensure for the locale when state=present. Each item is a mapping with the record's overrides[].key and its overrides[].value.

+

Ignored when state=absent.

+

Default: []

+
+
+

key

+ +

+ string + / required +

+
+

The message key to override.

+
+
+

value

+ +

+ string +

+
+

The override value for the message key. If omitted, value defaults to an empty string.

+

Default: ""

+
+
+

parent_id

+ +

+ string + / required +

+
+

Name of the realm that owns the locale overrides.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

Desired state of localization overrides for the given locale.

+

On present, the set of overrides for the locale are made to match overrides. If force is true keys not listed in overrides are removed, and the listed keys are created or updated. If force is false keys not listed in overrides are ignored, and the listed keys are created or updated.

+

On absent, overrides for the locale is removed. If force is true, all keys are removed. If force is false, only the keys listed in overrides are removed.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: full

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

See Also

+
+

See also

+
+
middleware_automation.keycloak.keycloak_realm

You can specify list of supported locales using supported_locales.

+
+
+
+
+
+

Examples

+
- name: Replace all overrides for locale "en" (credentials auth)
+  middleware_automation.keycloak.keycloak_realm_localization:
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    parent_id: my-realm
+    locale: en
+    state: present
+    force: true
+    overrides:
+      - key: greeting
+        value: "Hello"
+      - key: farewell
+        value: "Bye"
+  delegate_to: localhost
+
+- name: Replace listed overrides for locale "en" (credentials auth)
+  middleware_automation.keycloak.keycloak_realm_localization:
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    parent_id: my-realm
+    locale: en
+    state: present
+    force: false
+    overrides:
+      - key: greeting
+        value: "Hello"
+      - key: farewell
+        value: "Bye"
+  delegate_to: localhost
+
+- name: Ensure only one override exists for locale "fi" (token auth)
+  middleware_automation.keycloak.keycloak_realm_localization:
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    token: TOKEN
+    parent_id: my-realm
+    locale: fi
+    state: present
+    force: true
+    overrides:
+      - key: app.title
+        value: "Sovellukseni"
+  delegate_to: localhost
+
+- name: Remove all overrides for locale "de"
+  middleware_automation.keycloak.keycloak_realm_localization:
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    parent_id: my-realm
+    locale: de
+    state: absent
+    force: true
+  delegate_to: localhost
+
+- name: Remove only the listed overrides for locale "de"
+  middleware_automation.keycloak.keycloak_realm_localization:
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    parent_id: my-realm
+    locale: de
+    state: absent
+    force: false
+    overrides:
+      - key: app.title
+      - key: foo
+      - key: bar
+  delegate_to: localhost
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Final state of localization overrides for the locale after module execution.

+

Contains the locale and the list of overrides as key/value items.

+

Returned: on success

+
+
+

locale

+ +

+ string +

+
+

The locale code affected.

+

Returned: success

+

Sample: "en"

+
+
+

overrides

+ +

+ list + / elements=dictionary +

+
+

The list of overrides that exist after execution.

+

Returned: success

+

Sample: [{"key": "greeting", "value": "Hello"}, {"key": "farewell", "value": "Bye"}]

+
+

Authors

+
    +
  • Jakub Danek (@danekja)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_realm_rolemapping.html b/3.1.2/plugins/keycloak_realm_rolemapping.html new file mode 100644 index 0000000..82d1768 --- /dev/null +++ b/3.1.2/plugins/keycloak_realm_rolemapping.html @@ -0,0 +1,744 @@ + + + + + + + + + + keycloak_realm_rolemapping – Allows administration of Keycloak realm role mappings into groups with the Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • + View page source +
  • +
+
+
+
+
+ +
+

keycloak_realm_rolemapping – Allows administration of Keycloak realm role mappings into groups with the Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_realm_rolemapping.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows you to add, remove or modify Keycloak realm role mappings into groups with the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.

  • +
  • The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at https://www.keycloak.org/docs-api/18.0/rest-api/index.html.

  • +
  • Attributes are multi-valued in the Keycloak API. All attributes are lists of individual values and are returned that way by this module. You may pass single values for attributes when calling the module, and this is translated into a list suitable for the API.

  • +
  • When updating a group_rolemapping, where possible provide the role ID to the module. This removes a lookup to the API to translate the name into the role ID.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

gid

+ +

+ string +

+
+

ID of the group to be mapped.

+

This parameter is not required for updating or deleting the rolemapping but providing it reduces the number of API calls required.

+
+
+

group_name

+ +

+ string +

+
+

Name of the group to be mapped.

+

This parameter is required (can be replaced by gid for less API call).

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

parents

+ +

+ list + / elements=dictionary +

+
+

List of parent groups for the group to handle sorted top to bottom.

+

Set this if your group is a subgroup and you do not provide the GID in gid.

+
+
+

id

+ +

+ string +

+
+

Identify parent by ID.

+

Needs less API calls than using parents[].name.

+

A deep parent chain can be started at any point when first given parent is given as ID.

+

Note that in principle both ID and name can be specified at the same time but current implementation only always use just one of them, with ID being preferred.

+
+
+

name

+ +

+ string +

+
+

Identify parent by name.

+

Needs more internal API calls than using parents[].id to map names to ID's under the hood.

+

When giving a parent chain with only names it must be complete up to the top.

+

Note that in principle both ID and name can be specified at the same time but current implementation only always use just one of them, with ID being preferred.

+
+
+

realm

+ +

+ string +

+
+

They Keycloak realm under which this role_representation resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

roles

+ +

+ list + / elements=dictionary +

+
+

Roles to be mapped to the group.

+
+
+

id

+ +

+ string +

+
+

The unique identifier for this role_representation.

+

This parameter is not required for updating or deleting a role_representation but providing it reduces the number of API calls required.

+
+
+

name

+ +

+ string +

+
+

Name of the role_representation.

+

This parameter is required only when creating or updating the role_representation.

+
+
+

state

+ +

+ string +

+
+

State of the realm_rolemapping.

+

On present, the realm_rolemapping is created if it does not yet exist, or updated with the parameters you provide.

+

On absent, the realm_rolemapping is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: full

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Map a client role to a group, authentication with credentials
+  middleware_automation.keycloak.keycloak_realm_rolemapping:
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    state: present
+    group_name: group1
+    roles:
+      - name: role_name1
+        id: role_id1
+      - name: role_name2
+        id: role_id2
+  delegate_to: localhost
+
+- name: Map a client role to a group, authentication with token
+  middleware_automation.keycloak.keycloak_realm_rolemapping:
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    token: TOKEN
+    state: present
+    group_name: group1
+    roles:
+      - name: role_name1
+        id: role_id1
+      - name: role_name2
+        id: role_id2
+  delegate_to: localhost
+
+- name: Map a client role to a subgroup, authentication with token
+  middleware_automation.keycloak.keycloak_realm_rolemapping:
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    token: TOKEN
+    state: present
+    group_name: subgroup1
+    parents:
+      - name: parent-group
+    roles:
+      - name: role_name1
+        id: role_id1
+      - name: role_name2
+        id: role_id2
+  delegate_to: localhost
+
+- name: Unmap realm role from a group
+  middleware_automation.keycloak.keycloak_realm_rolemapping:
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    state: absent
+    group_name: group1
+    roles:
+      - name: role_name1
+        id: role_id1
+      - name: role_name2
+        id: role_id2
+  delegate_to: localhost
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of client role mapping after module execution.

+

The sample is truncated.

+

Returned: on success

+

Sample: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}

+
+
+

existing

+ +

+ dictionary +

+
+

Representation of existing client role mapping.

+

The sample is truncated.

+

Returned: always

+

Sample: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: "Role role1 assigned to group group1."

+
+
+

proposed

+ +

+ dictionary +

+
+

Representation of proposed client role mapping.

+

Returned: always

+

Sample: {"clientId": "test"}

+
+

Authors

+
    +
  • Gaëtan Daubresse (@Gaetan2907)

  • +
  • Marius Huysamen (@mhuysamen)

  • +
  • Alexander Groß (@agross)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_realm_users_info.html b/3.1.2/plugins/keycloak_realm_users_info.html new file mode 100644 index 0000000..32eb5ee --- /dev/null +++ b/3.1.2/plugins/keycloak_realm_users_info.html @@ -0,0 +1,509 @@ + + + + + + + + + + keycloak_realm_users_info – Retrieve users from a Keycloak realm using the Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

keycloak_realm_users_info – Retrieve users from a Keycloak realm using the Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_realm_users_info.

+
+

New in middleware_automation.keycloak 3.1.0

+ +
+

Synopsis

+
    +
  • This module retrieves all users from a specified Keycloak realm using the Keycloak REST API.

  • +
  • Access to the REST API is performed via OpenID Connect. The user and client used must have the necessary permissions.

  • +
  • Authentication can be performed either with username/password or with a token.

  • +
  • The names of module options are snake_case versions of the camelCase ones found in the Keycloak API and its documentation at https://www.keycloak.org/docs-api/latest/rest-api/index.html.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

realm

+ +

+ string +

+
+

The Keycloak realm from which users should be retrieved.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

This action does not modify state.

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: N/A

+

This action does not modify state.

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: List all users in the "MyCustomRealm" realm using username/password authentication
+  middleware_automation.keycloak.keycloak_realm_users_info:
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+  delegate_to: localhost
+
+- name: List all users in the "MyCustomRealm" realm using a token
+  middleware_automation.keycloak.keycloak_realm_users_info:
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    token: TOKEN
+  delegate_to: localhost
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + +

Key

Description

+
+

users

+ +

+ list + / elements=dictionary +

+
+

List of users in the specified realm.

+

Returned: always

+

Sample: [{"email": "user1@example.com", "id": "1234-5678-90", "username": "user1"}, {"email": "user2@example.com", "id": "2345-6789-01", "username": "user2"}]

+
+

Authors

+
    +
  • Felix Grzelka (@felix-grzelka)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_role.html b/3.1.2/plugins/keycloak_role.html new file mode 100644 index 0000000..923f5d4 --- /dev/null +++ b/3.1.2/plugins/keycloak_role.html @@ -0,0 +1,760 @@ + + + + + + + + + + keycloak_role – Allows administration of Keycloak roles using Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

keycloak_role – Allows administration of Keycloak roles using Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_role.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows you to add, remove or modify Keycloak roles using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.

  • +
  • The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at https://www.keycloak.org/docs-api/latest/rest-api/index.html.

  • +
  • Attributes are multi-valued in the Keycloak API. All attributes are lists of individual values and are returned that way by this module. You may pass single values for attributes when calling the module, and this is translated into a list suitable for the API.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

attributes

+ +

+ dictionary +

+
+

A dict of key/value pairs to set as custom attributes for the role.

+

Values may be single values (for example a string) or a list of strings.

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

client_id

+ +

+ string +

+
+

If the role is a client role, the client ID under which it resides.

+

If this parameter is absent, the role is considered a realm role.

+
+
+

composite

+ +

+ boolean +

+
+

If true, the role is a composition of other realm and/or client role.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

composites

+ +

+ list + / elements=dictionary +

+
+

List of roles to include to the composite realm role.

+

If the composite role is a client role, the clientId (not ID of the client) must be specified.

+

Default: []

+
+
+
+

client_id

+ +

aliases: clientId

+

+ string +

+
+

Client ID if the role is a client role. Do not include this option for a REALM role.

+

Use the client ID you can see in the Keycloak console, not the technical ID of the client.

+
+
+

name

+ +

+ string + / required +

+
+

Name of the role. This can be the name of a REALM role or a client role.

+
+
+

state

+ +

+ string +

+
+

Create the composite if present, remove it if absent.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

description

+ +

+ string +

+
+

The role description.

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

name

+ +

+ string + / required +

+
+

Name of the role.

+

This parameter is required.

+
+
+

realm

+ +

+ string +

+
+

The Keycloak realm under which this role resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

State of the role.

+

On present, the role is created if it does not yet exist, or updated with the parameters you provide.

+

On absent, the role is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: full

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Create a Keycloak realm role, authentication with credentials
+  middleware_automation.keycloak.keycloak_role:
+    name: my-new-kc-role
+    realm: MyCustomRealm
+    state: present
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+  delegate_to: localhost
+
+- name: Create a Keycloak realm role, authentication with token
+  middleware_automation.keycloak.keycloak_role:
+    name: my-new-kc-role
+    realm: MyCustomRealm
+    state: present
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    token: TOKEN
+  delegate_to: localhost
+
+- name: Create a Keycloak client role
+  middleware_automation.keycloak.keycloak_role:
+    name: my-new-kc-role
+    realm: MyCustomRealm
+    client_id: MyClient
+    state: present
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+  delegate_to: localhost
+
+- name: Delete a Keycloak role
+  middleware_automation.keycloak.keycloak_role:
+    name: my-role-for-deletion
+    state: absent
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+  delegate_to: localhost
+
+- name: Create a keycloak role with some custom attributes
+  middleware_automation.keycloak.keycloak_role:
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    name: my-new-role
+    attributes:
+      attrib1: value1
+      attrib2: value2
+      attrib3:
+        - with
+        - numerous
+        - individual
+        - list
+        - items
+  delegate_to: localhost
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of role after module execution (sample is truncated).

+

Returned: on success

+

Sample: {"attributes": {}, "clientRole": true, "composite": false, "containerId": "9f03eb61-a826-4771-a9fd-930e06d2d36a", "description": "My updated client test role", "id": "561703dd-0f38-45ff-9a5a-0c978f794547", "name": "myrole"}

+
+
+

existing

+ +

+ dictionary +

+
+

Representation of existing role.

+

Returned: always

+

Sample: {"attributes": {}, "clientRole": true, "composite": false, "containerId": "9f03eb61-a826-4771-a9fd-930e06d2d36a", "description": "My client test role", "id": "561703dd-0f38-45ff-9a5a-0c978f794547", "name": "myrole"}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: "Role myrole has been updated"

+
+
+

proposed

+ +

+ dictionary +

+
+

Representation of proposed role.

+

Returned: always

+

Sample: {"description": "My updated test description"}

+
+

Authors

+
    +
  • Laurent Paumier (@laurpaum)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_user.html b/3.1.2/plugins/keycloak_user.html new file mode 100644 index 0000000..c50bd67 --- /dev/null +++ b/3.1.2/plugins/keycloak_user.html @@ -0,0 +1,1152 @@ + + + + + + + + + + keycloak_user – Create and configure a user in Keycloak — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

keycloak_user – Create and configure a user in Keycloak

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_user.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module creates, removes, or updates Keycloak users.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

access

+ +

+ dictionary +

+
+

List user access.

+
+
+

attributes

+ +

+ list + / elements=dictionary +

+
+

List of user attributes.

+
+
+

name

+ +

+ string +

+
+

Name of the attribute.

+
+
+

state

+ +

+ string +

+
+

Control whether the attribute must exists or not.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

values

+ +

+ list + / elements=string +

+
+

Values for the attribute as list.

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+

auth_username

+ +

+ string +

+
+

Username to authenticate for API access with.

+
+
+
+

client_consents

+ +

aliases: clientConsents

+

+ list + / elements=dictionary +

+
+

Client Authenticator Type.

+

Default: []

+
+
+
+
+
+

client_id

+ +

aliases: clientId

+

+ string + / required +

+
+

Client ID of the client role. Not the technical ID of the client.

+
+
+
+

roles

+ +

+ list + / elements=string + / required +

+
+

List of client roles to assign to the user.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

credentials

+ +

+ list + / elements=dictionary +

+
+

User credentials.

+

Default: []

+
+
+

temporary

+ +

+ boolean +

+
+

If true, the users are required to reset their credentials at next login.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

type

+ +

+ string + / required +

+
+

Credential type.

+
+
+

value

+ +

+ string + / required +

+
+

Value of the credential.

+
+
+
+

disableable_credential_types

+ +

aliases: disableableCredentialTypes

+

+ list + / elements=string +

+
+

List user Credential Type.

+

Default: []

+
+
+

email

+ +

+ string +

+
+

User email.

+
+
+
+

email_verified

+ +

aliases: emailVerified

+

+ boolean +

+
+

Set or reset the emailVerified flag of the user.

+

When email_verified_behavior=no_defaults, the default value of this option becomes null and that causes the module not to change any existing value for that attribute.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

email_verified_behavior

+ +

+ string +

+

added in middleware_automation.keycloak 3.0.0

+
+

The email_verified option used to have a default value. This caused problems when the user expects different behavior from keycloak by default.

+

The default value of this option is compatibility, which will ensure that the old default value for email_verified is used.

+

When set to no_defaults, the module will not change existing values of email_verified if no value is specified.

+

Choices:

+
    +
  • "compatibility" ← (default)

  • +
  • "no_defaults"

  • +
+ +
+
+

enabled

+ +

+ boolean +

+
+

Enabled user.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+
+

federated_identities

+ +

aliases: federatedIdentities

+

+ list + / elements=string +

+
+

List of IDPs of user.

+

Default: []

+
+ + +

federation_link

+ +

aliases: federationLink

+

+ string +

+
+

Federation Link.

+
+
+
+

first_name

+ +

aliases: firstName

+

+ string +

+
+

The user's first name.

+
+
+

force

+ +

+ boolean +

+
+

If true, allows to remove user and recreate it.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

groups

+ +

+ list + / elements=dictionary +

+
+

List of groups for the user.

+

Groups can be referenced by their name, like staff, or their path, like /staff/engineering. The path syntax allows you to reference subgroups, which is not possible otherwise.

+

Using the path is possible since middleware_automation.keycloak 3.0.0.

+

Default: []

+
+
+

name

+ +

+ string +

+
+

Name of the group.

+
+
+

state

+ +

+ string +

+
+

Control whether the user must be member of this group or not.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

id

+ +

+ string +

+
+

ID of the user on the Keycloak server if known.

+
+
+
+

last_name

+ +

aliases: lastName

+

+ string +

+
+

The user's last name.

+
+
+

origin

+ +

+ string +

+
+

User origin.

+
+
+

realm

+ +

+ string +

+
+

The name of the realm in which is the client.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+
+

required_actions

+ +

aliases: requiredActions

+

+ list + / elements=string +

+
+

Set or reset a user's required actions.

+
+
+

self

+ +

+ string +

+
+

User self administration.

+
+
+
+

service_account_client_id

+ +

aliases: serviceAccountClientId

+

+ string +

+
+

Description of the client Application.

+
+
+

state

+ +

+ string +

+
+

Control whether the user should exists or not.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

username

+ +

+ string + / required +

+
+

Username for the user.

+
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: full

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Notes

+
+

Note

+
    +
  • The module does not modify the user ID of an existing user.

  • +
+
+
+
+

Examples

+
- name: Create a user user1
+  middleware_automation.keycloak.keycloak_user:
+    auth_keycloak_url: http://localhost:8080
+    auth_username: admin
+    auth_password: password
+    realm: master
+    username: user1
+    firstName: user1
+    lastName: user1
+    email: user1
+    enabled: true
+    emailVerified: false
+    credentials:
+      - type: password
+        value: password
+        temporary: false
+    attributes:
+      - name: attr1
+        values:
+          - value1
+        state: present
+      - name: attr2
+        values:
+          - value2
+        state: absent
+    groups:
+      - name: group1
+        state: present
+    state: present
+
+- name: Re-create a User
+  middleware_automation.keycloak.keycloak_user:
+    auth_keycloak_url: http://localhost:8080
+    auth_username: admin
+    auth_password: password
+    realm: master
+    username: user1
+    firstName: user1
+    lastName: user1
+    email: user1
+    enabled: true
+    emailVerified: false
+    credentials:
+      - type: password
+        value: password
+        temporary: false
+    attributes:
+      - name: attr1
+        values:
+          - value1
+        state: present
+      - name: attr2
+        values:
+          - value2
+        state: absent
+    groups:
+      - name: group1
+        state: present
+    state: present
+
+- name: Re-create a User
+  middleware_automation.keycloak.keycloak_user:
+    auth_keycloak_url: http://localhost:8080
+    auth_username: admin
+    auth_password: password
+    realm: master
+    username: user1
+    firstName: user1
+    lastName: user1
+    email: user1
+    enabled: true
+    emailVerified: false
+    credentials:
+      - type: password
+        value: password
+        temporary: false
+    attributes:
+      - name: attr1
+        values:
+          - value1
+        state: present
+      - name: attr2
+        values:
+          - value2
+        state: absent
+    groups:
+      - name: group1
+        state: present
+    state: present
+    force: true
+
+- name: Remove User
+  middleware_automation.keycloak.keycloak_user:
+    auth_keycloak_url: http://localhost:8080
+    auth_username: admin
+    auth_password: password
+    realm: master
+    username: user1
+    state: absent
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of the user after module execution.

+

Returned: on success

+
+
+

existing

+ +

+ dictionary +

+
+

Representation of the existing user.

+

Returned: on success

+
+
+

proposed

+ +

+ dictionary +

+
+

Representation of the proposed user.

+

Returned: on success

+
+
+

user_created

+ +

+ boolean +

+
+

Indicates whether a user was created.

+

Returned: in success

+
+

Authors

+
    +
  • Philippe Gauthier (@elfelip)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_user_execute_actions_email.html b/3.1.2/plugins/keycloak_user_execute_actions_email.html new file mode 100644 index 0000000..f2a731c --- /dev/null +++ b/3.1.2/plugins/keycloak_user_execute_actions_email.html @@ -0,0 +1,625 @@ + + + + + + + + + + keycloak_user_execute_actions_email – Send a Keycloak execute-actions email to a user — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

keycloak_user_execute_actions_email – Send a Keycloak execute-actions email to a user

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_user_execute_actions_email.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • Triggers the Keycloak endpoint execute-actions-email for a user. This sends an email with one or more required actions the user must complete (for example resetting the password).

  • +
  • If no actions list is provided, the default action UPDATE_PASSWORD is used.

  • +
  • You must supply either the user’s id or username. Supplying only username causes an extra lookup call.

  • +
  • This module always reports changed=true because sending an email is a side effect and cannot be made idempotent.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

actions

+ +

+ list + / elements=string +

+
+

List of required actions to include in the email.

+

Default: ["UPDATE_PASSWORD"]

+
+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+

auth_username

+ +

+ string +

+
+

Username to authenticate for API access with.

+
+
+
+

client_id

+ +

aliases: clientId

+

+ string +

+
+

Optional client ID used for the redirect link.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

id

+ +

+ string +

+
+

The unique ID (UUID) of the user.

+

Mutually exclusive with username.

+
+
+

lifespan

+ +

+ integer +

+
+

Optional lifespan (in seconds) for the action token (supported on newer Keycloak versions). Forwarded as query parameter if provided.

+
+
+

realm

+ +

+ string +

+
+

The Keycloak realm where the user resides.

+

Default: "master"

+
+
+
+

redirect_uri

+ +

aliases: redirectUri

+

+ string +

+
+

Optional redirect URI. Must be valid for the given client if client_id is set.

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

username

+ +

+ string +

+
+

Username of the user.

+

Mutually exclusive with id.

+
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: none

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Password reset email (default action) with 1h lifespan
+  middleware_automation.keycloak.keycloak_user_execute_actions_email:
+    username: johndoe
+    realm: MyRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: ADMIN
+    auth_password: SECRET
+    lifespan: 3600
+  delegate_to: localhost
+
+- name: Multiple required actions using token auth
+  middleware_automation.keycloak.keycloak_user_execute_actions_email:
+    username: johndoe
+    actions:
+      - UPDATE_PASSWORD
+      - VERIFY_EMAIL
+    realm: MyRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    token: TOKEN
+  delegate_to: localhost
+
+- name: Email by user id with redirect
+  middleware_automation.keycloak.keycloak_user_execute_actions_email:
+    id: 9d59aa76-2755-48c6-b1af-beb70a82c3cd
+    client_id: my-frontend
+    redirect_uri: https://app.example.com/post-actions
+    actions:
+      - UPDATE_PASSWORD
+    realm: MyRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: ADMIN
+    auth_password: SECRET
+  delegate_to: localhost
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + +

Key

Description

+
+

actions

+ +

+ list + / elements=string +

+
+

List of actions included in the email.

+

Returned: success

+
+
+

user_id

+ +

+ string +

+
+

The user ID the email was (or would be, in check mode) sent to.

+

Returned: success

+
+

Authors

+
    +
  • Marius Bertram (@mariusbertram)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_user_federation.html b/3.1.2/plugins/keycloak_user_federation.html new file mode 100644 index 0000000..5683fb1 --- /dev/null +++ b/3.1.2/plugins/keycloak_user_federation.html @@ -0,0 +1,1670 @@ + + + + + + + + + + keycloak_user_federation – Allows administration of Keycloak user federations using Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

keycloak_user_federation – Allows administration of Keycloak user federations using Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_user_federation.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows you to add, remove or modify Keycloak user federations using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.

  • +
  • The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at https://www.keycloak.org/docs-api/20.0.2/rest-api/index.html.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

bind_credential_update_mode

+ +

+ string +

+
+

The value of the config parameter config.bindCredential is redacted in the Keycloak responses. Comparing the redacted value with the desired value always evaluates to not equal. This means the before and desired states are never equal if the parameter is set.

+

Set to always to include config.bindCredential in the comparison of before and desired state. Because of the redacted value returned by Keycloak the module always detects a change and make an update if a config.bindCredential value is set.

+

Set to only_indirect to exclude config.bindCredential when comparing the before state with the desired state. The value of config.bindCredential is only updated if there are other changes to the user federation that require an update.

+

Choices:

+
    +
  • "always" ← (default)

  • +
  • "only_indirect"

  • +
+ +
+
+

config

+ +

+ dictionary +

+
+

Dict specifying the configuration options for the provider; the contents differ depending on the value of provider_id. Examples are given below for ldap, kerberos and sssd. It is easiest to obtain valid config values by dumping an already-existing user federation configuration through check-mode in the existing field.

+

The value sssd has been supported since middleware_automation.keycloak 4.2.0.

+
+
+

allowKerberosAuthentication

+ +

+ boolean +

+
+

Enable/disable HTTP authentication of users with SPNEGO/Kerberos tokens. The data about authenticated users is provisioned from this LDAP server.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

allowPasswordAuthentication

+ +

+ boolean +

+
+

Enable/disable possibility of username/password authentication against Kerberos database.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

authType

+ +

+ string +

+
+

Type of the Authentication method used during LDAP Bind operation. It is used in most of the requests sent to the LDAP server.

+

Choices:

+
    +
  • "none" ← (default)

  • +
  • "simple"

  • +
+ +
+
+

batchSizeForSync

+ +

+ integer +

+
+

Count of LDAP users to be imported from LDAP to Keycloak within a single transaction.

+

Default: 1000

+
+
+

bindCredential

+ +

+ string +

+
+

Password of LDAP admin.

+
+
+

bindDn

+ +

+ string +

+
+

DN of LDAP user which is used by Keycloak to access LDAP server.

+
+
+

cachePolicy

+ +

+ string +

+
+

Cache Policy for this storage provider.

+

Choices:

+
    +
  • "DEFAULT" ← (default)

  • +
  • "EVICT_DAILY"

  • +
  • "EVICT_WEEKLY"

  • +
  • "MAX_LIFESPAN"

  • +
  • "NO_CACHE"

  • +
+ +
+
+

changedSyncPeriod

+ +

+ integer +

+
+

Period for synchronization of changed or newly created LDAP users in seconds.

+

Default: -1

+
+
+

connectionPooling

+ +

+ boolean +

+
+

Determines if Keycloak should use connection pooling for accessing LDAP server.

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

connectionPoolingAuthentication

+ +

+ string +

+
+

A list of space-separated authentication types of connections that may be pooled.

+

Choices:

+
    +
  • "none"

  • +
  • "simple"

  • +
  • "DIGEST-MD5"

  • +
+ +
+
+

connectionPoolingDebug

+ +

+ string +

+
+

A string that indicates the level of debug output to produce. Example valid values are fine (trace connection creation and removal) and all (all debugging information).

+
+
+

connectionPoolingInitSize

+ +

+ integer +

+
+

The number of connections per connection identity to create when initially creating a connection for the identity.

+
+
+

connectionPoolingMaxSize

+ +

+ integer +

+
+

The maximum number of connections per connection identity that can be maintained concurrently.

+
+
+

connectionPoolingPrefSize

+ +

+ integer +

+
+

The preferred number of connections per connection identity that should be maintained concurrently.

+
+
+

connectionPoolingProtocol

+ +

+ string +

+
+

A list of space-separated protocol types of connections that may be pooled. Valid types are plain and ssl.

+
+
+

connectionPoolingTimeout

+ +

+ integer +

+
+

The number of milliseconds that an idle connection may remain in the pool without being closed and removed from the pool.

+
+
+

connectionTimeout

+ +

+ integer +

+
+

LDAP Connection Timeout in milliseconds.

+
+
+

connectionUrl

+ +

+ string +

+
+

Connection URL to your LDAP server.

+
+
+

customUserSearchFilter

+ +

+ string +

+
+

Additional LDAP Filter for filtering searched users. Leave this empty if you do not need additional filter.

+
+
+

debug

+ +

+ boolean +

+
+

Enable/disable debug logging to standard output for Krb5LoginModule.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

editMode

+ +

+ string +

+
+

READ_ONLY is a read-only LDAP store. WRITABLE means data is synced back to LDAP on demand. UNSYNCED means user data is imported, but not synced back to LDAP.

+

Choices:

+
    +
  • "READ_ONLY"

  • +
  • "WRITABLE"

  • +
  • "UNSYNCED"

  • +
+ +
+
+

enabled

+ +

+ boolean +

+
+

Enable/disable this user federation.

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

evictionDay

+ +

+ string +

+
+

Day of the week the entry is set to become invalid on.

+
+
+

evictionHour

+ +

+ string +

+
+

Hour of day the entry is set to become invalid on.

+
+
+

evictionMinute

+ +

+ string +

+
+

Minute of day the entry is set to become invalid on.

+
+
+

fullSyncPeriod

+ +

+ integer +

+
+

Period for full synchronization in seconds.

+

Default: -1

+
+
+

importEnabled

+ +

+ boolean +

+
+

If true, LDAP users are imported into Keycloak DB and synced by the configured sync policies.

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

kerberosRealm

+ +

+ string +

+
+

Name of kerberos realm.

+
+
+

keyTab

+ +

+ string +

+
+

Location of Kerberos KeyTab file containing the credentials of server principal. For example /etc/krb5.keytab.

+
+
+

krbPrincipalAttribute

+ +

+ string +

+
+

Name of the LDAP attribute, which refers to Kerberos principal. This is used to lookup appropriate LDAP user after successful Kerberos/SPNEGO authentication in Keycloak. When this is empty, the LDAP user is looked up based on LDAP username corresponding to the first part of his Kerberos principal. For instance, for principal john@KEYCLOAK.ORG, it assumes that LDAP username is john.

+
+
+

maxLifespan

+ +

+ integer +

+
+

Max lifespan of cache entry in milliseconds.

+
+
+

pagination

+ +

+ boolean +

+
+

Does the LDAP server support pagination.

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

priority

+ +

+ integer +

+
+

Priority of provider when doing a user lookup. Lowest first.

+

Default: 0

+
+
+

rdnLDAPAttribute

+ +

+ string +

+
+

Name of LDAP attribute, which is used as RDN (top attribute) of typical user DN. Usually it is the same as Username LDAP attribute, however it is not required. For example for Active directory, it is common to use cn as RDN attribute when username attribute might be sAMAccountName.

+
+
+

readTimeout

+ +

+ integer +

+
+

LDAP Read Timeout in milliseconds. This timeout applies for LDAP read operations.

+
+
+

referral

+ +

+ string +

+
+

Specifies if LDAP referrals should be followed or ignored. Please note that enabling referrals can slow down authentication as it allows the LDAP server to decide which other LDAP servers to use. This could potentially include untrusted servers.

+

Choices:

+
    +
  • "ignore"

  • +
  • "follow"

  • +
+ +
+
+

searchScope

+ +

+ string +

+
+

For one level, the search applies only for users in the DNs specified by User DNs. For subtree, the search applies to the whole subtree. See LDAP documentation for more details.

+

Choices:

+
    +
  • "1" ← (default)

  • +
  • "2"

  • +
+ +
+
+

serverPrincipal

+ +

+ string +

+
+

Full name of server principal for HTTP service including server and domain name. For example HTTP/host.foo.org@FOO.ORG. Use * to accept any service principal in the KeyTab file.

+
+
+

startTls

+ +

+ boolean +

+
+

Encrypts the connection to LDAP using STARTTLS, which disables connection pooling.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

syncRegistrations

+ +

+ boolean +

+
+

Should newly created users be created within LDAP store? Priority effects which provider is chosen to sync the new user.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

trustEmail

+ +

+ boolean +

+
+

If enabled, email provided by this provider is not verified even if verification is enabled for the realm.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

updateProfileFirstLogin

+ +

+ boolean +

+
+

Update profile on first login.

+

Choices:

+
    +
  • false

  • +
  • true

  • +
+ +
+
+

useKerberosForPasswordAuthentication

+ +

+ boolean +

+
+

Use Kerberos login module for authenticate username/password against Kerberos server instead of authenticating against LDAP server with Directory Service API.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

usePasswordModifyExtendedOp

+ +

+ boolean +

+
+

Use the LDAPv3 Password Modify Extended Operation (RFC-3062). The password modify extended operation usually requires that LDAP user already has password in the LDAP server. So when this is used with 'Sync Registrations', it can be good to add also 'Hardcoded LDAP attribute mapper' with randomly generated initial password.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

usernameLDAPAttribute

+ +

+ string +

+
+

Name of LDAP attribute, which is mapped as Keycloak username. For many LDAP server vendors it can be uid. For Active directory it can be sAMAccountName or cn. The attribute should be filled for all LDAP user records you want to import from LDAP to Keycloak.

+
+
+

userObjectClasses

+ +

+ string +

+
+

All values of LDAP objectClass attribute for users in LDAP divided by comma. For example inetOrgPerson, organizationalPerson. Newly created Keycloak users are written to LDAP with all those object classes and existing LDAP user records are found just if they contain all those object classes.

+
+
+

usersDn

+ +

+ string +

+
+

Full DN of LDAP tree where your users are. This DN is the parent of LDAP users.

+
+
+

useTruststoreSpi

+ +

+ string +

+
+

Specifies whether LDAP connection uses the truststore SPI with the truststore configured in standalone.xml/domain.xml. always means that it always uses it. never means that it does not use it. ldapsOnly means that it uses if your connection URL use ldaps.

+

Note even if standalone.xml/domain.xml is not configured, the default Java cacerts or certificate specified by javax.net.ssl.trustStore property is used.

+

Choices:

+
    +
  • "always"

  • +
  • "ldapsOnly" ← (default)

  • +
  • "never"

  • +
+ +
+
+

uuidLDAPAttribute

+ +

+ string +

+
+

Name of LDAP attribute, which is used as unique object identifier (UUID) for objects in LDAP. For many LDAP server vendors, it is entryUUID; however some are different. For example for Active directory it should be objectGUID. If your LDAP server does not support the notion of UUID, you can use any other attribute that is supposed to be unique among LDAP users in tree.

+
+
+

validatePasswordPolicy

+ +

+ boolean +

+
+

Determines if Keycloak should validate the password with the realm password policy before updating it.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

vendor

+ +

+ string +

+
+

LDAP vendor (provider).

+

Use short name. For instance, write rhds for "Red Hat Directory Server".

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

id

+ +

+ string +

+
+

The unique ID for this user federation. If left empty, the user federation is searched by its name.

+
+
+

mappers

+ +

+ list + / elements=dictionary +

+
+

A list of dicts defining mappers associated with this Identity Provider.

+
+
+

config

+ +

+ dictionary +

+
+

Dict specifying the configuration options for the mapper; the contents differ depending on the value of identityProviderMapper.

+
+
+

id

+ +

+ string +

+
+

Unique ID of this mapper.

+
+
+

name

+ +

+ string +

+
+

Name of the mapper. If no ID is given, the mapper is searched by name.

+
+
+

parentId

+ +

+ string +

+
+

Unique ID for the parent of this mapper. ID of the user federation is automatically used if left blank.

+
+
+

providerId

+ +

+ string +

+
+

The mapper type for this mapper (for instance user-attribute-ldap-mapper).

+
+
+

providerType

+ +

+ string +

+
+

Component type for this mapper.

+

Default: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"

+
+
+

name

+ +

+ string +

+
+

Display name of provider when linked in admin console.

+
+
+
+

parent_id

+ +

aliases: parentId

+

+ string +

+
+

Unique ID for the parent of this user federation. Realm ID is automatically used if left blank.

+
+
+
+

provider_id

+ +

aliases: providerId

+

+ string +

+
+

Provider for this user federation. Built-in providers are ldap, kerberos, and sssd. Custom user storage providers can also be used.

+
+
+
+

provider_type

+ +

aliases: providerType

+

+ string +

+
+

Component type for user federation (only supported value is org.keycloak.storage.UserStorageProvider).

+

Default: "org.keycloak.storage.UserStorageProvider"

+
+
+

realm

+ +

+ string +

+
+

The Keycloak realm under which this user federation resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

remove_unspecified_mappers

+ +

+ boolean +

+
+

Remove mappers that are not specified in the configuration for this federation.

+

Set to false to keep mappers that are not listed in mappers.

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

state

+ +

+ string +

+
+

State of the user federation.

+

On present, the user federation is created if it does not yet exist, or updated with the parameters you provide.

+

On absent, the user federation is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: full

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Create LDAP user federation
+  middleware_automation.keycloak.keycloak_user_federation:
+    auth_keycloak_url: https://keycloak.example.com
+    auth_realm: master
+    auth_username: admin
+    auth_password: password
+    realm: my-realm
+    name: my-ldap
+    state: present
+    provider_id: ldap
+    provider_type: org.keycloak.storage.UserStorageProvider
+    config:
+      priority: 0
+      enabled: true
+      cachePolicy: DEFAULT
+      batchSizeForSync: 1000
+      editMode: READ_ONLY
+      importEnabled: true
+      syncRegistrations: false
+      vendor: other
+      usernameLDAPAttribute: uid
+      rdnLDAPAttribute: uid
+      uuidLDAPAttribute: entryUUID
+      userObjectClasses: inetOrgPerson, organizationalPerson
+      connectionUrl: ldaps://ldap.example.com:636
+      usersDn: ou=Users,dc=example,dc=com
+      authType: simple
+      bindDn: cn=directory reader
+      bindCredential: password
+      searchScope: 1
+      validatePasswordPolicy: false
+      trustEmail: false
+      useTruststoreSpi: ldapsOnly
+      connectionPooling: true
+      pagination: true
+      allowKerberosAuthentication: false
+      debug: false
+      useKerberosForPasswordAuthentication: false
+    mappers:
+      - name: "full name"
+        providerId: "full-name-ldap-mapper"
+        providerType: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
+        config:
+          ldap.full.name.attribute: cn
+          read.only: true
+          write.only: false
+
+- name: Create Kerberos user federation
+  middleware_automation.keycloak.keycloak_user_federation:
+    auth_keycloak_url: https://keycloak.example.com
+    auth_realm: master
+    auth_username: admin
+    auth_password: password
+    realm: my-realm
+    name: my-kerberos
+    state: present
+    provider_id: kerberos
+    provider_type: org.keycloak.storage.UserStorageProvider
+    config:
+      priority: 0
+      enabled: true
+      cachePolicy: DEFAULT
+      kerberosRealm: EXAMPLE.COM
+      serverPrincipal: HTTP/host.example.com@EXAMPLE.COM
+      keyTab: keytab
+      allowPasswordAuthentication: false
+      updateProfileFirstLogin: false
+
+- name: Create sssd user federation
+  middleware_automation.keycloak.keycloak_user_federation:
+    auth_keycloak_url: https://keycloak.example.com
+    auth_realm: master
+    auth_username: admin
+    auth_password: password
+    realm: my-realm
+    name: my-sssd
+    state: present
+    provider_id: sssd
+    provider_type: org.keycloak.storage.UserStorageProvider
+    config:
+      priority: 0
+      enabled: true
+      cachePolicy: DEFAULT
+
+- name: Delete user federation
+  middleware_automation.keycloak.keycloak_user_federation:
+    auth_keycloak_url: https://keycloak.example.com
+    auth_realm: master
+    auth_username: admin
+    auth_password: password
+    realm: my-realm
+    name: my-federation
+    state: absent
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of user federation after module execution.

+

Returned: on success

+

Sample: {"config": {"allowPasswordAuthentication": "false", "cachePolicy": "DEFAULT", "enabled": "true", "kerberosRealm": "EXAMPLE.COM", "keyTab": "/etc/krb5.keytab", "priority": "0", "serverPrincipal": "HTTP/host.example.com@EXAMPLE.COM", "updateProfileFirstLogin": "false"}, "id": "cf52ae4f-4471-4435-a0cf-bb620cadc122", "mappers": [], "name": "kerberos", "parentId": "myrealm", "providerId": "kerberos", "providerType": "org.keycloak.storage.UserStorageProvider"}

+
+
+

existing

+ +

+ dictionary +

+
+

Representation of existing user federation.

+

Returned: always

+

Sample: {"config": {"allowKerberosAuthentication": "false", "authType": "simple", "batchSizeForSync": "1000", "bindCredential": "**********", "bindDn": "cn=directory reader", "cachePolicy": "DEFAULT", "changedSyncPeriod": "-1", "connectionPooling": "true", "connectionUrl": "ldaps://ldap.example.com:636", "debug": "false", "editMode": "READ_ONLY", "enabled": "true", "fullSyncPeriod": "-1", "importEnabled": "true", "pagination": "true", "priority": "0", "rdnLDAPAttribute": "uid", "searchScope": "1", "syncRegistrations": "false", "trustEmail": "false", "useKerberosForPasswordAuthentication": "false", "useTruststoreSpi": "ldapsOnly", "userObjectClasses": "inetOrgPerson, organizationalPerson", "usernameLDAPAttribute": "uid", "usersDn": "ou=Users,dc=example,dc=com", "uuidLDAPAttribute": "entryUUID", "validatePasswordPolicy": "false", "vendor": "other"}, "id": "01122837-9047-4ae4-8ca0-6e2e891a765f", "mappers": [{"config": {"always.read.value.from.ldap": "false", "is.mandatory.in.ldap": "false", "ldap.attribute": "mail", "read.only": "true", "user.model.attribute": "email"}, "id": "17d60ce2-2d44-4c2c-8b1f-1fba601b9a9f", "name": "email", "parentId": "01122837-9047-4ae4-8ca0-6e2e891a765f", "providerId": "user-attribute-ldap-mapper", "providerType": "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"}], "name": "myfed", "parentId": "myrealm", "providerId": "ldap", "providerType": "org.keycloak.storage.UserStorageProvider"}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: "No changes required to user federation 164bb483-c613-482e-80fe-7f1431308799."

+
+
+

proposed

+ +

+ dictionary +

+
+

Representation of proposed user federation.

+

Returned: always

+

Sample: {"config": {"allowKerberosAuthentication": "false", "authType": "simple", "batchSizeForSync": "1000", "bindCredential": "**********", "bindDn": "cn=directory reader", "cachePolicy": "DEFAULT", "connectionPooling": "true", "connectionUrl": "ldaps://ldap.example.com:636", "debug": "false", "editMode": "READ_ONLY", "enabled": "true", "importEnabled": "true", "pagination": "true", "priority": "0", "rdnLDAPAttribute": "uid", "searchScope": "1", "syncRegistrations": "false", "trustEmail": "false", "useKerberosForPasswordAuthentication": "false", "useTruststoreSpi": "ldapsOnly", "userObjectClasses": "inetOrgPerson, organizationalPerson", "usernameLDAPAttribute": "uid", "usersDn": "ou=Users,dc=example,dc=com", "uuidLDAPAttribute": "entryUUID", "validatePasswordPolicy": "false", "vendor": "other"}, "name": "ldap", "providerId": "ldap", "providerType": "org.keycloak.storage.UserStorageProvider"}

+
+

Authors

+
    +
  • Laurent Paumier (@laurpaum)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_user_rolemapping.html b/3.1.2/plugins/keycloak_user_rolemapping.html new file mode 100644 index 0000000..57bbc55 --- /dev/null +++ b/3.1.2/plugins/keycloak_user_rolemapping.html @@ -0,0 +1,760 @@ + + + + + + + + + + keycloak_user_rolemapping – Allows administration of Keycloak user_rolemapping with the Keycloak API — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • + View page source +
  • +
+
+
+
+
+ +
+

keycloak_user_rolemapping – Allows administration of Keycloak user_rolemapping with the Keycloak API

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_user_rolemapping.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows you to add, remove or modify Keycloak user_rolemapping with the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.

  • +
  • The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at https://www.keycloak.org/docs-api/latest/rest-api/index.html.

  • +
  • Attributes are multi-valued in the Keycloak API. All attributes are lists of individual values and are returned that way by this module. You may pass single values for attributes when calling the module, and this is translated into a list suitable for the API.

  • +
  • When updating a user_rolemapping, where possible provide the role ID to the module. This removes a lookup to the API to translate the name into the role ID.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

cid

+ +

+ string +

+
+

ID of the client whose role is to be mapped.

+

This parameter is not required for updating or deleting the rolemapping but providing it reduces the number of API calls required.

+

If neither cid nor client_id is specified, a realm role is mapped instead.

+
+
+

client_id

+ +

+ string +

+
+

Name of the client (different than cid) whose role is to be mapped.

+

This parameter is required if cid is not provided (can be replaced by cid to reduce the number of API calls that must be made).

+

If neither cid nor client_id is specified, a realm role is mapped instead.

+
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+

realm

+ +

+ string +

+
+

They Keycloak realm under which this role_representation resides.

+

Default: "master"

+
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

roles

+ +

+ list + / elements=dictionary +

+
+

Roles to be mapped to the user.

+
+
+

id

+ +

+ string +

+
+

The unique identifier for this role_representation.

+

This parameter is not required for updating or deleting a role_representation but providing it reduces the number of API calls required.

+
+
+

name

+ +

+ string +

+
+

Name of the role representation.

+

This parameter is required only when creating or updating the role_representation.

+
+
+

service_account_user_client_id

+ +

+ string +

+
+

Client ID of the service-account-user to be mapped.

+

This parameter is not required for updating or deleting the rolemapping but providing it reduces the number of API calls required.

+
+
+

state

+ +

+ string +

+
+

State of the user_rolemapping.

+

On present, the user_rolemapping is created if it does not yet exist, or updated with the parameters you provide.

+

On absent, the user_rolemapping is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

target_username

+ +

+ string +

+
+

Username of the user roles are mapped to.

+

This parameter is not required (can be replaced by uid for less API call).

+
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

uid

+ +

+ string +

+
+

ID of the user to be mapped.

+

This parameter is not required for updating or deleting the rolemapping but providing it reduces the number of API calls required.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: full

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Examples

+
- name: Map a realm role to a user, authentication with credentials
+  middleware_automation.keycloak.keycloak_user_rolemapping:
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    state: present
+    uid: user_uid
+    roles:
+      - name: role_name1
+        id: role_id1
+      - name: role_name2
+        id: role_id2
+  delegate_to: localhost
+
+- name: Map a client role to a user, authentication with credentials
+  middleware_automation.keycloak.keycloak_user_rolemapping:
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    state: present
+    client_id: client1
+    uid: user_uid
+    roles:
+      - name: role_name1
+        id: role_id1
+      - name: role_name2
+        id: role_id2
+  delegate_to: localhost
+
+- name: Map a client role to a service account user for a client, authentication with credentials
+  middleware_automation.keycloak.keycloak_user_rolemapping:
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    state: present
+    client_id: client1
+    service_account_user_client_id: clientIdOfServiceAccount
+    roles:
+      - name: role_name1
+        id: role_id1
+      - name: role_name2
+        id: role_id2
+  delegate_to: localhost
+
+- name: Map a client role to a user, authentication with token
+  middleware_automation.keycloak.keycloak_user_rolemapping:
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    token: TOKEN
+    state: present
+    client_id: client1
+    target_username: user1
+    roles:
+      - name: role_name1
+        id: role_id1
+      - name: role_name2
+        id: role_id2
+  delegate_to: localhost
+
+- name: Unmap client role from a user
+  middleware_automation.keycloak.keycloak_user_rolemapping:
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+    state: absent
+    client_id: client1
+    uid: 70e3ae72-96b6-11e6-9056-9737fd4d0764
+    roles:
+      - name: role_name1
+        id: role_id1
+      - name: role_name2
+        id: role_id2
+  delegate_to: localhost
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+
+

end_state

+ +

+ dictionary +

+
+

Representation of client role mapping after module execution.

+

The sample is truncated.

+

Returned: on success

+

Sample: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}

+
+
+

existing

+ +

+ dictionary +

+
+

Representation of existing client role mapping.

+

The sample is truncated.

+

Returned: always

+

Sample: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}

+
+
+

msg

+ +

+ string +

+
+

Message as to what action was taken.

+

Returned: always

+

Sample: "Role role1 assigned to user user1."

+
+
+

proposed

+ +

+ dictionary +

+
+

Representation of proposed client role mapping.

+

Returned: always

+

Sample: {"clientId": "test"}

+
+

Authors

+
    +
  • Dušan Marković (@bratwurzt)

  • +
  • Ivan Kokalović (@koke1997)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/plugins/keycloak_userprofile.html b/3.1.2/plugins/keycloak_userprofile.html new file mode 100644 index 0000000..2d6f4b1 --- /dev/null +++ b/3.1.2/plugins/keycloak_userprofile.html @@ -0,0 +1,1325 @@ + + + + + + + + + + keycloak_userprofile – Allows managing Keycloak User Profiles — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

keycloak_userprofile – Allows managing Keycloak User Profiles

+
+

Note

+

This module is part of the middleware_automation.keycloak collection.

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install middleware_automation.keycloak.

+

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_userprofile.

+
+

New in middleware_automation.keycloak 3.0.0

+ +
+

Synopsis

+
    +
  • This module allows you to create, update, or delete Keycloak User Profiles using the Keycloak API. You can also customize the “Unmanaged Attributes” with it.

  • +
  • The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at https://www.keycloak.org/docs-api/24.0.5/rest-api/index.html. For compatibility reasons, the module also accepts the camelCase versions of the options.

  • +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

auth_client_id

+ +

+ string +

+
+

OpenID Connect client_id to authenticate to the API with.

+

Default: "admin-cli"

+
+
+

auth_client_secret

+ +

+ string +

+
+

Client Secret to use in conjunction with auth_client_id (if required).

+
+
+
+

auth_keycloak_url

+ +

aliases: url

+

+ string + / required +

+
+

URL to the Keycloak instance.

+
+
+
+

auth_password

+ +

aliases: password

+

+ string +

+
+

Password to authenticate for API access with.

+
+
+

auth_realm

+ +

+ string +

+
+

Keycloak realm name to authenticate to for API access.

+
+
+
+

auth_username

+ +

aliases: username

+

+ string +

+
+

Username to authenticate for API access with.

+
+
+

config

+ +

+ dictionary +

+
+

The configuration of the User Profile Provider.

+
+
+
+

kc_user_profile_config

+ +

aliases: kcUserProfileConfig

+

+ list + / elements=dictionary +

+
+

Define a declarative User Profile. See EXAMPLES for more context.

+
+
+
+

attributes

+ +

+ list + / elements=dictionary +

+
+

A list of attributes to be included in the User Profile.

+
+
+
+

annotations

+ +

+ dictionary +

+
+

Annotations for the attribute.

+
+
+
+
+
+

display_name

+ +

aliases: displayName

+

+ string + / required +

+
+

The display name of the attribute.

+
+
+
+

group

+ +

+ string +

+
+

Specifies the User Profile group where this attribute is added.

+
+
+
+

multivalued

+ +

+ boolean +

+
+

Whether the attribute can have multiple values.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+
+

name

+ +

+ string + / required +

+
+

The name of the attribute.

+
+
+
+

permissions

+ +

+ dictionary +

+
+

The permissions for viewing and editing the attribute.

+
+
+
+

edit

+ +

+ list + / elements=string +

+
+

The roles that can edit the attribute.

+

Supported values are admin and user.

+

Default: ["admin", "user"]

+
+
+
+

view

+ +

+ list + / elements=string +

+
+

The roles that can view the attribute.

+

Supported values are admin and user.

+

Default: ["admin", "user"]

+
+
+
+

required

+ +

+ dictionary +

+
+

The roles that require this attribute.

+
+
+
+

roles

+ +

+ list + / elements=string +

+
+

The roles for which this attribute is required.

+

Supported values are admin and user.

+

Default: ["user"]

+
+
+
+

selector

+ +

+ dictionary +

+
+

Selector when the attribute should be added.

+
+
+
+

scopes

+ +

+ list + / elements=string +

+
+

Scopes to which the attribute should be added.

+
+
+
+

validations

+ +

+ dictionary +

+
+

The validations to be applied to the attribute.

+
+
+
+

double

+ +

+ dictionary +

+
+

The double validation for the attribute.

+
+
+
+

email

+ +

+ dictionary +

+
+

The email validation for the attribute.

+
+
+
+

integer

+ +

+ dictionary +

+
+

The integer validation for the attribute.

+
+
+
+
+
+

iso_date

+ +

aliases: isoDate

+

+ dictionary +

+
+

The iso-date validation for the attribute.

+
+
+
+

length

+ +

+ dictionary +

+
+

The length validation for the attribute.

+
+
+
+

max

+ +

+ integer + / required +

+
+

The maximum length of the attribute.

+
+
+
+

min

+ +

+ integer +

+
+

The minimum length of the attribute.

+
+
+
+
+
+

local_date

+ +

aliases: localDate

+

+ dictionary +

+
+

The local-date validation for the attribute.

+
+
+
+

multivalued

+ +

+ dictionary +

+
+

The multivalued validation for the attribute.

+
+
+
+

max

+ +

+ integer + / required +

+
+

The maximum amount of values of the attribute.

+
+
+
+

min

+ +

+ integer +

+
+

The minimum amount of values of the attribute.

+
+
+
+

options

+ +

+ dictionary +

+
+

Validation to ensure the attribute matches one of the provided options.

+
+
+
+

pattern

+ +

+ dictionary +

+
+

The pattern validation for the attribute using regular expressions.

+
+
+
+
+
+

person_name_prohibited_characters

+ +

aliases: personNameProhibitedCharacters

+

+ dictionary +

+
+

The prohibited characters validation for person name attributes.

+
+
+
+
+
+

up_username_not_idn_homograph

+ +

aliases: upUsernameNotIdnHomograph

+

+ dictionary +

+
+

The validation to prevent IDN homograph attacks in usernames.

+
+
+
+

uri

+ +

+ dictionary +

+
+

The URI validation for the attribute.

+
+
+
+
+
+

username_prohibited_characters

+ +

aliases: usernameProhibitedCharacters

+

+ dictionary +

+
+

The prohibited characters validation for the username attribute.

+
+
+
+

groups

+ +

+ list + / elements=dictionary +

+
+

A list of attribute groups to be included in the User Profile.

+
+
+
+

annotations

+ +

+ dictionary +

+
+

The annotations included in the group.

+
+
+
+
+
+

display_description

+ +

aliases: displayDescription

+

+ string +

+
+

The display description for the group.

+
+
+
+
+
+

display_header

+ +

aliases: displayHeader

+

+ string + / required +

+
+

The display header for the group.

+
+
+
+

name

+ +

+ string + / required +

+
+

The name of the group.

+
+
+
+
+
+

unmanaged_attribute_policy

+ +

aliases: unmanagedAttributePolicy

+

+ string +

+
+

Policy for unmanaged attributes.

+

Choices:

+
    +
  • "ENABLED"

  • +
  • "ADMIN_EDIT"

  • +
  • "ADMIN_VIEW"

  • +
+ +
+
+

connection_timeout

+ +

+ integer +

+
+

Controls the HTTP connections timeout period (in seconds) to Keycloak API.

+

Default: 10

+
+
+

http_agent

+ +

+ string +

+
+

Configures the HTTP User-Agent header.

+

Default: "Ansible"

+
+
+
+
+

parent_id

+ +

aliases: parentId, realm

+

+ string + / required +

+
+

The parent ID of the realm key. In practice the ID (name) of the realm.

+
+
+
+

provider_id

+ +

aliases: providerId

+

+ string +

+
+

The name of the provider ID for the key (supported value is declarative-user-profile).

+

Choices:

+
    +
  • "declarative-user-profile" ← (default)

  • +
+ +
+
+
+

provider_type

+ +

aliases: providerType

+

+ string +

+
+

Component type for User Profile (only supported value is org.keycloak.userprofile.UserProfileProvider).

+

Choices:

+
    +
  • "org.keycloak.userprofile.UserProfileProvider" ← (default)

  • +
+ +
+
+

refresh_token

+ +

+ string +

+
+

Authentication refresh token for Keycloak API.

+
+
+

state

+ +

+ string +

+
+

State of the User Profile provider.

+

On present, the User Profile provider is created if it does not yet exist, or updated with the parameters you provide.

+

On absent, the User Profile provider is removed if it exists.

+

Choices:

+
    +
  • "present" ← (default)

  • +
  • "absent"

  • +
+ +
+
+

token

+ +

+ string +

+
+

Authentication token for Keycloak API.

+
+
+

use_netrc

+ +

+ boolean +

+
+

Whether to use credentials from ~/.netrc file.

+

By default, ~/.netrc is not used because these modules authenticate via explicit OIDC credentials/token. A matching ~/.netrc entry would silently override the Bearer token with Basic authentication, causing 401 errors.

+

Choices:

+
    +
  • false ← (default)

  • +
  • true

  • +
+ +
+
+

validate_certs

+ +

+ boolean +

+
+

Verify TLS certificates (do not disable this in production).

+

Choices:

+
    +
  • false

  • +
  • true ← (default)

  • +
+ +
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + +

Attribute

Support

Description

+

action_group

+

Action group: middleware_automation.keycloak.keycloak

+

added in middleware_automation.keycloak 3.0.0

+

Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.

+
+

check_mode

+

Support: full

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: full

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

Notes

+
+

Note

+
    +
  • Currently, only a single declarative-user-profile entry is supported for provider_id (design of the Keyckoak API). However, there can be multiple config.kc_user_profile_config[].attributes[] entries.

  • +
+
+
+
+

Examples

+
- name: Create a Declarative User Profile with default settings
+  middleware_automation.keycloak.keycloak_userprofile:
+    state: present
+    parent_id: master
+    config:
+      kc_user_profile_config:
+        - attributes:
+            - name: username
+              displayName: ${username}
+              validations:
+                length:
+                  min: 3
+                  max: 255
+                username_prohibited_characters: {}
+                up_username_not_idn_homograph: {}
+              annotations: {}
+              permissions:
+                view:
+                  - admin
+                  - user
+                edit: []
+              multivalued: false
+            - name: email
+              displayName: ${email}
+              validations:
+                email: {}
+                length:
+                  max: 255
+              annotations: {}
+              required:
+                roles:
+                  - user
+              permissions:
+                view:
+                  - admin
+                  - user
+                edit: []
+              multivalued: false
+            - name: firstName
+              displayName: ${firstName}
+              validations:
+                length:
+                  max: 255
+                person_name_prohibited_characters: {}
+              annotations: {}
+              required:
+                roles:
+                  - user
+              permissions:
+                view:
+                  - admin
+                  - user
+                edit: []
+              multivalued: false
+            - name: lastName
+              displayName: ${lastName}
+              validations:
+                length:
+                  max: 255
+                person_name_prohibited_characters: {}
+              annotations: {}
+              required:
+                roles:
+                  - user
+              permissions:
+                view:
+                  - admin
+                  - user
+                edit: []
+              multivalued: false
+            - name: testAttribute
+              displayName: ${testAttribute}
+              validations:
+                integer:
+                  min: 0
+                  max: 255
+              annotations: {}
+              required:
+                roles:
+                  - user
+              permissions:
+                view:
+                  - admin
+                  - user
+                edit: []
+              multivalued: false
+          groups:
+            - name: user-metadata
+              displayHeader: User metadata
+              displayDescription: Attributes, which refer to user metadata
+              annotations: {}
+
+- name: Delete a Keycloak User Profile Provider
+  keycloak_userprofile:
+    state: absent
+    parent_id: master
+
+# Unmanaged attributes are user attributes not explicitly defined in the User Profile
+# configuration. By default, unmanaged attributes are "Disabled" and are not
+# available from any context such as registration, account, and the
+# administration console. By setting "Enabled", unmanaged attributes are fully
+# recognized by the server and accessible through all contexts, useful if you are
+# starting migrating an existing realm to the declarative User Profile
+# and you don't have yet all user attributes defined in the User Profile configuration.
+- name: Enable Unmanaged Attributes
+  middleware_automation.keycloak.keycloak_userprofile:
+    state: present
+    parent_id: master
+    config:
+      kc_user_profile_config:
+        - unmanagedAttributePolicy: ENABLED
+
+# By setting "Only administrators can write", unmanaged attributes can be managed
+# only through the administration console and API, useful if you have already
+# defined any custom attribute that can be managed by users but you are unsure
+# about adding other attributes that should only be managed by administrators.
+- name: Enable ADMIN_EDIT on Unmanaged Attributes
+  middleware_automation.keycloak.keycloak_userprofile:
+    state: present
+    parent_id: master
+    config:
+      kc_user_profile_config:
+        - unmanagedAttributePolicy: ADMIN_EDIT
+
+# By setting `Only administrators can view`, unmanaged attributes are read-only
+# and only available through the administration console and API.
+- name: Enable ADMIN_VIEW on Unmanaged Attributes
+  middleware_automation.keycloak.keycloak_userprofile:
+    state: present
+    parent_id: master
+    config:
+      kc_user_profile_config:
+        - unmanagedAttributePolicy: ADMIN_VIEW
+
+
+
+
+

Return Values

+

Common return values are documented here, the following are the fields unique to this module:

+ + + + + + + + + + + + + + + + + +

Key

Description

+
+

data

+ +

+ dictionary +

+
+

The data returned by the Keycloak API.

+

Returned: when state is present

+
+
+

msg

+ +

+ string +

+
+

The output message generated by the module.

+

Returned: always

+

Sample: "UserProfileProvider created successfully"

+
+

Authors

+
    +
  • Eike Waldt (@yeoldegrove)

  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/releasing.html b/3.1.2/releasing.html new file mode 100644 index 0000000..01d9a82 --- /dev/null +++ b/3.1.2/releasing.html @@ -0,0 +1,186 @@ + + + + + + + + + Collection Versioning Strategy — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Collection Versioning Strategy

+

Each supported collection maintained by Ansible follows Semantic Versioning 2.0.0 (https://semver.org/), for example: +Given a version number MAJOR.MINOR.PATCH, the following is incremented:

+

MAJOR version: when making incompatible API changes (see Feature Release scenarios below for examples)

+

MINOR version: when adding features or functionality in a backwards compatible manner, or updating testing matrix and/or metadata (deprecation)

+

PATCH version: when adding backwards compatible bug fixes or security fixes (strict).

+

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

+

The first version of a generally available supported collection on Ansible Automation Hub shall be version 1.0.0. NOTE: By default, all newly created collections may begin with a smaller default version of 0.1.0, and therefore a version of 1.0.0 should be explicitly stated by the collection maintainer.

+
+

New content is added to an existing collection

+

Assuming the current release is 1.0.0, and a new module is ready to be added to the collection, the minor version would be incremented to 1.1.0. The change in the MINOR version indicates an additive change was made while maintaining backward compatibility for existing content within the collection.

+
+
+

New feature to existing plugin or role within a collection (backwards compatible)

+

Assuming the current release is 1.0.0, and new features for an existing module are ready for release . We would increment the MINOR version to 1.1.0. The change in the MINOR version indicates an additive change was made while maintaining backward compatibility for existing content within the collection.

+
+
+

Bug fix or security fix to existing content within a collection

+

Assuming the current release is 1.0.0 and a bug is fixed prior to the next minor release, the PATCH version would be incremented to 1.0.1. The patch indicates only a bug was fixed within a current version. The PATCH release does not contain new content, nor was functionality removed. Bug fixes may be included in a MINOR or MAJOR feature release if the timing allows, eliminating the need for a PATCH dedicated to the fix.

+
+
+

Breaking change to any content within a collection

+

Assuming the current release is 1.0.0, and a breaking change (API or module) is introduced for a user or developer. The MAJOR version would be incremented to 2.0.0.

+

Examples of breaking changes within a collection may include but are not limited to:

+
    +
  • Argspec changes for a module that require either inventory structure or playbook changes.

  • +
  • A change in the shape of either the inbound or returned payload of a filter plugin.

  • +
  • Changes to a connection plugin that require additional inventory parameters or ansible.cfg entries.

  • +
  • New functionality added to a module that changes the outcome of that module as released in previous versions.

  • +
  • The removal of plugins from a collection.

  • +
+
+
+

Content removed from a collection

+

Deleting a module or API is a breaking change. Please see the ‘Breaking change’ section for how to version this.

+
+
+

A typographical error was fixed in the documentation for a collection

+

A correction to the README would be considered a bug fix and the PATCH incremented. See ‘Bug fix’ above.

+
+
+

Documentation added/removed/modified within a collection

+

Only the PATCH version should be increased for a release that contains changes limited to revised documentation.

+
+
+

Release automation

+

New releases are triggered by annotated git tags named after semantic versioning. The automation publishes the built artifacts to ansible-galaxy and github releases page.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/roles/index.html b/3.1.2/roles/index.html new file mode 100644 index 0000000..a2b0324 --- /dev/null +++ b/3.1.2/roles/index.html @@ -0,0 +1,187 @@ + + + + + + + + + Role Index — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ + +
+
+ + + + \ No newline at end of file diff --git a/3.1.2/roles/keycloak.html b/3.1.2/roles/keycloak.html new file mode 100644 index 0000000..51a9ef3 --- /dev/null +++ b/3.1.2/roles/keycloak.html @@ -0,0 +1,645 @@ + + + + + + + + + keycloak — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

keycloak

+

Install keycloak or Red Hat Single Sign-On server configurations.

+
+

Requirements

+

This role requires the python3-netaddr library installed on the controller node.

+
    +
  • to install via yum/dnf: dnf install python3-netaddr

  • +
  • to install via apt: apt install python3-netaddr

  • +
  • or via pip: pip install netaddr==0.8.0

  • +
  • or via the collection: pip install -r requirements.txt

  • +
+
+
+

Dependencies

+

The roles depends on:

+ +

To install all the dependencies via galaxy:

+
ansible-galaxy collection install -r requirements.yml
+
+
+
+
+

Versions

+ + + + + + + + + + + + + + + + + + + + + + + +

RH-SSO VERSION

Release Date

Keycloak Version

EAP Version

Notes

7.5.0 GA

September 20, 2021

15.0.2

7.4.6

Release Notes

7.6.0 GA

June 30, 2022

18.0.3

7.4.6

Release Notes

+
+
+

Patching

+

When variable keycloak_rhsso_apply_patches is true (default: false), the role will automatically apply the latest cumulative patch for the selected base version.

+ + + + + + + + + + + + + + + + + + + + +

RH-SSO VERSION

Release Date

RH-SSO LATEST CP

Notes

7.5.0 GA

January 20, 2022

7.5.3 GA

Release Notes

7.6.0 GA

November 11, 2022

7.6.1 GA

Release Notes

+
+
+

Role Defaults

+
    +
  • Service configuration

  • +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Variable

Description

Default

keycloak_ha_enabled

Enable auto configuration for database backend, clustering and remote caches on infinispan

False

keycloak_ha_discovery

Discovery protocol for HA cluster members

JDBC_PING if keycloak_db_enabled else TCPPING

keycloak_db_enabled

Enable auto configuration for database backend

True if keycloak_ha_enabled is True, else False

keycloak_remote_cache_enabled

Enable remote cache store when in clustered ha configurations

True if keycloak_ha_enabled else False

keycloak_admin_user

Administration console user account

admin

keycloak_bind_address

Address for binding service ports

0.0.0.0

keycloak_management_port_bind_address

Address for binding management ports

127.0.0.1

keycloak_host

hostname

localhost

keycloak_http_port

HTTP port

8080

keycloak_https_port

TLS HTTP port

8443

keycloak_ajp_port

AJP port

8009

keycloak_jgroups_port

jgroups cluster tcp port

7600

keycloak_management_http_port

Management port

9990

keycloak_management_https_port

TLS management port

9993

keycloak_prefer_ipv4

Prefer IPv4 stack and addresses for port binding

true

keycloak_config_standalone_xml

filename for configuration

keycloak.xml

keycloak_service_user

posix account username

keycloak

keycloak_service_group

posix account group

keycloak

keycloak_service_restart_always

systemd restart always behavior activation

False

keycloak_service_restart_on_failure

systemd restart on-failure behavior activation

False

keycloak_service_startlimitintervalsec

systemd StartLimitIntervalSec

300

keycloak_service_startlimitburst

systemd StartLimitBurst

5

keycloak_service_restartsec

systemd RestartSec

10s

keycloak_service_pidfile

pid file path for service

/run/keycloak/keycloak.pid

keycloak_features

List of name/status pairs of features (also known as profiles on RH-SSO) to enable or disable, example: [ { name: 'docker', status: 'enabled' } ]

[]

keycloak_jvm_package

RHEL java package runtime

java-1.8.0-openjdk-headless

keycloak_java_home

JAVA_HOME of installed JRE, leave empty for using RPM path at keycloak_jvm_package

None

keycloak_java_opts

Additional JVM options

-Xms1024m -Xmx2048m

+
    +
  • Install options

  • +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Variable

Description

Default

keycloak_offline_install

perform an offline install

false

keycloak_download_url

Download URL for keycloak

https://github.com/keycloak/keycloak/releases/download/<version>/<archive>

keycloak_version

keycloak.org package version

18.0.2

keycloak_dest

Installation root path

/opt/keycloak

keycloak_download_url

Download URL for keycloak

https://github.com/keycloak/keycloak/releases/download/{{ keycloak_version }}/{{ keycloak_archive }}

keycloak_configure_firewalld

Ensure firewalld is running and configure keycloak ports

false

+
    +
  • Miscellaneous configuration

  • +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Variable

Description

Default

keycloak_archive

keycloak install archive filename

keycloak-legacy-{{ keycloak_version }}.zip

keycloak_download_url_9x

Download URL for keycloak (deprecated)

https://downloads.jboss.org/keycloak/{{ keycloak_version }}/{{ keycloak_archive }}

keycloak_installdir

Installation path

{{ keycloak_dest }}/keycloak-{{ keycloak_version }}

keycloak_jboss_home

Installation work directory

{{ keycloak_rhsso_installdir }}

keycloak_jboss_port_offset

Port offset for the JBoss socket binding

0

keycloak_config_dir

Path for configuration

{{ keycloak_jboss_home }}/standalone/configuration

keycloak_config_path_to_standalone_xml

Custom path for configuration

{{ keycloak_jboss_home }}/standalone/configuration/{{ keycloak_config_standalone_xml }}

keycloak_config_override_template

Path to custom template for standalone.xml configuration

''

keycloak_auth_realm

Name for rest authentication realm

master

keycloak_auth_client

Authentication client for configuration REST calls

admin-cli

keycloak_force_install

Remove pre-existing versions of service

false

keycloak_url

URL for configuration rest calls

http://{{ keycloak_host }}:{{ keycloak_http_port + keycloak_jboss_port_offset }}

keycloak_management_url

URL for management console rest calls

http://{{ keycloak_host }}:{{ keycloak_management_http_port + keycloak_jboss_port_offset }}

keycloak_frontend_url_force

Force backend requests to use the frontend URL

false

keycloak_db_background_validation

Enable background validation of database connection

false

keycloak_db_background_validation_millis

How frequently the connection pool is validated in the background

10000 if background validation enabled

keycloak_db_background_validate_on_match

Enable validate on match for database connections

false

keycloak_frontend_url

frontend URL for keycloak endpoint

http://localhost:8080/auth/

keycloak_log_target

Set the destination of the keycloak log folder link

/var/log/keycloak

+
+
+

Role Variables

+

The following are a set of required variables for the role:

+ + + + + + + + + + + + + + +

Variable

Description

keycloak_admin_password

Password for the administration console user account (minimum 12 characters)

keycloak_frontend_url

frontend URL for keycloak endpoint

+

The following parameters are required only when keycloak_ha_enabled is true:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Variable

Description

Default

keycloak_modcluster_enabled

Enable configuration for modcluster subsystem

True if keycloak_ha_enabled is True, else False

keycloak_modcluster_url

deprecated Host for the modcluster reverse proxy

localhost

keycloak_modcluster_port

deprecated Port for the modcluster reverse proxy

6666

keycloak_modcluster_urls

List of {host,port} dicts for the modcluster reverse proxies

[ { localhost:6666 } ]

keycloak_jdbc_engine

backend database engine when db is enabled: [ postgres, mariadb, sqlserver ]

postgres

keycloak_infinispan_url

URL for the infinispan remote-cache server

localhost:11122

keycloak_infinispan_user

username for connecting to infinispan

supervisor

keycloak_infinispan_pass

password for connecting to infinispan

supervisor

keycloak_infinispan_sasl_mechanism

Authentication type

SCRAM-SHA-512

keycloak_infinispan_use_ssl

Enable hotrod TLS communication

False

keycloak_infinispan_trust_store_path

Path to truststore with infinispan server certificate

/etc/pki/java/cacerts

keycloak_infinispan_trust_store_password

Password for opening truststore

changeit

+

The following parameters are required only when keycloak_db_enabled is true:

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Variable

Description

Default

keycloak_jdbc_url

URL for the postgres backend database

jdbc:postgresql://localhost:5432/keycloak

keycloak_jdbc_driver_version

Version for the JDBC driver to download

9.4.1212

keycloak_db_user

username for connecting to postgres

keycloak-user

keycloak_db_pass

password for connecting to postgres

keycloak-pass

+

The following variables are optional:

+ + + + + + + + + + + + + + + + + +

Variable

Description

keycloak_db_valid_conn_sql

Override the default database connection validation query sql

keycloak_admin_url

Override the default administration endpoint URL

keycloak_jgroups_subnet

Override the subnet match for jgroups cluster formation; if not defined, it will be inferred from local machine route configuration

+
+
+

Example Playbook

+
    +
  • The following is an example playbook that makes use of the role to install keycloak from remote:

  • +
+
---
+- hosts: ...
+      vars:
+        keycloak_admin_password: "remembertochangeme"
+      roles:
+        - middleware_automation.keycloak.keycloak
+
+
+
    +
  • The following example playbook makes use of the role to install keycloak from the controller node:

  • +
+
---
+- hosts: ...
+      collections:
+        - middleware_automation.keycloak
+      tasks:
+        - name: Include keycloak role
+          include_role:
+            name: keycloak
+          vars:
+            keycloak_admin_password: "remembertochangeme"
+            keycloak_offline_install: true
+            # This should be the filename of keycloak archive on Ansible node: keycloak-16.1.0.zip
+
+
+
+
+

License

+

Apache License 2.0

+
+
+

Author Information

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/roles/keycloak_quarkus.html b/3.1.2/roles/keycloak_quarkus.html new file mode 100644 index 0000000..782e3f6 --- /dev/null +++ b/3.1.2/roles/keycloak_quarkus.html @@ -0,0 +1,958 @@ + + + + + + + + + keycloak_quarkus — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

keycloak_quarkus

+ +

Install keycloak >= 20.0.0 (quarkus) server configurations.

+ +
+

Requirements

+

This role requires the python3-netaddr and lxml library installed on the controller node.

+
    +
  • to install via yum/dnf: dnf install python3-netaddr python3-lxml

  • +
  • to install via apt: apt install python3-netaddr python3-lxml

  • +
  • or via the collection: pip install -r requirements.txt

  • +
+
+
+

Dependencies

+

The roles depends on:

+ +

To install all the dependencies via galaxy:

+
ansible-galaxy collection install -r requirements.yml
+
+
+
+
+

Role Defaults

+
+

Installation options

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Variable

Description

Default

keycloak_quarkus_version

keycloak.org package version

26.7.3

keycloak_quarkus_offline_install

Perform an offline install

False

keycloak_quarkus_dest

Installation root path

/opt/keycloak

keycloak_quarkus_download_url

Download URL for keycloak

https://github.com/keycloak/keycloak/releases/download/{{ keycloak_quarkus_version }}/{{ keycloak_quarkus_archive }}

keycloak_quarkus_download_path

Path local to controller for offline/download of install archives

{{ lookup('env', 'PWD') }}

+
+
+

Service configuration

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Variable

Description

Default

keycloak_quarkus_bootstrap_admin_user

Administration console user account

admin

keycloak_quarkus_admin_user

Deprecated, use keycloak_quarkus_bootstrap_admin_user instead.

keycloak_quarkus_bind_address

Deprecated, use keycloak_quarkus_http_host instead

0.0.0.0

keycloak_quarkus_host

Deprecated, use keycloak_quarkus_hostname instead.

keycloak_quarkus_port

Deprecated, use keycloak_quarkus_hostname instead.

keycloak_quarkus_path

Deprecated, use keycloak_quarkus_hostname instead.

keycloak_quarkus_service_user

Posix account username

keycloak

keycloak_quarkus_service_group

Posix account group

keycloak

keycloak_quarkus_service_restart_always

systemd restart always behavior activation

False

keycloak_quarkus_service_restart_on_failure

systemd restart on-failure behavior activation

False

keycloak_quarkus_service_restartsec

systemd RestartSec

10s

keycloak_quarkus_jvm_package

RHEL java package runtime

java-21-openjdk-headless

keycloak_quarkus_java_home

JAVA_HOME of installed JRE, leave empty for using specified keycloak_quarkus_jvm_package RPM path

None

keycloak_quarkus_java_heap_opts

Heap memory JVM setting (JAVA_OPTS_KC_HEAP when using Keycloak defaults)

-Xms1024m -Xmx2048m

keycloak_quarkus_java_jvm_opts

Optional extra JVM flags (JAVA_OPTS_APPEND with Keycloak defaults)

""

keycloak_quarkus_java_opts_use_keycloak_defaults

Let kc.sh apply upstream JAVA_OPTS (recommended)

true

keycloak_quarkus_java_append_opts

JGroups and extra JVM flags appended after Keycloak defaults

JGroups bind/external settings

keycloak_quarkus_java_opts

Full JAVA_OPTS when keycloak_quarkus_java_opts_use_keycloak_defaults is false

combined heap, JGroups, and java_jvm_opts

keycloak_quarkus_additional_env_vars

List of additional env variables of { key: str, value: str} to be put in sysconfig file, see https://www.keycloak.org/server/all-config

[]

keycloak_quarkus_frontend_url

Deprecated, use keycloak_quarkus_hostname instead.

keycloak_quarkus_admin_url

Deprecated, use keycloak_quarkus_hostname_admin instead.

keycloak_quarkus_health_check_url

Full URL for the health check endpoint, targets localhost

Composed from keycloak_quarkus_http_enabled, keycloak_quarkus_http_port/keycloak_quarkus_https_port, and keycloak_quarkus_http_relative_path

keycloak_quarkus_health_check_url_path

Path appended to the health check URL; ignored if keycloak_quarkus_health_check_url is set directly

realms/{{ keycloak_quarkus_master_realm }}/.well-known/openid-configuration

keycloak_quarkus_proxy_headers

Parse reverse proxy headers (forwarded or xforwarded)

""

keycloak_quarkus_config_key_store_file

Path to the configuration key store; only used if keycloak_quarkus_config_key_store_password is not empty

{{ keycloak.home }}/conf/conf_store.p12 if keycloak_quarkus_config_key_store_password != '', else ''

keycloak_quarkus_config_key_store_password

Password of the configuration keystore; if non-empty, keycloak_quarkus_db_pass will be saved to the keystore at keycloak_quarkus_config_key_store_file instead of being written to the configuration file in clear text

""

keycloak_quarkus_configure_firewalld

Ensure firewalld is running and configure keycloak ports

False

keycloak_quarkus_configure_iptables

Ensure iptables is configured for keycloak ports

False

+
+
+

High-availability

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Variable

Description

Default

keycloak_quarkus_ha_enabled

Enable auto configuration for database backend, clustering and remote caches on infinispan

False

keycloak_quarkus_ha_discovery

Discovery protocol for HA cluster members

JDBCPING

keycloak_quarkus_db_enabled

Enable auto configuration for database backend

True if keycloak_quarkus_ha_enabled is True, else False

keycloak_quarkus_jgroups_ip

Host jgroups IP. If changing this variable you must make sure it is always set for all hosts in your cluster.

{{ ansible_facts['default_ipv4']['address'] }}

keycloak_quarkus_jgroups_port

jgroups cluster tcp port

7800

keycloak_quarkus_systemd_wait_for_port

Whether systemd unit should wait for keycloak port before returning

{{ keycloak_quarkus_ha_enabled }}

keycloak_quarkus_systemd_wait_for_port_number

Which port the systemd unit should wait for

{{ keycloak_quarkus_https_port }}

keycloak_quarkus_systemd_wait_for_log

Whether systemd unit should wait for service to be up in logs

false

keycloak_quarkus_systemd_wait_for_timeout

How long to wait for service to be alive (seconds)

60

keycloak_quarkus_systemd_wait_for_delay

Activation delay for service systemd unit (seconds)

10

keycloak_quarkus_restart_strategy

Strategy task file for restarting in HA (one of provided restart/[‘serial.yml’,’none.yml’,’serial_then_parallel.yml’]) or path to file when providing custom strategy

restart/serial.yml

keycloak_quarkus_restart_health_check

Whether to wait for successful health check after restart

true

keycloak_quarkus_restart_health_check_delay

Seconds to let pass before starting health checks

10

keycloak_quarkus_restart_health_check_retries

Number of attempts for successful health check before failing

25

keycloak_quarkus_validate_certs

Whether to validate SSL certificates when performing health checks

true

keycloak_quarkus_restart_pause

Seconds to wait between restarts in HA strategy

15

+
+
+

Hostname configuration

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Variable

Description

Default

keycloak_quarkus_hostname

Address at which is the server exposed. Can be a full URL, or just a hostname. When only hostname is provided, scheme, port and context path are resolved from the request.

keycloak_quarkus_hostname_admin

Set the base URL for accessing the administration console, including scheme, host, port and path

``

keycloak_quarkus_hostname_strict

Disables dynamically resolving the hostname from request headers

true

keycloak_quarkus_hostname_backchannel_dynamic

Enables dynamic resolving of backchannel URLs, including hostname, scheme, port and context path. Set to true if your application accesses Keycloak via a private network. If set to true, hostname option needs to be specified as a full URL.

false

keycloak_quarkus_hostname_strict_backchannel

Deprecated, use (the inverted!)keycloak_quarkus_hostname_backchannel_dynamic instead.

+
+
+

HTTP(S) configuration

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Variable

Description

Default

keycloak_quarkus_http_relative_path

Set the path relative to / for serving resources. The path must start with a /

/

keycloak_quarkus_http_host

The http host, ie. the address used to bind the service

0.0.0.0

keycloak_quarkus_http_port

HTTP listening port

8080

keycloak_quarkus_https_port

TLS HTTP listening port

8443

keycloak_quarkus_http_management_port

Port of the management interface. Relevant only when something is exposed on the management interface - see the guide for details.

9000

keycloak_quarkus_https_key_store_file

The file path to the key store

{{ keycloak.home }}/conf/key_store.p12

keycloak_quarkus_https_key_store_password

Password for the key store

""

keycloak_quarkus_https_trust_store_enabled

Enable configuration of the https trust store

False

keycloak_quarkus_https_trust_store_file

The file path to the trust store

{{ keycloak.home }}/conf/trust_store.p12

keycloak_quarkus_https_trust_store_password

Password for the trust store

""

keycloak_quarkus_https_key_file_enabled

Enable listener on HTTPS port

False

keycloak_quarkus_key_file_copy_enabled

Enable copy of key file to target host

False

keycloak_quarkus_key_content

Content of the TLS private key. Use "{{ lookup('file', 'server.key.pem') }}" to lookup a file.

""

keycloak_quarkus_key_file

The file path to a private key in PEM format

/etc/pki/tls/private/server.key.pem

keycloak_quarkus_cert_file_copy_enabled

Enable copy of cert file to target host

False

keycloak_quarkus_cert_file_src

Set the source file path

""

keycloak_quarkus_cert_file

The file path to a server certificate or certificate chain in PEM format

/etc/pki/tls/certs/server.crt.pem

keycloak_quarkus_https_key_store_enabled

Enable configuration of HTTPS via a key store

False

keycloak_quarkus_key_store_file

Deprecated, use keycloak_quarkus_https_key_store_file instead.

keycloak_quarkus_key_store_password

Deprecated, use keycloak_quarkus_https_key_store_password instead.

keycloak_quarkus_http_relative_path

Set the path relative to / for serving resources. The path must start with a /

/

keycloak_quarkus_http_management_relative_path

Set the path relative to / for serving resources from management interface. The path must start with a /. If not given, the value is inherited from HTTP options. Relevant only when something is exposed on the management interface - see the guide for details.

/

keycloak_quarkus_http_enabled

Enable listener on HTTP port

True

+
+
+

Infinispan configuration

+ + + + + + + + + + + + + + + + + +

Variable

Description

Default

keycloak_quarkus_cache_managed_infinispan_config

Manage infinispan configuration

"{{ keycloak_quarkus_version is version('26.4.0', '<') }}"

keycloak_quarkus_cache_infinispan_template

Infinispan cache template file

cache-ispn.xml

+

As explained in the official documentation, since version 26.4, it is recommended not to modify the XML configuration file but rather to configure the cache via the keycloak.properties file. By default, the role will no longer automatically deploy this file for versions higher than 26.4.

+

For earlier versions, it is possible to override the given template to customize the cache using the keycloak_quarkus_cache_infinispan_template variable.

+
+
+

Database configuration

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Variable

Description

Default

keycloak_quarkus_db_engine

Database engine [mariadb,postres,mssql]

postgres

keycloak_quarkus_db_user

User for database connection

keycloak-user

keycloak_quarkus_db_pass

Password for database connection

keycloak-pass

keycloak_quarkus_db_url

JDBC URL for connecting to database

jdbc:postgresql://localhost:5432/keycloak

keycloak_quarkus_db_driver_version

Version for JDBC engine driver

9.4.1212

+
+
+

Cache configuration

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Variable

Description

Default

keycloak_quarkus_cache_remote

Whether to connect to remote cache infinispan server

false

keycloak_quarkus_cache_remote_username

Username for connecting to infinispan

supervisor

keycloak_quarkus_cache_remote_password

Password for connecting to infinispan

supervisor

keycloak_quarkus_cache_remote_host

Hostname for connecting to infinispan

localhost

keycloak_quarkus_cache_remote_port

Port for connecting to infinispan

11222

keycloak_quarkus_cache_remote_sasl_mechanism

Infinispan auth mechanism

SCRAM-SHA-512

keycloak_quarkus_cache_remote_tls_enabled

Whether infinispan uses TLS connection

false

keycloak_quarkus_cache_embedded_properties

Embedded cache properties

``

+
+
+

Logging configuration

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Variable

Description

Default

keycloak_quarkus_log

Enable one or more log handlers in a comma-separated list

file

keycloak_quarkus_log_level

The log level of the root category or a comma-separated list of individual categories and their levels

info

keycloak_quarkus_log_file

Set the log file path and filename relative to keycloak home

data/log/keycloak.log

keycloak_quarkus_log_format

Set a format specific to file log entries

%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n

keycloak_quarkus_log_target

Set the destination of the keycloak log folder link

/var/log/keycloak

keycloak_quarkus_log_max_file_size

Set the maximum log file size before a log rotation happens; A size configuration option recognises string in this format (shown as a regular expression): [0-9]+[KkMmGgTtPpEeZzYy]?. If no suffix is given, assume bytes.

10M

keycloak_quarkus_log_max_backup_index

Set the maximum number of archived log files to keep

10

keycloak_quarkus_log_file_suffix

Set the log file handler rotation file suffix. When used, the file will be rotated based on its suffix; Note: If the suffix ends with .zip or .gz, the rotation file will also be compressed.

.yyyy-MM-dd.zip

+
+
+

Miscellaneous configuration

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Variable

Description

Default

keycloak_quarkus_metrics_enabled

Whether to enable metrics

False

keycloak_quarkus_health_enabled

If the server should expose health check endpoints on the management interface

True

keycloak_quarkus_archive

keycloak install archive filename

keycloak-{{ keycloak_quarkus_version }}.zip

keycloak_quarkus_installdir

Installation path

{{ keycloak_quarkus_dest }}/keycloak-{{ keycloak_quarkus_version }}

keycloak_quarkus_home

Installation work directory

{{ keycloak_quarkus_installdir }}

keycloak_quarkus_config_dir

Path for configuration

{{ keycloak_quarkus_home }}/conf

keycloak_quarkus_master_realm

Name for rest authentication realm

master

keycloak_auth_client

Authentication client for configuration REST calls

admin-cli

keycloak_quarkus_force_install

Remove pre-existing versions of service

False

keycloak_quarkus_proxy_mode

The proxy address forwarding mode if the server is behind a reverse proxy (deprecated)

none

keycloak_quarkus_start_dev

Whether to start the service in development mode (start-dev)

False

keycloak_quarkus_transaction_xa_enabled

Whether to use XA transactions

True

keycloak_quarkus_spi_sticky_session_encoder_infinispan_should_attach_route

If the route should be attached to cookies to reflect the node that owns a particular session. If false, route is not attached to cookies and we rely on the session affinity capabilities from reverse proxy

True

keycloak_quarkus_show_deprecation_warnings

Whether deprecation warnings should be shown

True

+
+
+

Vault configuration

+ + + + + + + + + + + + + + + + + + + + + +

Variable

Description

Default

keycloak_quarkus_ks_vault_enabled

Whether to enable the vault SPI

false

keycloak_quarkus_ks_vault_file

The keystore path for the vault SPI

{{ keycloak_quarkus_config_dir }}/keystore.p12

keycloak_quarkus_ks_vault_type

Type of the keystore used for the vault SPI

PKCS12

+
+
+

Configuring providers

+ + + + + + + + + + + + + +

Variable

Description

Default

keycloak_quarkus_providers

List of provider definitions; see below

[]

+

Providers support different sources:

+
    +
  • url: http download for providers not requiring authentication

  • +
  • maven: maven download for providers hosted publicly on Apache Maven Central or private Maven repositories like Github Maven requiring authentication

  • +
  • local_path: static providers to be uploaded

  • +
+

Provider definition:

+
keycloak_quarkus_providers:
+  - id: http-client                         # required; "{{ id }}.jar" identifies the file name on RHBK
+    spi: connections                        # required if neither url, local_path nor maven are specified; required for setting properties
+    default: true                           # optional, whether to set default for spi, default false
+    restart: true                           # optional, whether to rebuild config and restart the service after deploying, default true
+    url: https://.../.../custom_spi.jar     # optional, url for download via http
+    local_path: my_theme_spi.jar            # optional, path on local controller for SPI to be uploaded
+    remote: true                            # optional, whether to copy from localhost or remotely, see https://docs.ansible.com/ansible/latest/collections/ansible/builtin/copy_module.html#parameter-remote_src, default false
+    maven:                                  # optional, for download using maven
+      repository_url: https://maven.pkg.github.com/OWNER/REPOSITORY # optional, maven repo url
+      group_id:  my.group                   # optional, maven group id
+      artifact_id: artifact                 # optional, maven artifact id
+      version: 24.0.5                       # optional, defaults to latest
+      username:  user                       # optional, cf. https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#authenticating-to-github-packages
+      password: pat                         # optional, provide a PAT for accessing Github's Apache Maven registry
+    properties:                             # optional, list of key-values
+      - key: default-connection-pool-size
+        value: 10
+    checksum: sha256:D98291AC[...]B6DC7B97  # optional, checksum used to verify integrity:
+                                            #  for `url` SPIs, use format: <algorithm>:<checksum|url>, cf. <https://docs.ansible.com/ansible/latest/collections/ansible/builtin/get_url_module.html#parameter-checksum>;
+                                            #  for `local_path` SPIs, use SHA1 format <https://docs.ansible.com/ansible/latest/collections/ansible/builtin/copy_module.html#parameter-checksum>
+                                            #  for `maven` SPIs, this field is ignored since maven has integrity verification methods enabled by default
+
+
+

the definition above will generate the following build command:

+
bin/kc.sh build --spi-connections-provider=http-client --spi-connections-http-client-default-connection-pool-size=10
+
+
+
+
+

Configuring policies

+ + + + + + + + + + + + + +

Variable

Description

Default

keycloak_quarkus_policies

List of policy definitions; see below

[]

+

Provider definition:

+
keycloak_quarkus_policies:
+  - name: john-the-ripper.txt                                                                          # required, resulting file name
+    url: https://github.com/danielmiessler/SecLists/raw/master/Passwords/Software/john-the-ripper.txt  # required, url for download
+    type: password-blacklists                                                                          # optional, defaults to `password-blacklists`; supported values: [`password-blacklists`]
+
+
+
+
+
+

Role Variables

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Variable

Description

Required

keycloak_quarkus_bootstrap_admin_password

Password of console admin account

yes

keycloak_quarkus_admin_pass

Deprecated, use keycloak_quarkus_bootstrap_admin_password instead.

keycloak_quarkus_ks_vault_pass

The password for accessing the keystore vault SPI

no

keycloak_quarkus_alternate_download_url

Alternate location with optional authentication for downloading RHBK

no

keycloak_quarkus_download_user

Optional username for http authentication

no*

keycloak_quarkus_download_pass

Optional password for http authentication

no*

keycloak_quarkus_download_validate_certs

Whether to validate certs for URL keycloak_quarkus_alternate_download_url

no

keycloak_quarkus_jdbc_download_user

Optional username for http authentication

no*

keycloak_quarkus_jdbc_download_pass

Optional password for http authentication

no*

keycloak_quarkus_jdbc_download_validate_certs

Whether to validate certs for URL keycloak_quarkus_download_validate_certs

no

+

* username/password authentication credentials must be both declared or both undefined

+
+
+

Role custom facts

+

The role uses the following custom facts found in /etc/ansible/facts.d/keycloak.fact (and thus identified by the ansible_local.keycloak. prefix):

+ + + + + + + + + + + +

Variable

Description

general.bootstrapped

A custom fact indicating whether this role has been used for bootstrapping keycloak on the respective host before; set to false (e.g., when starting off with a new, empty database) ensures that the initial admin user as defined by keycloak_quarkus_bootstrap_admin_user[_password] gets created

+
+
+

License

+

Apache License 2.0

+
+
+

Author Information

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/roles/keycloak_realm.html b/3.1.2/roles/keycloak_realm.html new file mode 100644 index 0000000..1341eb1 --- /dev/null +++ b/3.1.2/roles/keycloak_realm.html @@ -0,0 +1,412 @@ + + + + + + + + + keycloak_realm — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

keycloak_realm

+ +

Create realms and clients in keycloak or Red Hat Single Sign-On services.

+ +
+

Role Defaults

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Variable

Description

Default

keycloak_realm_admin_user

Administration console user account

admin

keycloak_realm_host

hostname

localhost

keycloak_realm_context

Context path for rest calls (set to /auth for legacy WildFly-based Keycloak)

``

keycloak_realm_http_port

HTTP port

8080

keycloak_realm_https_port

TLS HTTP port

8443

keycloak_realm_auth_realm

Name of the main authentication realm

master

keycloak_realm_management_http_port

Management port

9990

keycloak_realm_auth_client

Authentication client for configuration REST calls

admin-cli

keycloak_realm_client_public

Configure a public realm client

True

keycloak_realm_client_web_origins

Web origins for realm client

/*

keycloak_realm_url

URL for configuration rest calls

http://{{ keycloak_realm_host }}:{{ keycloak_realm_http_port }}

keycloak_realm_management_url

URL for management console rest calls

http://{{ keycloak_realm_host }}:{{ keycloak_realm_management_http_port }}

+
+
+

Role Variables

+

The following are a set of required variables for the role:

+ + + + + + + + + + + + + + +

Variable

Description

keycloak_realm_realm

Name of the realm to be created

keycloak_realm_admin_password

Password for the administration console user account

+

The following variables are available for creating clients:

+ + + + + + + + + + + + + + + + + + + + + +

Variable

Description

Default

keycloak_realm_clients

List of client declarations for the realm

[]

keycloak_realm_client_default_roles

List of default role name for clients

[]

keycloak_realm_client_users

List of user/role mappings for a client

[]

+

The following variables are available for creating user federation:

+ + + + + + + + + + + + + +

Variable

Description

Default

keycloak_realm_user_federation

List of keycloak_user_federation for the realm

[]

+
+
+

Variable formats

+
    +
  • keycloak_realm_user_federation, a list of:

  • +
+
    - realm:  <name of the realm in which user federation should be configured, required>
+      name: <name of the user federation provider, required>
+      provider_id: <type of the user federation provider, required>
+      provider_type: <Provider Type, default is set to org.keycloak.storage.UserStorageProvider>
+      config: <dictionary of supported configuration values, required>
+      mappers: <list of supported configuration values, required>
+
+
+

Refer to docs for information on supported variables.

+
    +
  • keycloak_realm_clients, a list of:

  • +
+
    - name: <name of the client>
+      id: <id of the client>
+      client_id: <id of the client>
+      secret: <secret of the client (Optional)>
+      roles: <keycloak_realm_client_default_roles>
+      realm: <name of the realm that contains the client>
+      public_client: <true for public, false for confidential>
+      web_origins: <list of allowed we origins for the client>
+      users: <keycloak_realm_client_users>
+
+
+

name and either id or client_id are required.

+
    +
  • keycloak_realm_client_users, a list of:

  • +
+
    - username: <username, required>
+      password: <password, required>
+      firstName: <firstName, optional>
+      lastName: <lastName, optional>
+      email: <email, optional>
+      client_roles: <list of client user/role mappings>
+
+
+
    +
  • Client user/role mappings, a list of:

  • +
+
    - client: <name of the client>
+      role: <name of the role>
+      realm: <name of the realm>
+
+
+

For a comprehensive example, refer to the playbook.

+
+ +
+

Example Playbook

+

The following is an example playbook that makes use of the role to create a realm in keycloak.

+
---
+- hosts: ...
+      collections:
+        - middleware_automation.keycloak
+      tasks:
+        - name: Include keycloak role
+          include_role:
+            name: keycloak_realm
+          vars:
+            keycloak_admin_password: "changeme"
+            keycloak_realm: TestRealm
+            keycloak_clients: [...]
+
+
+

The following example uses the keycloak_client_scope module to create a client scope with protocol mappers:

+
- name: Create client scope
+  middleware_automation.keycloak.keycloak_client_scope:
+    auth_keycloak_url: http://localhost:8080
+    auth_realm: master
+    auth_username: admin
+    auth_password: changeme
+    realm: TestRealm
+    name: my-scope
+    protocol_mappers:
+      - name: email
+        protocolMapper: oidc-usermodel-attribute-mapper
+        config:
+          user.attribute: email
+          claim.name: email
+          id.token.claim: "true"
+          access.token.claim: "true"
+    state: present
+
+
+

The following example uses the keycloak_authentication_flow module to create a custom authentication flow:

+
- name: Create authentication flow
+  middleware_automation.keycloak.keycloak_authentication_flow:
+    auth_keycloak_url: http://localhost:8080
+    auth_realm: master
+    auth_username: admin
+    auth_password: changeme
+    realm: TestRealm
+    alias: my-browser-flow
+    executions:
+      - provider_id: auth-cookie
+        requirement: ALTERNATIVE
+      - provider_id: auth-password
+        requirement: REQUIRED
+    state: present
+
+
+
+
+

License

+

Apache License 2.0

+
+
+

Author Information

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/3.1.2/search.html b/3.1.2/search.html new file mode 100644 index 0000000..4c59299 --- /dev/null +++ b/3.1.2/search.html @@ -0,0 +1,142 @@ + + + + + + + + Search — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + + + +
+ +
+ +
+
+ +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/3.1.2/searchindex.js b/3.1.2/searchindex.js new file mode 100644 index 0000000..98d5a71 --- /dev/null +++ b/3.1.2/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"alltitles":{"A typographical error was fixed in the documentation for a collection":[[41,"a-typographical-error-was-fixed-in-the-documentation-for-a-collection"]],"Ansible Collection - middleware_automation.keycloak":[[1,null]],"Ansible version compatibility":[[1,"ansible-version-compatibility"]],"Attributes":[[5,"attributes"],[6,"attributes"],[7,"attributes"],[8,"attributes"],[9,"attributes"],[10,"attributes"],[11,"attributes"],[12,"attributes"],[13,"attributes"],[14,"attributes"],[15,"attributes"],[16,"attributes"],[17,"attributes"],[18,"attributes"],[19,"attributes"],[20,"attributes"],[21,"attributes"],[22,"attributes"],[23,"attributes"],[24,"attributes"],[25,"attributes"],[26,"attributes"],[27,"attributes"],[28,"attributes"],[29,"attributes"],[30,"attributes"],[31,"attributes"],[32,"attributes"],[33,"attributes"],[34,"attributes"],[35,"attributes"],[36,"attributes"],[37,"attributes"],[38,"attributes"],[39,"attributes"],[40,"attributes"]],"Author Information":[[43,"author-information"],[44,"author-information"],[45,"author-information"]],"Authors":[[5,"authors"],[6,"authors"],[7,"authors"],[8,"authors"],[9,"authors"],[10,"authors"],[11,"authors"],[12,"authors"],[13,"authors"],[14,"authors"],[15,"authors"],[16,"authors"],[17,"authors"],[18,"authors"],[19,"authors"],[20,"authors"],[21,"authors"],[22,"authors"],[23,"authors"],[24,"authors"],[25,"authors"],[26,"authors"],[27,"authors"],[28,"authors"],[29,"authors"],[30,"authors"],[31,"authors"],[32,"authors"],[33,"authors"],[34,"authors"],[35,"authors"],[36,"authors"],[37,"authors"],[38,"authors"],[39,"authors"],[40,"authors"]],"Breaking Changes / Porting Guide":[[0,"breaking-changes-porting-guide"],[0,"id151"],[0,"id170"],[0,"id227"],[0,"id231"]],"Breaking change to any content within a collection":[[41,"breaking-change-to-any-content-within-a-collection"]],"Bug fix or security fix to existing content within a collection":[[41,"bug-fix-or-security-fix-to-existing-content-within-a-collection"]],"Bugfixes":[[0,"bugfixes"],[0,"id9"],[0,"id32"],[0,"id41"],[0,"id48"],[0,"id59"],[0,"id68"],[0,"id76"],[0,"id84"],[0,"id92"],[0,"id101"],[0,"id115"],[0,"id120"],[0,"id123"],[0,"id140"],[0,"id153"],[0,"id159"],[0,"id165"],[0,"id180"],[0,"id185"],[0,"id196"],[0,"id206"],[0,"id211"],[0,"id220"],[0,"id229"],[0,"id233"],[0,"id235"],[0,"id245"],[0,"id250"]],"Build and install locally":[[2,"build-and-install-locally"]],"Cache configuration":[[44,"cache-configuration"]],"Collection Versioning Strategy":[[41,null]],"Configure with modules":[[1,"configure-with-modules"]],"Configure with roles":[[1,"configure-with-roles"]],"Configuring policies":[[44,"configuring-policies"]],"Configuring providers":[[44,"configuring-providers"]],"Content removed from a collection":[[41,"content-removed-from-a-collection"]],"Continuous integration":[[46,"continuous-integration"]],"Contributor\u2019s Guidelines":[[2,"contributor-s-guidelines"]],"Database configuration":[[44,"database-configuration"]],"Dependencies":[[43,"dependencies"],[44,"dependencies"]],"Developer documentation":[[3,null]],"Developing":[[2,null]],"Development environment":[[2,"development-environment"]],"Documentation added/removed/modified within a collection":[[41,"documentation-added-removed-modified-within-a-collection"]],"Example Playbook":[[43,"example-playbook"],[45,"example-playbook"]],"Example configuration command":[[1,"example-configuration-command"]],"Example installation command":[[1,"example-installation-command"]],"Examples":[[5,"examples"],[6,"examples"],[7,"examples"],[8,"examples"],[9,"examples"],[10,"examples"],[11,"examples"],[12,"examples"],[13,"examples"],[14,"examples"],[15,"examples"],[16,"examples"],[17,"examples"],[18,"examples"],[19,"examples"],[20,"examples"],[21,"examples"],[22,"examples"],[23,"examples"],[24,"examples"],[25,"examples"],[26,"examples"],[27,"examples"],[28,"examples"],[29,"examples"],[30,"examples"],[31,"examples"],[32,"examples"],[33,"examples"],[34,"examples"],[35,"examples"],[36,"examples"],[37,"examples"],[38,"examples"],[39,"examples"],[40,"examples"]],"HTTP(S) configuration":[[44,"http-s-configuration"]],"High-availability":[[44,"high-availability"]],"Hostname configuration":[[44,"hostname-configuration"]],"Included modules":[[1,"included-modules"]],"Included roles":[[1,"included-roles"]],"Infinispan configuration":[[44,"infinispan-configuration"]],"Install Keycloak":[[1,"install-keycloak"]],"Install from alternate sources (like corporate Nexus, artifactory, proxy, etc)":[[1,"install-from-alternate-sources-like-corporate-nexus-artifactory-proxy-etc"]],"Install from controller node (offline)":[[1,"install-from-controller-node-offline"]],"Installation":[[1,"installation"]],"Installation options":[[44,"installation-options"]],"Installing the Collection from Ansible Galaxy":[[1,"installing-the-collection-from-ansible-galaxy"]],"License":[[1,"license"],[43,"license"],[44,"license"],[45,"license"]],"Logging configuration":[[44,"logging-configuration"]],"Major Changes":[[0,"major-changes"],[0,"id35"],[0,"id43"],[0,"id50"],[0,"id54"],[0,"id61"],[0,"id103"],[0,"id106"],[0,"id125"],[0,"id145"],[0,"id174"],[0,"id213"],[0,"id241"],[0,"id253"]],"Middleware collections":[[3,null]],"Minor Changes":[[0,"minor-changes"],[0,"id6"],[0,"id11"],[0,"id27"],[0,"id37"],[0,"id45"],[0,"id52"],[0,"id57"],[0,"id64"],[0,"id71"],[0,"id82"],[0,"id86"],[0,"id97"],[0,"id99"],[0,"id109"],[0,"id117"],[0,"id127"],[0,"id136"],[0,"id147"],[0,"id155"],[0,"id162"],[0,"id167"],[0,"id176"],[0,"id182"],[0,"id189"],[0,"id192"],[0,"id198"],[0,"id203"],[0,"id209"],[0,"id215"],[0,"id222"],[0,"id238"],[0,"id243"],[0,"id247"],[0,"id255"]],"Miscellaneous configuration":[[44,"miscellaneous-configuration"]],"New Modules":[[0,"new-modules"]],"New content is added to an existing collection":[[41,"new-content-is-added-to-an-existing-collection"]],"New feature to existing plugin or role within a collection (backwards compatible)":[[41,"new-feature-to-existing-plugin-or-role-within-a-collection-backwards-compatible"]],"Notes":[[21,"notes"],[24,"notes"],[30,"notes"],[36,"notes"],[40,"notes"]],"Parameters":[[5,"parameters"],[6,"parameters"],[7,"parameters"],[8,"parameters"],[9,"parameters"],[10,"parameters"],[11,"parameters"],[12,"parameters"],[13,"parameters"],[14,"parameters"],[15,"parameters"],[16,"parameters"],[17,"parameters"],[18,"parameters"],[19,"parameters"],[20,"parameters"],[21,"parameters"],[22,"parameters"],[23,"parameters"],[24,"parameters"],[25,"parameters"],[26,"parameters"],[27,"parameters"],[28,"parameters"],[29,"parameters"],[30,"parameters"],[31,"parameters"],[32,"parameters"],[33,"parameters"],[34,"parameters"],[35,"parameters"],[36,"parameters"],[37,"parameters"],[38,"parameters"],[39,"parameters"],[40,"parameters"]],"Patching":[[43,"patching"]],"Plugin Index":[[4,null]],"Related Modules":[[45,"related-modules"]],"Release Summary":[[0,"release-summary"],[0,"id122"],[0,"id135"],[0,"id240"],[0,"id252"],[0,"id257"]],"Release and Upgrade Notes":[[1,"release-and-upgrade-notes"]],"Release automation":[[41,"release-automation"]],"Requirements":[[43,"requirements"],[44,"requirements"]],"Return Values":[[5,"return-values"],[6,"return-values"],[7,"return-values"],[8,"return-values"],[9,"return-values"],[10,"return-values"],[11,"return-values"],[12,"return-values"],[13,"return-values"],[14,"return-values"],[15,"return-values"],[16,"return-values"],[17,"return-values"],[18,"return-values"],[19,"return-values"],[20,"return-values"],[21,"return-values"],[22,"return-values"],[23,"return-values"],[24,"return-values"],[25,"return-values"],[26,"return-values"],[27,"return-values"],[28,"return-values"],[29,"return-values"],[30,"return-values"],[31,"return-values"],[32,"return-values"],[33,"return-values"],[34,"return-values"],[35,"return-values"],[36,"return-values"],[37,"return-values"],[38,"return-values"],[39,"return-values"],[40,"return-values"]],"Role Defaults":[[43,"role-defaults"],[44,"role-defaults"],[45,"role-defaults"]],"Role Index":[[42,null]],"Role Variables":[[43,"role-variables"],[44,"role-variables"],[45,"role-variables"]],"Role custom facts":[[44,"role-custom-facts"]],"See Also":[[32,"see-also"]],"Service configuration":[[44,"service-configuration"]],"Support":[[1,"support"]],"Synopsis":[[5,"synopsis"],[6,"synopsis"],[7,"synopsis"],[8,"synopsis"],[9,"synopsis"],[10,"synopsis"],[11,"synopsis"],[12,"synopsis"],[13,"synopsis"],[14,"synopsis"],[15,"synopsis"],[16,"synopsis"],[17,"synopsis"],[18,"synopsis"],[19,"synopsis"],[20,"synopsis"],[21,"synopsis"],[22,"synopsis"],[23,"synopsis"],[24,"synopsis"],[25,"synopsis"],[26,"synopsis"],[27,"synopsis"],[28,"synopsis"],[29,"synopsis"],[30,"synopsis"],[31,"synopsis"],[32,"synopsis"],[33,"synopsis"],[34,"synopsis"],[35,"synopsis"],[36,"synopsis"],[37,"synopsis"],[38,"synopsis"],[39,"synopsis"],[40,"synopsis"]],"Test playbooks":[[46,"test-playbooks"]],"Testing":[[46,null]],"Topics":[[0,"topics"]],"Usage":[[1,"usage"]],"User documentation":[[3,null]],"Variable formats":[[45,"variable-formats"]],"Vault configuration":[[44,"vault-configuration"]],"Versions":[[43,"versions"]],"Welcome to Keycloak Collection documentation":[[3,null]],"keycloak":[[43,null]],"keycloak_authentication \u2013 Configure authentication in Keycloak":[[5,null]],"keycloak_authentication_flow \u2013 Allows administration of Keycloak authentication flows via Keycloak API":[[6,null]],"keycloak_authentication_required_actions \u2013 Allows administration of Keycloak authentication required actions":[[7,null]],"keycloak_authentication_v2 \u2013 Configure authentication flows in Keycloak in an idempotent and safe manner.":[[8,null]],"keycloak_authz_authorization_scope \u2013 Allows administration of Keycloak client authorization scopes using Keycloak API":[[9,null]],"keycloak_authz_custom_policy \u2013 Allows administration of Keycloak client custom Javascript policies using Keycloak API":[[10,null]],"keycloak_authz_permission \u2013 Allows administration of Keycloak client authorization permissions using Keycloak API":[[11,null]],"keycloak_authz_permission_info \u2013 Query Keycloak client authorization permissions information":[[12,null]],"keycloak_client \u2013 Allows administration of Keycloak clients using Keycloak API":[[13,null]],"keycloak_client_rolemapping \u2013 Allows administration of Keycloak client_rolemapping with the Keycloak API":[[14,null]],"keycloak_client_rolescope \u2013 Allows administration of Keycloak client roles scope to restrict the usage of certain roles to a other specific client applications":[[15,null]],"keycloak_client_scope \u2013 Allows administration of Keycloak client scopes via Keycloak API":[[16,null]],"keycloak_client_scope_rolemappings \u2013 Allows administration of Keycloak client scope scope mappings to restrict the usage of certain roles to specific client scopes":[[17,null]],"keycloak_client_scope_type \u2013 Set the type of a client scope in a realm or client using the Keycloak API":[[18,null]],"keycloak_clientsecret_info \u2013 Retrieve client secret using Keycloak API":[[19,null]],"keycloak_clientsecret_regenerate \u2013 Regenerate Keycloak client secret using Keycloak API":[[20,null]],"keycloak_clienttemplate \u2013 Allows administration of Keycloak client templates using Keycloak API":[[21,null]],"keycloak_component \u2013 Allows administration of Keycloak components using Keycloak API":[[22,null]],"keycloak_component_info \u2013 Retrieve component info in Keycloak":[[23,null]],"keycloak_group \u2013 Allows administration of Keycloak groups using Keycloak API":[[24,null]],"keycloak_identity_provider \u2013 Allows administration of Keycloak identity providers using Keycloak API":[[25,null]],"keycloak_organization \u2013 Allows administration of Keycloak organizations using Keycloak API":[[26,null]],"keycloak_organization_info \u2013 Retrieve organization info in Keycloak":[[27,null]],"keycloak_quarkus":[[44,null]],"keycloak_realm":[[45,null]],"keycloak_realm \u2013 Allows administration of Keycloak realm using Keycloak API":[[28,null]],"keycloak_realm_info \u2013 Allows obtaining Keycloak realm public information using Keycloak API":[[29,null]],"keycloak_realm_key \u2013 Allows administration of Keycloak realm keys using Keycloak API":[[30,null]],"keycloak_realm_keys_metadata_info \u2013 Allows obtaining Keycloak realm keys metadata using Keycloak API":[[31,null]],"keycloak_realm_localization \u2013 Allows management of Keycloak realm localization overrides via the Keycloak API":[[32,null]],"keycloak_realm_rolemapping \u2013 Allows administration of Keycloak realm role mappings into groups with the Keycloak API":[[33,null]],"keycloak_realm_users_info \u2013 Retrieve users from a Keycloak realm using the Keycloak API":[[34,null]],"keycloak_role \u2013 Allows administration of Keycloak roles using Keycloak API":[[35,null]],"keycloak_user \u2013 Create and configure a user in Keycloak":[[36,null]],"keycloak_user_execute_actions_email \u2013 Send a Keycloak execute-actions email to a user":[[37,null]],"keycloak_user_federation \u2013 Allows administration of Keycloak user federations using Keycloak API":[[38,null]],"keycloak_user_rolemapping \u2013 Allows administration of Keycloak user_rolemapping with the Keycloak API":[[39,null]],"keycloak_userprofile \u2013 Allows managing Keycloak User Profiles":[[40,null]],"middleware_automation.keycloak Release Notes":[[0,null]],"modules plugins":[[4,null]],"v1.0.0":[[0,"v1-0-0"]],"v1.0.1":[[0,"v1-0-1"]],"v1.0.2":[[0,"v1-0-2"]],"v1.0.3":[[0,"v1-0-3"]],"v1.0.4":[[0,"v1-0-4"]],"v1.0.5":[[0,"v1-0-5"]],"v1.0.6":[[0,"v1-0-6"]],"v1.0.7":[[0,"v1-0-7"]],"v1.1.0":[[0,"v1-1-0"]],"v1.1.1":[[0,"v1-1-1"]],"v1.2.0":[[0,"v1-2-0"]],"v1.2.1":[[0,"v1-2-1"]],"v1.2.4":[[0,"v1-2-4"]],"v1.2.5":[[0,"v1-2-5"]],"v1.2.6":[[0,"v1-2-6"]],"v1.2.7":[[0,"v1-2-7"]],"v1.2.8":[[0,"v1-2-8"]],"v1.3.0":[[0,"v1-3-0"]],"v2.0.0":[[0,"v2-0-0"]],"v2.0.1":[[0,"v2-0-1"]],"v2.0.2":[[0,"v2-0-2"]],"v2.1.0":[[0,"v2-1-0"]],"v2.1.1":[[0,"v2-1-1"]],"v2.1.2":[[0,"v2-1-2"]],"v2.2.0":[[0,"v2-2-0"]],"v2.2.1":[[0,"v2-2-1"]],"v2.2.2":[[0,"v2-2-2"]],"v2.3.0":[[0,"v2-3-0"]],"v2.4.0":[[0,"v2-4-0"]],"v2.4.1":[[0,"v2-4-1"]],"v2.4.2":[[0,"v2-4-2"]],"v2.4.3":[[0,"v2-4-3"]],"v3.0.0":[[0,"v3-0-0"]],"v3.0.1":[[0,"v3-0-1"]],"v3.0.10":[[0,"v3-0-10"]],"v3.0.11":[[0,"v3-0-11"]],"v3.0.2":[[0,"v3-0-2"]],"v3.0.3":[[0,"v3-0-3"]],"v3.0.4":[[0,"v3-0-4"]],"v3.0.5":[[0,"v3-0-5"]],"v3.0.6":[[0,"v3-0-6"]],"v3.0.7":[[0,"v3-0-7"]],"v3.0.8":[[0,"v3-0-8"]],"v3.0.9":[[0,"v3-0-9"]],"v3.1.0":[[0,"v3-1-0"]],"v3.1.1":[[0,"v3-1-1"]],"v3.1.2":[[0,"v3-1-2"]]},"docnames":["CHANGELOG","README","developing","index","plugins/index","plugins/keycloak_authentication","plugins/keycloak_authentication_flow","plugins/keycloak_authentication_required_actions","plugins/keycloak_authentication_v2","plugins/keycloak_authz_authorization_scope","plugins/keycloak_authz_custom_policy","plugins/keycloak_authz_permission","plugins/keycloak_authz_permission_info","plugins/keycloak_client","plugins/keycloak_client_rolemapping","plugins/keycloak_client_rolescope","plugins/keycloak_client_scope","plugins/keycloak_client_scope_rolemappings","plugins/keycloak_client_scope_type","plugins/keycloak_clientsecret_info","plugins/keycloak_clientsecret_regenerate","plugins/keycloak_clienttemplate","plugins/keycloak_component","plugins/keycloak_component_info","plugins/keycloak_group","plugins/keycloak_identity_provider","plugins/keycloak_organization","plugins/keycloak_organization_info","plugins/keycloak_realm","plugins/keycloak_realm_info","plugins/keycloak_realm_key","plugins/keycloak_realm_keys_metadata_info","plugins/keycloak_realm_localization","plugins/keycloak_realm_rolemapping","plugins/keycloak_realm_users_info","plugins/keycloak_role","plugins/keycloak_user","plugins/keycloak_user_execute_actions_email","plugins/keycloak_user_federation","plugins/keycloak_user_rolemapping","plugins/keycloak_userprofile","releasing","roles/index","roles/keycloak","roles/keycloak_quarkus","roles/keycloak_realm","testing"],"envversion":{"sphinx":66,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1},"filenames":["CHANGELOG.rst","README.md","developing.md","index.rst","plugins/index.rst","plugins/keycloak_authentication.rst","plugins/keycloak_authentication_flow.rst","plugins/keycloak_authentication_required_actions.rst","plugins/keycloak_authentication_v2.rst","plugins/keycloak_authz_authorization_scope.rst","plugins/keycloak_authz_custom_policy.rst","plugins/keycloak_authz_permission.rst","plugins/keycloak_authz_permission_info.rst","plugins/keycloak_client.rst","plugins/keycloak_client_rolemapping.rst","plugins/keycloak_client_rolescope.rst","plugins/keycloak_client_scope.rst","plugins/keycloak_client_scope_rolemappings.rst","plugins/keycloak_client_scope_type.rst","plugins/keycloak_clientsecret_info.rst","plugins/keycloak_clientsecret_regenerate.rst","plugins/keycloak_clienttemplate.rst","plugins/keycloak_component.rst","plugins/keycloak_component_info.rst","plugins/keycloak_group.rst","plugins/keycloak_identity_provider.rst","plugins/keycloak_organization.rst","plugins/keycloak_organization_info.rst","plugins/keycloak_realm.rst","plugins/keycloak_realm_info.rst","plugins/keycloak_realm_key.rst","plugins/keycloak_realm_keys_metadata_info.rst","plugins/keycloak_realm_localization.rst","plugins/keycloak_realm_rolemapping.rst","plugins/keycloak_realm_users_info.rst","plugins/keycloak_role.rst","plugins/keycloak_user.rst","plugins/keycloak_user_execute_actions_email.rst","plugins/keycloak_user_federation.rst","plugins/keycloak_user_rolemapping.rst","plugins/keycloak_userprofile.rst","releasing.md","roles/index.rst","roles/keycloak.md","roles/keycloak_quarkus.md","roles/keycloak_realm.md","testing.md"],"indexentries":{},"objects":{},"objnames":{},"objtypes":{},"terms":{"075ef2fa":23,"0c133918a454":[11,12],"0c978f794547":35,"0f38":35,"100d":11,"10m":44,"10s":[43,44],"11e6":39,"13a6":17,"164bb483":38,"17d60ce2":38,"19fc":23,"1b80":25,"1fba601b9a9f":38,"1h":37,"23f38145":[24,26],"249f57365fd2":23,"2d44":38,"2e9e3c9c424c":15,"31f6":13,"3677ba4e5fbb":13,"39c62a6d":15,"40ec":9,"41021eb33967":15,"416f":[5,8],"44c8":13,"451e":17,"45bb":25,"45ff":35,"462c":[24,26],"46ad":[22,30],"46f0":15,"481e":21,"482e":38,"48c6":[19,20,24,37],"48f23b6a0a41":9,"496a":[5,8],"49e052ff":11,"4a6d":23,"4ab9a3e78d95":13,"4ae4":38,"4b79":11,"4b87":13,"4c2c":38,"4c90336b":13,"4d28d7e3":25,"4d988f8eaa5c":[5,8],"4def":17,"52669ed3c11d":11,"542c":15,"561703dd":35,"581ce7b87013":17,"5822bf55aa1c":25,"59a6":15,"5b7ec13f":[22,30],"5p":44,"6e2e891a765f":38,"6f09e4fb":[5,8],"70e3ae72":39,"76da7b006e5f":21,"77f9bd4e":17,"7f1431308799":38,"7fa9779df6d7":[5,8],"80fe":38,"817e":21,"86f5":17,"88b09ccf0b4c":[5,8],"8a30":25,"8b1f":38,"8ca0":38,"8f77dab8":[5,8],"916d":13,"92d2":15,"930e06d2d36a":35,"954f":21,"96b6":39,"97041ccea73":[24,26],"9737fd4d0764":39,"97e7":[24,26],"989e":[5,8],"99da":[22,30],"9a5a":35,"9c3712ab":21,"9c72":17,"9d59aa76":[19,20,24,37],"9da05cd2":[11,12],"9e155ef7":17,"9f03eb61":35,"9f39":9,"A":[1,3,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,44],"All":[1,2,8,14,15,17,24,26,28,29,33,35,38,39],"An":[13,21,24],"Are":13,"As":[21,44],"At":13,"Be":[13,21,24,28],"By":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,41,44],"Cannot":6,"Do":[0,13,35],"Each":[6,16,32,41],"For":[1,5,13,30,32,38,40,44,45],"Has":30,"How":[13,43,44],"If":[1,5,6,8,13,15,17,18,21,25,26,27,28,30,32,35,36,37,38,39,44],"In":[0,2,6,9,10,11,12,13,14,15,16,17,18,19,20,21,22,24,25,26,28,30,33,35,38,39,40,46],"Is":[5,13,21],"It":[1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,45],"My":[8,26,35],"No":[28,38],"Not":[24,30,36],"On":[1,3,6,9,10,11,13,14,15,16,17,21,22,24,25,26,28,30,32,33,35,38,39,40,43,45],"Should":38,"So":38,"That":[22,30],"The":[1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,43,44,45,46],"There":11,"These":[24,30],"They":[14,19,20,24,25,29,31,33,39],"This":[0,1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,43,44],"To":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,43,44],"We":41,"What":45,"When":[1,2,8,13,14,19,20,24,26,30,33,36,38,39,43,44],"Which":44,"While":[13,21],"You":[1,14,15,17,24,26,29,30,32,33,35,37,39,40],"__future__":0,"_password":44,"_provid":22,"_resourceserverrepresent":13,"_tmp_for_swap":8,"a0cf":38,"a1":30,"a6ab1cf2":9,"a7e4":13,"a826":35,"a9dd":11,"a9fd":35,"aad4":[5,8],"aaguid":28,"ab4c73cf4ce4":[22,30],"abov":[41,44],"absent":[5,6,7,8,9,10,11,13,14,15,16,17,21,22,24,25,26,28,30,32,33,35,36,38,39,40],"absolut":0,"accept":[13,21,28,38,40],"access":[0,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,44,45],"access_code_lifespan":28,"access_code_lifespan_login":28,"access_code_lifespan_user_act":28,"access_token_lifespan":28,"access_token_lifespan_for_implicit_flow":28,"accesscodelifespan":28,"accesscodelifespanlogin":28,"accesscodelifespanuseract":28,"accesstokenlifespan":28,"accesstokenlifespanforimplicitflow":28,"accident":8,"accord":0,"account":[1,5,8,13,28,29,39,40,43,44,45],"account_them":28,"accountthem":28,"acm":[26,27],"action":[0,1,3,4,5,6,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,38,39,40],"action_group":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40],"action_token_generated_by_admin_lifespan":28,"action_token_generated_by_user_lifespan":28,"actiontokengeneratedbyadminlifespan":28,"actiontokengeneratedbyuserlifespan":28,"activ":[2,8,13,21,28,30,31,38,43,44],"activemq":3,"actual":[5,30],"ad":1,"adam":24,"adamgoossen":24,"add":[0,3,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,33,35,36,38,39,40],"add_read_token_role_on_cr":25,"addit":[0,11,28,38,41,43,44],"addreadtokenroleoncr":25,"address":[0,13,21,43,44],"admin":[0,1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,43,44,45],"admin_edit":40,"admin_events_details_en":28,"admin_events_en":28,"admin_permissions_en":28,"admin_them":28,"admin_url":[13,14,28,33,39],"admin_view":40,"admineventsdetailsen":28,"admineventsen":28,"administr":[0,1,3,4,36,40,43,44,45],"adminpermissionsen":28,"adminthem":28,"adminurl":[13,14,28,33,39],"advanc":25,"ae":30,"affect":32,"affin":44,"affirm":11,"agent":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40],"agross":33,"ahead":28,"ajp":43,"alexand":33,"alg":[13,14,28,33,39],"algorithm":[13,28,30,31,44],"alia":[5,6,7,8,25,26,30,45],"alias":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],"aliv":44,"allow":[0,1,3,4,5,8,12,18,19,20,36,41,45],"allowkerberosauthent":38,"allowpasswordauthent":38,"alongsid":30,"alphanumer":13,"alreadi":[1,8,9,10,11,13,21,22,25,28,30,38,40],"also":[1,4,5,7,16,25,28,30,38,40,43,44,45],"altern":[0,5,6,8,30,44,45],"alway":[0,5,6,7,9,10,11,12,13,14,15,16,18,19,20,21,23,24,25,26,27,28,29,30,31,33,34,35,37,38,39,40,43,44],"always_display_in_consol":13,"alwaysdisplayinconsol":13,"among":38,"amount":[28,40],"amq":3,"amw":0,"andr":[15,23],"ani":[3,5,7,8,13,14,21,24,25,32,33,36,38,40],"annot":[0,40,41],"anoth":24,"ansibl":[0,2,3,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,43,44,46],"ansible_connect":[1,46],"ansible_fact":[0,44],"ansible_host":1,"ansible_loc":44,"ansible_manag":0,"ansible_play_batch":1,"anyway":13,"apach":[1,43,44,45],"api":[0,1,3,4,5,7,8,12,15,17,23,27,36,37,40,41],"app":[32,37],"append":[8,13,44],"appli":[0,24,26,32,38,40,43,44],"applic":[3,4,28,30,36,44],"appropri":[13,38],"apt":[43,44],"archiv":[1,43,44],"arg":0,"argspec":41,"argument":[0,2],"argument_spec":2,"around":[2,13,21,28],"array":24,"artifact":[0,41,44],"artifact_id":44,"ascii":30,"ask":25,"assert":[0,13,25],"assign":[0,1,7,14,25,33,36,39],"associ":[16,25,26,38],"assum":[38,41,44],"attach":[10,11,28,44],"attack":40,"attempt":[11,44],"attest":28,"attr1":[24,26,36],"attr2":36,"attrib1":[24,35],"attrib2":[24,35],"attrib3":[24,35],"attribut":[0,4,45],"audienc":16,"auth":[1,5,6,8,13,14,15,17,18,19,20,21,24,25,26,27,28,29,31,32,33,34,35,37,39,43,44,45],"auth_client_id":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40],"auth_client_secret":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40],"auth_keycloak_url":[1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,45],"auth_password":[1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,45],"auth_realm":[1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,45],"auth_usernam":[1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,45],"authent":[0,1,3,4,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,43,44,45],"authenticate_by_default":25,"authenticatebydefault":25,"authentication_flow_binding_overrid":13,"authentication_v2":0,"authenticationconfig":[5,8],"authenticationexecut":[5,8],"authenticationflowbindingoverrid":13,"authnrequest":25,"authnstat":13,"author":[1,3,4,42],"authorization_services_en":13,"authorization_set":13,"authorizationservicesen":13,"authorizationset":13,"authorizationurl":25,"authtyp":38,"auto":[30,43,44],"autogener":30,"autom":[1,2,3],"automat":[0,24,30,38,43,44],"avail":[1,2,9,10,11,12,13,21,25,26,27,30,40,41,42,45,46],"avoid":[0,2,8,19,20,28],"awar":24,"b1af":[19,20,24,37],"b2":30,"b273":[11,12],"b460":15,"b507":17,"b6dc7b97":44,"b873":[5,8],"b898":[5,8],"bach":31,"back":[13,38],"backchannel":[0,13,25,44],"backchannel_logout_url":13,"backchannellogouturl":13,"backchannelsupport":25,"backend":[0,15,17,43,44],"background":[0,43],"backward":[3,13],"bar":[2,32],"bargetz":8,"base":[0,1,11,13,21,24,30,38,43,44,45],"base64":13,"base_url":13,"basepath":13,"baseurl":13,"basic":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40],"batchsizeforsync":38,"bb620cadc122":38,"bbd8":[11,12],"bc228863":[5,8],"bce6f5e9":21,"bearer":[0,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40],"bearer_on":13,"beareron":[13,21],"beb70a82c3cd":[19,20,24,37],"becaus":[0,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40],"becom":[0,1,36,38],"befor":[1,8,13,18,25,26,27,28,29,38,44],"begin":[8,41],"behav":13,"behavior":[0,13,36,43,44],"behaviour":[0,8],"behind":44,"bell":13,"belong":[1,22,26,30],"bergmann":8,"bertram":37,"bf1d":13,"bf4c":23,"bin":[2,44],"binari":0,"bind":[8,13,38,43,44],"bind_credential_update_mod":38,"bindcredenti":38,"binddn":38,"bindep":0,"bit":30,"bj\u00f6rn":22,"blacklist":44,"blank":38,"block":26,"blog":[9,10,11,12],"bn7p5nc_v2m7n_":30,"boolean":[0,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],"bootstrap":[0,44],"bottom":[14,24,33],"bound":8,"branch":2,"bratwurzt":39,"break":3,"broke":0,"broker":[3,5,8,25,28],"brown":[26,27],"browser":[6,13,28,45],"browser_flow":28,"browser_nam":13,"browser_security_head":28,"browserflow":28,"browsernam":13,"browsersecurityhead":28,"brute":28,"brute_force_protect":28,"brute_force_strategi":28,"bruteforceprotect":28,"bruteforcestrategi":28,"bug":[0,1,3,30],"build":[0,1,3,25,41,44],"built":[38,41],"builtin":[5,6,8,31,44],"bump":0,"bye":32,"byte":[30,44],"b\u00f6sel":22,"c":44,"c14n":13,"c3":30,"c5b7f8d65b3f":21,"c613":38,"cacert":[38,43],"cach":[0,1,38,42,43],"cachepolici":[22,38],"call":[11,14,15,17,19,20,24,26,29,33,35,37,39,43,44,45],"callback":0,"camelcas":[9,10,11,12,13,14,21,22,24,25,26,28,29,30,31,33,34,35,38,39,40],"can":[1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,44],"canonic":13,"cant":[19,20],"capabl":44,"care":[13,21,28],"case":[12,24,30],"cat":46,"categori":44,"caus":[0,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40],"central":44,"cert":[0,31,44],"certain":[3,4],"certif":[0,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,43,44],"certifi":1,"certificate_fingerprint":30,"certificateher":13,"cf":44,"cf52ae4f":38,"cfg":41,"chain":[14,24,33,44],"chakraborti":[43,44,45],"chang":[1,2,3,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,44],"changedsyncperiod":38,"changeit":43,"changelog":[0,1,3],"changem":[1,45],"charact":[40,43],"check":[0,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,44],"check_mod":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],"checkout":2,"checksum":[0,44],"chen":[19,20,29],"children":24,"choic":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],"chosen":[13,21,28,38],"chribro":[26,27],"chris":[26,27],"christoph":28,"ci":0,"cid":[14,39],"claim":[13,16,21,25,45],"class":[13,21,38],"claus":0,"clear":44,"cli":[1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,43,44,45],"client":[0,1,3,4,5,6,7,8,14,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,43,44,45],"client1":[14,39],"client_authentication_flow":28,"client_authenticator_typ":13,"client_cons":36,"client_id":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,45],"client_offline_session_idle_timeout":28,"client_offline_session_max_lifespan":28,"client_rol":45,"client_rolemap":[3,4],"client_scope_id":17,"client_scope_map":28,"client_scopes_behavior":13,"client_secret_post":25,"client_session_idle_timeout":28,"client_session_max_lifespan":28,"client_templ":13,"clientauthenticationflow":28,"clientauthenticatortyp":13,"clientauthmethod":25,"clientcons":36,"clientid":[9,10,11,12,13,14,18,19,20,25,33,35,36,37,39],"clientidofserviceaccount":39,"clientofflinesessionidletimeout":28,"clientofflinesessionmaxlifespan":28,"clientregistr":23,"clientregistrationpolici":23,"clientrol":[15,17,24,35],"clientscopemap":28,"clientscopesbehavior":13,"clientsecret":25,"clientsecret_info":19,"clientsessionidletimeout":28,"clientsessionmaxlifespan":28,"clienttempl":13,"clone":[2,46],"close":38,"cluster":[0,1,13,43,44],"cn":[13,38],"code":[0,28,32,46],"collect":[0,2,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,43,44,45,46],"colon":30,"com":[0,1,13,14,15,17,18,19,20,21,24,25,26,27,28,29,31,32,33,34,35,37,38,39,43,44],"combin":44,"comma":[38,44],"command":44,"comment":[0,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],"common":[0,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,43,44],"communic":43,"communiti":[0,1],"compabl":0,"compar":[8,30,38],"comparison":[13,30,38],"compat":[0,2,3,13,36,40],"complet":[14,24,33,37],"complex":[7,9,11,12,19,20,24,26],"compon":[1,3,4,30,38,40],"compos":44,"composit":[15,17,35],"comprehens":45,"compress":44,"concaten":2,"concurr":38,"condit":[5,6,7,8,13,28],"conf":[0,30,44],"conf_stor":44,"confidenti":45,"config":[0,5,7,8,12,13,16,21,22,25,30,38,40,44,45],"config_key_store_fil":0,"configur":[0,3,4,6,7,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,37,38,39,40,42,43,45],"confirm":8,"confus":30,"conjunct":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40],"connect":[0,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,43,44],"connection_timeout":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40],"connectionpool":38,"connectionpoolingauthent":38,"connectionpoolingdebug":38,"connectionpoolinginits":38,"connectionpoolingmaxs":38,"connectionpoolingprefs":38,"connectionpoolingprotocol":38,"connectionpoolingtimeout":38,"connectiontimeout":38,"connectionurl":38,"consensus":11,"consent":[13,21],"consent_requir":13,"consentrequir":[13,21],"consenttext":[13,21],"consid":[15,17,30,35,41],"consol":[0,1,13,21,29,35,38,40,43,44,45],"consum":13,"contain":[1,2,5,13,21,23,32,38,41,45],"containerid":[15,17,35],"content":[3,13,21,22,25,30,31,38,44],"context":[1,40,44,45],"continu":[3,8],"contributor":3,"control":[0,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,43,44],"convent":2,"convey":28,"cooki":[5,6,8,44,45],"copi":[0,5,6,31,44],"copy_from":6,"copy_modul":44,"copyfrom":[5,6],"cor":13,"core":[0,2,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],"corp":26,"corpor":26,"correct":[0,41,46],"correspond":[25,30,38],"count":38,"counter":28,"cover":[45,46],"coverag":8,"cp":43,"crash":0,"creat":[1,2,3,4,5,6,8,9,10,11,12,13,14,16,21,22,24,25,26,28,30,32,33,35,38,39,40,41,44,45,46],"creation":[5,8,13,26,28,38],"credenti":[0,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,44],"crt":44,"cryptograph":30,"cugnx1eiettppakcygmv0ncyqdpu68p1":[19,20],"cumul":[0,43],"current":[8,13,14,24,30,33,40,41],"curv":30,"custom":[0,1,3,4,6,16,24,26,28,30,35,38,40,42,43,45],"custom_spi":44,"customusersearchfilt":38,"d":44,"d4":30,"d7d3":21,"d8b127a3":13,"d98291ac":44,"danek":32,"danekja":32,"danielmiessl":44,"dash":2,"data":[3,8,11,13,25,38,40,44],"databas":[0,25,38,42,43],"date":[13,40,43],"daubress":[5,14,33],"day":38,"db":[38,43],"dc":38,"dd":44,"de":32,"debian":0,"debug":[0,38],"decd":21,"decid":[8,38],"decis":[11,12],"decision_strategi":11,"decisionstrategi":[11,12],"declar":[0,40,44,45],"dedic":[41,45],"deep":[14,24,33],"default":[0,1,2,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42],"default_client_scop":[13,18],"default_default_client_scop":28,"default_group":28,"default_ipv4":44,"default_local":28,"default_optional_client_scop":28,"default_rol":[13,28],"default_signature_algorithm":28,"defaultact":7,"defaultclientscop":13,"defaultdefaultclientscop":28,"defaultgroup":28,"defaultlocal":28,"defaultoptionalclientscop":28,"defaultrol":[13,28],"defaultscop":25,"defaultsignaturealgorithm":28,"defin":[2,13,21,25,28,38,40,43,44],"definit":[0,6,9,10,11,12,13,14,15,16,17,18,19,20,21,22,24,25,26,28,30,33,35,38,39,44],"delay":[0,44],"delegate_to":[6,13,14,16,18,19,20,21,24,26,29,31,32,33,34,35,37,39],"delet":[1,5,6,7,8,9,10,11,13,14,16,21,24,26,28,33,35,38,39,40,41],"delta":28,"demand":38,"depend":[0,1,2,13,21,22,25,38,42],"deploy":[0,1,10,44],"deprec":[0,41,43,44],"depth":8,"desand01":[15,23],"describ":[0,5,8,24],"descript":[0,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,43,44,45],"design":40,"desir":[8,30,32,38],"desrosi":[15,23],"dest":31,"destin":[43,44],"detail":[1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,44],"detect":[11,28,30,38],"determin":[11,13,25,30,38],"dev":[31,44],"devel":0,"develop":[0,41,44,46],"devic":28,"dict":[6,13,16,21,24,25,26,28,30,31,35,38,43],"dictionari":[5,6,7,8,10,12,13,14,15,16,17,18,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,38,39,40,45],"diff":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],"diff_mod":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],"differ":[10,11,13,14,21,25,30,36,38,39,44],"digest":38,"digit":28,"direct":[13,24,28,44],"direct_access_grants_en":13,"direct_gr":13,"direct_grant_flow":28,"direct_grant_nam":13,"directaccessgrantsen":[13,21],"directgr":13,"directgrantflow":28,"directgrantnam":13,"directori":[0,1,2,38,43,44,46],"disabl":[0,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,43,44],"disableable_credential_typ":36,"disableablecredentialtyp":36,"discard":21,"discoveri":[0,43,44],"display":[7,9,13,25,28,38,40],"display_descript":40,"display_head":40,"display_nam":[9,25,28,40],"display_name_html":28,"displaydescript":40,"displayhead":40,"displaynam":[5,8,25,28,40],"displaynamehtml":28,"dist":1,"distribut":0,"diverg":30,"divid":38,"dn":38,"dnf":[43,44],"dns":38,"doc":[13,14,21,22,24,25,26,28,29,30,31,33,34,35,38,39,40,44,45],"docker":[2,13,21,28,43],"docker_authentication_flow":28,"dockerauthenticationflow":28,"document":[0,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,44],"doe":[1,6,12,13,14,16,19,21,23,24,25,26,27,28,29,31,33,34,35,36,38,39,40,41],"domain":[26,28,38],"don":[2,40],"donotstoreus":25,"doubl":40,"download":[0,1,25,43,44],"driver":[0,43,44],"drop":[0,13],"dsa_sha1":13,"due":[0,30],"dump":[13,21,25,38],"duplic":[7,28],"duplicate_emails_allow":28,"duplicateemailsallow":28,"durat":8,"dure":[0,8,26,38],"du\u0161an":39,"dynam":[30,44],"e":[0,1,2,6,16,26,44],"e5":30,"eap":[3,43],"earlier":44,"easiest":[13,21,25,38],"ecdh":30,"ecdh_":30,"ecdh_es_a128kw":30,"ecdh_es_a192kw":30,"ecdh_es_a256kw":30,"ecdsa":30,"ed25519":30,"ed448":30,"eddsa":30,"edit":[28,40],"edit_username_allow":28,"editmod":38,"editusernameallow":28,"ee6997299c1f":17,"effect":[21,30,37,38],"eik":[13,21,40],"eikef":[13,21],"either":[13,30,34,37,41,45],"element":[5,6,7,8,11,13,14,15,16,17,18,21,23,24,25,26,27,28,31,32,33,34,35,36,37,38,39,40],"elfelip":[5,36],"elimin":41,"ellipt":30,"elliptic_curv":30,"els":[43,44],"email":[1,3,4,13,16,25,28,34,36,38,40,45],"email_them":28,"email_verifi":36,"email_verified_behavior":36,"emailthem":28,"emailverifi":36,"embed":44,"empti":[12,21,28,30,32,38,43,44],"en":[32,44],"enabl":[0,1,7,9,10,11,12,13,22,25,26,27,28,30,36,38,40,43,44],"enabled_event_typ":28,"enabledeventtyp":28,"enc":[23,30],"encod":13,"encrypt":[13,30,38],"end":[11,25,44],"end_stat":[5,6,7,8,9,10,11,13,14,15,16,17,18,20,21,22,24,25,26,28,30,32,33,35,36,38,39],"endpoint":[0,11,12,13,25,28,29,30,37,43,44],"enforc":[21,30],"engin":[36,43,44],"enhanc":0,"ensur":[8,30,32,36,40,43,44],"entiti":[0,25,28],"entityid":25,"entri":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,41,44],"entryuuid":38,"env":[0,2,44],"environ":[0,3,46],"envvar":0,"eof":46,"epoch":30,"equal":38,"equalto":31,"error":[0,3,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40],"es":[13,21],"es256":30,"es384":30,"es512":30,"escal":0,"especi":8,"etc":[38,43,44],"evalu":38,"even":[13,25,30,38],"event":28,"events_en":28,"events_expir":28,"events_listen":28,"eventsen":28,"eventsexpir":28,"eventslisten":28,"evict_daili":38,"evict_week":38,"evictionday":38,"evictionhour":38,"evictionminut":38,"exact":[13,27],"exampl":[4,41,42],"exc":13,"except":2,"exchang":30,"exclud":38,"exclus":[13,25,37],"exclusive_with_com":13,"execut":[0,1,2,3,4,5,6,7,8,9,10,11,13,14,15,16,17,18,20,21,22,24,25,26,28,30,32,33,35,36,38,39,45],"execution1":5,"execution2":5,"exhaust":[13,21],"exist":[0,3,5,6,8,9,10,11,13,14,15,16,17,18,21,22,24,25,26,28,30,32,33,35,36,38,39,40,43,44],"exit":13,"expect":[6,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,24,25,26,28,30,33,35,36,38,39],"experiment":28,"expir":[28,30],"explain":44,"explicit":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,41],"expos":44,"express":[13,40,44],"ext":13,"extend":[13,21,38],"extens":[2,13,41],"extern":[25,28,44],"extra":[0,19,20,37,44],"eyjwt_token":13,"f6":30,"fact":[0,42],"factor":28,"fail":[0,8,19,44],"failur":[0,28,43,44],"failure_factor":28,"failurefactor":28,"fals":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,43,44,45],"famili":[13,21],"family_nam":[13,21],"familynam":[13,21],"farewel":32,"featur":[0,1,3,13,21,25,28,30,43,45],"feder":[0,1,3,4,36,45],"federated_ident":36,"federatedident":36,"federation_link":36,"federationlink":36,"felix":[17,34],"fetch":[30,31],"fi":32,"field":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,44],"file":[0,1,2,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,43,44],"filenam":[1,43,44],"filesystem":30,"fill":38,"filter":[0,7,23,38,41],"final":[1,32],"fine":38,"fingerprint":30,"firewalld":[43,44],"first":[0,5,6,7,8,14,24,25,28,31,33,36,38,41],"first_broker_login_flow":28,"first_broker_login_flow_alia":25,"first_nam":[1,25,36],"firstbrokerloginflow":28,"firstbrokerloginflowalia":25,"firstnam":[36,40,45],"fivetid":22,"fix":[0,3,11,12],"flag":[36,44],"flow":[0,1,3,4,5,13,25,28,45],"flowalia":5,"focus":2,"folder":[43,44],"follow":[0,1,2,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,43,44,45,46],"foo":[2,32,38],"forc":[0,5,13,25,28,30,32,36,43],"force_temporary_swap_flow_delet":8,"form":[5,6,8,28],"formact":0,"format":[1,11,13,25,30,41,42,43,44],"forward":[37,44],"found":[13,14,21,22,24,25,26,28,29,30,31,32,33,34,35,38,39,40,44],"four":13,"frequent":43,"friend":[25,26],"fromurl":25,"frontchannel":13,"frontchannel_logout":13,"frontchannellogout":[13,21],"frontend":[0,15,17,37,43],"frost":[13,21],"full":[1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,44],"full_scope_allow":[13,15,21],"fulli":[30,40],"fullscopeallow":[13,21],"fullsyncperiod":38,"function":41,"fynn":[19,20,29],"fynncfchen":[19,20,29],"g":[0,2,6,16,26,44],"ga":43,"gaetan2907":[5,14,33],"galaxi":[2,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,43,44],"gap":8,"gauthier":[5,36],"ga\u00ebtan":[5,14,33],"general":[0,1,41,44],"generat":[13,19,20,23,28,30,38,40,44],"get":[11,19,20,29,31,44],"get_url_modul":44,"gid":[14,33],"gill":28,"git":41,"github":[0,1,41,43,44],"give":[14,24,33],"given":[13,14,21,24,25,32,33,37,38,41,44],"go":[2,7,11,13,21],"good":38,"goossen":24,"grammar":0,"grant":[13,24,28],"grazioli":[43,44,45],"greet":32,"grid":3,"group":[0,1,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,25,26,27,28,30,31,32,34,35,36,37,38,39,40,43,44],"group1":[14,33,36],"group_id":44,"group_nam":[14,25,33],"group_rolemap":33,"gro\u00df":33,"grp":24,"grzelka":[17,34],"gt":[13,21],"gui":25,"gui_ord":25,"guid":[24,26,44],"guidelin":3,"guido":[43,44,45],"guiorder":25,"gz":[2,44],"ha":[0,43,44],"handl":[0,1,8,14,24,33],"handler":[0,44],"happen":[0,30,44],"hardcod":[13,21,38],"hat":[1,3,38,43,45],"header":[0,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,44],"headless":[43,44],"health":[0,44],"heap":44,"hello":32,"hex":30,"hh":44,"hidden":25,"hide_on_login":25,"hide_on_login_pag":[0,25],"hideonlogin":25,"high":42,"higher":44,"hint":0,"hmac":30,"home":[0,44],"homograph":40,"honour":0,"hood":[14,24,33],"host":[0,1,28,38,43,44,45],"hostnam":[0,42,43,45],"hotrod":43,"hour":38,"howev":[30,38,40],"hs256":30,"hs384":30,"hs512":30,"html":[13,14,21,22,24,25,26,28,29,30,31,33,34,35,38,39,40,44],"http":[0,1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,42,43,45],"http_agent":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40],"http_relative_path":0,"https":[0,9,10,11,12,13,14,15,17,18,19,20,21,22,24,25,26,27,28,29,30,31,32,33,34,35,37,38,39,40,41,43,44],"hub":[1,41],"human":[8,9,10,11,12,13,21],"huysamen":33,"icon":9,"icon_uri":9,"id":[5,6,7,8,9,11,12,13,14,15,16,17,19,20,21,22,23,24,25,26,28,29,30,33,34,35,36,37,38,39,40,44,45],"idempot":[3,4,13,30,37,46],"ident":[1,3,4,5,8,38],"identifi":[1,8,14,19,20,24,25,26,30,33,38,39,44],"identityprovideralia":25,"identityprovidermapp":[25,38],"idl":[28,38],"idn":40,"idp":[5,8,25,36],"idprealm":25,"ie":[1,2,44],"ignor":[0,13,32,38,44],"immut":26,"implement":[0,14,24,33],"implicit":[13,28],"implicit_flow_en":13,"implicitflowen":[13,21],"import":[0,8,30,38],"importen":38,"imposs":[13,21,30],"improv":0,"inact":30,"inadvert":8,"inbound":41,"includ":[0,2,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,43,44,45,46],"include_rol":[43,45],"inclus":13,"inclusive_with_com":13,"incompat":41,"inconsist":0,"incorrect":0,"increas":41,"increment":[28,41],"indent":2,"index":[3,5,8,13,14,21,22,24,25,26,28,29,30,31,33,34,35,38,39,40],"indic":[7,36,38,41,44],"individu":[14,15,17,24,26,29,33,35,39,44],"inetorgperson":38,"infer":43,"infinispan":[0,3,42,43],"infinispan_":0,"info":[3,4,13,21,25,44],"inform":[1,3,4,23,27,31,38,42],"inherit":[25,28,44],"initi":[0,28,38,44],"input":[13,28],"instal":[0,3,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,42,43,46],"instanc":[1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],"instead":[0,1,8,11,13,19,20,38,39,44],"integ":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],"integr":[0,3,25,44],"interest":11,"interfac":[13,44],"intermedi":8,"internal":[0,2,13,14,21,24,33,45],"internalid":25,"internation":28,"internationalization_en":28,"internationalizationen":28,"internet":26,"interpol":2,"interrupt":8,"introduc":[0,41],"invalid":[0,38],"inventori":[1,41,46],"invert":44,"invok":0,"ip":[0,44],"ipaddr":0,"iptabl":44,"ipv4":43,"iso":40,"iso_d":40,"isod":40,"ispn":44,"issu":[0,1,13],"issuer":25,"item":[24,32,35],"ivan":[13,30,39],"j2":0,"jakub":32,"januari":43,"jar":[0,10,44],"java":[0,30,38,43,44],"java_hom":[0,43,44],"java_jvm_opt":44,"java_opt":[0,44],"java_opts_append":[0,44],"java_opts_kc_heap":[0,44],"javascript":[3,4],"javax":38,"jboss":[3,43],"jbossneworkapi":0,"jcliff":3,"jdbc":[0,43,44],"jdbc_ping":43,"jdbcping":44,"jdk":0,"jdk21":0,"jgroup":[0,43,44],"jinja":2,"jks":30,"john":[19,20,38,44],"johncant":[19,20],"johndo":37,"jre":[43,44],"js":10,"json":[11,23,27,30],"jsontyp":[13,16,21],"june":43,"just":[14,24,33,38,44],"jvm":[0,43,44],"jwa":13,"jwk":[13,25],"jwks":[13,25],"jwks_url_for_client_auth_jwt":13,"jwksurl":25,"jws":3,"jwt":13,"jwt_credential_certificate_for_client_auth":13,"kafka":3,"kc":[0,24,35,44],"kc_idp_hint":25,"kc_user_profile_config":40,"kcuserprofileconfig":40,"keep":[2,38,44],"kerbero":38,"kerberosrealm":38,"key":[0,1,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,32,33,34,35,36,37,38,39,40,44],"key_alia":30,"key_info":30,"key_password":30,"key_siz":30,"key_stor":44,"keyckoak":40,"keycloak":[2,4,42,44,45,46],"keycloak_admin_password":[0,1,43,45],"keycloak_admin_url":43,"keycloak_admin_us":43,"keycloak_ajp_port":43,"keycloak_arch":43,"keycloak_auth_cli":[43,44],"keycloak_auth_realm":43,"keycloak_authent":[1,3,4],"keycloak_authentication_flow":[1,3,4,45],"keycloak_authentication_required_act":[1,3,4],"keycloak_authentication_v2":[0,1,3,4],"keycloak_authz_authorization_scop":[1,3,4],"keycloak_authz_custom_polici":[1,3,4],"keycloak_authz_permiss":[1,3,4],"keycloak_authz_permission_info":[1,3,4],"keycloak_bind_address":43,"keycloak_cli":[0,1,3,4,21,45],"keycloak_client_rolemap":[1,3,4],"keycloak_client_rolescop":[1,3,4],"keycloak_client_scop":[1,3,4,45],"keycloak_client_scope_rolemap":[3,4],"keycloak_client_scope_typ":[1,3,4],"keycloak_clientscop":1,"keycloak_clientsecret_info":[1,3,4,20],"keycloak_clientsecret_regener":[1,3,4],"keycloak_clienttempl":[1,3,4],"keycloak_compon":[1,3,4],"keycloak_component_info":[1,3,4],"keycloak_config_dir":43,"keycloak_config_override_templ":[0,43],"keycloak_config_path_to_standalone_xml":43,"keycloak_config_standalone_xml":43,"keycloak_configure_firewalld":43,"keycloak_context":1,"keycloak_db_background_valid":43,"keycloak_db_background_validate_on_match":43,"keycloak_db_background_validation_milli":43,"keycloak_db_en":43,"keycloak_db_pass":43,"keycloak_db_us":43,"keycloak_db_valid_conn_sql":[0,43],"keycloak_dest":43,"keycloak_download_url":[1,43],"keycloak_download_url_9x":43,"keycloak_featur":43,"keycloak_feder":1,"keycloak_force_instal":43,"keycloak_frontend_url":[0,43],"keycloak_frontend_url_forc":43,"keycloak_group":[0,1,3,4],"keycloak_ha_discoveri":43,"keycloak_ha_en":43,"keycloak_host":43,"keycloak_http_port":43,"keycloak_https_port":43,"keycloak_identity_provid":[0,1,3,4],"keycloak_infinispan_":0,"keycloak_infinispan_pass":43,"keycloak_infinispan_sasl_mechan":43,"keycloak_infinispan_trust_store_password":43,"keycloak_infinispan_trust_store_path":43,"keycloak_infinispan_url":43,"keycloak_infinispan_us":43,"keycloak_infinispan_use_ssl":43,"keycloak_installdir":43,"keycloak_java_hom":43,"keycloak_java_opt":43,"keycloak_jboss_hom":43,"keycloak_jboss_port_offset":43,"keycloak_jdbc_driver_vers":43,"keycloak_jdbc_engin":43,"keycloak_jdbc_url":43,"keycloak_jgroups_port":43,"keycloak_jgroups_subnet":[0,43],"keycloak_jvm_packag":43,"keycloak_keys_metadata":31,"keycloak_log_target":43,"keycloak_management_http_port":43,"keycloak_management_https_port":43,"keycloak_management_port_bind_address":43,"keycloak_management_url":43,"keycloak_modcluster_en":43,"keycloak_modcluster_port":43,"keycloak_modcluster_url":43,"keycloak_no_log":0,"keycloak_offline_instal":[1,43],"keycloak_organ":[3,4],"keycloak_organization_info":[3,4],"keycloak_prefer_ipv4":43,"keycloak_quarkus":[0,1,3,42],"keycloak_quarkus_additional_env_var":44,"keycloak_quarkus_admin_pass":44,"keycloak_quarkus_admin_url":44,"keycloak_quarkus_admin_us":44,"keycloak_quarkus_alternate_download_url":44,"keycloak_quarkus_arch":44,"keycloak_quarkus_bind_address":44,"keycloak_quarkus_bootstrap_admin_password":[1,44],"keycloak_quarkus_bootstrap_admin_us":44,"keycloak_quarkus_cache_embedded_properti":44,"keycloak_quarkus_cache_infinispan_templ":44,"keycloak_quarkus_cache_managed_infinispan_config":44,"keycloak_quarkus_cache_remot":44,"keycloak_quarkus_cache_remote_host":44,"keycloak_quarkus_cache_remote_password":44,"keycloak_quarkus_cache_remote_port":44,"keycloak_quarkus_cache_remote_sasl_mechan":44,"keycloak_quarkus_cache_remote_tls_en":44,"keycloak_quarkus_cache_remote_usernam":44,"keycloak_quarkus_cert_fil":44,"keycloak_quarkus_cert_file_copy_en":44,"keycloak_quarkus_cert_file_src":44,"keycloak_quarkus_config_dir":44,"keycloak_quarkus_config_key_store_fil":44,"keycloak_quarkus_config_key_store_password":44,"keycloak_quarkus_configure_firewalld":44,"keycloak_quarkus_configure_ipt":44,"keycloak_quarkus_db_driver_vers":44,"keycloak_quarkus_db_en":44,"keycloak_quarkus_db_engin":44,"keycloak_quarkus_db_pass":44,"keycloak_quarkus_db_url":44,"keycloak_quarkus_db_us":44,"keycloak_quarkus_dest":44,"keycloak_quarkus_download_pass":44,"keycloak_quarkus_download_path":[0,44],"keycloak_quarkus_download_url":44,"keycloak_quarkus_download_us":44,"keycloak_quarkus_download_validate_cert":44,"keycloak_quarkus_force_instal":[0,44],"keycloak_quarkus_frontend_url":44,"keycloak_quarkus_ha_discoveri":44,"keycloak_quarkus_ha_en":44,"keycloak_quarkus_health_check_url":[0,44],"keycloak_quarkus_health_check_url_path":44,"keycloak_quarkus_health_en":44,"keycloak_quarkus_hom":44,"keycloak_quarkus_host":44,"keycloak_quarkus_hostnam":44,"keycloak_quarkus_hostname_admin":44,"keycloak_quarkus_hostname_backchannel_dynam":44,"keycloak_quarkus_hostname_strict":44,"keycloak_quarkus_hostname_strict_backchannel":44,"keycloak_quarkus_hostname_strict_http":0,"keycloak_quarkus_http_en":44,"keycloak_quarkus_http_host":[0,44],"keycloak_quarkus_http_management_port":44,"keycloak_quarkus_http_management_relative_path":44,"keycloak_quarkus_http_port":44,"keycloak_quarkus_http_relative_path":44,"keycloak_quarkus_https_key_file_en":44,"keycloak_quarkus_https_key_store_en":44,"keycloak_quarkus_https_key_store_fil":44,"keycloak_quarkus_https_key_store_password":44,"keycloak_quarkus_https_port":44,"keycloak_quarkus_https_trust_store_en":44,"keycloak_quarkus_https_trust_store_fil":44,"keycloak_quarkus_https_trust_store_password":44,"keycloak_quarkus_installdir":44,"keycloak_quarkus_java_append_opt":44,"keycloak_quarkus_java_heap_opt":44,"keycloak_quarkus_java_hom":44,"keycloak_quarkus_java_jvm_opt":44,"keycloak_quarkus_java_opt":[0,44],"keycloak_quarkus_java_opts_use_keycloak_default":44,"keycloak_quarkus_jdbc_download_pass":44,"keycloak_quarkus_jdbc_download_us":44,"keycloak_quarkus_jdbc_download_validate_cert":44,"keycloak_quarkus_jgroups_ip":44,"keycloak_quarkus_jgroups_port":44,"keycloak_quarkus_jvm_packag":44,"keycloak_quarkus_key_cont":44,"keycloak_quarkus_key_fil":44,"keycloak_quarkus_key_file_copy_en":44,"keycloak_quarkus_key_store_fil":44,"keycloak_quarkus_key_store_password":44,"keycloak_quarkus_ks_vault_en":44,"keycloak_quarkus_ks_vault_fil":44,"keycloak_quarkus_ks_vault_pass":44,"keycloak_quarkus_ks_vault_typ":44,"keycloak_quarkus_log":44,"keycloak_quarkus_log_fil":44,"keycloak_quarkus_log_file_suffix":44,"keycloak_quarkus_log_format":44,"keycloak_quarkus_log_level":44,"keycloak_quarkus_log_max_backup_index":44,"keycloak_quarkus_log_max_file_s":44,"keycloak_quarkus_log_target":44,"keycloak_quarkus_master_realm":44,"keycloak_quarkus_metrics_en":44,"keycloak_quarkus_offline_instal":44,"keycloak_quarkus_path":44,"keycloak_quarkus_polici":44,"keycloak_quarkus_port":44,"keycloak_quarkus_provid":[0,44],"keycloak_quarkus_proxy_head":44,"keycloak_quarkus_proxy_mod":[0,44],"keycloak_quarkus_restart_health_check":44,"keycloak_quarkus_restart_health_check_delay":44,"keycloak_quarkus_restart_health_check_retri":44,"keycloak_quarkus_restart_paus":44,"keycloak_quarkus_restart_strategi":44,"keycloak_quarkus_service_group":44,"keycloak_quarkus_service_restart_alway":44,"keycloak_quarkus_service_restart_on_failur":44,"keycloak_quarkus_service_restartsec":44,"keycloak_quarkus_service_us":44,"keycloak_quarkus_show_deprecation_warn":44,"keycloak_quarkus_spi_sticky_session_encoder_infinispan_should_attach_rout":44,"keycloak_quarkus_start_dev":44,"keycloak_quarkus_systemd_wait_for_delay":44,"keycloak_quarkus_systemd_wait_for_log":44,"keycloak_quarkus_systemd_wait_for_port":44,"keycloak_quarkus_systemd_wait_for_port_numb":44,"keycloak_quarkus_systemd_wait_for_timeout":44,"keycloak_quarkus_transaction_xa_en":44,"keycloak_quarkus_validate_cert":44,"keycloak_quarkus_vers":44,"keycloak_realm":[0,1,3,4,26,32,42],"keycloak_realm_admin_password":[1,45],"keycloak_realm_admin_us":45,"keycloak_realm_auth_cli":45,"keycloak_realm_auth_realm":45,"keycloak_realm_cli":[1,45],"keycloak_realm_client_default_rol":45,"keycloak_realm_client_publ":45,"keycloak_realm_client_us":45,"keycloak_realm_client_web_origin":45,"keycloak_realm_context":45,"keycloak_realm_host":45,"keycloak_realm_http_port":45,"keycloak_realm_https_port":45,"keycloak_realm_info":[1,3,4],"keycloak_realm_key":[1,3,4],"keycloak_realm_keys_metadata_info":[1,3,4],"keycloak_realm_loc":[1,3,4],"keycloak_realm_management_http_port":45,"keycloak_realm_management_url":45,"keycloak_realm_realm":[1,45],"keycloak_realm_rolemap":[1,3,4],"keycloak_realm_url":45,"keycloak_realm_user_feder":45,"keycloak_realm_users_info":[1,3,4],"keycloak_remote_cache_en":43,"keycloak_rhsso_apply_patch":[0,43],"keycloak_rhsso_installdir":43,"keycloak_rol":[1,3,4,45],"keycloak_service_group":43,"keycloak_service_pidfil":43,"keycloak_service_restart_alway":43,"keycloak_service_restart_on_failur":43,"keycloak_service_restartsec":43,"keycloak_service_startlimitburst":43,"keycloak_service_startlimitintervalsec":43,"keycloak_service_us":[0,43],"keycloak_url":43,"keycloak_us":[0,1,3,4],"keycloak_user_execute_actions_email":[1,3,4],"keycloak_user_feder":[0,1,3,4,45],"keycloak_user_rolemap":[0,1,3,4],"keycloak_userprofil":[1,3,4],"keycloak_vers":43,"keycloakx":0,"keyinfo":13,"keyprovid":23,"keys_metadata":31,"keysmetadatarepresent":31,"keystor":[0,30,44],"keystore_password":30,"keytab":38,"kid":30,"kkmmggttppeezzyy":44,"know":[24,30],"known":[21,25,36,43,44],"kokalovi\u0107":[13,30,39],"koke1997":[13,30,39],"krb5":38,"krb5loginmodul":38,"krbprincipalattribut":38,"kris2kri":28,"kumar":43,"label":[0,13,16,21,41],"lack":0,"larg":11,"last":[8,13,36],"last_nam":[1,25,36],"lastnam":[13,21,36,40,45],"later":[1,24,26,27],"latest":[0,13,14,21,22,26,28,29,30,31,34,35,39,43,44],"laurent":[25,35,38],"laurpaum":[25,35,38],"ldap":[1,23,38,45],"ldapson":38,"ldapstoragemapp":[23,38],"ldapv3":38,"leak":0,"least":[11,13,21],"leav":[38,43,44],"left":[8,38],"legaci":[1,43,45],"length":40,"less":[14,24,33,39],"let":44,"level":[0,5,6,8,18,24,38,44],"librari":[43,44],"licens":[3,42],"lifespan":[0,28,37,38],"like":[2,11,36,44],"limit":[24,41],"linear":28,"link":[5,8,13,25,36,37,38,43,44],"link_on":25,"linkon":25,"lint":[0,2],"list":[0,2,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,43,44,45],"listen":[28,44],"load":0,"local":[0,1,3,4,28,40,43,44,46],"local_d":40,"local_path":44,"locald":40,"localhost":[0,1,5,6,7,8,9,10,11,12,13,14,16,18,19,20,21,22,23,24,26,29,30,31,32,33,34,35,36,37,39,43,44,45,46],"localization_text":28,"localizationtext":28,"locat":[0,30,38,44],"lock":0,"lockout":28,"log":[0,13,19,20,25,38,42,43],"logfil":0,"logic":[0,11,12],"login":[5,8,13,25,28,36,38],"login_them":28,"login_with_email_allow":28,"loginthem":28,"loginwithemailallow":28,"logout":[13,25],"logouturl":25,"long":44,"longer":44,"look":[13,21,28,38],"lookup":[0,13,14,19,20,24,26,33,37,38,39,44],"loss":8,"lowercas":[0,2],"lowest":38,"lxml":[1,44],"machin":[2,43],"made":[8,32,37,39,41],"mail":38,"main":[0,2,45],"maintain":[38,41],"major":41,"make":[0,1,2,5,11,13,30,38,41,43,44,45],"manag":[1,3,4,9,10,11,16,22,24,28,30,43,44,45],"managemembership":24,"mandatori":38,"mani":38,"manipul":15,"manner":[3,4,41],"map":[1,3,4,14,15,18,24,28,31,32,38,39,45],"mapper":[0,1,13,16,21,23,25,38,45],"mariadb":[0,43,44],"marius":[33,37],"mariusbertram":37,"markovi\u0107":39,"mask":30,"master":[1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,43,44,45],"match":[0,1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,43],"materi":[0,30],"matrix":41,"matter":11,"mattock":[9,10,11,12,30],"maven":[0,44],"max":[28,38,40],"max_delta_time_second":28,"max_failure_wait_second":28,"max_lifespan":38,"max_secondary_auth_failur":[0,28],"max_temporary_lockout":28,"maxdeltatimesecond":28,"maxfailurewaitsecond":28,"maximum":[38,40,44],"maxlifespan":38,"maxsecondaryauthfailur":28,"maxtemporarylockout":28,"may":[1,13,14,15,17,21,24,26,29,30,33,35,38,39,41],"mb5vvsrvpkq5qd_ouarinb9ofsj0":30,"md5":38,"mean":[28,38],"mechan":[8,28,44],"member":[26,36,43,44],"membership":[13,21],"memori":44,"menon":[6,16],"merg":0,"messag":[5,6,7,9,10,11,12,13,14,15,16,18,20,21,24,25,26,28,29,30,31,32,33,35,38,39,40],"meta":2,"metadata":[1,3,4,30,40,41],"method":[13,25,38,44],"metric":44,"mhuysamen":33,"middlewar":0,"middleware_autom":[2,3,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,43,44,45],"might":[30,38],"migrat":[0,1,40],"miibijanbgkqhkig9w0baqefaao":29,"milli":0,"millisecond":[28,30,38],"min":40,"minim":[13,21,28],"minimum":[0,28,40,43],"minimum_quick_login_wait_second":28,"minimumquickloginwaitsecond":28,"minor":41,"minut":38,"miscellan":[42,43],"miss":[0,5,8,13,32],"mm":44,"modclust":[0,43],"mode":[0,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,44],"model":38,"modif":8,"modifi":[3,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,44],"modul":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42],"module_default":[1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40],"molecul":[0,2,46],"motaparthi":43,"move":0,"ms":28,"msg":[5,6,7,9,10,11,12,13,14,15,16,18,19,20,21,24,25,26,28,29,30,31,33,35,38,39,40],"mssql":44,"multi":[8,14,15,17,24,26,29,33,35,39],"multipl":[0,1,10,11,28,37,40],"multivalu":40,"must":[1,5,6,9,10,11,12,13,14,15,16,17,18,19,20,21,22,24,25,26,27,28,30,32,33,34,35,36,37,38,39,44],"mutual":[13,25,37],"my_custom_key":22,"my_key":25,"my_path":2,"my_playbook":2,"my_rol":2,"my_theme_spi":44,"my_token":[6,16],"my_valu":25,"myclient":[9,10,11,12,35],"myclientid":[19,20],"mycustomcli":18,"mycustomkey":22,"mycustomrealm":[14,15,17,18,19,20,24,29,31,33,34,35,39],"myfe":38,"myflow_tmp_for_swap":8,"mykey":[22,30],"myldap":23,"myrealm":[9,10,11,12,22,23,25,26,27,29,30,37,38],"myrol":35,"n":[12,19,23,27,29,31,34,44],"name":[0,1,2,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,43,44,45],"nameformat":13,"nameid":13,"nameidpolicyformat":25,"namespac":1,"necessari":[24,30,34],"necessarili":24,"need":[1,2,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,44],"neither":[39,44],"net":[9,10,11,12,38],"netaddr":[1,43,44],"netrc":[0,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40],"network":44,"never":[8,38],"new":[2,3,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,44],"new_group":24,"newer":[1,37],"newli":[7,38,41],"next":[36,41],"nil":8,"nilsbergmann":8,"no_cach":[22,38],"no_default":36,"no_log":[0,19,20],"node":[0,13,43,44],"node01":13,"node_re_registration_timeout":13,"nodenam":13,"nodereregistrationtimeout":13,"non":[0,44],"none":[0,10,11,13,20,21,28,37,38,43,44],"normal":0,"normalis":8,"not_befor":[13,28],"notbefor":[13,28],"note":[3,4,13,14,19,20,33,38,41,43,44],"noth":2,"notion":38,"novemb":43,"now":0,"null":36,"number":[0,11,14,19,20,24,25,26,33,38,39,41,44],"numer":[24,35],"oaep":30,"oauth2_device_code_lifespan":28,"oauth2_device_polling_interv":28,"oauth2devicecodelifespan":28,"oauth2devicepollinginterv":28,"object":[13,14,28,33,38,39],"objectclass":38,"objectguid":38,"observ":12,"obtain":[3,4,13,21,25,38],"occurr":7,"offici":[9,10,11,12,44],"offlin":[0,28,43,44],"offline_session_idle_timeout":28,"offline_session_max_lifespan":28,"offline_session_max_lifespan_en":28,"offlinesessionidletimeout":28,"offlinesessionmaxlifespan":28,"offlinesessionmaxlifespanen":28,"offset":[0,43],"oidc":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,45],"old":[8,25,36],"older":0,"omit":[13,32],"on_creat":30,"onc":[0,8,26],"one":[6,11,13,14,21,22,24,25,26,28,29,30,31,32,33,34,35,37,38,39,40,44],"onetimeus":13,"onli":[0,1,5,6,8,9,10,11,12,13,14,21,24,25,26,27,30,32,33,37,38,39,40,41,43,44],"only_indirect":38,"onlyown":10,"onto":2,"open":43,"openid":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,44],"openjdk":[0,43,44],"oper":[11,38],"opt":[30,43,44],"optim":13,"option":[0,1,5,8,9,10,11,12,13,14,18,21,22,24,25,26,28,29,30,31,32,33,34,35,36,37,38,39,40,42,43,45],"optional_client_scop":[13,18],"optionalclientscop":13,"order":[2,5,25,46],"org":[13,14,21,22,23,24,25,26,27,28,29,30,31,33,34,35,38,39,40,41,43,44,45],"organiz":[3,4,28],"organizationalperson":38,"organizations_en":[26,28],"organizationsen":28,"origin":[8,13,28,36,45],"otherwis":[0,13,36],"otp":[6,28],"otp_policy_algorithm":28,"otp_policy_digit":28,"otp_policy_initial_count":28,"otp_policy_look_ahead_window":28,"otp_policy_period":28,"otp_policy_typ":28,"otp_supported_appl":28,"otppolicyalgorithm":28,"otppolicydigit":28,"otppolicyinitialcount":28,"otppolicylookaheadwindow":28,"otppolicyperiod":28,"otppolicytyp":28,"otpsupportedappl":28,"ou":38,"outcom":41,"output":[38,40],"overrid":[0,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,33,34,35,36,37,38,39,40,43,44],"overridden":2,"owner":44,"owns":[32,44],"p":30,"p12":44,"packag":[0,1,43,44],"page":[25,41],"pagin":38,"pahl":18,"pair":[16,24,26,35,43],"pairwis":[13,21],"paramet":[0,4,41,43,44],"parent":[5,13,14,21,23,24,33,38,40],"parent_id":[22,23,30,32,38,40],"parentid":[22,30,38,40],"pars":44,"parseabl":0,"part":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],"parti":28,"partial":[8,27,30],"particular":[11,44],"pass":[0,14,15,17,19,20,24,26,29,33,35,39,43,44],"passiv":30,"passkey":28,"password":[0,1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,43,44,45],"password_polici":28,"passwordless":28,"passwordpolici":28,"pat":44,"patch":[0,13,41,42],"path":[0,1,2,9,10,11,12,24,30,36,43,44,45],"path_to_dev_virtualenv":2,"pattern":[13,40],"paulo":[6,16],"paulomenon":[6,16],"paumier":[25,35,38],"pavan":43,"payload":[9,10,11,12,30,41],"peculiar":11,"peliss":[43,45],"pem":44,"per":[32,38],"perform":[0,1,25,34,43,44],"period":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40],"perman":28,"permanent_lockout":28,"permanentlockout":28,"permiss":[0,1,3,4,13,28,34,40],"permission_typ":11,"persist":13,"person":40,"person_name_prohibited_charact":40,"personnameprohibitedcharact":40,"philipp":[5,36],"phone":18,"pick":2,"pid":43,"pip":[1,2,43,44],"pkcs12":[30,44],"pkg":44,"pki":[43,44],"place":8,"plain":38,"platform":2,"play":[0,2],"playbook":[1,2,3,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42],"pleas":[1,13,19,20,30,38,41],"plugin":[1,2,3],"plus":8,"png":9,"podman":2,"point":[10,14,24,33],"polici":[0,1,3,4,11,12,23,28,38,40,42],"policy_typ":10,"poll":28,"pool":[0,38,43,44],"port":[43,44,45],"posit":[11,12],"posix":[43,44],"possibl":[1,2,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,44],"post":[8,11,13,37],"post_broker_login_flow_alia":25,"post_task":2,"postbrokerloginflowalia":25,"postgr":[43,44],"postgresql":[43,44],"postlogoutredirecturi":13,"postr":44,"potenti":38,"practic":[22,30,40],"pre":[8,32,41,43,44],"pre_task":2,"preced":13,"predict":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],"prefer":[14,24,28,33,38,43],"prefix":[0,1,44],"present":[1,5,6,7,8,9,10,11,13,14,15,16,17,21,22,24,25,26,28,30,32,33,35,36,38,39,40,45],"preserv":[7,30],"prevent":[0,8,40],"previous":[8,41],"princip":38,"principaltyp":25,"principl":[14,24,33],"prior":41,"prioriti":[5,7,30,38],"privat":[13,15,30,44],"private_key":30,"privatekeyher":13,"privileg":[0,32],"problem":36,"procedur":8,"proceed":8,"produc":38,"product":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],"profil":[0,1,3,4,5,8,18,38,43],"prohibit":40,"project":[9,10,11,12],"properti":[0,5,13,21,22,30,38,44],"propos":[13,14,18,21,25,28,33,35,36,38,39],"protect":[0,28],"protocol":[0,1,13,16,21,25,29,38,43,44,45],"protocol_mapp":[13,16,21,45],"protocol_mapper_typ":16,"protocolmapp":[13,16,21,45],"provid":[0,1,3,4,5,6,7,8,13,14,15,16,17,19,20,21,22,23,24,26,27,28,30,31,33,35,37,38,39,40,42,45,46],"provider_id":[6,22,25,30,38,40,45],"provider_typ":[22,23,38,40,45],"providerid":[5,6,7,8,22,25,30,38,40],"providertyp":[22,30,38,40],"provis":[1,5,38],"proxi":[0,43,44],"proxy_head":0,"proxy_mod":0,"prs":0,"prune_undefined_realm_attribut":28,"pruneundefinedrealmattribut":28,"ps256":30,"ps384":30,"ps512":30,"public":[3,4,13,15,17,25,44,45],"public_cli":[13,45],"public_key":29,"publiccli":[13,21],"publish":41,"pull":0,"puppet":[9,10,11,12],"purpos":0,"put":[11,44],"pwd":44,"py":0,"python":[1,2,46],"python3":[0,43,44],"quarkus":[0,1,44],"queri":[3,4,24,37,43],"queried_st":12,"quick":28,"quick_login_check_milli_second":28,"quicklogincheckmillisecond":28,"r":[1,2,43,44],"rais":0,"ranabir":[43,44,45],"random":38,"rather":[8,44],"raw":44,"rdn":38,"rdnldapattribut":38,"re":[5,8,13,36],"read":[24,25,38,40],"read_on":38,"readabl":[8,9,10,11,12,13,21],"reader":38,"readi":41,"readm":[0,1,41],"readtimeout":38,"reallywellkeptsecret":13,"realm":[0,1,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,19,20,21,22,23,24,25,26,27,35,36,37,38,39,40,43,44,45],"realm_info":29,"realm_rolemap":33,"realmrol":24,"reason":40,"rebuild":[0,44],"rec":13,"recent":0,"recogn":40,"recognis":44,"recommend":44,"record":[32,38],"recoveri":0,"recreat":[5,36],"red":[1,3,38,43,45],"redact":38,"redhat":1,"redhat_csp_download":0,"redirect":[0,8,13,25,37],"redirect_uri":[13,37],"redirecturi":[13,37],"reduc":[0,14,19,20,24,26,33,39],"refer":[1,13,25,36,38,40,45],"referenc":[13,36],"referr":38,"reflect":44,"refresh":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40],"refresh_token":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40],"refresh_token_max_reus":28,"refreshtokenmaxreus":28,"regardless":[28,32],"regener":[1,3,4],"regex":13,"regist":[7,13,24,25,28,31],"registered_nod":13,"registerednod":13,"registr":[7,8,13,28,38,40],"registration_access_token":13,"registration_allow":28,"registration_email_as_usernam":28,"registration_flow":28,"registrationaccesstoken":13,"registrationallow":28,"registrationemailasusernam":28,"registrationflow":28,"registri":44,"regular":[13,40,44],"relat":[0,1,13,42,44],"releas":[3,43,44],"relev":[27,44],"reli":[28,44],"remain":38,"rememb":28,"remember_m":28,"rememberm":28,"remembertochangem":43,"remot":[0,43,44],"remote_src":44,"remov":[0,3,5,6,8,9,10,11,13,14,15,16,17,19,20,21,22,24,25,26,28,30,32,33,35,36,38,39,40,43,44],"remove_unspecified_mapp":38,"renam":[0,8],"replac":[0,1,2,14,32,33,39],"repo":[0,44],"report":[0,1,37],"repositori":[0,2,44,46],"repository_url":44,"represent":[5,6,7,8,9,10,11,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,33,35,36,38,39],"request":[1,11,13,14,21,25,28,33,38,39,43,44],"requir":[0,1,2,3,4,5,6,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,45,46],"required_act":[7,36],"requiredact":36,"requirementchoic":[5,8],"requisit":[6,9,10,11,12,13,14,15,16,17,18,19,20,21,22,24,25,26,28,30,33,35,38,39],"reset":[28,36,37],"reset_credentials_flow":28,"reset_password_allow":28,"resetcredentialsflow":28,"resetpasswordallow":28,"resid":[6,8,14,15,16,17,19,20,24,25,26,28,33,35,37,38,39],"resolv":44,"resourc":[1,11,12,30,44],"resourcepermiss":[11,12],"respect":44,"respons":[11,13,25,30,38],"rest":[1,6,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,24,25,26,28,29,30,31,32,33,34,35,38,39,40,43,44,45],"restart":[0,43,44],"restartsec":[43,44],"restor":8,"restrict":[0,3,4],"result":[0,11,19,20,44],"result_new_kcgrp":24,"result_new_kcgrp_sub":24,"retri":0,"retriev":[1,3,4],"retriv":23,"return":[4,41,44],"reus":28,"revers":[0,43,44],"review":[5,8],"revis":41,"revok":[13,28],"revoke_refresh_token":28,"revokerefreshtoken":28,"rfc":38,"rh":[0,1,43],"rhbk":[0,1,44],"rhds":38,"rhel":[43,44,46],"rhel9":0,"right":[6,9,10,11,12,13,14,15,16,17,18,19,20,21,22,24,25,26,28,30,33,35,38,39],"ripper":44,"role":[0,2,3,4,6,9,10,11,12,13,14,16,18,19,20,21,22,24,25,26,28,30,36,38,39,40,46],"role1":[14,33,39],"role_id1":[14,33,39],"role_id2":[14,33,39],"role_nam":[15,17],"role_name1":[14,33,39],"role_name2":[14,33,39],"role_owner_client_id":15,"role_represent":[14,33,39],"rolemap":[14,33,39],"romain":[43,45],"root":[1,8,13,43,44],"root_url":13,"rooturl":13,"rotat":[0,44],"rout":[0,43,44],"rpm":[43,44],"rs256":[13,14,28,30,31,33,39],"rs384":30,"rs512":30,"rsa":[22,23,30],"rsa1_5":30,"rsa_sha1":13,"rsa_sha256":13,"rsa_sha512":13,"rule":0,"run":[0,1,2,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,43,44,46],"runtim":[0,43,44],"s":[1,3,13,14,19,20,24,30,32,33,36,37,42],"safe":[3,4,26],"said":30,"samaccountnam":38,"saml":[13,16,21,25,28],"saml_assertion_consumer_url_post":13,"saml_assertion_consumer_url_redirect":13,"saml_force_name_id_format":13,"saml_name_id_format":13,"saml_signature_canonicalization_method":13,"saml_single_logout_service_url_post":13,"saml_single_logout_service_url_redirect":13,"sampl":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,24,25,26,28,29,30,32,33,34,35,38,39,40,46],"samuli":[9,10,11,12,30],"saniti":[0,13,28],"save":[13,44],"scenario":[41,46],"scheme":44,"scope":[1,3,4,6,10,11,12,13,14,19,20,21,22,24,25,26,28,30,33,35,38,39,40,45],"scopepermiss":[11,12],"scram":[43,44],"screen":25,"script":[10,13,21],"search":[27,38],"searchscop":38,"seclist":44,"second":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,44],"secondari":28,"secret":[0,1,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,45],"secret_s":30,"section":[13,41],"secur":[3,28],"see":[1,4,13,22,25,31,35,38,40,41,44,45],"seen":12,"select":[0,43],"selectattr":31,"selector":40,"self":[2,36],"semant":41,"semver":41,"send":[3,4,13,25,30],"sensibl":[13,21,28],"sensit":0,"sent":[13,25,30,37,38],"separ":[2,6,9,10,11,12,13,14,15,16,17,18,19,20,21,22,24,25,26,28,30,33,35,38,39,44],"sepp\u00e4nen":[9,10,11,12,30],"septemb":43,"sequenc":0,"serial":44,"serial_then_parallel":44,"serv":44,"server":[1,10,13,21,25,28,30,36,38,40,43,44],"server_develop":22,"serverprincip":38,"servic":[0,1,9,10,11,12,13,23,25,29,38,39,42,43,45],"service_account_client_id":36,"service_account_user_client_id":39,"service_accounts_en":13,"serviceaccountclientid":36,"serviceaccountsen":[13,21],"session":[0,13,21,25,28,44],"set":[0,1,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,43,44,45],"setup":[0,2,46],"sh":[0,44],"sha":[43,44],"sha1":44,"sha256":[13,21,30,44],"shall":41,"shape":41,"share":1,"ship":[13,21],"short":[0,38],"show":[0,19,20],"shown":44,"side":[0,30,37],"sign":[1,3,13,30,43,45],"signatur":[13,14,25,28,33,39],"silent":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40],"simon":18,"simonpahl":18,"simpl":38,"simplifi":0,"sinc":[13,21,25,30,36,38,44],"singl":[1,2,3,13,14,15,17,24,26,29,33,35,38,39,40,43,45],"singlelogoutserviceurl":25,"singlesignonserviceurl":25,"size":[30,44],"skip":[0,1],"skrekulko":7,"slash":2,"slow":38,"smaller":41,"smtp":28,"smtp_server":28,"smtpserver":28,"snake_cas":[9,10,11,12,13,14,21,22,24,25,26,28,29,30,31,32,33,34,35,38,39,40],"socket":43,"softwar":44,"some_realm":22,"someth":44,"sort":[0,14,24,33],"sourc":[2,13,21,44,46],"sovellukseni":32,"space":[2,38],"spec":0,"specif":[1,2,3,4,13,21,25,27,28,44],"specifi":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,44],"spell":0,"spi":[0,38,44],"spis":[13,21,44],"spnego":38,"sql":43,"sqlserver":[0,43],"ss":44,"ssl":[28,38,44],"ssl_requir":28,"sslrequir":28,"sso":[0,1,28,43],"sso_session_idle_timeout":28,"sso_session_idle_timeout_remember_m":28,"sso_session_max_lifespan":28,"sso_session_max_lifespan_remember_m":28,"ssosessionidletimeout":28,"ssosessionidletimeoutrememberm":28,"ssosessionmaxlifespan":28,"ssosessionmaxlifespanrememberm":28,"sss":44,"sssd":38,"stabl":0,"stack":43,"staff":36,"standalon":[38,43],"standard":[13,38],"standard_flow_en":13,"standardflowen":[13,21],"start":[0,2,14,24,33,40,44],"startlimitburst":43,"startlimitintervalsec":43,"starttl":38,"state":[1,5,6,7,8,9,10,11,12,13,14,15,16,17,19,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,38,39,40,41,45],"statement":13,"static":44,"status":[0,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,43],"step":[1,6,8,45,46],"sticki":0,"storag":[0,22,23,38,45],"store":[0,13,25,38,43,44],"store_token":25,"storetoken":25,"str":44,"strategi":[0,11,12,28,44],"stream":3,"strict":[0,41],"string":[0,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,44],"structur":[5,13,41],"sub":[0,8,13,21,23,24],"sub2":24,"subdirectori":[2,46],"subflow":[5,8],"subflowtyp":[5,8],"subgroup":[0,1,14,24,33,36],"subgroup1":[14,33],"subject":13,"subjectdn":13,"sublow":5,"subnet":[0,43],"subsystem":43,"subtre":38,"succeed":19,"success":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,24,25,26,28,30,32,33,35,36,37,38,39,40,44],"suffici":32,"suffix":[0,8,44],"suitabl":[14,15,17,24,26,29,33,35,39],"supersed":0,"supervisor":[43,44],"suppli":[21,37],"support":[0,3,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,44,45],"supported_local":[28,32],"supportedlocal":28,"suppos":38,"sure":[0,1,2,44],"surrog":13,"surrogate_auth_requir":13,"surrogateauthrequir":13,"swap":8,"switch":0,"symlink":0,"sync":[25,38],"sync_mod":25,"synchron":38,"syncmod":25,"syncregistr":38,"synopsi":4,"syntax":[0,36],"sysconfig":[0,44],"system":46,"systemd":[0,43,44,46],"t":[2,40,44],"tag":[2,41],"tailor":[6,9,10,11,12,13,14,15,16,17,18,19,20,21,22,24,25,26,28,30,33,35,38,39],"take":13,"taken":[5,6,7,8,9,10,11,12,13,14,15,16,18,20,21,24,25,26,28,29,30,31,33,35,38,39],"tar":2,"target":[1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,44],"target_client_id":15,"target_usernam":39,"task":[0,1,2,19,20,43,44,45],"tcp":[43,44],"tcpping":[0,43],"technic":[35,36],"templat":[0,1,3,4,13,43,44],"temporari":[8,28,36],"temporary_swap_flow_suffix":8,"term":7,"terms_and_condit":7,"test":[0,1,2,3,5,7,13,14,24,28,33,35,39,41],"test01":[13,21],"test02":13,"test1":5,"test2":5,"testattribut":40,"testclient":[13,21],"testrealm":[1,6,16,28,45],"testus":1,"text":[1,28,44],"textual":19,"theme":[0,28],"therefor":[11,30,41],"thing":11,"this_is_a_test":[13,21],"thoma":[8,31],"thomasbach":31,"thomasbargetz":8,"though":21,"thus":[30,44],"time":[0,13,14,24,28,33,41],"timeout":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40],"timestamp":[13,30],"titl":32,"tls":[0,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,43,44,45],"tmp":31,"togeth":6,"token":[0,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,45],"tokenurl":25,"tomcat":3,"tool":2,"top":[0,6,14,24,33,38],"toplevel":[5,6,8],"tr":13,"trace":38,"track":25,"trail":2,"transact":[0,38,44],"transfer":8,"transient":[0,13,25],"translat":[14,15,17,19,20,24,26,29,33,35,39],"tree":38,"trigger":[0,1,8,25,30,37,41],"true":[0,1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,43,44,45],"truli":11,"truncat":[13,14,18,21,24,28,33,35,39],"trust":[0,44],"trust_email":25,"trust_stor":44,"trustemail":[25,38],"truststor":[38,43],"turn":0,"txt":[0,1,2,43,44],"type":[0,3,4,5,8,10,11,12,13,16,19,20,21,22,23,25,28,30,36,38,40,43,44,45],"typic":38,"typograph":3,"ubuntu":0,"ui":28,"uid":[38,39],"unabl":30,"unanim":[11,12],"unauthoris":8,"undefin":[0,44],"underscor":2,"unexpect":0,"union":0,"uniqu":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],"unique_realm_nam":28,"unit":[0,44],"unix":13,"unmanag":40,"unmanaged_attribute_polici":40,"unmanagedattributepolici":40,"unmap":[14,33,39],"unrelax":0,"unsaf":8,"unset":0,"unsign":13,"unspecifi":0,"unsur":40,"unsync":38,"untrust":38,"up_username_not_idn_homograph":40,"updat":[0,1,5,7,8,9,10,11,13,14,15,16,21,22,24,25,26,28,30,32,33,35,36,38,39,40,41],"update_password":[30,37],"updateprofilefirstlogin":38,"upgrad":3,"upload":44,"upon":0,"upstream":[0,44],"upusernamenotidnhomograph":40,"uri":[9,13,24,25,37,40],"url":[0,1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,43,44,45],"usag":[0,3,4],"use":[0,1,2,3,4,5,6,7,8,12,14,15,16,17,23,27,32,33,36,37,39,40,43,44,45],"use_netrc":[0,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40],"use_template_config":13,"use_template_mapp":13,"use_template_scop":13,"usejwksurl":25,"usekerberosforpasswordauthent":38,"usepasswordmodifyextendedop":38,"user":[0,1,2,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,35,39,41,43,44,45],"user1":[34,36,39],"user2":34,"user_cr":36,"user_id":37,"user_managed_access_allow":28,"user_rolemap":[3,4],"user_uid":39,"userinfo":[13,16,21,25],"userinfourl":25,"usermanagedaccessallow":28,"usermodel":[13,16,21,45],"usernam":[1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,43,44,45],"username_prohibited_charact":40,"usernameldapattribut":38,"usernameprohibitedcharact":40,"userobjectclass":38,"userprofil":[22,23,40],"userprofileprovid":[22,23,40],"usersdn":38,"usersessionmodel":[13,21],"userstorageprovid":[22,23,38,45],"usetemplateconfig":13,"usetemplatemapp":13,"usetemplatescop":13,"usetruststorespi":38,"usual":[9,10,11,12,13,21,28,38],"util":[0,3],"uuid":[6,13,16,21,31,37,38],"uuidldapattribut":38,"v1":3,"v2":[1,3,13,21],"v21":0,"v26":0,"v3":3,"val1":[24,26],"val2":[24,26],"val3":24,"valid":[0,2,13,21,25,30,37,38,40,43,44],"valid_post_logout_redirect_uri":13,"valid_to":30,"validate_cert":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],"validatepasswordpolici":38,"validatesignatur":25,"valu":[0,4,44,45],"value1":[24,35,36],"value2":[24,35,36],"var":[0,2,43,44,45],"vari":22,"variabl":[0,1,2,42],"various":[13,21],"vault":[0,42],"vendor":38,"verif":[25,28,38,44],"verifi":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,44,46],"verify_email":[28,37],"verifyemail":28,"version":[0,2,3,9,10,11,12,13,14,21,22,24,25,26,28,29,30,31,32,33,34,35,37,38,39,40,42,44],"via":[0,1,3,4,5,7,8,9,10,11,12,13,14,15,17,18,19,20,21,22,23,24,25,26,27,28,30,31,33,34,35,36,37,38,39,40,43,44],"view":[0,1,24,40],"virtual":2,"virtualenv":2,"vs":2,"w3":13,"wait":[28,44],"wait_for_log":0,"wait_for_port":0,"wait_increment_second":28,"waitincrementsecond":28,"waldt":40,"want":[2,25,30,38],"wantassertionssign":25,"wantauthnrequestssign":25,"warn":[0,44],"way":[13,14,15,17,21,24,25,26,28,29,33,35,39],"web":45,"web_authn_policy_acceptable_aaguid":28,"web_authn_policy_attestation_conveyance_prefer":28,"web_authn_policy_authenticator_attach":28,"web_authn_policy_avoid_same_authenticator_regist":28,"web_authn_policy_create_timeout":28,"web_authn_policy_extra_origin":28,"web_authn_policy_passwordless_acceptable_aaguid":28,"web_authn_policy_passwordless_attestation_conveyance_prefer":28,"web_authn_policy_passwordless_authenticator_attach":28,"web_authn_policy_passwordless_avoid_same_authenticator_regist":28,"web_authn_policy_passwordless_create_timeout":28,"web_authn_policy_passwordless_extra_origin":28,"web_authn_policy_passwordless_passkeys_en":28,"web_authn_policy_passwordless_require_resident_key":28,"web_authn_policy_passwordless_rp_entity_nam":28,"web_authn_policy_passwordless_rp_id":28,"web_authn_policy_passwordless_signature_algorithm":28,"web_authn_policy_passwordless_user_verification_requir":28,"web_authn_policy_require_resident_key":28,"web_authn_policy_rp_entity_nam":28,"web_authn_policy_rp_id":28,"web_authn_policy_signature_algorithm":28,"web_authn_policy_user_verification_requir":28,"web_origin":[13,45],"webauthn":28,"webauthnpolicyacceptableaaguid":28,"webauthnpolicyattestationconveyanceprefer":28,"webauthnpolicyauthenticatorattach":28,"webauthnpolicyavoidsameauthenticatorregist":28,"webauthnpolicycreatetimeout":28,"webauthnpolicyextraorigin":28,"webauthnpolicypasswordlessacceptableaaguid":28,"webauthnpolicypasswordlessattestationconveyanceprefer":28,"webauthnpolicypasswordlessauthenticatorattach":28,"webauthnpolicypasswordlessavoidsameauthenticatorregist":28,"webauthnpolicypasswordlesscreatetimeout":28,"webauthnpolicypasswordlessextraorigin":28,"webauthnpolicypasswordlesspasskeysen":28,"webauthnpolicypasswordlessrequireresidentkey":28,"webauthnpolicypasswordlessrpentitynam":28,"webauthnpolicypasswordlessrpid":28,"webauthnpolicypasswordlesssignaturealgorithm":28,"webauthnpolicypasswordlessuserverificationrequir":28,"webauthnpolicyrequireresidentkey":28,"webauthnpolicyrpentitynam":28,"webauthnpolicyrpid":28,"webauthnpolicysignaturealgorithm":28,"webauthnpolicyuserverificationrequir":28,"weborigin":13,"week":38,"well":[13,22,25,28,30,44],"wflyctl0117":0,"wherea":11,"whether":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,44],"whistl":13,"whole":38,"whose":39,"wildfli":[1,3,45],"will":[0,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,43,44],"window":28,"withcom":13,"within":[1,3,8,16,25,26,30,38],"without":[0,1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],"wonder":13,"work":[0,1,6,9,10,11,12,13,14,15,16,17,18,19,20,21,22,24,25,26,28,30,33,35,38,39,43,44],"workflow":0,"writabl":38,"write":[31,38,40],"written":[38,44],"www":[9,10,11,12,13,14,21,22,24,25,26,28,29,30,31,33,34,35,38,39,40,44],"x":[0,1],"x27":[13,14,21,24,30,32,33,36,38],"x509":13,"xa":[0,44],"xa_datasource_class":0,"xforward":44,"xml":[0,13,38,43,44],"xms1024m":[43,44],"xmx2048m":[43,44],"y":1,"yaml":[0,2],"yamllint":2,"yeoldegrov":40,"yes":[28,44],"yet":[5,6,8,13,14,15,16,17,24,25,26,33,35,38,39,40],"yml":[1,2,43,44,46],"yum":[43,44],"yyyi":44,"z":1,"zip":[1,43,44]},"titles":["middleware_automation.keycloak Release Notes","Ansible Collection - middleware_automation.keycloak","Developing","Welcome to Keycloak Collection documentation","Plugin Index","keycloak_authentication \u2013 Configure authentication in Keycloak","keycloak_authentication_flow \u2013 Allows administration of Keycloak authentication flows via Keycloak API","keycloak_authentication_required_actions \u2013 Allows administration of Keycloak authentication required actions","keycloak_authentication_v2 \u2013 Configure authentication flows in Keycloak in an idempotent and safe manner.","keycloak_authz_authorization_scope \u2013 Allows administration of Keycloak client authorization scopes using Keycloak API","keycloak_authz_custom_policy \u2013 Allows administration of Keycloak client custom Javascript policies using Keycloak API","keycloak_authz_permission \u2013 Allows administration of Keycloak client authorization permissions using Keycloak API","keycloak_authz_permission_info \u2013 Query Keycloak client authorization permissions information","keycloak_client \u2013 Allows administration of Keycloak clients using Keycloak API","keycloak_client_rolemapping \u2013 Allows administration of Keycloak client_rolemapping with the Keycloak API","keycloak_client_rolescope \u2013 Allows administration of Keycloak client roles scope to restrict the usage of certain roles to a other specific client applications","keycloak_client_scope \u2013 Allows administration of Keycloak client scopes via Keycloak API","keycloak_client_scope_rolemappings \u2013 Allows administration of Keycloak client scope scope mappings to restrict the usage of certain roles to specific client scopes","keycloak_client_scope_type \u2013 Set the type of a client scope in a realm or client using the Keycloak API","keycloak_clientsecret_info \u2013 Retrieve client secret using Keycloak API","keycloak_clientsecret_regenerate \u2013 Regenerate Keycloak client secret using Keycloak API","keycloak_clienttemplate \u2013 Allows administration of Keycloak client templates using Keycloak API","keycloak_component \u2013 Allows administration of Keycloak components using Keycloak API","keycloak_component_info \u2013 Retrieve component info in Keycloak","keycloak_group \u2013 Allows administration of Keycloak groups using Keycloak API","keycloak_identity_provider \u2013 Allows administration of Keycloak identity providers using Keycloak API","keycloak_organization \u2013 Allows administration of Keycloak organizations using Keycloak API","keycloak_organization_info \u2013 Retrieve organization info in Keycloak","keycloak_realm \u2013 Allows administration of Keycloak realm using Keycloak API","keycloak_realm_info \u2013 Allows obtaining Keycloak realm public information using Keycloak API","keycloak_realm_key \u2013 Allows administration of Keycloak realm keys using Keycloak API","keycloak_realm_keys_metadata_info \u2013 Allows obtaining Keycloak realm keys metadata using Keycloak API","keycloak_realm_localization \u2013 Allows management of Keycloak realm localization overrides via the Keycloak API","keycloak_realm_rolemapping \u2013 Allows administration of Keycloak realm role mappings into groups with the Keycloak API","keycloak_realm_users_info \u2013 Retrieve users from a Keycloak realm using the Keycloak API","keycloak_role \u2013 Allows administration of Keycloak roles using Keycloak API","keycloak_user \u2013 Create and configure a user in Keycloak","keycloak_user_execute_actions_email \u2013 Send a Keycloak execute-actions email to a user","keycloak_user_federation \u2013 Allows administration of Keycloak user federations using Keycloak API","keycloak_user_rolemapping \u2013 Allows administration of Keycloak user_rolemapping with the Keycloak API","keycloak_userprofile \u2013 Allows managing Keycloak User Profiles","Collection Versioning Strategy","Role Index","keycloak","keycloak_quarkus","keycloak_realm","Testing"],"titleterms":{"A":41,"action":[7,37],"add":41,"administr":[6,7,9,10,11,13,14,15,16,17,21,22,24,25,26,28,30,33,35,38,39],"allow":[6,7,9,10,11,13,14,15,16,17,21,22,24,25,26,28,29,30,31,32,33,35,38,39,40],"also":32,"altern":1,"ani":41,"ansibl":1,"api":[6,9,10,11,13,14,16,18,19,20,21,22,24,25,26,28,29,30,31,32,33,34,35,38,39],"applic":15,"artifactori":1,"attribut":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],"authent":[5,6,7,8],"author":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,43,44,45],"autom":41,"avail":44,"backward":41,"break":[0,41],"bug":41,"bugfix":0,"build":2,"cach":44,"certain":[15,17],"chang":[0,41],"client":[9,10,11,12,13,15,16,17,18,19,20,21],"client_rolemap":14,"collect":[1,3,41],"command":1,"compat":[1,41],"compon":[22,23],"configur":[1,5,8,36,44],"content":41,"continu":46,"contributor":2,"control":1,"corpor":1,"creat":36,"custom":[10,44],"databas":44,"default":[43,44,45],"depend":[43,44],"develop":[2,3],"document":[3,41],"email":37,"environ":2,"error":41,"etc":1,"exampl":[1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,43,45],"execut":37,"exist":41,"fact":44,"featur":41,"feder":38,"fix":41,"flow":[6,8],"format":45,"galaxi":1,"group":[24,33],"guid":0,"guidelin":2,"high":44,"hostnam":44,"http":44,"idempot":8,"ident":25,"includ":1,"index":[4,42],"infinispan":44,"info":[23,27],"inform":[12,29,43,44,45],"instal":[1,2,44],"integr":46,"javascript":10,"key":[30,31],"keycloak":[0,1,3,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,43],"keycloak_authent":5,"keycloak_authentication_flow":6,"keycloak_authentication_required_act":7,"keycloak_authentication_v2":8,"keycloak_authz_authorization_scop":9,"keycloak_authz_custom_polici":10,"keycloak_authz_permiss":11,"keycloak_authz_permission_info":12,"keycloak_cli":13,"keycloak_client_rolemap":14,"keycloak_client_rolescop":15,"keycloak_client_scop":16,"keycloak_client_scope_rolemap":17,"keycloak_client_scope_typ":18,"keycloak_clientsecret_info":19,"keycloak_clientsecret_regener":20,"keycloak_clienttempl":21,"keycloak_compon":22,"keycloak_component_info":23,"keycloak_group":24,"keycloak_identity_provid":25,"keycloak_organ":26,"keycloak_organization_info":27,"keycloak_quarkus":44,"keycloak_realm":[28,45],"keycloak_realm_info":29,"keycloak_realm_key":30,"keycloak_realm_keys_metadata_info":31,"keycloak_realm_loc":32,"keycloak_realm_rolemap":33,"keycloak_realm_users_info":34,"keycloak_rol":35,"keycloak_us":36,"keycloak_user_execute_actions_email":37,"keycloak_user_feder":38,"keycloak_user_rolemap":39,"keycloak_userprofil":40,"licens":[1,43,44,45],"like":1,"local":[2,32],"log":44,"major":0,"manag":[32,40],"manner":8,"map":[17,33],"metadata":31,"middlewar":3,"middleware_autom":[0,1],"minor":0,"miscellan":44,"modifi":41,"modul":[0,1,4,45],"new":[0,41],"nexus":1,"node":1,"note":[0,1,21,24,30,36,40],"obtain":[29,31],"offlin":1,"option":44,"organiz":[26,27],"overrid":32,"paramet":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],"patch":43,"permiss":[11,12],"playbook":[43,45,46],"plugin":[4,41],"polici":[10,44],"port":0,"profil":40,"provid":[25,44],"proxi":1,"public":29,"queri":12,"realm":[18,28,29,30,31,32,33,34],"regener":20,"relat":45,"releas":[0,1,41],"remov":41,"requir":[7,43,44],"restrict":[15,17],"retriev":[19,23,27,34],"return":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],"role":[1,15,17,33,35,41,42,43,44,45],"s":[2,44],"safe":8,"scope":[9,15,16,17,18],"secret":[19,20],"secur":41,"see":32,"send":37,"servic":44,"set":18,"sourc":1,"specif":[15,17],"strategi":41,"summari":0,"support":1,"synopsi":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],"templat":21,"test":46,"topic":0,"type":18,"typograph":41,"upgrad":1,"usag":[1,15,17],"use":[9,10,11,13,18,19,20,21,22,24,25,26,28,29,30,31,34,35,38],"user":[3,34,36,37,38,40],"user_rolemap":39,"v1":0,"v2":0,"v3":0,"valu":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],"variabl":[43,44,45],"vault":44,"version":[1,41,43],"via":[6,16,32],"welcom":3,"within":41}}) \ No newline at end of file diff --git a/3.1.2/testing.html b/3.1.2/testing.html new file mode 100644 index 0000000..f6e32d2 --- /dev/null +++ b/3.1.2/testing.html @@ -0,0 +1,155 @@ + + + + + + + + + Testing — Keycloak Ansible Collection documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Testing

+
+

Continuous integration

+

The collection is tested with a molecule setup covering the included roles and verifying correct installation and idempotency. +In order to run the molecule tests locally with python 3.9 available, after cloning the repository: +The test scenarios are available on the source code repository each on his own subdirectory under molecule/.

+
+
+

Test playbooks

+

Sample playbooks are provided in the playbooks/ directory; to run the playbooks locally (requires a rhel system with python 3.9+, ansible, and systemd) the steps are as follows:

+
# setup environment as in developing
+# create inventory for localhost
+cat << EOF > inventory
+[keycloak]
+localhost ansible_connection=local
+EOF
+# run the playbook
+ansible-playbook -i inventory playbooks/keycloak.yml
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file