ansible-collections/middleware_automation.keycloak
1
0
Fork 0
mirror of https://github.com/ansible-middleware/keycloak.git synced 2025-04-14 23:00:28 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Update docs for main

Browse source
This commit is contained in:
github-actions 2023-03-08 07:52:37 +00:00
parent b68c066200
commit e7648fe428
23 changed files with 10869 additions and 95 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

189
main/CHANGELOG.html
View file

@ -44,6 +44,7 @@
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="README.html">Ansible Collection - middleware_automation.keycloak</a></li>
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Plugin Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>
@ -57,6 +58,7 @@
<li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#v1-2-0-devel">v1.2.0-devel</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#major-changes">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#minor-changes">Minor Changes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-1-1">v1.1.1</a><ul>
@ -64,44 +66,44 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-1-0">v1.1.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#minor-changes">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id4">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#breaking-changes-porting-guide">Breaking Changes / Porting Guide</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id8">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id10">Bugfixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-7">v1.0.7</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id10">Breaking Changes / Porting Guide</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id12">Bugfixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-6">v1.0.6</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id12">Breaking Changes / Porting Guide</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id14">Bugfixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-6">v1.0.6</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id16">Bugfixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-5">v1.0.5</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id17">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id19">Minor Changes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-4">v1.0.4</a></li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-3">v1.0.3</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id19">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id21">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id23">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id21">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id23">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id25">Bugfixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-2">v1.0.2</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id25">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id28">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id27">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id30">Bugfixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-1">v1.0.1</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#release-summary">Release Summary</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id30">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id32">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id32">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id34">Minor Changes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-0">v1.0.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id34">Release Summary</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id36">Release Summary</a></li>
</ul>
</li>
</ul>
@ -144,69 +146,70 @@
<div itemprop="articleBody">
<section id="middleware-automation-keycloak-release-notes">
<h1><a class="toc-backref" href="#id35" role="doc-backlink">middleware_automation.keycloak Release Notes</a><a class="headerlink" href="#middleware-automation-keycloak-release-notes" title="Permalink to this heading"></a></h1>
<h1><a class="toc-backref" href="#id37" role="doc-backlink">middleware_automation.keycloak Release Notes</a><a class="headerlink" href="#middleware-automation-keycloak-release-notes" title="Permalink to this heading"></a></h1>
<nav class="contents" id="topics">
<p class="topic-title">Topics</p>
<ul class="simple">
<li><p><a class="reference internal" href="#middleware-automation-keycloak-release-notes" id="id35">middleware_automation.keycloak Release Notes</a></p>
<li><p><a class="reference internal" href="#middleware-automation-keycloak-release-notes" id="id37">middleware_automation.keycloak Release Notes</a></p>
<ul>
<li><p><a class="reference internal" href="#v1-2-0-devel" id="id36">v1.2.0-devel</a></p>
<li><p><a class="reference internal" href="#v1-2-0-devel" id="id38">v1.2.0-devel</a></p>
<ul>
<li><p><a class="reference internal" href="#major-changes" id="id37">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#major-changes" id="id39">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#minor-changes" id="id40">Minor Changes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-1-1" id="id38">v1.1.1</a></p>
<li><p><a class="reference internal" href="#v1-1-1" id="id41">v1.1.1</a></p>
<ul>
<li><p><a class="reference internal" href="#bugfixes" id="id39">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#bugfixes" id="id42">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-1-0" id="id40">v1.1.0</a></p>
<li><p><a class="reference internal" href="#v1-1-0" id="id43">v1.1.0</a></p>
<ul>
<li><p><a class="reference internal" href="#minor-changes" id="id41">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#breaking-changes-porting-guide" id="id42">Breaking Changes / Porting Guide</a></p></li>
<li><p><a class="reference internal" href="#id8" id="id43">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id4" id="id44">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#breaking-changes-porting-guide" id="id45">Breaking Changes / Porting Guide</a></p></li>
<li><p><a class="reference internal" href="#id10" id="id46">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-7" id="id44">v1.0.7</a></p>
<li><p><a class="reference internal" href="#v1-0-7" id="id47">v1.0.7</a></p>
<ul>
<li><p><a class="reference internal" href="#id10" id="id45">Breaking Changes / Porting Guide</a></p></li>
<li><p><a class="reference internal" href="#id12" id="id46">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id12" id="id48">Breaking Changes / Porting Guide</a></p></li>
<li><p><a class="reference internal" href="#id14" id="id49">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-6" id="id47">v1.0.6</a></p>
<li><p><a class="reference internal" href="#v1-0-6" id="id50">v1.0.6</a></p>
<ul>
<li><p><a class="reference internal" href="#id14" id="id48">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id16" id="id51">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-5" id="id49">v1.0.5</a></p>
<li><p><a class="reference internal" href="#v1-0-5" id="id52">v1.0.5</a></p>
<ul>
<li><p><a class="reference internal" href="#id17" id="id50">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id19" id="id53">Minor Changes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-4" id="id51">v1.0.4</a></p></li>
<li><p><a class="reference internal" href="#v1-0-3" id="id52">v1.0.3</a></p>
<li><p><a class="reference internal" href="#v1-0-4" id="id54">v1.0.4</a></p></li>
<li><p><a class="reference internal" href="#v1-0-3" id="id55">v1.0.3</a></p>
<ul>
<li><p><a class="reference internal" href="#id19" id="id53">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id21" id="id54">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id23" id="id55">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id21" id="id56">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id23" id="id57">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id25" id="id58">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-2" id="id56">v1.0.2</a></p>
<li><p><a class="reference internal" href="#v1-0-2" id="id59">v1.0.2</a></p>
<ul>
<li><p><a class="reference internal" href="#id25" id="id57">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id28" id="id58">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id27" id="id60">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id30" id="id61">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-1" id="id59">v1.0.1</a></p>
<li><p><a class="reference internal" href="#v1-0-1" id="id62">v1.0.1</a></p>
<ul>
<li><p><a class="reference internal" href="#release-summary" id="id60">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id30" id="id61">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id32" id="id62">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#release-summary" id="id63">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id32" id="id64">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id34" id="id65">Minor Changes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-0" id="id63">v1.0.0</a></p>
<li><p><a class="reference internal" href="#v1-0-0" id="id66">v1.0.0</a></p>
<ul>
<li><p><a class="reference internal" href="#id34" id="id64">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id36" id="id67">Release Summary</a></p></li>
</ul>
</li>
</ul>
@ -215,27 +218,33 @@
</nav>
<p>This changelog describes changes after version 0.2.6.</p>
<section id="v1-2-0-devel">
<h2><a class="toc-backref" href="#id36" role="doc-backlink">v1.2.0-devel</a><a class="headerlink" href="#v1-2-0-devel" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id38" role="doc-backlink">v1.2.0-devel</a><a class="headerlink" href="#v1-2-0-devel" title="Permalink to this heading"></a></h2>
<section id="major-changes">
<h3><a class="toc-backref" href="#id37" role="doc-backlink">Major Changes</a><a class="headerlink" href="#major-changes" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id39" role="doc-backlink">Major Changes</a><a class="headerlink" href="#major-changes" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Provide config for multiple modcluster proxies <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/60">#60</a></p></li>
</ul>
</section>
<section id="minor-changes">
<h3><a class="toc-backref" href="#id40" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#minor-changes" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Drop community.general from dependencies <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/61">#61</a></p></li>
</ul>
</section>
</section>
<section id="v1-1-1">
<h2><a class="toc-backref" href="#id38" role="doc-backlink">v1.1.1</a><a class="headerlink" href="#v1-1-1" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id41" role="doc-backlink">v1.1.1</a><a class="headerlink" href="#v1-1-1" title="Permalink to this heading"></a></h2>
<section id="bugfixes">
<h3><a class="toc-backref" href="#id39" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#bugfixes" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id42" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#bugfixes" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>keycloak-quarkus: fix <code class="docutils literal notranslate"><span class="pre">cache-config-file</span></code> path in keycloak.conf.j2 template <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/53">#53</a></p></li>
</ul>
</section>
</section>
<section id="v1-1-0">
<h2><a class="toc-backref" href="#id40" role="doc-backlink">v1.1.0</a><a class="headerlink" href="#v1-1-0" title="Permalink to this heading"></a></h2>
<section id="minor-changes">
<h3><a class="toc-backref" href="#id41" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#minor-changes" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id43" role="doc-backlink">v1.1.0</a><a class="headerlink" href="#v1-1-0" title="Permalink to this heading"></a></h2>
<section id="id4">
<h3><a class="toc-backref" href="#id44" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id4" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Update keycloak to 18.0.2 - sso to 7.6.1 <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/46">#46</a></p></li>
<li><p>Variable <code class="docutils literal notranslate"><span class="pre">keycloak_no_log</span></code> controls ansible <code class="docutils literal notranslate"><span class="pre">no_log</span></code> parameter (for debugging purposes) <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/47">#47</a></p></li>
@ -244,37 +253,37 @@
</ul>
</section>
<section id="breaking-changes-porting-guide">
<h3><a class="toc-backref" href="#id42" role="doc-backlink">Breaking Changes / Porting Guide</a><a class="headerlink" href="#breaking-changes-porting-guide" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id45" role="doc-backlink">Breaking Changes / Porting Guide</a><a class="headerlink" href="#breaking-changes-porting-guide" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Rename variables from <code class="docutils literal notranslate"><span class="pre">infinispan_</span></code> prefix to <code class="docutils literal notranslate"><span class="pre">keycloak_infinispan_</span></code> <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/42">#42</a></p></li>
</ul>
</section>
<section id="id8">
<h3><a class="toc-backref" href="#id43" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id8" title="Permalink to this heading"></a></h3>
<section id="id10">
<h3><a class="toc-backref" href="#id46" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id10" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>keycloak_quarkus: fix /var/log/keycloak symlink to keycloak log directory <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/44">#44</a></p></li>
</ul>
</section>
</section>
<section id="v1-0-7">
<h2><a class="toc-backref" href="#id44" role="doc-backlink">v1.0.7</a><a class="headerlink" href="#v1-0-7" title="Permalink to this heading"></a></h2>
<section id="id10">
<h3><a class="toc-backref" href="#id45" role="doc-backlink">Breaking Changes / Porting Guide</a><a class="headerlink" href="#id10" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id47" role="doc-backlink">v1.0.7</a><a class="headerlink" href="#v1-0-7" title="Permalink to this heading"></a></h2>
<section id="id12">
<h3><a class="toc-backref" href="#id48" role="doc-backlink">Breaking Changes / Porting Guide</a><a class="headerlink" href="#id12" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>keycloak_quarkus: use absolute path for certificate files <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/39">#39</a></p></li>
</ul>
</section>
<section id="id12">
<h3><a class="toc-backref" href="#id46" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id12" title="Permalink to this heading"></a></h3>
<section id="id14">
<h3><a class="toc-backref" href="#id49" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id14" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>keycloak_quarkus: use become for tasks that will otherwise fail <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/38">#38</a></p></li>
</ul>
</section>
</section>
<section id="v1-0-6">
<h2><a class="toc-backref" href="#id47" role="doc-backlink">v1.0.6</a><a class="headerlink" href="#v1-0-6" title="Permalink to this heading"></a></h2>
<section id="id14">
<h3><a class="toc-backref" href="#id48" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id14" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id50" role="doc-backlink">v1.0.6</a><a class="headerlink" href="#v1-0-6" title="Permalink to this heading"></a></h2>
<section id="id16">
<h3><a class="toc-backref" href="#id51" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id16" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>keycloak_quarkus: add selected java to PATH in systemd unit <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/34">#34</a></p></li>
<li><p>keycloak_quarkus: set logfile path correctly under keycloak home <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/35">#35</a></p></li>
@ -282,77 +291,77 @@
</section>
</section>
<section id="v1-0-5">
<h2><a class="toc-backref" href="#id49" role="doc-backlink">v1.0.5</a><a class="headerlink" href="#v1-0-5" title="Permalink to this heading"></a></h2>
<section id="id17">
<h3><a class="toc-backref" href="#id50" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id17" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id52" role="doc-backlink">v1.0.5</a><a class="headerlink" href="#v1-0-5" title="Permalink to this heading"></a></h2>
<section id="id19">
<h3><a class="toc-backref" href="#id53" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id19" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Update config options: keycloak and quarkus <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/32">#32</a></p></li>
</ul>
</section>
</section>
<section id="v1-0-4">
<h2><a class="toc-backref" href="#id51" role="doc-backlink">v1.0.4</a><a class="headerlink" href="#v1-0-4" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id54" role="doc-backlink">v1.0.4</a><a class="headerlink" href="#v1-0-4" title="Permalink to this heading"></a></h2>
</section>
<section id="v1-0-3">
<h2><a class="toc-backref" href="#id52" role="doc-backlink">v1.0.3</a><a class="headerlink" href="#v1-0-3" title="Permalink to this heading"></a></h2>
<section id="id19">
<h3><a class="toc-backref" href="#id53" role="doc-backlink">Major Changes</a><a class="headerlink" href="#id19" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id55" role="doc-backlink">v1.0.3</a><a class="headerlink" href="#v1-0-3" title="Permalink to this heading"></a></h2>
<section id="id21">
<h3><a class="toc-backref" href="#id56" role="doc-backlink">Major Changes</a><a class="headerlink" href="#id21" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>New role for installing keycloak &gt;= 17.0.0 (quarkus) <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/29">#29</a></p></li>
</ul>
</section>
<section id="id21">
<h3><a class="toc-backref" href="#id54" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id21" title="Permalink to this heading"></a></h3>
<section id="id23">
<h3><a class="toc-backref" href="#id57" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id23" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Add <code class="docutils literal notranslate"><span class="pre">keycloak_config_override_template</span></code> parameter for passing a custom xml config template <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/30">#30</a></p></li>
</ul>
</section>
<section id="id23">
<h3><a class="toc-backref" href="#id55" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id23" title="Permalink to this heading"></a></h3>
<section id="id25">
<h3><a class="toc-backref" href="#id58" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id25" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Make sure systemd unit starts with selected java JVM <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/31">#31</a></p></li>
</ul>
</section>
</section>
<section id="v1-0-2">
<h2><a class="toc-backref" href="#id56" role="doc-backlink">v1.0.2</a><a class="headerlink" href="#v1-0-2" title="Permalink to this heading"></a></h2>
<section id="id25">
<h3><a class="toc-backref" href="#id57" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id25" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id59" role="doc-backlink">v1.0.2</a><a class="headerlink" href="#v1-0-2" title="Permalink to this heading"></a></h2>
<section id="id27">
<h3><a class="toc-backref" href="#id60" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id27" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Make <code class="docutils literal notranslate"><span class="pre">keycloak_admin_password</span></code> a default with assert (was: role variable) <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/26">#26</a></p></li>
<li><p>Simplify dependency install logic and reduce play execution time <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/19">#19</a></p></li>
</ul>
</section>
<section id="id28">
<h3><a class="toc-backref" href="#id58" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id28" title="Permalink to this heading"></a></h3>
<section id="id30">
<h3><a class="toc-backref" href="#id61" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id30" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Set <code class="docutils literal notranslate"><span class="pre">keycloak_frontend_url</span></code> default according to other defaults <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/25">#25</a></p></li>
</ul>
</section>
</section>
<section id="v1-0-1">
<h2><a class="toc-backref" href="#id59" role="doc-backlink">v1.0.1</a><a class="headerlink" href="#v1-0-1" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id62" role="doc-backlink">v1.0.1</a><a class="headerlink" href="#v1-0-1" title="Permalink to this heading"></a></h2>
<section id="release-summary">
<h3><a class="toc-backref" href="#id60" role="doc-backlink">Release Summary</a><a class="headerlink" href="#release-summary" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id63" role="doc-backlink">Release Summary</a><a class="headerlink" href="#release-summary" title="Permalink to this heading"></a></h3>
<p>Minor enhancements, bug and documentation fixes.</p>
</section>
<section id="id30">
<h3><a class="toc-backref" href="#id61" role="doc-backlink">Major Changes</a><a class="headerlink" href="#id30" title="Permalink to this heading"></a></h3>
<section id="id32">
<h3><a class="toc-backref" href="#id64" role="doc-backlink">Major Changes</a><a class="headerlink" href="#id32" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Apply latest cumulative patch of RH-SSO automatically when new parameter <code class="docutils literal notranslate"><span class="pre">keycloak_rhsso_apply_patches</span></code> is <code class="docutils literal notranslate"><span class="pre">true</span></code> <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/18">#18</a></p></li>
</ul>
</section>
<section id="id32">
<h3><a class="toc-backref" href="#id62" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id32" title="Permalink to this heading"></a></h3>
<section id="id34">
<h3><a class="toc-backref" href="#id65" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id34" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Clustered installs now perform database initialization on first node to avoid locking issues <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/17">#17</a></p></li>
</ul>
</section>
</section>
<section id="v1-0-0">
<h2><a class="toc-backref" href="#id63" role="doc-backlink">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Permalink to this heading"></a></h2>
<section id="id34">
<h3><a class="toc-backref" href="#id64" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id34" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id66" role="doc-backlink">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Permalink to this heading"></a></h2>
<section id="id36">
<h3><a class="toc-backref" href="#id67" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id36" title="Permalink to this heading"></a></h3>
<p>This is the first stable release of the <code class="docutils literal notranslate"><span class="pre">middleware_automation.keycloak</span></code> collection.</p>
</section>
</section>

