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

Update docs for main

Browse source 
Signed-off-by: github-actions <ggraziol@redhat.com>
This commit is contained in:
github-actions 2023-08-24 11:22:09 +00:00
commit 669dc31c39
24 changed files with 479 additions and 415 deletions
Download patch file Download diff file Expand all files Collapse all files

59
main/plugins/keycloak_role.html
View file

@ -7,16 +7,17 @@
<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/antsibull-minimal.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="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.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/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
@ -112,7 +113,7 @@
<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>
<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="Link 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>
@ -122,15 +123,15 @@
<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="#attributes" id="id27">Attributes</a></p></li>
<li><p><a class="reference internal" href="#examples" id="id28">Examples</a></p></li>
<li><p><a class="reference internal" href="#return-values" id="id29">Return Values</a></p></li>
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
<li><p><a class="reference internal" href="#parameters" id="id2">Parameters</a></p></li>
<li><p><a class="reference internal" href="#attributes" id="id3">Attributes</a></p></li>
<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li>
<li><p><a class="reference internal" href="#return-values" id="id5">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>
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link 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>
@ -138,7 +139,7 @@
</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>
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Link 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>
@ -159,7 +160,7 @@
<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>
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;admin-cli&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
@ -217,7 +218,7 @@
<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>
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">10</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
@ -233,7 +234,7 @@
<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>
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;Ansible&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
@ -249,7 +250,7 @@
<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>
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;master&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
@ -261,8 +262,8 @@
<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>
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">&quot;present&quot;</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;absent&quot;</span></code></p></li>
</ul>
</div></td>
</tr>
@ -281,8 +282,8 @@
<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>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">true</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
</ul>
</div></td>
</tr>
@ -290,7 +291,7 @@
</table>
</section>
<section id="attributes">
<h2><a class="toc-backref" href="#id27" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Link 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>Attribute</p></th>
@ -319,7 +320,7 @@
</table>
</section>
<section id="examples">
<h2><a class="toc-backref" href="#id28" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link 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>
@ -388,7 +389,7 @@
</div>
</section>
<section id="return-values">
<h2><a class="toc-backref" href="#id29" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Link 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 v8)"><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>
@ -403,7 +404,7 @@
</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>
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">{&quot;attributes&quot;:</span> <span class="pre">{},</span> <span class="pre">&quot;clientRole&quot;:</span> <span class="pre">true,</span> <span class="pre">&quot;composite&quot;:</span> <span class="pre">false,</span> <span class="pre">&quot;containerId&quot;:</span> <span class="pre">&quot;9f03eb61-a826-4771-a9fd-930e06d2d36a&quot;,</span> <span class="pre">&quot;description&quot;:</span> <span class="pre">&quot;My</span> <span class="pre">updated</span> <span class="pre">client</span> <span class="pre">test</span> <span class="pre">role&quot;,</span> <span class="pre">&quot;id&quot;:</span> <span class="pre">&quot;561703dd-0f38-45ff-9a5a-0c978f794547&quot;,</span> <span class="pre">&quot;name&quot;:</span> <span class="pre">&quot;myrole&quot;}</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
@ -412,7 +413,7 @@
</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>
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">{&quot;attributes&quot;:</span> <span class="pre">{},</span> <span class="pre">&quot;clientRole&quot;:</span> <span class="pre">true,</span> <span class="pre">&quot;composite&quot;:</span> <span class="pre">false,</span> <span class="pre">&quot;containerId&quot;:</span> <span class="pre">&quot;9f03eb61-a826-4771-a9fd-930e06d2d36a&quot;,</span> <span class="pre">&quot;description&quot;:</span> <span class="pre">&quot;My</span> <span class="pre">client</span> <span class="pre">test</span> <span class="pre">role&quot;,</span> <span class="pre">&quot;id&quot;:</span> <span class="pre">&quot;561703dd-0f38-45ff-9a5a-0c978f794547&quot;,</span> <span class="pre">&quot;name&quot;:</span> <span class="pre">&quot;myrole&quot;}</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
@ -421,7 +422,7 @@
</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>
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">&quot;Role</span> <span class="pre">myrole</span> <span class="pre">has</span> <span class="pre">been</span> <span class="pre">updated&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
@ -430,13 +431,13 @@
</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>
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">{&quot;description&quot;:</span> <span class="pre">&quot;My</span> <span class="pre">updated</span> <span class="pre">test</span> <span class="pre">description&quot;}</span></code></p>
</div></td>
</tr>
</tbody>
</table>
<section id="authors">
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3>
<h3>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Laurent Paumier (&#64;laurpaum)</p></li>
</ul>