5
main/README.html
View file

@ -19,7 +19,7 @@
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Role Index" href="roles/index.html" />
<link rel="next" title="Plugin Index" href="plugins/index.html" />
<link rel="prev" title="Welcome to Keycloak Collection documentation" href="index.html" />
</head>
@ -69,6 +69,7 @@
<li class="toctree-l2"><a class="reference internal" href="#license">License</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Plugin Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>
@ -253,7 +254,7 @@ the download tasks. The local path for the archive matches the downloaded archiv
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to Keycloak Collection documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="roles/index.html" class="btn btn-neutral float-right" title="Role Index" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="plugins/index.html" class="btn btn-neutral float-right" title="Plugin Index" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>

5
main/_sources/CHANGELOG.rst.txt
View file

@ -14,6 +14,11 @@ Major Changes
- Provide config for multiple modcluster proxies `#60 <https://github.com/ansible-middleware/keycloak/pull/60>`_
Minor Changes
-------------
- Drop community.general from dependencies `#61 <https://github.com/ansible-middleware/keycloak/pull/61>`_
v1.1.1
======

11
main/_sources/plugins/index.rst.txt Normal file
View file

@ -0,0 +1,11 @@
Plugin Index
============
.. toctree::
:caption: modules plugins
:maxdepth: 0
keycloak_client
keycloak_role
keycloak_user_federation

3707
main/_sources/plugins/keycloak_client.rst.txt Normal file
View file

File diff suppressed because it is too large Load diff

1015
main/_sources/plugins/keycloak_role.rst.txt Normal file
View file

File diff suppressed because it is too large Load diff

3233
main/_sources/plugins/keycloak_user_federation.rst.txt Normal file
View file

File diff suppressed because it is too large Load diff

1
main/developing.html
View file

@ -45,6 +45,7 @@
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="README.html">Ansible Collection - middleware_automation.keycloak</a></li>
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Plugin Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>

1
main/genindex.html
View file

@ -42,6 +42,7 @@
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="README.html">Ansible Collection - middleware_automation.keycloak</a></li>
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Plugin Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>

7
main/index.html
View file

@ -44,6 +44,7 @@
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="README.html">Ansible Collection - middleware_automation.keycloak</a></li>
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Plugin Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>
@ -106,6 +107,12 @@
<li class="toctree-l2"><a class="reference internal" href="README.html#license">License</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Plugin Index</a><ul>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_client.html">keycloak_client – Allows administration of Keycloak clients via Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_role.html">keycloak_role – Allows administration of Keycloak roles via Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_user_federation.html">keycloak_user_federation – Allows administration of Keycloak user federations via Keycloak API</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a><ul>
<li class="toctree-l2"><a class="reference internal" href="roles/keycloak.html">keycloak</a></li>
<li class="toctree-l2"><a class="reference internal" href="roles/keycloak_quarkus.html">keycloak_quarkus</a></li>

BIN
main/objects.inv
View file

Binary file not shown.

172
main/plugins/index.html Normal file
View file

@ -0,0 +1,172 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Plugin Index &mdash; Keycloak Ansible Collection documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/ansible-basic-sphinx-ext.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="keycloak_client – Allows administration of Keycloak clients via Keycloak API" href="keycloak_client.html" />
<link rel="prev" title="Ansible Collection - middleware_automation.keycloak" href="../README.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home">
Keycloak Ansible Collection
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../README.html">Ansible Collection - middleware_automation.keycloak</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Plugin Index</a><ul>
<li class="toctree-l2"><a class="reference internal" href="keycloak_client.html">keycloak_client – Allows administration of Keycloak clients via Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="keycloak_role.html">keycloak_role – Allows administration of Keycloak roles via Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="keycloak_user_federation.html">keycloak_user_federation – Allows administration of Keycloak user federations via Keycloak API</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../roles/index.html">Role Index</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../developing.html">Contributor’s Guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="../releasing.html">Collection Versioning Strategy</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">General</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../CHANGELOG.html">Changelog</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Middleware collections</span></p>
<ul>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/infinispan/">Infinispan / Red Hat Data Grid</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/keycloak/">Keycloak / Red Hat Single Sign-On</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/wildfly/">Wildfly / Red Hat JBoss EAP</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/jws/">Tomcat / Red Hat JWS</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/amq/">ActiveMQ / Red Hat AMQ Broker</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/amq_streams/">Kafka / Red Hat AMQ Streams</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/redhat-csp-download/">Red Hat CSP Download</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/ansible_collections_jcliff/">JCliff</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Keycloak Ansible Collection</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Plugin Index</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/plugins/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="plugin-index">
<h1>Plugin Index<a class="headerlink" href="#plugin-index" title="Permalink to this heading"></a></h1>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">modules plugins</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="keycloak_client.html">keycloak_client – Allows administration of Keycloak clients via Keycloak API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="keycloak_client.html#synopsis">Synopsis</a></li>
<li class="toctree-l2"><a class="reference internal" href="keycloak_client.html#parameters">Parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="keycloak_client.html#examples">Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="keycloak_client.html#return-values">Return Values</a><ul>
<li class="toctree-l3"><a class="reference internal" href="keycloak_client.html#authors">Authors</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="keycloak_role.html">keycloak_role – Allows administration of Keycloak roles via Keycloak API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="keycloak_role.html#synopsis">Synopsis</a></li>
<li class="toctree-l2"><a class="reference internal" href="keycloak_role.html#parameters">Parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="keycloak_role.html#examples">Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="keycloak_role.html#return-values">Return Values</a><ul>
<li class="toctree-l3"><a class="reference internal" href="keycloak_role.html#authors">Authors</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="keycloak_user_federation.html">keycloak_user_federation – Allows administration of Keycloak user federations via Keycloak API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="keycloak_user_federation.html#synopsis">Synopsis</a></li>
<li class="toctree-l2"><a class="reference internal" href="keycloak_user_federation.html#parameters">Parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="keycloak_user_federation.html#examples">Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="keycloak_user_federation.html#return-values">Return Values</a><ul>
<li class="toctree-l3"><a class="reference internal" href="keycloak_user_federation.html#authors">Authors</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../README.html" class="btn btn-neutral float-left" title="Ansible Collection - middleware_automation.keycloak" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="keycloak_client.html" class="btn btn-neutral float-right" title="keycloak_client – Allows administration of Keycloak clients via Keycloak API" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023, Red Hat, Inc..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

1156
main/plugins/keycloak_client.html Normal file
View file

File diff suppressed because it is too large Load diff

446
main/plugins/keycloak_role.html Normal file
View file

@ -0,0 +1,446 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>keycloak_role – Allows administration of Keycloak roles via Keycloak API &mdash; Keycloak Ansible Collection documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/ansible-basic-sphinx-ext.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="keycloak_user_federation – Allows administration of Keycloak user federations via Keycloak API" href="keycloak_user_federation.html" />
<link rel="prev" title="keycloak_client – Allows administration of Keycloak clients via Keycloak API" href="keycloak_client.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home">
Keycloak Ansible Collection
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../README.html">Ansible Collection - middleware_automation.keycloak</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Plugin Index</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="keycloak_client.html">keycloak_client – Allows administration of Keycloak clients via Keycloak API</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">keycloak_role – Allows administration of Keycloak roles via Keycloak API</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#synopsis">Synopsis</a></li>
<li class="toctree-l3"><a class="reference internal" href="#parameters">Parameters</a></li>
<li class="toctree-l3"><a class="reference internal" href="#examples">Examples</a></li>
<li class="toctree-l3"><a class="reference internal" href="#return-values">Return Values</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#authors">Authors</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="keycloak_user_federation.html">keycloak_user_federation – Allows administration of Keycloak user federations via Keycloak API</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../roles/index.html">Role Index</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../developing.html">Contributor’s Guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="../releasing.html">Collection Versioning Strategy</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">General</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../CHANGELOG.html">Changelog</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Middleware collections</span></p>
<ul>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/infinispan/">Infinispan / Red Hat Data Grid</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/keycloak/">Keycloak / Red Hat Single Sign-On</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/wildfly/">Wildfly / Red Hat JBoss EAP</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/jws/">Tomcat / Red Hat JWS</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/amq/">ActiveMQ / Red Hat AMQ Broker</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/amq_streams/">Kafka / Red Hat AMQ Streams</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/redhat-csp-download/">Red Hat CSP Download</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/ansible_collections_jcliff/">JCliff</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Keycloak Ansible Collection</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="index.html">Plugin Index</a></li>
<li class="breadcrumb-item active">keycloak_role – Allows administration of Keycloak roles via Keycloak API</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/plugins/keycloak_role.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<span class="target" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module"></span><section id="keycloak-role-allows-administration-of-keycloak-roles-via-keycloak-api">
<h1>keycloak_role – Allows administration of Keycloak roles via Keycloak API<a class="headerlink" href="#keycloak-role-allows-administration-of-keycloak-roles-via-keycloak-api" title="Permalink to this heading"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/middleware_automation/keycloak">middleware_automation.keycloak collection</a>.</p>
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">middleware_automation.keycloak</span></code>.</p>
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">middleware_automation.keycloak.keycloak_role</span></code>.</p>
</div>
<p class="ansible-version-added">New in middleware_automation.keycloak 3.4.0</p>
<nav class="contents local" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#synopsis" id="id25">Synopsis</a></p></li>
<li><p><a class="reference internal" href="#parameters" id="id26">Parameters</a></p></li>
<li><p><a class="reference internal" href="#examples" id="id27">Examples</a></p></li>
<li><p><a class="reference internal" href="#return-values" id="id28">Return Values</a></p></li>
</ul>
</nav>
<section id="synopsis">
<h2><a class="toc-backref" href="#id25" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p>This module allows you to add, remove or modify Keycloak roles 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.</p></li>
<li><p>The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at <a class="reference external" href="https://www.keycloak.org/docs-api/8.0/rest-api/index.html">https://www.keycloak.org/docs-api/8.0/rest-api/index.html</a>.</p></li>
<li><p>Attributes are multi-valued in the Keycloak API. All attributes are lists of individual values and will be returned that way by this module. You may pass single values for attributes when calling the module, and this will be translated into a list suitable for the API.</p></li>
</ul>
</section>
<section id="parameters">
<h2><a class="toc-backref" href="#id26" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h2>
<table class="ansible-option-table docutils align-default" style="width: 100%">
<thead>
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
<th class="head"><p>Comments</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-attributes"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-attributes"><strong>attributes</strong></p>
<a class="ansibleOptionLink" href="#parameter-attributes" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>A dict of key/value pairs to set as custom attributes for the role.</p>
<p>Values may be single values (e.g. a string) or a list of strings.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-auth_client_id"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-auth-client-id"><strong>auth_client_id</strong></p>
<a class="ansibleOptionLink" href="#parameter-auth_client_id" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>OpenID Connect <em>client_id</em> to authenticate to the API with.</p>
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <a href="#id1"><span class="problematic" id="id2">:ansible-option-default:`&quot;admin-cli&quot;`</span></a></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-auth_client_secret"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-auth-client-secret"><strong>auth_client_secret</strong></p>
<a class="ansibleOptionLink" href="#parameter-auth_client_secret" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Client Secret to use in conjunction with <em>auth_client_id</em> (if required).</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-auth_keycloak_url"></div>
<div class="ansibleOptionAnchor" id="parameter-url"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-url"><span id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-auth-keycloak-url"></span><strong>auth_keycloak_url</strong></p>
<a class="ansibleOptionLink" href="#parameter-auth_keycloak_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: url</span></p>
<p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>URL to the Keycloak instance.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-auth_password"></div>
<div class="ansibleOptionAnchor" id="parameter-password"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-password"><span id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-auth-password"></span><strong>auth_password</strong></p>
<a class="ansibleOptionLink" href="#parameter-auth_password" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: password</span></p>
<p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Password to authenticate for API access with.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-auth_realm"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-auth-realm"><strong>auth_realm</strong></p>
<a class="ansibleOptionLink" href="#parameter-auth_realm" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Keycloak realm name to authenticate to for API access.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-auth_username"></div>
<div class="ansibleOptionAnchor" id="parameter-username"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-username"><span id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-auth-username"></span><strong>auth_username</strong></p>
<a class="ansibleOptionLink" href="#parameter-auth_username" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: username</span></p>
<p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Username to authenticate for API access with.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-client_id"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-client-id"><strong>client_id</strong></p>
<a class="ansibleOptionLink" href="#parameter-client_id" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>If the role is a client role, the client id under which it resides.</p>
<p>If this parameter is absent, the role is considered a realm role.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-connection_timeout"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-connection-timeout"><strong>connection_timeout</strong></p>
<a class="ansibleOptionLink" href="#parameter-connection_timeout" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
<p><span class="ansible-option-versionadded">added in middleware_automation.keycloak 4.5.0</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Controls the HTTP connections timeout period (in seconds) to Keycloak API.</p>
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <a href="#id3"><span class="problematic" id="id4">:ansible-option-default:`10`</span></a></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-description"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-description"><strong>description</strong></p>
<a class="ansibleOptionLink" href="#parameter-description" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>The role description.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-http_agent"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-http-agent"><strong>http_agent</strong></p>
<a class="ansibleOptionLink" href="#parameter-http_agent" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
<p><span class="ansible-option-versionadded">added in middleware_automation.keycloak 5.4.0</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Configures the HTTP User-Agent header.</p>
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <a href="#id5"><span class="problematic" id="id6">:ansible-option-default:`&quot;Ansible&quot;`</span></a></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-name"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-name"><strong>name</strong></p>
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Name of the role.</p>
<p>This parameter is required.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-realm"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-realm"><strong>realm</strong></p>
<a class="ansibleOptionLink" href="#parameter-realm" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>The Keycloak realm under which this role resides.</p>
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <a href="#id7"><span class="problematic" id="id8">:ansible-option-default:`&quot;master&quot;`</span></a></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-state"><strong>state</strong></p>
<a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>State of the role.</p>
<p>On <code class="docutils literal notranslate"><span class="pre">present</span></code>, the role will be created if it does not yet exist, or updated with the parameters you provide.</p>
<p>On <code class="docutils literal notranslate"><span class="pre">absent</span></code>, the role will be removed if it exists.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
<ul class="simple">
<li><p><a href="#id9"><span class="problematic" id="id10">:ansible-option-choices-entry-default:`&quot;present&quot;`</span></a> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
<li><p><a href="#id11"><span class="problematic" id="id12">:ansible-option-choices-entry:`&quot;absent&quot;`</span></a></p></li>
</ul>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-token"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-token"><strong>token</strong></p>
<a class="ansibleOptionLink" href="#parameter-token" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
<p><span class="ansible-option-versionadded">added in middleware_automation.keycloak 3.0.0</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Authentication token for Keycloak API.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-validate_certs"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-validate-certs"><strong>validate_certs</strong></p>
<a class="ansibleOptionLink" href="#parameter-validate_certs" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Verify TLS certificates (do not disable this in production).</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
<ul class="simple">
<li><p><a href="#id13"><span class="problematic" id="id14">:ansible-option-choices-entry:`false`</span></a></p></li>
<li><p><a href="#id15"><span class="problematic" id="id16">:ansible-option-choices-entry-default:`true`</span></a> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
</ul>
</div></td>
</tr>
</tbody>
</table>
</section>
<section id="examples">
<h2><a class="toc-backref" href="#id27" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create a Keycloak realm role, authentication with credentials</span>
<span class="w"> </span><span class="nt">middleware_automation.keycloak.keycloak_role</span><span class="p">:</span>
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-new-kc-role</span>
<span class="w"> </span><span class="nt">realm</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">MyCustomRealm</span>
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">present</span>
<span class="w"> </span><span class="nt">auth_client_id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">admin-cli</span>
<span class="w"> </span><span class="nt">auth_keycloak_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://auth.example.com/auth</span>
<span class="w"> </span><span class="nt">auth_realm</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">master</span>
<span class="w"> </span><span class="nt">auth_username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">USERNAME</span>
<span class="w"> </span><span class="nt">auth_password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PASSWORD</span>
<span class="w"> </span><span class="nt">delegate_to</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">localhost</span>
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create a Keycloak realm role, authentication with token</span>
<span class="w"> </span><span class="nt">middleware_automation.keycloak.keycloak_role</span><span class="p">:</span>
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-new-kc-role</span>
<span class="w"> </span><span class="nt">realm</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">MyCustomRealm</span>
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">present</span>
<span class="w"> </span><span class="nt">auth_client_id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">admin-cli</span>
<span class="w"> </span><span class="nt">auth_keycloak_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://auth.example.com/auth</span>
<span class="w"> </span><span class="nt">token</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">TOKEN</span>
<span class="w"> </span><span class="nt">delegate_to</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">localhost</span>
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create a Keycloak client role</span>
<span class="w"> </span><span class="nt">middleware_automation.keycloak.keycloak_role</span><span class="p">:</span>
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-new-kc-role</span>
<span class="w"> </span><span class="nt">realm</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">MyCustomRealm</span>
<span class="w"> </span><span class="nt">client_id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">MyClient</span>
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">present</span>
<span class="w"> </span><span class="nt">auth_client_id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">admin-cli</span>
<span class="w"> </span><span class="nt">auth_keycloak_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://auth.example.com/auth</span>
<span class="w"> </span><span class="nt">auth_realm</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">master</span>
<span class="w"> </span><span class="nt">auth_username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">USERNAME</span>
<span class="w"> </span><span class="nt">auth_password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PASSWORD</span>
<span class="w"> </span><span class="nt">delegate_to</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">localhost</span>
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Delete a Keycloak role</span>
<span class="w"> </span><span class="nt">middleware_automation.keycloak.keycloak_role</span><span class="p">:</span>
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-role-for-deletion</span>
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">absent</span>
<span class="w"> </span><span class="nt">auth_client_id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">admin-cli</span>
<span class="w"> </span><span class="nt">auth_keycloak_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://auth.example.com/auth</span>
<span class="w"> </span><span class="nt">auth_realm</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">master</span>
<span class="w"> </span><span class="nt">auth_username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">USERNAME</span>
<span class="w"> </span><span class="nt">auth_password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PASSWORD</span>
<span class="w"> </span><span class="nt">delegate_to</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">localhost</span>
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create a keycloak role with some custom attributes</span>
<span class="w"> </span><span class="nt">middleware_automation.keycloak.keycloak_role</span><span class="p">:</span>
<span class="w"> </span><span class="nt">auth_client_id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">admin-cli</span>
<span class="w"> </span><span class="nt">auth_keycloak_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://auth.example.com/auth</span>
<span class="w"> </span><span class="nt">auth_realm</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">master</span>
<span class="w"> </span><span class="nt">auth_username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">USERNAME</span>
<span class="w"> </span><span class="nt">auth_password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PASSWORD</span>
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-new-role</span>
<span class="w"> </span><span class="nt">attributes</span><span class="p">:</span>
<span class="w"> </span><span class="nt">attrib1</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">value1</span>
<span class="w"> </span><span class="nt">attrib2</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">value2</span>
<span class="w"> </span><span class="nt">attrib3</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">with</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">numerous</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">individual</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">list</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">items</span>
<span class="w"> </span><span class="nt">delegate_to</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">localhost</span>
</pre></div>
</div>
</section>
<section id="return-values">
<h2><a class="toc-backref" href="#id28" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading"></a></h2>
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible v7)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
<table class="ansible-option-table docutils align-default" style="width: 100%">
<thead>
<tr class="row-odd"><th class="head"><p>Key</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-end_state"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-return-end-state"><strong>end_state</strong></p>
<a class="ansibleOptionLink" href="#return-end_state" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Representation of role after module execution (sample is truncated).</p>
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> on success</p>
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <a href="#id17"><span class="problematic" id="id18">:ansible-rv-sample-value:`{&quot;attributes&quot;: {}, &quot;clientRole&quot;: true, &quot;composite&quot;: false, &quot;containerId&quot;: &quot;9f03eb61-a826-4771-a9fd-930e06d2d36a&quot;, &quot;description&quot;: &quot;My updated client test role&quot;, &quot;id&quot;: &quot;561703dd-0f38-45ff-9a5a-0c978f794547&quot;, &quot;name&quot;: &quot;myrole&quot;}`</span></a></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-existing"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-return-existing"><strong>existing</strong></p>
<a class="ansibleOptionLink" href="#return-existing" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Representation of existing role.</p>
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> always</p>
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <a href="#id19"><span class="problematic" id="id20">:ansible-rv-sample-value:`{&quot;attributes&quot;: {}, &quot;clientRole&quot;: true, &quot;composite&quot;: false, &quot;containerId&quot;: &quot;9f03eb61-a826-4771-a9fd-930e06d2d36a&quot;, &quot;description&quot;: &quot;My client test role&quot;, &quot;id&quot;: &quot;561703dd-0f38-45ff-9a5a-0c978f794547&quot;, &quot;name&quot;: &quot;myrole&quot;}`</span></a></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-msg"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-return-msg"><strong>msg</strong></p>
<a class="ansibleOptionLink" href="#return-msg" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Message as to what action was taken.</p>
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> always</p>
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <a href="#id21"><span class="problematic" id="id22">:ansible-rv-sample-value:`&quot;Role myrole has been updated&quot;`</span></a></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-proposed"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-return-proposed"><strong>proposed</strong></p>
<a class="ansibleOptionLink" href="#return-proposed" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Representation of proposed role.</p>
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> always</p>
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <a href="#id23"><span class="problematic" id="id24">:ansible-rv-sample-value:`{&quot;description&quot;: &quot;My updated test description&quot;}`</span></a></p>
</div></td>
</tr>
</tbody>
</table>
<section id="authors">
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Laurent Paumier (&#64;laurpaum)</p></li>
</ul>
</section>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="keycloak_client.html" class="btn btn-neutral float-left" title="keycloak_client – Allows administration of Keycloak clients via Keycloak API" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="keycloak_user_federation.html" class="btn btn-neutral float-right" title="keycloak_user_federation – Allows administration of Keycloak user federations via Keycloak API" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023, Red Hat, Inc..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

1003
main/plugins/keycloak_user_federation.html Normal file
View file

File diff suppressed because it is too large Load diff

1
main/releasing.html
View file

@ -45,6 +45,7 @@
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="README.html">Ansible Collection - middleware_automation.keycloak</a></li>
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Plugin Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>

5
main/roles/index.html
View file

@ -20,7 +20,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="keycloak" href="keycloak.html" />
<link rel="prev" title="Ansible Collection - middleware_automation.keycloak" href="../README.html" />
<link rel="prev" title="keycloak_user_federation – Allows administration of Keycloak user federations via Keycloak API" href="../plugins/keycloak_user_federation.html" />
</head>
<body class="wy-body-for-nav">
@ -45,6 +45,7 @@
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../README.html">Ansible Collection - middleware_automation.keycloak</a></li>
<li class="toctree-l1"><a class="reference internal" href="../plugins/index.html">Plugin Index</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Role Index</a><ul>
<li class="toctree-l2"><a class="reference internal" href="keycloak.html">keycloak</a></li>
<li class="toctree-l2"><a class="reference internal" href="keycloak_quarkus.html">keycloak_quarkus</a></li>
@ -138,7 +139,7 @@
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../README.html" class="btn btn-neutral float-left" title="Ansible Collection - middleware_automation.keycloak" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../plugins/keycloak_user_federation.html" class="btn btn-neutral float-left" title="keycloak_user_federation – Allows administration of Keycloak user federations via Keycloak API" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="keycloak.html" class="btn btn-neutral float-right" title="keycloak" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

1
main/roles/keycloak.html
View file

@ -45,6 +45,7 @@
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../README.html">Ansible Collection - middleware_automation.keycloak</a></li>
<li class="toctree-l1"><a class="reference internal" href="../plugins/index.html">Plugin Index</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Role Index</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">keycloak</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#requirements">Requirements</a></li>

1
main/roles/keycloak_quarkus.html
View file

@ -45,6 +45,7 @@
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../README.html">Ansible Collection - middleware_automation.keycloak</a></li>
<li class="toctree-l1"><a class="reference internal" href="../plugins/index.html">Plugin Index</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Role Index</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="keycloak.html">keycloak</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">keycloak_quarkus</a><ul>

1
main/roles/keycloak_realm.html
View file

@ -45,6 +45,7 @@
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../README.html">Ansible Collection - middleware_automation.keycloak</a></li>
<li class="toctree-l1"><a class="reference internal" href="../plugins/index.html">Plugin Index</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Role Index</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="keycloak.html">keycloak</a></li>
<li class="toctree-l2"><a class="reference internal" href="keycloak_quarkus.html">keycloak_quarkus</a></li>

1
main/search.html
View file

@ -45,6 +45,7 @@
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="README.html">Ansible Collection - middleware_automation.keycloak</a></li>
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Plugin Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>

2
main/searchindex.js
View file

File diff suppressed because one or more lines are too long

1
main/testing.html
View file

@ -45,6 +45,7 @@
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="README.html">Ansible Collection - middleware_automation.keycloak</a></li>
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Plugin Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>