ansible-collections/middleware_automation.keycloak
1
0
Fork 0
mirror of https://github.com/ansible-middleware/keycloak.git synced 2025-06-27 19:20:21 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Update docs for main

Browse source 
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
This commit is contained in:
ansible-middleware-core 2023-10-16 13:31:06 +00:00
parent 0d265793db
commit b06de7c901
13 changed files with 1468 additions and 877 deletions
Download patch file Download diff file Expand all files Collapse all files

344
main/CHANGELOG.html
View file

@ -58,88 +58,92 @@
<p class="caption" role="heading"><span class="caption-text">General</span></p> <p class="caption" role="heading"><span class="caption-text">General</span></p>
<ul class="current"> <ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul> <li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#v1-3-0-devel">v1.3.0-devel</a><ul> <li class="toctree-l2"><a class="reference internal" href="#v1-3-1-devel">v1.3.1-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> <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-3-0">v1.3.0</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="#id3">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#bugfixes">Bugfixes</a></li> <li class="toctree-l3"><a class="reference internal" href="#bugfixes">Bugfixes</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l2"><a class="reference internal" href="#v1-2-8">v1.2.8</a><ul> <li class="toctree-l2"><a class="reference internal" href="#v1-2-8">v1.2.8</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id6">Minor Changes</a></li> <li class="toctree-l3"><a class="reference internal" href="#id8">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id9">Bugfixes</a></li> <li class="toctree-l3"><a class="reference internal" href="#id11">Bugfixes</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l2"><a class="reference internal" href="#v1-2-7">v1.2.7</a><ul> <li class="toctree-l2"><a class="reference internal" href="#v1-2-7">v1.2.7</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id13">Minor Changes</a></li> <li class="toctree-l3"><a class="reference internal" href="#id15">Minor Changes</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l2"><a class="reference internal" href="#v1-2-6">v1.2.6</a><ul> <li class="toctree-l2"><a class="reference internal" href="#v1-2-6">v1.2.6</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id16">Minor Changes</a></li> <li class="toctree-l3"><a class="reference internal" href="#id18">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id20">Bugfixes</a></li> <li class="toctree-l3"><a class="reference internal" href="#id22">Bugfixes</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l2"><a class="reference internal" href="#v1-2-5">v1.2.5</a><ul> <li class="toctree-l2"><a class="reference internal" href="#v1-2-5">v1.2.5</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id22">Minor Changes</a></li> <li class="toctree-l3"><a class="reference internal" href="#id24">Minor Changes</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l2"><a class="reference internal" href="#v1-2-4">v1.2.4</a><ul> <li class="toctree-l2"><a class="reference internal" href="#v1-2-4">v1.2.4</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id27">Minor Changes</a></li> <li class="toctree-l3"><a class="reference internal" href="#id29">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id30">Bugfixes</a></li> <li class="toctree-l3"><a class="reference internal" href="#id32">Bugfixes</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l2"><a class="reference internal" href="#v1-2-1">v1.2.1</a><ul> <li class="toctree-l2"><a class="reference internal" href="#v1-2-1">v1.2.1</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id33">Minor Changes</a></li> <li class="toctree-l3"><a class="reference internal" href="#id35">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id35">Bugfixes</a></li> <li class="toctree-l3"><a class="reference internal" href="#id37">Bugfixes</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l2"><a class="reference internal" href="#v1-2-0">v1.2.0</a><ul> <li class="toctree-l2"><a class="reference internal" href="#v1-2-0">v1.2.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id37">Major Changes</a></li> <li class="toctree-l3"><a class="reference internal" href="#id39">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id39">Minor Changes</a></li> <li class="toctree-l3"><a class="reference internal" href="#id41">Minor Changes</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l2"><a class="reference internal" href="#v1-1-1">v1.1.1</a><ul> <li class="toctree-l2"><a class="reference internal" href="#v1-1-1">v1.1.1</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id44">Bugfixes</a></li> <li class="toctree-l3"><a class="reference internal" href="#id46">Bugfixes</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l2"><a class="reference internal" href="#v1-1-0">v1.1.0</a><ul> <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="#id46">Minor Changes</a></li> <li class="toctree-l3"><a class="reference internal" href="#id48">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="#breaking-changes-porting-guide">Breaking Changes / Porting Guide</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id52">Bugfixes</a></li> <li class="toctree-l3"><a class="reference internal" href="#id54">Bugfixes</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-7">v1.0.7</a><ul> <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="#id54">Breaking Changes / Porting Guide</a></li> <li class="toctree-l3"><a class="reference internal" href="#id56">Breaking Changes / Porting Guide</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id56">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="#id58">Bugfixes</a></li> <li class="toctree-l3"><a class="reference internal" href="#id58">Bugfixes</a></li>
</ul> </ul>
</li> </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="#id60">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-l2"><a class="reference internal" href="#v1-0-5">v1.0.5</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id61">Minor Changes</a></li> <li class="toctree-l3"><a class="reference internal" href="#id63">Minor Changes</a></li>
</ul> </ul>
</li> </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-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-l2"><a class="reference internal" href="#v1-0-3">v1.0.3</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id63">Major Changes</a></li> <li class="toctree-l3"><a class="reference internal" href="#id65">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id65">Minor Changes</a></li> <li class="toctree-l3"><a class="reference internal" href="#id67">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id67">Bugfixes</a></li> <li class="toctree-l3"><a class="reference internal" href="#id69">Bugfixes</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-2">v1.0.2</a><ul> <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="#id69">Minor Changes</a></li> <li class="toctree-l3"><a class="reference internal" href="#id71">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id72">Bugfixes</a></li> <li class="toctree-l3"><a class="reference internal" href="#id74">Bugfixes</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-1">v1.0.1</a><ul> <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="#release-summary">Release Summary</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id74">Major Changes</a></li> <li class="toctree-l3"><a class="reference internal" href="#id76">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id76">Minor Changes</a></li> <li class="toctree-l3"><a class="reference internal" href="#id78">Minor Changes</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-0">v1.0.0</a><ul> <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="#id78">Release Summary</a></li> <li class="toctree-l3"><a class="reference internal" href="#id80">Release Summary</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -182,111 +186,116 @@
<div itemprop="articleBody"> <div itemprop="articleBody">
<section id="middleware-automation-keycloak-release-notes"> <section id="middleware-automation-keycloak-release-notes">
<h1><a class="toc-backref" href="#id79" role="doc-backlink">middleware_automation.keycloak Release Notes</a><a class="headerlink" href="#middleware-automation-keycloak-release-notes" title="Link to this heading"></a></h1> <h1><a class="toc-backref" href="#id81" role="doc-backlink">middleware_automation.keycloak Release Notes</a><a class="headerlink" href="#middleware-automation-keycloak-release-notes" title="Link to this heading"></a></h1>
<nav class="contents" id="topics"> <nav class="contents" id="topics">
<p class="topic-title">Topics</p> <p class="topic-title">Topics</p>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference internal" href="#middleware-automation-keycloak-release-notes" id="id79">middleware_automation.keycloak Release Notes</a></p> <li><p><a class="reference internal" href="#middleware-automation-keycloak-release-notes" id="id81">middleware_automation.keycloak Release Notes</a></p>
<ul> <ul>
<li><p><a class="reference internal" href="#v1-3-0-devel" id="id80">v1.3.0-devel</a></p> <li><p><a class="reference internal" href="#v1-3-1-devel" id="id82">v1.3.1-devel</a></p>
<ul> <ul>
<li><p><a class="reference internal" href="#major-changes" id="id81">Major Changes</a></p></li> <li><p><a class="reference internal" href="#minor-changes" id="id83">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#minor-changes" id="id82">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#bugfixes" id="id83">Bugfixes</a></p></li>
</ul> </ul>
</li> </li>
<li><p><a class="reference internal" href="#v1-2-8" id="id84">v1.2.8</a></p> <li><p><a class="reference internal" href="#v1-3-0" id="id84">v1.3.0</a></p>
<ul> <ul>
<li><p><a class="reference internal" href="#id6" id="id85">Minor Changes</a></p></li> <li><p><a class="reference internal" href="#major-changes" id="id85">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id9" id="id86">Bugfixes</a></p></li> <li><p><a class="reference internal" href="#id3" id="id86">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#bugfixes" id="id87">Bugfixes</a></p></li>
</ul> </ul>
</li> </li>
<li><p><a class="reference internal" href="#v1-2-7" id="id87">v1.2.7</a></p> <li><p><a class="reference internal" href="#v1-2-8" id="id88">v1.2.8</a></p>
<ul> <ul>
<li><p><a class="reference internal" href="#id13" id="id88">Minor Changes</a></p></li> <li><p><a class="reference internal" href="#id8" id="id89">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id11" id="id90">Bugfixes</a></p></li>
</ul> </ul>
</li> </li>
<li><p><a class="reference internal" href="#v1-2-6" id="id89">v1.2.6</a></p> <li><p><a class="reference internal" href="#v1-2-7" id="id91">v1.2.7</a></p>
<ul> <ul>
<li><p><a class="reference internal" href="#id16" id="id90">Minor Changes</a></p></li> <li><p><a class="reference internal" href="#id15" id="id92">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id20" id="id91">Bugfixes</a></p></li>
</ul> </ul>
</li> </li>
<li><p><a class="reference internal" href="#v1-2-5" id="id92">v1.2.5</a></p> <li><p><a class="reference internal" href="#v1-2-6" id="id93">v1.2.6</a></p>
<ul> <ul>
<li><p><a class="reference internal" href="#id22" id="id93">Minor Changes</a></p></li> <li><p><a class="reference internal" href="#id18" id="id94">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id22" id="id95">Bugfixes</a></p></li>
</ul> </ul>
</li> </li>
<li><p><a class="reference internal" href="#v1-2-4" id="id94">v1.2.4</a></p> <li><p><a class="reference internal" href="#v1-2-5" id="id96">v1.2.5</a></p>
<ul> <ul>
<li><p><a class="reference internal" href="#id27" id="id95">Minor Changes</a></p></li> <li><p><a class="reference internal" href="#id24" id="id97">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id30" id="id96">Bugfixes</a></p></li>
</ul> </ul>
</li> </li>
<li><p><a class="reference internal" href="#v1-2-1" id="id97">v1.2.1</a></p> <li><p><a class="reference internal" href="#v1-2-4" id="id98">v1.2.4</a></p>
<ul> <ul>
<li><p><a class="reference internal" href="#id33" id="id98">Minor Changes</a></p></li> <li><p><a class="reference internal" href="#id29" id="id99">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id35" id="id99">Bugfixes</a></p></li> <li><p><a class="reference internal" href="#id32" id="id100">Bugfixes</a></p></li>
</ul> </ul>
</li> </li>
<li><p><a class="reference internal" href="#v1-2-0" id="id100">v1.2.0</a></p> <li><p><a class="reference internal" href="#v1-2-1" id="id101">v1.2.1</a></p>
<ul> <ul>
<li><p><a class="reference internal" href="#id37" id="id101">Major Changes</a></p></li> <li><p><a class="reference internal" href="#id35" id="id102">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id39" id="id102">Minor Changes</a></p></li> <li><p><a class="reference internal" href="#id37" id="id103">Bugfixes</a></p></li>
</ul> </ul>
</li> </li>
<li><p><a class="reference internal" href="#v1-1-1" id="id103">v1.1.1</a></p> <li><p><a class="reference internal" href="#v1-2-0" id="id104">v1.2.0</a></p>
<ul> <ul>
<li><p><a class="reference internal" href="#id44" id="id104">Bugfixes</a></p></li> <li><p><a class="reference internal" href="#id39" id="id105">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id41" id="id106">Minor Changes</a></p></li>
</ul> </ul>
</li> </li>
<li><p><a class="reference internal" href="#v1-1-0" id="id105">v1.1.0</a></p> <li><p><a class="reference internal" href="#v1-1-1" id="id107">v1.1.1</a></p>
<ul> <ul>
<li><p><a class="reference internal" href="#id46" id="id106">Minor Changes</a></p></li> <li><p><a class="reference internal" href="#id46" id="id108">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#breaking-changes-porting-guide" id="id107">Breaking Changes / Porting Guide</a></p></li>
<li><p><a class="reference internal" href="#id52" id="id108">Bugfixes</a></p></li>
</ul> </ul>
</li> </li>
<li><p><a class="reference internal" href="#v1-0-7" id="id109">v1.0.7</a></p> <li><p><a class="reference internal" href="#v1-1-0" id="id109">v1.1.0</a></p>
<ul> <ul>
<li><p><a class="reference internal" href="#id54" id="id110">Breaking Changes / Porting Guide</a></p></li> <li><p><a class="reference internal" href="#id48" id="id110">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id56" id="id111">Bugfixes</a></p></li> <li><p><a class="reference internal" href="#breaking-changes-porting-guide" id="id111">Breaking Changes / Porting Guide</a></p></li>
<li><p><a class="reference internal" href="#id54" id="id112">Bugfixes</a></p></li>
</ul> </ul>
</li> </li>
<li><p><a class="reference internal" href="#v1-0-6" id="id112">v1.0.6</a></p> <li><p><a class="reference internal" href="#v1-0-7" id="id113">v1.0.7</a></p>
<ul> <ul>
<li><p><a class="reference internal" href="#id58" id="id113">Bugfixes</a></p></li> <li><p><a class="reference internal" href="#id56" id="id114">Breaking Changes / Porting Guide</a></p></li>
<li><p><a class="reference internal" href="#id58" id="id115">Bugfixes</a></p></li>
</ul> </ul>
</li> </li>
<li><p><a class="reference internal" href="#v1-0-5" id="id114">v1.0.5</a></p> <li><p><a class="reference internal" href="#v1-0-6" id="id116">v1.0.6</a></p>
<ul> <ul>
<li><p><a class="reference internal" href="#id61" id="id115">Minor Changes</a></p></li> <li><p><a class="reference internal" href="#id60" id="id117">Bugfixes</a></p></li>
</ul> </ul>
</li> </li>
<li><p><a class="reference internal" href="#v1-0-4" id="id116">v1.0.4</a></p></li> <li><p><a class="reference internal" href="#v1-0-5" id="id118">v1.0.5</a></p>
<li><p><a class="reference internal" href="#v1-0-3" id="id117">v1.0.3</a></p>
<ul> <ul>
<li><p><a class="reference internal" href="#id63" id="id118">Major Changes</a></p></li> <li><p><a class="reference internal" href="#id63" id="id119">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id65" id="id119">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id67" id="id120">Bugfixes</a></p></li>
</ul> </ul>
</li> </li>
<li><p><a class="reference internal" href="#v1-0-2" id="id121">v1.0.2</a></p> <li><p><a class="reference internal" href="#v1-0-4" id="id120">v1.0.4</a></p></li>
<li><p><a class="reference internal" href="#v1-0-3" id="id121">v1.0.3</a></p>
<ul> <ul>
<li><p><a class="reference internal" href="#id69" id="id122">Minor Changes</a></p></li> <li><p><a class="reference internal" href="#id65" id="id122">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id72" id="id123">Bugfixes</a></p></li> <li><p><a class="reference internal" href="#id67" id="id123">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id69" id="id124">Bugfixes</a></p></li>
</ul> </ul>
</li> </li>
<li><p><a class="reference internal" href="#v1-0-1" id="id124">v1.0.1</a></p> <li><p><a class="reference internal" href="#v1-0-2" id="id125">v1.0.2</a></p>
<ul> <ul>
<li><p><a class="reference internal" href="#release-summary" id="id125">Release Summary</a></p></li> <li><p><a class="reference internal" href="#id71" id="id126">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id74" id="id126">Major Changes</a></p></li> <li><p><a class="reference internal" href="#id74" id="id127">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id76" id="id127">Minor Changes</a></p></li>
</ul> </ul>
</li> </li>
<li><p><a class="reference internal" href="#v1-0-0" id="id128">v1.0.0</a></p> <li><p><a class="reference internal" href="#v1-0-1" id="id128">v1.0.1</a></p>
<ul> <ul>
<li><p><a class="reference internal" href="#id78" id="id129">Release Summary</a></p></li> <li><p><a class="reference internal" href="#release-summary" id="id129">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id76" id="id130">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id78" id="id131">Minor Changes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-0" id="id132">v1.0.0</a></p>
<ul>
<li><p><a class="reference internal" href="#id80" id="id133">Release Summary</a></p></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -294,16 +303,25 @@
</ul> </ul>
</nav> </nav>
<p>This changelog describes changes after version 0.2.6.</p> <p>This changelog describes changes after version 0.2.6.</p>
<section id="v1-3-0-devel"> <section id="v1-3-1-devel">
<h2><a class="toc-backref" href="#id80" role="doc-backlink">v1.3.0-devel</a><a class="headerlink" href="#v1-3-0-devel" title="Link to this heading"></a></h2> <h2><a class="toc-backref" href="#id82" role="doc-backlink">v1.3.1-devel</a><a class="headerlink" href="#v1-3-1-devel" title="Link to this heading"></a></h2>
<section id="minor-changes">
<h3><a class="toc-backref" href="#id83" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#minor-changes" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Update Keycloak to version 22.0.4 <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/117">#117</a></p></li>
</ul>
</section>
</section>
<section id="v1-3-0">
<h2><a class="toc-backref" href="#id84" role="doc-backlink">v1.3.0</a><a class="headerlink" href="#v1-3-0" title="Link to this heading"></a></h2>
<section id="major-changes"> <section id="major-changes">
<h3><a class="toc-backref" href="#id81" role="doc-backlink">Major Changes</a><a class="headerlink" href="#major-changes" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id85" role="doc-backlink">Major Changes</a><a class="headerlink" href="#major-changes" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Run service as <code class="docutils literal notranslate"><span class="pre">keycloak_service_user</span></code> <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/106">#106</a></p></li> <li><p>Run service as <code class="docutils literal notranslate"><span class="pre">keycloak_service_user</span></code> <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/106">#106</a></p></li>
</ul> </ul>
</section> </section>
<section id="minor-changes"> <section id="id3">
<h3><a class="toc-backref" href="#id82" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#minor-changes" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id86" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id3" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>keycloak_quarkus: Update Keycloak to version 22.0.3 <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/112">#112</a></p></li> <li><p>keycloak_quarkus: Update Keycloak to version 22.0.3 <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/112">#112</a></p></li>
<li><p>keycloak_quarkus: fix admin console redirect when running locally <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/111">#111</a></p></li> <li><p>keycloak_quarkus: fix admin console redirect when running locally <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/111">#111</a></p></li>
@ -311,23 +329,23 @@
</ul> </ul>
</section> </section>
<section id="bugfixes"> <section id="bugfixes">
<h3><a class="toc-backref" href="#id83" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#bugfixes" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id87" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#bugfixes" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Fix validation failure upon port configuration change <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/113">#113</a></p></li> <li><p>keycloak_quarkus: fix validation failure upon port configuration change <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/113">#113</a></p></li>
</ul> </ul>
</section> </section>
</section> </section>
<section id="v1-2-8"> <section id="v1-2-8">
<h2><a class="toc-backref" href="#id84" role="doc-backlink">v1.2.8</a><a class="headerlink" href="#v1-2-8" title="Link to this heading"></a></h2> <h2><a class="toc-backref" href="#id88" role="doc-backlink">v1.2.8</a><a class="headerlink" href="#v1-2-8" title="Link to this heading"></a></h2>
<section id="id6"> <section id="id8">
<h3><a class="toc-backref" href="#id85" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id6" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id89" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id8" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>keycloak_quarkus: set openjdk 17 as default <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/103">#103</a></p></li> <li><p>keycloak_quarkus: set openjdk 17 as default <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/103">#103</a></p></li>
<li><p>keycloak_quarkus: update to version 22.0.1 <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/107">#107</a></p></li> <li><p>keycloak_quarkus: update to version 22.0.1 <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/107">#107</a></p></li>
</ul> </ul>
</section> </section>
<section id="id9"> <section id="id11">
<h3><a class="toc-backref" href="#id86" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id9" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id90" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id11" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Fix incorrect checks for <code class="docutils literal notranslate"><span class="pre">keycloak_jgroups_subnet</span></code> <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/98">#98</a></p></li> <li><p>Fix incorrect checks for <code class="docutils literal notranslate"><span class="pre">keycloak_jgroups_subnet</span></code> <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/98">#98</a></p></li>
<li><p>Undefine <code class="docutils literal notranslate"><span class="pre">keycloak_db_valid_conn_sql</span></code> default <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/91">#91</a></p></li> <li><p>Undefine <code class="docutils literal notranslate"><span class="pre">keycloak_db_valid_conn_sql</span></code> default <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/91">#91</a></p></li>
@ -336,9 +354,9 @@
</section> </section>
</section> </section>
<section id="v1-2-7"> <section id="v1-2-7">
<h2><a class="toc-backref" href="#id87" role="doc-backlink">v1.2.7</a><a class="headerlink" href="#v1-2-7" title="Link to this heading"></a></h2> <h2><a class="toc-backref" href="#id91" role="doc-backlink">v1.2.7</a><a class="headerlink" href="#v1-2-7" title="Link to this heading"></a></h2>
<section id="id13"> <section id="id15">
<h3><a class="toc-backref" href="#id88" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id13" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id92" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id15" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Allow to override jgroups subnet <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/93">#93</a></p></li> <li><p>Allow to override jgroups subnet <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/93">#93</a></p></li>
<li><p>keycloak-quarkus: update keycloakx to v21.1.1 <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/92">#92</a></p></li> <li><p>keycloak-quarkus: update keycloakx to v21.1.1 <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/92">#92</a></p></li>
@ -346,26 +364,26 @@
</section> </section>
</section> </section>
<section id="v1-2-6"> <section id="v1-2-6">
<h2><a class="toc-backref" href="#id89" role="doc-backlink">v1.2.6</a><a class="headerlink" href="#v1-2-6" title="Link to this heading"></a></h2> <h2><a class="toc-backref" href="#id93" role="doc-backlink">v1.2.6</a><a class="headerlink" href="#v1-2-6" title="Link to this heading"></a></h2>
<section id="id16"> <section id="id18">
<h3><a class="toc-backref" href="#id90" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id16" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id94" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id18" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Add profile features enabling/disabling <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/87">#87</a></p></li> <li><p>Add profile features enabling/disabling <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/87">#87</a></p></li>
<li><p>Improve service restart behavior configuration <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/88">#88</a></p></li> <li><p>Improve service restart behavior configuration <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/88">#88</a></p></li>
<li><p>Update default xa_datasource_class value for mariadb jdbc configuration <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/89">#89</a></p></li> <li><p>Update default xa_datasource_class value for mariadb jdbc configuration <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/89">#89</a></p></li>
</ul> </ul>
</section> </section>
<section id="id20"> <section id="id22">
<h3><a class="toc-backref" href="#id91" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id20" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id95" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id22" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Handle WFLYCTL0117 when background validation millis is 0 <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/90">#90</a></p></li> <li><p>Handle WFLYCTL0117 when background validation millis is 0 <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/90">#90</a></p></li>
</ul> </ul>
</section> </section>
</section> </section>
<section id="v1-2-5"> <section id="v1-2-5">
<h2><a class="toc-backref" href="#id92" role="doc-backlink">v1.2.5</a><a class="headerlink" href="#v1-2-5" title="Link to this heading"></a></h2> <h2><a class="toc-backref" href="#id96" role="doc-backlink">v1.2.5</a><a class="headerlink" href="#v1-2-5" title="Link to this heading"></a></h2>
<section id="id22"> <section id="id24">
<h3><a class="toc-backref" href="#id93" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id22" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id97" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id24" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Add configuration for database connection pool validation <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/85">#85</a></p></li> <li><p>Add configuration for database connection pool validation <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/85">#85</a></p></li>
<li><p>Allow to configure administration endpoint URL <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/86">#86</a></p></li> <li><p>Allow to configure administration endpoint URL <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/86">#86</a></p></li>
@ -375,16 +393,16 @@
</section> </section>
</section> </section>
<section id="v1-2-4"> <section id="v1-2-4">
<h2><a class="toc-backref" href="#id94" role="doc-backlink">v1.2.4</a><a class="headerlink" href="#v1-2-4" title="Link to this heading"></a></h2> <h2><a class="toc-backref" href="#id98" role="doc-backlink">v1.2.4</a><a class="headerlink" href="#v1-2-4" title="Link to this heading"></a></h2>
<section id="id27"> <section id="id29">
<h3><a class="toc-backref" href="#id95" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id27" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id99" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id29" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Add <code class="docutils literal notranslate"><span class="pre">sqlserver</span></code> to keycloak role jdbc configurations <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/78">#78</a></p></li> <li><p>Add <code class="docutils literal notranslate"><span class="pre">sqlserver</span></code> to keycloak role jdbc configurations <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/78">#78</a></p></li>
<li><p>Add configurability for XA transactions <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/73">#73</a></p></li> <li><p>Add configurability for XA transactions <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/73">#73</a></p></li>
</ul> </ul>
</section> </section>
<section id="id30"> <section id="id32">
<h3><a class="toc-backref" href="#id96" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id30" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id100" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id32" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Fix deprecation warning for <code class="docutils literal notranslate"><span class="pre">ipaddr</span></code> <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/77">#77</a></p></li> <li><p>Fix deprecation warning for <code class="docutils literal notranslate"><span class="pre">ipaddr</span></code> <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/77">#77</a></p></li>
<li><p>Fix undefined facts when offline patching sso <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/71">#71</a></p></li> <li><p>Fix undefined facts when offline patching sso <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/71">#71</a></p></li>
@ -392,30 +410,30 @@
</section> </section>
</section> </section>
<section id="v1-2-1"> <section id="v1-2-1">
<h2><a class="toc-backref" href="#id97" role="doc-backlink">v1.2.1</a><a class="headerlink" href="#v1-2-1" title="Link to this heading"></a></h2> <h2><a class="toc-backref" href="#id101" role="doc-backlink">v1.2.1</a><a class="headerlink" href="#v1-2-1" title="Link to this heading"></a></h2>
<section id="id33"> <section id="id35">
<h3><a class="toc-backref" href="#id98" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id33" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id102" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id35" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Allow to setup keycloak HA cluster without remote cache store <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/68">#68</a></p></li> <li><p>Allow to setup keycloak HA cluster without remote cache store <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/68">#68</a></p></li>
</ul> </ul>
</section> </section>
<section id="id35"> <section id="id37">
<h3><a class="toc-backref" href="#id99" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id35" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id103" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id37" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Pass attributes to realm clients <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/69">#69</a></p></li> <li><p>Pass attributes to realm clients <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/69">#69</a></p></li>
</ul> </ul>
</section> </section>
</section> </section>
<section id="v1-2-0"> <section id="v1-2-0">
<h2><a class="toc-backref" href="#id100" role="doc-backlink">v1.2.0</a><a class="headerlink" href="#v1-2-0" title="Link to this heading"></a></h2> <h2><a class="toc-backref" href="#id104" role="doc-backlink">v1.2.0</a><a class="headerlink" href="#v1-2-0" title="Link to this heading"></a></h2>
<section id="id37"> <section id="id39">
<h3><a class="toc-backref" href="#id101" role="doc-backlink">Major Changes</a><a class="headerlink" href="#id37" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id105" role="doc-backlink">Major Changes</a><a class="headerlink" href="#id39" title="Link to this heading"></a></h3>
<ul class="simple"> <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> <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> </ul>
</section> </section>
<section id="id39"> <section id="id41">
<h3><a class="toc-backref" href="#id102" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id39" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id106" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id41" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Allow to configure TCPPING for cluster discovery <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/62">#62</a></p></li> <li><p>Allow to configure TCPPING for cluster discovery <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/62">#62</a></p></li>
<li><p>Drop community.general from dependencies <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/61">#61</a></p></li> <li><p>Drop community.general from dependencies <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/61">#61</a></p></li>
@ -425,18 +443,18 @@
</section> </section>
</section> </section>
<section id="v1-1-1"> <section id="v1-1-1">
<h2><a class="toc-backref" href="#id103" role="doc-backlink">v1.1.1</a><a class="headerlink" href="#v1-1-1" title="Link to this heading"></a></h2> <h2><a class="toc-backref" href="#id107" role="doc-backlink">v1.1.1</a><a class="headerlink" href="#v1-1-1" title="Link to this heading"></a></h2>
<section id="id44"> <section id="id46">
<h3><a class="toc-backref" href="#id104" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id44" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id108" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id46" title="Link to this heading"></a></h3>
<ul class="simple"> <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> <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> </ul>
</section> </section>
</section> </section>
<section id="v1-1-0"> <section id="v1-1-0">
<h2><a class="toc-backref" href="#id105" role="doc-backlink">v1.1.0</a><a class="headerlink" href="#v1-1-0" title="Link to this heading"></a></h2> <h2><a class="toc-backref" href="#id109" role="doc-backlink">v1.1.0</a><a class="headerlink" href="#v1-1-0" title="Link to this heading"></a></h2>
<section id="id46"> <section id="id48">
<h3><a class="toc-backref" href="#id106" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id46" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id110" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id48" title="Link to this heading"></a></h3>
<ul class="simple"> <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>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> <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>
@ -445,37 +463,37 @@
</ul> </ul>
</section> </section>
<section id="breaking-changes-porting-guide"> <section id="breaking-changes-porting-guide">
<h3><a class="toc-backref" href="#id107" role="doc-backlink">Breaking Changes / Porting Guide</a><a class="headerlink" href="#breaking-changes-porting-guide" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id111" role="doc-backlink">Breaking Changes / Porting Guide</a><a class="headerlink" href="#breaking-changes-porting-guide" title="Link to this heading"></a></h3>
<ul class="simple"> <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> <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> </ul>
</section> </section>
<section id="id52"> <section id="id54">
<h3><a class="toc-backref" href="#id108" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id52" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id112" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id54" title="Link to this heading"></a></h3>
<ul class="simple"> <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> <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> </ul>
</section> </section>
</section> </section>
<section id="v1-0-7"> <section id="v1-0-7">
<h2><a class="toc-backref" href="#id109" role="doc-backlink">v1.0.7</a><a class="headerlink" href="#v1-0-7" title="Link to this heading"></a></h2> <h2><a class="toc-backref" href="#id113" role="doc-backlink">v1.0.7</a><a class="headerlink" href="#v1-0-7" title="Link to this heading"></a></h2>
<section id="id54"> <section id="id56">
<h3><a class="toc-backref" href="#id110" role="doc-backlink">Breaking Changes / Porting Guide</a><a class="headerlink" href="#id54" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id114" role="doc-backlink">Breaking Changes / Porting Guide</a><a class="headerlink" href="#id56" title="Link to this heading"></a></h3>
<ul class="simple"> <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> <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> </ul>
</section> </section>
<section id="id56"> <section id="id58">
<h3><a class="toc-backref" href="#id111" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id56" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id115" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id58" title="Link to this heading"></a></h3>
<ul class="simple"> <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> <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> </ul>
</section> </section>
</section> </section>
<section id="v1-0-6"> <section id="v1-0-6">
<h2><a class="toc-backref" href="#id112" role="doc-backlink">v1.0.6</a><a class="headerlink" href="#v1-0-6" title="Link to this heading"></a></h2> <h2><a class="toc-backref" href="#id116" role="doc-backlink">v1.0.6</a><a class="headerlink" href="#v1-0-6" title="Link to this heading"></a></h2>
<section id="id58"> <section id="id60">
<h3><a class="toc-backref" href="#id113" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id58" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id117" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id60" title="Link to this heading"></a></h3>
<ul class="simple"> <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: 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> <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>
@ -483,77 +501,77 @@
</section> </section>
</section> </section>
<section id="v1-0-5"> <section id="v1-0-5">
<h2><a class="toc-backref" href="#id114" role="doc-backlink">v1.0.5</a><a class="headerlink" href="#v1-0-5" title="Link to this heading"></a></h2> <h2><a class="toc-backref" href="#id118" role="doc-backlink">v1.0.5</a><a class="headerlink" href="#v1-0-5" title="Link to this heading"></a></h2>
<section id="id61"> <section id="id63">
<h3><a class="toc-backref" href="#id115" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id61" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id119" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id63" title="Link to this heading"></a></h3>
<ul class="simple"> <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> <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> </ul>
</section> </section>
</section> </section>
<section id="v1-0-4"> <section id="v1-0-4">
<h2><a class="toc-backref" href="#id116" role="doc-backlink">v1.0.4</a><a class="headerlink" href="#v1-0-4" title="Link to this heading"></a></h2> <h2><a class="toc-backref" href="#id120" role="doc-backlink">v1.0.4</a><a class="headerlink" href="#v1-0-4" title="Link to this heading"></a></h2>
</section> </section>
<section id="v1-0-3"> <section id="v1-0-3">
<h2><a class="toc-backref" href="#id117" role="doc-backlink">v1.0.3</a><a class="headerlink" href="#v1-0-3" title="Link to this heading"></a></h2> <h2><a class="toc-backref" href="#id121" role="doc-backlink">v1.0.3</a><a class="headerlink" href="#v1-0-3" title="Link to this heading"></a></h2>
<section id="id63"> <section id="id65">
<h3><a class="toc-backref" href="#id118" role="doc-backlink">Major Changes</a><a class="headerlink" href="#id63" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id122" role="doc-backlink">Major Changes</a><a class="headerlink" href="#id65" title="Link to this heading"></a></h3>
<ul class="simple"> <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> <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> </ul>
</section> </section>
<section id="id65"> <section id="id67">
<h3><a class="toc-backref" href="#id119" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id65" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id123" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id67" title="Link to this heading"></a></h3>
<ul class="simple"> <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> <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> </ul>
</section> </section>
<section id="id67"> <section id="id69">
<h3><a class="toc-backref" href="#id120" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id67" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id124" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id69" title="Link to this heading"></a></h3>
<ul class="simple"> <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> <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> </ul>
</section> </section>
</section> </section>
<section id="v1-0-2"> <section id="v1-0-2">
<h2><a class="toc-backref" href="#id121" role="doc-backlink">v1.0.2</a><a class="headerlink" href="#v1-0-2" title="Link to this heading"></a></h2> <h2><a class="toc-backref" href="#id125" role="doc-backlink">v1.0.2</a><a class="headerlink" href="#v1-0-2" title="Link to this heading"></a></h2>
<section id="id69"> <section id="id71">
<h3><a class="toc-backref" href="#id122" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id69" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id126" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id71" title="Link to this heading"></a></h3>
<ul class="simple"> <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>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> <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> </ul>
</section> </section>
<section id="id72"> <section id="id74">
<h3><a class="toc-backref" href="#id123" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id72" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id127" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id74" title="Link to this heading"></a></h3>
<ul class="simple"> <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> <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> </ul>
</section> </section>
</section> </section>
<section id="v1-0-1"> <section id="v1-0-1">
<h2><a class="toc-backref" href="#id124" role="doc-backlink">v1.0.1</a><a class="headerlink" href="#v1-0-1" title="Link to this heading"></a></h2> <h2><a class="toc-backref" href="#id128" role="doc-backlink">v1.0.1</a><a class="headerlink" href="#v1-0-1" title="Link to this heading"></a></h2>
<section id="release-summary"> <section id="release-summary">
<h3><a class="toc-backref" href="#id125" role="doc-backlink">Release Summary</a><a class="headerlink" href="#release-summary" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id129" role="doc-backlink">Release Summary</a><a class="headerlink" href="#release-summary" title="Link to this heading"></a></h3>
<p>Minor enhancements, bug and documentation fixes.</p> <p>Minor enhancements, bug and documentation fixes.</p>
</section> </section>
<section id="id74"> <section id="id76">
<h3><a class="toc-backref" href="#id126" role="doc-backlink">Major Changes</a><a class="headerlink" href="#id74" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id130" role="doc-backlink">Major Changes</a><a class="headerlink" href="#id76" title="Link to this heading"></a></h3>
<ul class="simple"> <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> <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> </ul>
</section> </section>
<section id="id76"> <section id="id78">
<h3><a class="toc-backref" href="#id127" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id76" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id131" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id78" title="Link to this heading"></a></h3>
<ul class="simple"> <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> <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> </ul>
</section> </section>
</section> </section>
<section id="v1-0-0"> <section id="v1-0-0">
<h2><a class="toc-backref" href="#id128" role="doc-backlink">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Link to this heading"></a></h2> <h2><a class="toc-backref" href="#id132" role="doc-backlink">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Link to this heading"></a></h2>
<section id="id78"> <section id="id80">
<h3><a class="toc-backref" href="#id129" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id78" title="Link to this heading"></a></h3> <h3><a class="toc-backref" href="#id133" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id80" title="Link 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> <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>
</section> </section>

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

@ -6,9 +6,17 @@ middleware_automation.keycloak Release Notes
This changelog describes changes after version 0.2.6. This changelog describes changes after version 0.2.6.
v1.3.0-devel v1.3.1-devel
============ ============
Minor Changes
-------------
- Update Keycloak to version 22.0.4 `#117 <https://github.com/ansible-middleware/keycloak/pull/117>`_
v1.3.0
======
Major Changes Major Changes
------------- -------------
@ -24,7 +32,7 @@ Minor Changes
Bugfixes Bugfixes
-------- --------
- Fix validation failure upon port configuration change `#113 <https://github.com/ansible-middleware/keycloak/pull/113>`_ - keycloak_quarkus: fix validation failure upon port configuration change `#113 <https://github.com/ansible-middleware/keycloak/pull/113>`_
v1.2.8 v1.2.8
====== ======

749
main/_sources/plugins/keycloak_client.rst.txt
View file

File diff suppressed because it is too large Load diff

125
main/_sources/plugins/keycloak_role.rst.txt
View file

@ -6,23 +6,8 @@
.. |antsibull-internal-nbsp| unicode:: 0xA0 .. |antsibull-internal-nbsp| unicode:: 0xA0
:trim: :trim:
.. role:: ansible-attribute-support-label .. meta::
.. role:: ansible-attribute-support-property :antsibull-docs: 2.5.0
.. role:: ansible-attribute-support-full
.. role:: ansible-attribute-support-partial
.. role:: ansible-attribute-support-none
.. role:: ansible-attribute-support-na
.. role:: ansible-option-type
.. role:: ansible-option-elements
.. role:: ansible-option-required
.. role:: ansible-option-versionadded
.. role:: ansible-option-aliases
.. role:: ansible-option-choices
.. role:: ansible-option-choices-default-mark
.. role:: ansible-option-default-bold
.. role:: ansible-option-configuration
.. role:: ansible-option-returned-bold
.. role:: ansible-option-sample-bold
.. Anchors .. Anchors
@ -38,7 +23,10 @@ keycloak_role -- Allows administration of Keycloak roles via Keycloak API
.. Collection note .. Collection note
.. note:: .. note::
This module is part of the `middleware_automation.keycloak collection <https://galaxy.ansible.com/middleware_automation/keycloak>`_. This module is part of the `middleware_automation.keycloak collection <https://galaxy.ansible.com/ui/repo/published/middleware_automation/keycloak/>`_.
It is not included in ``ansible-core``.
To check whether it is installed, run :code:`ansible-galaxy collection list`.
To install it, use: :code:`ansible-galaxy collection install middleware\_automation.keycloak`. To install it, use: :code:`ansible-galaxy collection install middleware\_automation.keycloak`.
@ -82,12 +70,13 @@ Synopsis
Parameters Parameters
---------- ----------
.. rst-class:: ansible-option-table .. tabularcolumns:: \X{1}{3}\X{2}{3}
.. list-table:: .. list-table::
:width: 100% :width: 100%
:widths: auto :widths: auto
:header-rows: 1 :header-rows: 1
:class: longtable ansible-option-table
* - Parameter * - Parameter
- Comments - Comments
@ -107,9 +96,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-attributes" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-attributes" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line .. ansible-option-type-line::
:ansible-option-type:`dictionary` :ansible-option-type:`dictionary`
.. raw:: html .. raw:: html
@ -143,9 +132,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-auth_client_id" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-auth_client_id" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line .. ansible-option-type-line::
:ansible-option-type:`string` :ansible-option-type:`string`
.. raw:: html .. raw:: html
@ -181,9 +170,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-auth_client_secret" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-auth_client_secret" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line .. ansible-option-type-line::
:ansible-option-type:`string` :ansible-option-type:`string`
.. raw:: html .. raw:: html
@ -217,13 +206,11 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-auth_keycloak_url" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-auth_keycloak_url" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line .. ansible-option-type-line::
:ansible-option-aliases:`aliases: url` :ansible-option-aliases:`aliases: url`
.. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required`
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html .. raw:: html
@ -257,13 +244,11 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-auth_password" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-auth_password" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line .. ansible-option-type-line::
:ansible-option-aliases:`aliases: password` :ansible-option-aliases:`aliases: password`
.. rst-class:: ansible-option-type-line :ansible-option-type:`string`
:ansible-option-type:`string`
.. raw:: html .. raw:: html
@ -295,9 +280,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-auth_realm" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-auth_realm" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line .. ansible-option-type-line::
:ansible-option-type:`string` :ansible-option-type:`string`
.. raw:: html .. raw:: html
@ -331,13 +316,11 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-auth_username" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-auth_username" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line .. ansible-option-type-line::
:ansible-option-aliases:`aliases: username` :ansible-option-aliases:`aliases: username`
.. rst-class:: ansible-option-type-line :ansible-option-type:`string`
:ansible-option-type:`string`
.. raw:: html .. raw:: html
@ -369,9 +352,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-client_id" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-client_id" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line .. ansible-option-type-line::
:ansible-option-type:`string` :ansible-option-type:`string`
.. raw:: html .. raw:: html
@ -405,9 +388,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-connection_timeout" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-connection_timeout" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line .. ansible-option-type-line::
:ansible-option-type:`integer` :ansible-option-type:`integer`
:ansible-option-versionadded:`added in middleware\_automation.keycloak 4.5.0` :ansible-option-versionadded:`added in middleware\_automation.keycloak 4.5.0`
@ -446,9 +429,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-description" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-description" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line .. ansible-option-type-line::
:ansible-option-type:`string` :ansible-option-type:`string`
.. raw:: html .. raw:: html
@ -480,9 +463,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-http_agent" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-http_agent" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line .. ansible-option-type-line::
:ansible-option-type:`string` :ansible-option-type:`string`
:ansible-option-versionadded:`added in middleware\_automation.keycloak 5.4.0` :ansible-option-versionadded:`added in middleware\_automation.keycloak 5.4.0`
@ -521,9 +504,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line .. ansible-option-type-line::
:ansible-option-type:`string` / :ansible-option-required:`required` :ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html .. raw:: html
@ -557,9 +540,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-realm" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-realm" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line .. ansible-option-type-line::
:ansible-option-type:`string` :ansible-option-type:`string`
.. raw:: html .. raw:: html
@ -595,9 +578,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line .. ansible-option-type-line::
:ansible-option-type:`string` :ansible-option-type:`string`
.. raw:: html .. raw:: html
@ -641,9 +624,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-token" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-token" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line .. ansible-option-type-line::
:ansible-option-type:`string` :ansible-option-type:`string`
:ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0`
@ -678,9 +661,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-validate_certs" title="Permalink to this option"></a> <a class="ansibleOptionLink" href="#parameter-validate_certs" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line .. ansible-option-type-line::
:ansible-option-type:`boolean` :ansible-option-type:`boolean`
.. raw:: html .. raw:: html
@ -712,12 +695,13 @@ Parameters
Attributes Attributes
---------- ----------
.. rst-class:: ansible-option-table .. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10}
.. list-table:: .. list-table::
:width: 100% :width: 100%
:widths: auto :widths: auto
:header-rows: 1 :header-rows: 1
:class: longtable ansible-option-table
* - Attribute * - Attribute
- Support - Support
@ -899,12 +883,13 @@ Return Values
------------- -------------
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
.. rst-class:: ansible-option-table .. tabularcolumns:: \X{1}{3}\X{2}{3}
.. list-table:: .. list-table::
:width: 100% :width: 100%
:widths: auto :widths: auto
:header-rows: 1 :header-rows: 1
:class: longtable ansible-option-table
* - Key * - Key
- Description - Description
@ -924,9 +909,9 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
<a class="ansibleOptionLink" href="#return-end_state" title="Permalink to this return value"></a> <a class="ansibleOptionLink" href="#return-end_state" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line .. ansible-option-type-line::
:ansible-option-type:`dictionary` :ansible-option-type:`dictionary`
.. raw:: html .. raw:: html
@ -969,9 +954,9 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
<a class="ansibleOptionLink" href="#return-existing" title="Permalink to this return value"></a> <a class="ansibleOptionLink" href="#return-existing" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line .. ansible-option-type-line::
:ansible-option-type:`dictionary` :ansible-option-type:`dictionary`
.. raw:: html .. raw:: html
@ -1014,9 +999,9 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
<a class="ansibleOptionLink" href="#return-msg" title="Permalink to this return value"></a> <a class="ansibleOptionLink" href="#return-msg" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line .. ansible-option-type-line::
:ansible-option-type:`string` :ansible-option-type:`string`
.. raw:: html .. raw:: html
@ -1059,9 +1044,9 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
<a class="ansibleOptionLink" href="#return-proposed" title="Permalink to this return value"></a> <a class="ansibleOptionLink" href="#return-proposed" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line .. ansible-option-type-line::
:ansible-option-type:`dictionary` :ansible-option-type:`dictionary`
.. raw:: html .. raw:: html

809
main/_sources/plugins/keycloak_user_federation.rst.txt
View file

File diff suppressed because it is too large Load diff

4
main/_sources/roles/keycloak_quarkus.md.txt
View file

@ -11,7 +11,7 @@ Role Defaults
| Variable | Description | Default | | Variable | Description | Default |
|:---------|:------------|:--------| |:---------|:------------|:--------|
|`keycloak_quarkus_version`| keycloak.org package version | `22.0.3` | |`keycloak_quarkus_version`| keycloak.org package version | `22.0.4` |
* Service configuration * Service configuration
@ -72,7 +72,7 @@ Role Defaults
|:---------|:------------|:---------| |:---------|:------------|:---------|
|`keycloak_quarkus_offline_install` | Perform an offline install | `False`| |`keycloak_quarkus_offline_install` | Perform an offline install | `False`|
|`keycloak_quarkus_download_url`| Download URL for keycloak | `https://github.com/keycloak/keycloak/releases/download/<version>/<archive>`| |`keycloak_quarkus_download_url`| Download URL for keycloak | `https://github.com/keycloak/keycloak/releases/download/<version>/<archive>`|
|`keycloak_quarkus_version`| keycloak.org package version | `22.0.3` | |`keycloak_quarkus_version`| keycloak.org package version | `22.0.4` |
|`keycloak_quarkus_dest`| Installation root path | `/opt/keycloak` | |`keycloak_quarkus_dest`| Installation root path | `/opt/keycloak` |
|`keycloak_quarkus_download_url` | Download URL for keycloak | `https://github.com/keycloak/keycloak/releases/download/{{ keycloak_quarkus_version }}/{{ keycloak_quarkus_archive }}` | |`keycloak_quarkus_download_url` | Download URL for keycloak | `https://github.com/keycloak/keycloak/releases/download/{{ keycloak_quarkus_version }}/{{ keycloak_quarkus_archive }}` |
|`keycloak_quarkus_configure_firewalld` | Ensure firewalld is running and configure keycloak ports | `False` | |`keycloak_quarkus_configure_firewalld` | Ensure firewalld is running and configure keycloak ports | `False` |

2
main/_static/antsibull-minimal.css
View file

File diff suppressed because one or more lines are too long

3
main/index.html
View file

@ -149,7 +149,8 @@
<p class="caption" role="heading"><span class="caption-text">General</span></p> <p class="caption" role="heading"><span class="caption-text">General</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="CHANGELOG.html">Changelog</a><ul> <li class="toctree-l1"><a class="reference internal" href="CHANGELOG.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-3-0-devel">v1.3.0-devel</a></li> <li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-3-1-devel">v1.3.1-devel</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-3-0">v1.3.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-2-8">v1.2.8</a></li> <li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-2-8">v1.2.8</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-2-7">v1.2.7</a></li> <li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-2-7">v1.2.7</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-2-6">v1.2.6</a></li> <li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-2-6">v1.2.6</a></li>

101
main/plugins/keycloak_client.html
View file

@ -2,6 +2,7 @@
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta content="2.5.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>keycloak_client – Allows administration of Keycloak clients via Keycloak API &mdash; Keycloak Ansible Collection documentation</title> <title>keycloak_client – Allows administration of Keycloak clients via Keycloak API &mdash; Keycloak Ansible Collection documentation</title>
@ -116,7 +117,9 @@
<h1>keycloak_client – Allows administration of Keycloak clients via Keycloak API<a class="headerlink" href="#keycloak-client-allows-administration-of-keycloak-clients-via-keycloak-api" title="Link to this heading"></a></h1> <h1>keycloak_client – Allows administration of Keycloak clients via Keycloak API<a class="headerlink" href="#keycloak-client-allows-administration-of-keycloak-clients-via-keycloak-api" title="Link to this heading"></a></h1>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <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>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/middleware_automation/keycloak/">middleware_automation.keycloak collection</a>.</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</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 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_client</span></code>.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">middleware_automation.keycloak.keycloak_client</span></code>.</p>
</div> </div>
@ -139,7 +142,7 @@
</section> </section>
<section id="parameters"> <section id="parameters">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Link 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%"> <table class="longtable ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Parameter</p></th> <tr class="row-odd"><th class="head"><p>Parameter</p></th>
<th class="head"><p>Comments</p></th> <th class="head"><p>Comments</p></th>
@ -160,10 +163,10 @@
<div class="ansibleOptionAnchor" id="parameter-alwaysDisplayInConsole"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-client-module-parameter-alwaysdisplayinconsole"><span id="ansible-collections-middleware-automation-keycloak-keycloak-client-module-parameter-always-display-in-console"></span><strong>always_display_in_console</strong></p> <div class="ansibleOptionAnchor" id="parameter-alwaysDisplayInConsole"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-client-module-parameter-alwaysdisplayinconsole"><span id="ansible-collections-middleware-automation-keycloak-keycloak-client-module-parameter-always-display-in-console"></span><strong>always_display_in_console</strong></p>
<a class="ansibleOptionLink" href="#parameter-always_display_in_console" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: alwaysDisplayInConsole</span></p> <a class="ansibleOptionLink" href="#parameter-always_display_in_console" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: alwaysDisplayInConsole</span></p>
<p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
<p><span class="ansible-option-versionadded">added in middleware_automation.keycloak 4.7.0</span></p> <p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 4.7.0</em></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Whether or not to display this client in account console, even if the user does not have an active session.</p> <td><div class="ansible-option-cell"><p>Whether or not to display this client in account console, even if the user does not have an active session.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
@ -336,7 +339,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> <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> </div></td>
<td><div class="ansible-option-cell"><p>OpenID Connect <em>client_id</em> to authenticate to the API with.</p> <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> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;admin-cli&quot;</span></code></p> <p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;admin-cli&quot;</span></code></p>
</div></td> </div></td>
</tr> </tr>
<tr class="row-even"><td><div class="ansible-option-cell"> <tr class="row-even"><td><div class="ansible-option-cell">
@ -385,7 +388,7 @@
<div class="ansibleOptionAnchor" id="parameter-authenticationFlowBindingOverrides"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-client-module-parameter-authenticationflowbindingoverrides"><span id="ansible-collections-middleware-automation-keycloak-keycloak-client-module-parameter-authentication-flow-binding-overrides"></span><strong>authentication_flow_binding_overrides</strong></p> <div class="ansibleOptionAnchor" id="parameter-authenticationFlowBindingOverrides"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-client-module-parameter-authenticationflowbindingoverrides"><span id="ansible-collections-middleware-automation-keycloak-keycloak-client-module-parameter-authentication-flow-binding-overrides"></span><strong>authentication_flow_binding_overrides</strong></p>
<a class="ansibleOptionLink" href="#parameter-authentication_flow_binding_overrides" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: authenticationFlowBindingOverrides</span></p> <a class="ansibleOptionLink" href="#parameter-authentication_flow_binding_overrides" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: authenticationFlowBindingOverrides</span></p>
<p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> <p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
<p><span class="ansible-option-versionadded">added in middleware_automation.keycloak 3.4.0</span></p> <p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 3.4.0</em></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Override realm authentication flow bindings.</p> <td><div class="ansible-option-cell"><p>Override realm authentication flow bindings.</p>
</div></td> </div></td>
@ -397,7 +400,7 @@
<p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Are authorization services enabled for this client or not (OpenID connect). This is ‘authorizationServicesEnabled’ in the Keycloak REST API.</p> <td><div class="ansible-option-cell"><p>Are authorization services enabled for this client or not (OpenID connect). This is ‘authorizationServicesEnabled’ in the Keycloak REST API.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
@ -429,7 +432,7 @@
<p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>The access type of this client is bearer-only. This is ‘bearerOnly’ in the Keycloak REST API.</p> <td><div class="ansible-option-cell"><p>The access type of this client is bearer-only. This is ‘bearerOnly’ in the Keycloak REST API.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
@ -443,7 +446,7 @@
<p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> <p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>How do clients authenticate with the auth server? Either <code class="docutils literal notranslate"><span class="pre">client-secret</span></code> or <code class="docutils literal notranslate"><span class="pre">client-jwt</span></code> can be chosen. When using <code class="docutils literal notranslate"><span class="pre">client-secret</span></code>, the module parameter <em>secret</em> can set it, while for <code class="docutils literal notranslate"><span class="pre">client-jwt</span></code>, you can use the keys <code class="docutils literal notranslate"><span class="pre">use.jwks.url</span></code>, <code class="docutils literal notranslate"><span class="pre">jwks.url</span></code>, and <code class="docutils literal notranslate"><span class="pre">jwt.credential.certificate</span></code> in the <em>attributes</em> module parameter to configure its behavior. This is ‘clientAuthenticatorType’ in the Keycloak REST API.</p> <td><div class="ansible-option-cell"><p>How do clients authenticate with the auth server? Either <code class="docutils literal notranslate"><span class="pre">client-secret</span></code> or <code class="docutils literal notranslate"><span class="pre">client-jwt</span></code> can be chosen. When using <code class="docutils literal notranslate"><span class="pre">client-secret</span></code>, the module parameter <em>secret</em> can set it, while for <code class="docutils literal notranslate"><span class="pre">client-jwt</span></code>, you can use the keys <code class="docutils literal notranslate"><span class="pre">use.jwks.url</span></code>, <code class="docutils literal notranslate"><span class="pre">jwks.url</span></code>, and <code class="docutils literal notranslate"><span class="pre">jwt.credential.certificate</span></code> in the <em>attributes</em> module parameter to configure its behavior. This is ‘clientAuthenticatorType’ in the Keycloak REST API.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;client-secret&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;client-secret&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;client-jwt&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;client-jwt&quot;</span></code></p></li>
@ -471,10 +474,10 @@
<tr class="row-odd"><td><div class="ansible-option-cell"> <tr class="row-odd"><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-client-module-parameter-connection-timeout"><strong>connection_timeout</strong></p> <div class="ansibleOptionAnchor" id="parameter-connection_timeout"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-client-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> <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> <p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 4.5.0</em></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Controls the HTTP connections timeout period (in seconds) to Keycloak API.</p> <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> <code class="ansible-option-default docutils literal notranslate"><span class="pre">10</span></code></p> <p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">10</span></code></p>
</div></td> </div></td>
</tr> </tr>
<tr class="row-even"><td><div class="ansible-option-cell"> <tr class="row-even"><td><div class="ansible-option-cell">
@ -484,7 +487,7 @@
<p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>If enabled, users have to consent to client access. This is ‘consentRequired’ in the Keycloak REST API.</p> <td><div class="ansible-option-cell"><p>If enabled, users have to consent to client access. This is ‘consentRequired’ in the Keycloak REST API.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
@ -496,7 +499,7 @@
<div class="ansibleOptionAnchor" id="parameter-defaultClientScopes"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-client-module-parameter-defaultclientscopes"><span id="ansible-collections-middleware-automation-keycloak-keycloak-client-module-parameter-default-client-scopes"></span><strong>default_client_scopes</strong></p> <div class="ansibleOptionAnchor" id="parameter-defaultClientScopes"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-client-module-parameter-defaultclientscopes"><span id="ansible-collections-middleware-automation-keycloak-keycloak-client-module-parameter-default-client-scopes"></span><strong>default_client_scopes</strong></p>
<a class="ansibleOptionLink" href="#parameter-default_client_scopes" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: defaultClientScopes</span></p> <a class="ansibleOptionLink" href="#parameter-default_client_scopes" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: defaultClientScopes</span></p>
<p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p> <p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
<p><span class="ansible-option-versionadded">added in middleware_automation.keycloak 4.7.0</span></p> <p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 4.7.0</em></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>List of default client scopes.</p> <td><div class="ansible-option-cell"><p>List of default client scopes.</p>
</div></td> </div></td>
@ -524,7 +527,7 @@
<p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Are direct access grants enabled for this client or not (OpenID connect). This is ‘directAccessGrantsEnabled’ in the Keycloak REST API.</p> <td><div class="ansible-option-cell"><p>Are direct access grants enabled for this client or not (OpenID connect). This is ‘directAccessGrantsEnabled’ in the Keycloak REST API.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
@ -536,7 +539,7 @@
<a class="ansibleOptionLink" href="#parameter-enabled" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <a class="ansibleOptionLink" href="#parameter-enabled" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Is this client enabled or not?</p> <td><div class="ansible-option-cell"><p>Is this client enabled or not?</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
@ -550,7 +553,7 @@
<p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Is frontchannel logout enabled for this client or not. This is ‘frontchannelLogout’ in the Keycloak REST API.</p> <td><div class="ansible-option-cell"><p>Is frontchannel logout enabled for this client or not. This is ‘frontchannelLogout’ in the Keycloak REST API.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
@ -564,7 +567,7 @@
<p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Is the “Full Scope Allowed” feature set for this client or not. This is ‘fullScopeAllowed’ in the Keycloak REST API.</p> <td><div class="ansible-option-cell"><p>Is the “Full Scope Allowed” feature set for this client or not. This is ‘fullScopeAllowed’ in the Keycloak REST API.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
@ -574,10 +577,10 @@
<tr class="row-even"><td><div class="ansible-option-cell"> <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-client-module-parameter-http-agent"><strong>http_agent</strong></p> <div class="ansibleOptionAnchor" id="parameter-http_agent"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-client-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> <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> <p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 5.4.0</em></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Configures the HTTP User-Agent header.</p> <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> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;Ansible&quot;</span></code></p> <p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;Ansible&quot;</span></code></p>
</div></td> </div></td>
</tr> </tr>
<tr class="row-odd"><td><div class="ansible-option-cell"> <tr class="row-odd"><td><div class="ansible-option-cell">
@ -594,7 +597,7 @@
<p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Enable implicit flow for this client or not (OpenID connect). This is ‘implicitFlowEnabled’ in the Keycloak REST API.</p> <td><div class="ansible-option-cell"><p>Enable implicit flow for this client or not (OpenID connect). This is ‘implicitFlowEnabled’ in the Keycloak REST API.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
@ -631,7 +634,7 @@
<div class="ansibleOptionAnchor" id="parameter-optionalClientScopes"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-client-module-parameter-optionalclientscopes"><span id="ansible-collections-middleware-automation-keycloak-keycloak-client-module-parameter-optional-client-scopes"></span><strong>optional_client_scopes</strong></p> <div class="ansibleOptionAnchor" id="parameter-optionalClientScopes"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-client-module-parameter-optionalclientscopes"><span id="ansible-collections-middleware-automation-keycloak-keycloak-client-module-parameter-optional-client-scopes"></span><strong>optional_client_scopes</strong></p>
<a class="ansibleOptionLink" href="#parameter-optional_client_scopes" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: optionalClientScopes</span></p> <a class="ansibleOptionLink" href="#parameter-optional_client_scopes" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: optionalClientScopes</span></p>
<p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p> <p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
<p><span class="ansible-option-versionadded">added in middleware_automation.keycloak 4.7.0</span></p> <p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 4.7.0</em></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>List of optional client scopes.</p> <td><div class="ansible-option-cell"><p>List of optional client scopes.</p>
</div></td> </div></td>
@ -641,7 +644,7 @@
<a class="ansibleOptionLink" href="#parameter-protocol" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> <a class="ansibleOptionLink" href="#parameter-protocol" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Type of client (either <code class="docutils literal notranslate"><span class="pre">openid-connect</span></code> or <code class="docutils literal notranslate"><span class="pre">saml</span></code>.</p> <td><div class="ansible-option-cell"><p>Type of client (either <code class="docutils literal notranslate"><span class="pre">openid-connect</span></code> or <code class="docutils literal notranslate"><span class="pre">saml</span></code>.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;openid-connect&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;openid-connect&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;saml&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;saml&quot;</span></code></p></li>
@ -671,7 +674,7 @@
<a class="ansibleOptionLink" href="#parameter-protocol_mappers/consentRequired" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <a class="ansibleOptionLink" href="#parameter-protocol_mappers/consentRequired" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Specifies whether a user needs to provide consent to a client for this mapper to be active.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Specifies whether a user needs to provide consent to a client for this mapper to be active.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
@ -708,7 +711,7 @@
<a class="ansibleOptionLink" href="#parameter-protocol_mappers/protocol" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> <a class="ansibleOptionLink" href="#parameter-protocol_mappers/protocol" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>This is either <code class="docutils literal notranslate"><span class="pre">openid-connect</span></code> or <code class="docutils literal notranslate"><span class="pre">saml</span></code>, this specifies for which protocol this protocol mapper. is active.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>This is either <code class="docutils literal notranslate"><span class="pre">openid-connect</span></code> or <code class="docutils literal notranslate"><span class="pre">saml</span></code>, this specifies for which protocol this protocol mapper. is active.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;openid-connect&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;openid-connect&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;saml&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;saml&quot;</span></code></p></li>
@ -753,7 +756,7 @@
<p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Is the access type for this client public or not. This is ‘publicClient’ in the Keycloak REST API.</p> <td><div class="ansible-option-cell"><p>Is the access type for this client public or not. This is ‘publicClient’ in the Keycloak REST API.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
@ -765,7 +768,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> <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> </div></td>
<td><div class="ansible-option-cell"><p>The realm to create the client in.</p> <td><div class="ansible-option-cell"><p>The realm to create the client in.</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> <p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;master&quot;</span></code></p>
</div></td> </div></td>
</tr> </tr>
<tr class="row-even"><td><div class="ansible-option-cell"> <tr class="row-even"><td><div class="ansible-option-cell">
@ -818,7 +821,7 @@
<p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Are service accounts enabled for this client or not (OpenID connect). This is ‘serviceAccountsEnabled’ in the Keycloak REST API.</p> <td><div class="ansible-option-cell"><p>Are service accounts enabled for this client or not (OpenID connect). This is ‘serviceAccountsEnabled’ in the Keycloak REST API.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
@ -832,7 +835,7 @@
<p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Enable standard flow for this client or not (OpenID connect). This is ‘standardFlowEnabled’ in the Keycloak REST API.</p> <td><div class="ansible-option-cell"><p>Enable standard flow for this client or not (OpenID connect). This is ‘standardFlowEnabled’ in the Keycloak REST API.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
@ -846,9 +849,9 @@
<td><div class="ansible-option-cell"><p>State of the client</p> <td><div class="ansible-option-cell"><p>State of the client</p>
<p>On <code class="docutils literal notranslate"><span class="pre">present</span></code>, the client will be created (or updated if it exists already).</p> <p>On <code class="docutils literal notranslate"><span class="pre">present</span></code>, the client will be created (or updated if it exists already).</p>
<p>On <code class="docutils literal notranslate"><span class="pre">absent</span></code>, the client will be removed if it exists</p> <p>On <code class="docutils literal notranslate"><span class="pre">absent</span></code>, the client will be removed if it exists</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-default-bold docutils literal notranslate"><strong><span class="pre">&quot;present&quot;</span></strong></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> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;absent&quot;</span></code></p></li>
</ul> </ul>
</div></td> </div></td>
@ -860,7 +863,7 @@
<p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Whether or not surrogate auth is required. This is ‘surrogateAuthRequired’ in the Keycloak REST API.</p> <td><div class="ansible-option-cell"><p>Whether or not surrogate auth is required. This is ‘surrogateAuthRequired’ in the Keycloak REST API.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
@ -870,7 +873,7 @@
<tr class="row-odd"><td><div class="ansible-option-cell"> <tr class="row-odd"><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-client-module-parameter-token"><strong>token</strong></p> <div class="ansibleOptionAnchor" id="parameter-token"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-client-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> <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> <p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 3.0.0</em></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Authentication token for Keycloak API.</p> <td><div class="ansible-option-cell"><p>Authentication token for Keycloak API.</p>
</div></td> </div></td>
@ -882,7 +885,7 @@
<p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Whether or not to use configuration from the <em>client_template</em>. This is ‘useTemplateConfig’ in the Keycloak REST API.</p> <td><div class="ansible-option-cell"><p>Whether or not to use configuration from the <em>client_template</em>. This is ‘useTemplateConfig’ in the Keycloak REST API.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
@ -896,7 +899,7 @@
<p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Whether or not to use mapper configuration from the <em>client_template</em>. This is ‘useTemplateMappers’ in the Keycloak REST API.</p> <td><div class="ansible-option-cell"><p>Whether or not to use mapper configuration from the <em>client_template</em>. This is ‘useTemplateMappers’ in the Keycloak REST API.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
@ -910,7 +913,7 @@
<p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Whether or not to use scope configuration from the <em>client_template</em>. This is ‘useTemplateScope’ in the Keycloak REST API.</p> <td><div class="ansible-option-cell"><p>Whether or not to use scope configuration from the <em>client_template</em>. This is ‘useTemplateScope’ in the Keycloak REST API.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
@ -922,10 +925,10 @@
<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> <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> </div></td>
<td><div class="ansible-option-cell"><p>Verify TLS certificates (do not disable this in production).</p> <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> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-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> <li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
</ul> </ul>
</div></td> </div></td>
</tr> </tr>
@ -943,7 +946,7 @@
</section> </section>
<section id="attributes"> <section id="attributes">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Link 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%"> <table class="longtable ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Attribute</p></th> <tr class="row-odd"><th class="head"><p>Attribute</p></th>
<th class="head"><p>Support</p></th> <th class="head"><p>Support</p></th>
@ -954,7 +957,7 @@
<tr class="row-even"><td><div class="ansible-option-cell"> <tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="attribute-check_mode"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-client-module-attribute-check-mode"><strong>check_mode</strong></p> <div class="ansibleOptionAnchor" id="attribute-check_mode"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-client-module-attribute-check-mode"><strong>check_mode</strong></p>
<a class="ansibleOptionLink" href="#attribute-check_mode" title="Permalink to this attribute"></a></div></td> <a class="ansibleOptionLink" href="#attribute-check_mode" title="Permalink to this attribute"></a></div></td>
<td><div class="ansible-option-cell"><p><span class="ansible-attribute-support-label">Support: </span><span class="ansible-attribute-support-full">full</span></p> <td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Can run in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code> and return changed status prediction without modifying target.</p> <td><div class="ansible-option-cell"><p>Can run in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code> and return changed status prediction without modifying target.</p>
</div></td> </div></td>
@ -962,7 +965,7 @@
<tr class="row-odd"><td><div class="ansible-option-cell"> <tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="attribute-diff_mode"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-client-module-attribute-diff-mode"><strong>diff_mode</strong></p> <div class="ansibleOptionAnchor" id="attribute-diff_mode"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-client-module-attribute-diff-mode"><strong>diff_mode</strong></p>
<a class="ansibleOptionLink" href="#attribute-diff_mode" title="Permalink to this attribute"></a></div></td> <a class="ansibleOptionLink" href="#attribute-diff_mode" title="Permalink to this attribute"></a></div></td>
<td><div class="ansible-option-cell"><p><span class="ansible-attribute-support-label">Support: </span><span class="ansible-attribute-support-full">full</span></p> <td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Will return details on what has changed (or possibly needs changing in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code>), when in diff mode.</p> <td><div class="ansible-option-cell"><p>Will return details on what has changed (or possibly needs changing in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code>), when in diff mode.</p>
</div></td> </div></td>
@ -1101,7 +1104,7 @@
<section id="return-values"> <section id="return-values">
<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> <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> <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%"> <table class="longtable ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Key</p></th> <tr class="row-odd"><th class="head"><p>Key</p></th>
<th class="head"><p>Description</p></th> <th class="head"><p>Description</p></th>
@ -1113,8 +1116,8 @@
<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> <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> </div></td>
<td><div class="ansible-option-cell"><p>Representation of client after module execution (sample is truncated).</p> <td><div class="ansible-option-cell"><p>Representation of client 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"><strong class="ansible-option-returned-bold">Returned:</strong> on success</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;adminUrl&quot;:</span> <span class="pre">&quot;http://www.example.com/admin_url&quot;,</span> <span class="pre">&quot;attributes&quot;:</span> <span class="pre">{&quot;request.object.signature.alg&quot;:</span> <span class="pre">&quot;RS256&quot;}}</span></code></p> <p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">{&quot;adminUrl&quot;:</span> <span class="pre">&quot;http://www.example.com/admin_url&quot;,</span> <span class="pre">&quot;attributes&quot;:</span> <span class="pre">{&quot;request.object.signature.alg&quot;:</span> <span class="pre">&quot;RS256&quot;}}</span></code></p>
</div></td> </div></td>
</tr> </tr>
<tr class="row-odd"><td><div class="ansible-option-cell"> <tr class="row-odd"><td><div class="ansible-option-cell">
@ -1122,8 +1125,8 @@
<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> <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> </div></td>
<td><div class="ansible-option-cell"><p>Representation of existing client (sample is truncated).</p> <td><div class="ansible-option-cell"><p>Representation of existing client (sample is truncated).</p>
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> always</p> <p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</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;adminUrl&quot;:</span> <span class="pre">&quot;http://www.example.com/admin_url&quot;,</span> <span class="pre">&quot;attributes&quot;:</span> <span class="pre">{&quot;request.object.signature.alg&quot;:</span> <span class="pre">&quot;RS256&quot;}}</span></code></p> <p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">{&quot;adminUrl&quot;:</span> <span class="pre">&quot;http://www.example.com/admin_url&quot;,</span> <span class="pre">&quot;attributes&quot;:</span> <span class="pre">{&quot;request.object.signature.alg&quot;:</span> <span class="pre">&quot;RS256&quot;}}</span></code></p>
</div></td> </div></td>
</tr> </tr>
<tr class="row-even"><td><div class="ansible-option-cell"> <tr class="row-even"><td><div class="ansible-option-cell">
@ -1131,8 +1134,8 @@
<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> <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> </div></td>
<td><div class="ansible-option-cell"><p>Message as to what action was taken.</p> <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"><strong class="ansible-option-returned-bold">Returned:</strong> always</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;Client</span> <span class="pre">testclient</span> <span class="pre">has</span> <span class="pre">been</span> <span class="pre">updated&quot;</span></code></p> <p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">&quot;Client</span> <span class="pre">testclient</span> <span class="pre">has</span> <span class="pre">been</span> <span class="pre">updated&quot;</span></code></p>
</div></td> </div></td>
</tr> </tr>
<tr class="row-odd"><td><div class="ansible-option-cell"> <tr class="row-odd"><td><div class="ansible-option-cell">
@ -1140,8 +1143,8 @@
<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> <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> </div></td>
<td><div class="ansible-option-cell"><p>Representation of proposed client.</p> <td><div class="ansible-option-cell"><p>Representation of proposed client.</p>
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> always</p> <p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</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;clientId&quot;:</span> <span class="pre">&quot;test&quot;}</span></code></p> <p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">{&quot;clientId&quot;:</span> <span class="pre">&quot;test&quot;}</span></code></p>
</div></td> </div></td>
</tr> </tr>
</tbody> </tbody>

53
main/plugins/keycloak_role.html
View file

@ -2,6 +2,7 @@
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta content="2.5.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <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> <title>keycloak_role – Allows administration of Keycloak roles via Keycloak API &mdash; Keycloak Ansible Collection documentation</title>
@ -116,7 +117,9 @@
<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> <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"> <div class="admonition note">
<p class="admonition-title">Note</p> <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>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/middleware_automation/keycloak/">middleware_automation.keycloak collection</a>.</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</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 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> <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> </div>
@ -140,7 +143,7 @@
</section> </section>
<section id="parameters"> <section id="parameters">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Link 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%"> <table class="longtable ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Parameter</p></th> <tr class="row-odd"><th class="head"><p>Parameter</p></th>
<th class="head"><p>Comments</p></th> <th class="head"><p>Comments</p></th>
@ -160,7 +163,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> <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> </div></td>
<td><div class="ansible-option-cell"><p>OpenID Connect <em>client_id</em> to authenticate to the API with.</p> <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> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;admin-cli&quot;</span></code></p> <p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;admin-cli&quot;</span></code></p>
</div></td> </div></td>
</tr> </tr>
<tr class="row-even"><td><div class="ansible-option-cell"> <tr class="row-even"><td><div class="ansible-option-cell">
@ -215,10 +218,10 @@
<tr class="row-even"><td><div class="ansible-option-cell"> <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> <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> <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> <p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 4.5.0</em></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Controls the HTTP connections timeout period (in seconds) to Keycloak API.</p> <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> <code class="ansible-option-default docutils literal notranslate"><span class="pre">10</span></code></p> <p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">10</span></code></p>
</div></td> </div></td>
</tr> </tr>
<tr class="row-odd"><td><div class="ansible-option-cell"> <tr class="row-odd"><td><div class="ansible-option-cell">
@ -231,10 +234,10 @@
<tr class="row-even"><td><div class="ansible-option-cell"> <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> <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> <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> <p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 5.4.0</em></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Configures the HTTP User-Agent header.</p> <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> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;Ansible&quot;</span></code></p> <p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;Ansible&quot;</span></code></p>
</div></td> </div></td>
</tr> </tr>
<tr class="row-odd"><td><div class="ansible-option-cell"> <tr class="row-odd"><td><div class="ansible-option-cell">
@ -250,7 +253,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> <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> </div></td>
<td><div class="ansible-option-cell"><p>The Keycloak realm under which this role resides.</p> <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> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;master&quot;</span></code></p> <p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;master&quot;</span></code></p>
</div></td> </div></td>
</tr> </tr>
<tr class="row-odd"><td><div class="ansible-option-cell"> <tr class="row-odd"><td><div class="ansible-option-cell">
@ -260,9 +263,9 @@
<td><div class="ansible-option-cell"><p>State of the role.</p> <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">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>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> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-default-bold docutils literal notranslate"><strong><span class="pre">&quot;present&quot;</span></strong></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> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;absent&quot;</span></code></p></li>
</ul> </ul>
</div></td> </div></td>
@ -270,7 +273,7 @@
<tr class="row-even"><td><div class="ansible-option-cell"> <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> <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> <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> <p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 3.0.0</em></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Authentication token for Keycloak API.</p> <td><div class="ansible-option-cell"><p>Authentication token for Keycloak API.</p>
</div></td> </div></td>
@ -280,10 +283,10 @@
<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> <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> </div></td>
<td><div class="ansible-option-cell"><p>Verify TLS certificates (do not disable this in production).</p> <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> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-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> <li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
</ul> </ul>
</div></td> </div></td>
</tr> </tr>
@ -292,7 +295,7 @@
</section> </section>
<section id="attributes"> <section id="attributes">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Link 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%"> <table class="longtable ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Attribute</p></th> <tr class="row-odd"><th class="head"><p>Attribute</p></th>
<th class="head"><p>Support</p></th> <th class="head"><p>Support</p></th>
@ -303,7 +306,7 @@
<tr class="row-even"><td><div class="ansible-option-cell"> <tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="attribute-check_mode"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-attribute-check-mode"><strong>check_mode</strong></p> <div class="ansibleOptionAnchor" id="attribute-check_mode"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-attribute-check-mode"><strong>check_mode</strong></p>
<a class="ansibleOptionLink" href="#attribute-check_mode" title="Permalink to this attribute"></a></div></td> <a class="ansibleOptionLink" href="#attribute-check_mode" title="Permalink to this attribute"></a></div></td>
<td><div class="ansible-option-cell"><p><span class="ansible-attribute-support-label">Support: </span><span class="ansible-attribute-support-full">full</span></p> <td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Can run in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code> and return changed status prediction without modifying target.</p> <td><div class="ansible-option-cell"><p>Can run in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code> and return changed status prediction without modifying target.</p>
</div></td> </div></td>
@ -311,7 +314,7 @@
<tr class="row-odd"><td><div class="ansible-option-cell"> <tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="attribute-diff_mode"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-attribute-diff-mode"><strong>diff_mode</strong></p> <div class="ansibleOptionAnchor" id="attribute-diff_mode"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-attribute-diff-mode"><strong>diff_mode</strong></p>
<a class="ansibleOptionLink" href="#attribute-diff_mode" title="Permalink to this attribute"></a></div></td> <a class="ansibleOptionLink" href="#attribute-diff_mode" title="Permalink to this attribute"></a></div></td>
<td><div class="ansible-option-cell"><p><span class="ansible-attribute-support-label">Support: </span><span class="ansible-attribute-support-full">full</span></p> <td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Will return details on what has changed (or possibly needs changing in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code>), when in diff mode.</p> <td><div class="ansible-option-cell"><p>Will return details on what has changed (or possibly needs changing in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code>), when in diff mode.</p>
</div></td> </div></td>
@ -391,7 +394,7 @@
<section id="return-values"> <section id="return-values">
<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> <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> <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%"> <table class="longtable ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Key</p></th> <tr class="row-odd"><th class="head"><p>Key</p></th>
<th class="head"><p>Description</p></th> <th class="head"><p>Description</p></th>
@ -403,8 +406,8 @@
<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> <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> </div></td>
<td><div class="ansible-option-cell"><p>Representation of role after module execution (sample is truncated).</p> <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"><strong class="ansible-option-returned-bold">Returned:</strong> on success</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> <p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <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> </div></td>
</tr> </tr>
<tr class="row-odd"><td><div class="ansible-option-cell"> <tr class="row-odd"><td><div class="ansible-option-cell">
@ -412,8 +415,8 @@
<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> <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> </div></td>
<td><div class="ansible-option-cell"><p>Representation of existing role.</p> <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"><strong class="ansible-option-returned-bold">Returned:</strong> always</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> <p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <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> </div></td>
</tr> </tr>
<tr class="row-even"><td><div class="ansible-option-cell"> <tr class="row-even"><td><div class="ansible-option-cell">
@ -421,8 +424,8 @@
<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> <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> </div></td>
<td><div class="ansible-option-cell"><p>Message as to what action was taken.</p> <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"><strong class="ansible-option-returned-bold">Returned:</strong> always</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> <p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <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> </div></td>
</tr> </tr>
<tr class="row-odd"><td><div class="ansible-option-cell"> <tr class="row-odd"><td><div class="ansible-option-cell">
@ -430,8 +433,8 @@
<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> <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> </div></td>
<td><div class="ansible-option-cell"><p>Representation of proposed role.</p> <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"><strong class="ansible-option-returned-bold">Returned:</strong> always</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> <p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <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> </div></td>
</tr> </tr>
</tbody> </tbody>

137
main/plugins/keycloak_user_federation.html
View file

@ -2,6 +2,7 @@
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta content="2.5.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>keycloak_user_federation – Allows administration of Keycloak user federations via Keycloak API &mdash; Keycloak Ansible Collection documentation</title> <title>keycloak_user_federation – Allows administration of Keycloak user federations via Keycloak API &mdash; Keycloak Ansible Collection documentation</title>
@ -116,7 +117,9 @@
<h1>keycloak_user_federation – Allows administration of Keycloak user federations via Keycloak API<a class="headerlink" href="#keycloak-user-federation-allows-administration-of-keycloak-user-federations-via-keycloak-api" title="Link to this heading"></a></h1> <h1>keycloak_user_federation – Allows administration of Keycloak user federations via Keycloak API<a class="headerlink" href="#keycloak-user-federation-allows-administration-of-keycloak-user-federations-via-keycloak-api" title="Link to this heading"></a></h1>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <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>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/middleware_automation/keycloak/">middleware_automation.keycloak collection</a>.</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</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 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_user_federation</span></code>.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">middleware_automation.keycloak.keycloak_user_federation</span></code>.</p>
</div> </div>
@ -139,7 +142,7 @@
</section> </section>
<section id="parameters"> <section id="parameters">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Link 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%"> <table class="longtable ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Parameter</p></th> <tr class="row-odd"><th class="head"><p>Parameter</p></th>
<th class="head"><p>Comments</p></th> <th class="head"><p>Comments</p></th>
@ -151,7 +154,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> <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> </div></td>
<td><div class="ansible-option-cell"><p>OpenID Connect <em>client_id</em> to authenticate to the API with.</p> <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> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;admin-cli&quot;</span></code></p> <p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;admin-cli&quot;</span></code></p>
</div></td> </div></td>
</tr> </tr>
<tr class="row-odd"><td><div class="ansible-option-cell"> <tr class="row-odd"><td><div class="ansible-option-cell">
@ -208,9 +211,9 @@
<a class="ansibleOptionLink" href="#parameter-config/allowKerberosAuthentication" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <a class="ansibleOptionLink" href="#parameter-config/allowKerberosAuthentication" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Enable/disable HTTP authentication of users with SPNEGO/Kerberos tokens. The data about authenticated users will be provisioned from this LDAP server.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Enable/disable HTTP authentication of users with SPNEGO/Kerberos tokens. The data about authenticated users will be provisioned from this LDAP server.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li> <li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></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">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
</ul> </ul>
</div></td> </div></td>
@ -220,7 +223,7 @@
<a class="ansibleOptionLink" href="#parameter-config/allowPasswordAuthentication" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <a class="ansibleOptionLink" href="#parameter-config/allowPasswordAuthentication" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Enable/disable possibility of username/password authentication against Kerberos database.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Enable/disable possibility of username/password authentication against Kerberos database.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
@ -232,9 +235,9 @@
<a class="ansibleOptionLink" href="#parameter-config/authType" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> <a class="ansibleOptionLink" href="#parameter-config/authType" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Type of the Authentication method used during LDAP Bind operation. It is used in most of the requests sent to the LDAP server.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Type of the Authentication method used during LDAP Bind operation. It is used in most of the requests sent to the LDAP server.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">&quot;none&quot;</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li> <li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">&quot;none&quot;</span></strong></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;simple&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;simple&quot;</span></code></p></li>
</ul> </ul>
</div></td> </div></td>
@ -244,7 +247,7 @@
<a class="ansibleOptionLink" href="#parameter-config/batchSizeForSync" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p> <a class="ansibleOptionLink" href="#parameter-config/batchSizeForSync" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Count of LDAP users to be imported from LDAP to Keycloak within a single transaction.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Count of LDAP users to be imported from LDAP to Keycloak within a single transaction.</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">1000</span></code></p> <p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">1000</span></code></p>
</div></td> </div></td>
</tr> </tr>
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> <tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
@ -266,9 +269,9 @@
<a class="ansibleOptionLink" href="#parameter-config/cachePolicy" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> <a class="ansibleOptionLink" href="#parameter-config/cachePolicy" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Cache Policy for this storage provider.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Cache Policy for this storage provider.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">&quot;DEFAULT&quot;</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li> <li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">&quot;DEFAULT&quot;</span></strong></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;EVICT_DAILY&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;EVICT_DAILY&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;EVICT_WEEKLY&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;EVICT_WEEKLY&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;MAX_LIFESPAN&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;MAX_LIFESPAN&quot;</span></code></p></li>
@ -281,7 +284,7 @@
<a class="ansibleOptionLink" href="#parameter-config/changedSyncPeriod" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p> <a class="ansibleOptionLink" href="#parameter-config/changedSyncPeriod" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Period for synchronization of changed or newly created LDAP users in seconds.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Period for synchronization of changed or newly created LDAP users in seconds.</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">-1</span></code></p> <p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">-1</span></code></p>
</div></td> </div></td>
</tr> </tr>
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> <tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
@ -289,10 +292,10 @@
<a class="ansibleOptionLink" href="#parameter-config/connectionPooling" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <a class="ansibleOptionLink" href="#parameter-config/connectionPooling" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Determines if Keycloak should use connection pooling for accessing LDAP server.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Determines if Keycloak should use connection pooling for accessing LDAP server.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-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> <li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
</ul> </ul>
</div></td> </div></td>
</tr> </tr>
@ -301,7 +304,7 @@
<a class="ansibleOptionLink" href="#parameter-config/connectionPoolingAuthentication" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> <a class="ansibleOptionLink" href="#parameter-config/connectionPoolingAuthentication" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>A list of space-separated authentication types of connections that may be pooled.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>A list of space-separated authentication types of connections that may be pooled.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;none&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;none&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;simple&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;simple&quot;</span></code></p></li>
@ -377,7 +380,7 @@
<a class="ansibleOptionLink" href="#parameter-config/debug" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <a class="ansibleOptionLink" href="#parameter-config/debug" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Enable/disable debug logging to standard output for Krb5LoginModule.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Enable/disable debug logging to standard output for Krb5LoginModule.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
@ -389,7 +392,7 @@
<a class="ansibleOptionLink" href="#parameter-config/editMode" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> <a class="ansibleOptionLink" href="#parameter-config/editMode" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p><code class="docutils literal notranslate"><span class="pre">READ_ONLY</span></code> is a read-only LDAP store. <code class="docutils literal notranslate"><span class="pre">WRITABLE</span></code> means data will be synced back to LDAP on demand. <code class="docutils literal notranslate"><span class="pre">UNSYNCED</span></code> means user data will be imported, but not synced back to LDAP.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p><code class="docutils literal notranslate"><span class="pre">READ_ONLY</span></code> is a read-only LDAP store. <code class="docutils literal notranslate"><span class="pre">WRITABLE</span></code> means data will be synced back to LDAP on demand. <code class="docutils literal notranslate"><span class="pre">UNSYNCED</span></code> means user data will be imported, but not synced back to LDAP.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;READ_ONLY&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;READ_ONLY&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;WRITABLE&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;WRITABLE&quot;</span></code></p></li>
@ -402,10 +405,10 @@
<a class="ansibleOptionLink" href="#parameter-config/enabled" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <a class="ansibleOptionLink" href="#parameter-config/enabled" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Enable/disable this user federation.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Enable/disable this user federation.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-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> <li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
</ul> </ul>
</div></td> </div></td>
</tr> </tr>
@ -435,7 +438,7 @@
<a class="ansibleOptionLink" href="#parameter-config/fullSyncPeriod" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p> <a class="ansibleOptionLink" href="#parameter-config/fullSyncPeriod" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Period for full synchronization in seconds.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Period for full synchronization in seconds.</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">-1</span></code></p> <p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">-1</span></code></p>
</div></td> </div></td>
</tr> </tr>
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> <tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
@ -443,10 +446,10 @@
<a class="ansibleOptionLink" href="#parameter-config/importEnabled" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <a class="ansibleOptionLink" href="#parameter-config/importEnabled" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>If <code class="docutils literal notranslate"><span class="pre">true</span></code>, LDAP users will be imported into Keycloak DB and synced by the configured sync policies.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>If <code class="docutils literal notranslate"><span class="pre">true</span></code>, LDAP users will be imported into Keycloak DB and synced by the configured sync policies.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-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> <li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
</ul> </ul>
</div></td> </div></td>
</tr> </tr>
@ -476,10 +479,10 @@
<a class="ansibleOptionLink" href="#parameter-config/pagination" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <a class="ansibleOptionLink" href="#parameter-config/pagination" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Does the LDAP server support pagination.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Does the LDAP server support pagination.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-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> <li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
</ul> </ul>
</div></td> </div></td>
</tr> </tr>
@ -488,7 +491,7 @@
<a class="ansibleOptionLink" href="#parameter-config/priority" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p> <a class="ansibleOptionLink" href="#parameter-config/priority" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Priority of provider when doing a user lookup. Lowest first.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Priority of provider when doing a user lookup. Lowest first.</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">0</span></code></p> <p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">0</span></code></p>
</div></td> </div></td>
</tr> </tr>
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> <tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
@ -510,9 +513,9 @@
<a class="ansibleOptionLink" href="#parameter-config/searchScope" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> <a class="ansibleOptionLink" href="#parameter-config/searchScope" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>For one level, the search applies only for users in the DNs specified by User DNs. For subtree, the search applies to the whole subtree. See LDAP documentation for more details.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>For one level, the search applies only for users in the DNs specified by User DNs. For subtree, the search applies to the whole subtree. See LDAP documentation for more details.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">&quot;1&quot;</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li> <li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">&quot;1&quot;</span></strong></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;2&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;2&quot;</span></code></p></li>
</ul> </ul>
</div></td> </div></td>
@ -529,9 +532,9 @@
<a class="ansibleOptionLink" href="#parameter-config/startTls" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <a class="ansibleOptionLink" href="#parameter-config/startTls" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Encrypts the connection to LDAP using STARTTLS, which will disable connection pooling.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Encrypts the connection to LDAP using STARTTLS, which will disable connection pooling.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li> <li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></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">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
</ul> </ul>
</div></td> </div></td>
@ -541,9 +544,9 @@
<a class="ansibleOptionLink" href="#parameter-config/syncRegistrations" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <a class="ansibleOptionLink" href="#parameter-config/syncRegistrations" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Should newly created users be created within LDAP store? Priority effects which provider is chosen to sync the new user.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Should newly created users be created within LDAP store? Priority effects which provider is chosen to sync the new user.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li> <li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></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">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
</ul> </ul>
</div></td> </div></td>
@ -553,9 +556,9 @@
<a class="ansibleOptionLink" href="#parameter-config/trustEmail" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <a class="ansibleOptionLink" href="#parameter-config/trustEmail" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>If enabled, email provided by this provider is not verified even if verification is enabled for the realm.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>If enabled, email provided by this provider is not verified even if verification is enabled for the realm.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li> <li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></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">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
</ul> </ul>
</div></td> </div></td>
@ -565,7 +568,7 @@
<a class="ansibleOptionLink" href="#parameter-config/updateProfileFirstLogin" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <a class="ansibleOptionLink" href="#parameter-config/updateProfileFirstLogin" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Update profile on first login.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Update profile on first login.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
@ -577,9 +580,9 @@
<a class="ansibleOptionLink" href="#parameter-config/useKerberosForPasswordAuthentication" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <a class="ansibleOptionLink" href="#parameter-config/useKerberosForPasswordAuthentication" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Use Kerberos login module for authenticate username/password against Kerberos server instead of authenticating against LDAP server with Directory Service API.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Use Kerberos login module for authenticate username/password against Kerberos server instead of authenticating against LDAP server with Directory Service API.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li> <li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></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">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
</ul> </ul>
</div></td> </div></td>
@ -589,9 +592,9 @@
<a class="ansibleOptionLink" href="#parameter-config/usePasswordModifyExtendedOp" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <a class="ansibleOptionLink" href="#parameter-config/usePasswordModifyExtendedOp" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Use the LDAPv3 Password Modify Extended Operation (RFC-3062). The password modify extended operation usually requires that LDAP user already has password in the LDAP server. So when this is used with ‘Sync Registrations’, it can be good to add also ‘Hardcoded LDAP attribute mapper’ with randomly generated initial password.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Use the LDAPv3 Password Modify Extended Operation (RFC-3062). The password modify extended operation usually requires that LDAP user already has password in the LDAP server. So when this is used with ‘Sync Registrations’, it can be good to add also ‘Hardcoded LDAP attribute mapper’ with randomly generated initial password.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li> <li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></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">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
</ul> </ul>
</div></td> </div></td>
@ -622,10 +625,10 @@
<a class="ansibleOptionLink" href="#parameter-config/useTruststoreSpi" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> <a class="ansibleOptionLink" href="#parameter-config/useTruststoreSpi" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Specifies whether LDAP connection will use the truststore SPI with the truststore configured in standalone.xml/domain.xml. <code class="docutils literal notranslate"><span class="pre">Always</span></code> means that it will always use it. <code class="docutils literal notranslate"><span class="pre">Never</span></code> means that it will not use it. <code class="docutils literal notranslate"><span class="pre">Only</span> <span class="pre">for</span> <span class="pre">ldaps</span></code> means that it will use if your connection URL use ldaps. Note even if standalone.xml/domain.xml is not configured, the default Java cacerts or certificate specified by <code class="docutils literal notranslate"><span class="pre">javax.net.ssl.trustStore</span></code> property will be used.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Specifies whether LDAP connection will use the truststore SPI with the truststore configured in standalone.xml/domain.xml. <code class="docutils literal notranslate"><span class="pre">Always</span></code> means that it will always use it. <code class="docutils literal notranslate"><span class="pre">Never</span></code> means that it will not use it. <code class="docutils literal notranslate"><span class="pre">Only</span> <span class="pre">for</span> <span class="pre">ldaps</span></code> means that it will use if your connection URL use ldaps. Note even if standalone.xml/domain.xml is not configured, the default Java cacerts or certificate specified by <code class="docutils literal notranslate"><span class="pre">javax.net.ssl.trustStore</span></code> property will be used.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;always&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;always&quot;</span></code></p></li>
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">&quot;ldapsOnly&quot;</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li> <li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">&quot;ldapsOnly&quot;</span></strong></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;never&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;never&quot;</span></code></p></li>
</ul> </ul>
</div></td> </div></td>
@ -642,9 +645,9 @@
<a class="ansibleOptionLink" href="#parameter-config/validatePasswordPolicy" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> <a class="ansibleOptionLink" href="#parameter-config/validatePasswordPolicy" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Determines if Keycloak should validate the password with the realm password policy before updating it.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Determines if Keycloak should validate the password with the realm password policy before updating it.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li> <li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></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">true</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
</ul> </ul>
</div></td> </div></td>
@ -660,19 +663,19 @@
<tr class="row-even"><td><div class="ansible-option-cell"> <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-user-federation-module-parameter-connection-timeout"><strong>connection_timeout</strong></p> <div class="ansibleOptionAnchor" id="parameter-connection_timeout"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-user-federation-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> <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> <p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 4.5.0</em></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Controls the HTTP connections timeout period (in seconds) to Keycloak API.</p> <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> <code class="ansible-option-default docutils literal notranslate"><span class="pre">10</span></code></p> <p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">10</span></code></p>
</div></td> </div></td>
</tr> </tr>
<tr class="row-odd"><td><div class="ansible-option-cell"> <tr class="row-odd"><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-user-federation-module-parameter-http-agent"><strong>http_agent</strong></p> <div class="ansibleOptionAnchor" id="parameter-http_agent"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-user-federation-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> <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> <p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 5.4.0</em></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Configures the HTTP User-Agent header.</p> <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> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;Ansible&quot;</span></code></p> <p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;Ansible&quot;</span></code></p>
</div></td> </div></td>
</tr> </tr>
<tr class="row-even"><td><div class="ansible-option-cell"> <tr class="row-even"><td><div class="ansible-option-cell">
@ -729,7 +732,7 @@
<a class="ansibleOptionLink" href="#parameter-mappers/providerType" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> <a class="ansibleOptionLink" href="#parameter-mappers/providerType" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td> </div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Component type for this mapper.</p> <td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Component type for this mapper.</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;org.keycloak.storage.ldap.mappers.LDAPStorageMapper&quot;</span></code></p> <p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;org.keycloak.storage.ldap.mappers.LDAPStorageMapper&quot;</span></code></p>
</div></td> </div></td>
</tr> </tr>
<tr class="row-even"><td><div class="ansible-option-cell"> <tr class="row-even"><td><div class="ansible-option-cell">
@ -755,7 +758,7 @@
<p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> <p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Provider for this user federation.</p> <td><div class="ansible-option-cell"><p>Provider for this user federation.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ldap&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ldap&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;kerberos&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;kerberos&quot;</span></code></p></li>
@ -770,7 +773,7 @@
<p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> <p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Component type for user federation (only supported value is <code class="docutils literal notranslate"><span class="pre">org.keycloak.storage.UserStorageProvider</span></code>).</p> <td><div class="ansible-option-cell"><p>Component type for user federation (only supported value is <code class="docutils literal notranslate"><span class="pre">org.keycloak.storage.UserStorageProvider</span></code>).</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;org.keycloak.storage.UserStorageProvider&quot;</span></code></p> <p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;org.keycloak.storage.UserStorageProvider&quot;</span></code></p>
</div></td> </div></td>
</tr> </tr>
<tr class="row-even"><td><div class="ansible-option-cell"> <tr class="row-even"><td><div class="ansible-option-cell">
@ -778,7 +781,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> <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> </div></td>
<td><div class="ansible-option-cell"><p>The Keycloak realm under which this user federation resides.</p> <td><div class="ansible-option-cell"><p>The Keycloak realm under which this user federation resides.</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> <p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;master&quot;</span></code></p>
</div></td> </div></td>
</tr> </tr>
<tr class="row-odd"><td><div class="ansible-option-cell"> <tr class="row-odd"><td><div class="ansible-option-cell">
@ -788,9 +791,9 @@
<td><div class="ansible-option-cell"><p>State of the user federation.</p> <td><div class="ansible-option-cell"><p>State of the user federation.</p>
<p>On <code class="docutils literal notranslate"><span class="pre">present</span></code>, the user federation 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">present</span></code>, the user federation 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 user federation will be removed if it exists.</p> <p>On <code class="docutils literal notranslate"><span class="pre">absent</span></code>, the user federation will be removed if it exists.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-default-bold docutils literal notranslate"><strong><span class="pre">&quot;present&quot;</span></strong></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> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;absent&quot;</span></code></p></li>
</ul> </ul>
</div></td> </div></td>
@ -798,7 +801,7 @@
<tr class="row-even"><td><div class="ansible-option-cell"> <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-user-federation-module-parameter-token"><strong>token</strong></p> <div class="ansibleOptionAnchor" id="parameter-token"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-user-federation-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> <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> <p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 3.0.0</em></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Authentication token for Keycloak API.</p> <td><div class="ansible-option-cell"><p>Authentication token for Keycloak API.</p>
</div></td> </div></td>
@ -808,10 +811,10 @@
<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> <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> </div></td>
<td><div class="ansible-option-cell"><p>Verify TLS certificates (do not disable this in production).</p> <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> <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple"> <ul class="simple">
<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-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> <li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
</ul> </ul>
</div></td> </div></td>
</tr> </tr>
@ -820,7 +823,7 @@
</section> </section>
<section id="attributes"> <section id="attributes">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Link 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%"> <table class="longtable ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Attribute</p></th> <tr class="row-odd"><th class="head"><p>Attribute</p></th>
<th class="head"><p>Support</p></th> <th class="head"><p>Support</p></th>
@ -831,7 +834,7 @@
<tr class="row-even"><td><div class="ansible-option-cell"> <tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="attribute-check_mode"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-user-federation-module-attribute-check-mode"><strong>check_mode</strong></p> <div class="ansibleOptionAnchor" id="attribute-check_mode"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-user-federation-module-attribute-check-mode"><strong>check_mode</strong></p>
<a class="ansibleOptionLink" href="#attribute-check_mode" title="Permalink to this attribute"></a></div></td> <a class="ansibleOptionLink" href="#attribute-check_mode" title="Permalink to this attribute"></a></div></td>
<td><div class="ansible-option-cell"><p><span class="ansible-attribute-support-label">Support: </span><span class="ansible-attribute-support-full">full</span></p> <td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Can run in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code> and return changed status prediction without modifying target.</p> <td><div class="ansible-option-cell"><p>Can run in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code> and return changed status prediction without modifying target.</p>
</div></td> </div></td>
@ -839,7 +842,7 @@
<tr class="row-odd"><td><div class="ansible-option-cell"> <tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="attribute-diff_mode"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-user-federation-module-attribute-diff-mode"><strong>diff_mode</strong></p> <div class="ansibleOptionAnchor" id="attribute-diff_mode"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-user-federation-module-attribute-diff-mode"><strong>diff_mode</strong></p>
<a class="ansibleOptionLink" href="#attribute-diff_mode" title="Permalink to this attribute"></a></div></td> <a class="ansibleOptionLink" href="#attribute-diff_mode" title="Permalink to this attribute"></a></div></td>
<td><div class="ansible-option-cell"><p><span class="ansible-attribute-support-label">Support: </span><span class="ansible-attribute-support-full">full</span></p> <td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Will return details on what has changed (or possibly needs changing in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code>), when in diff mode.</p> <td><div class="ansible-option-cell"><p>Will return details on what has changed (or possibly needs changing in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code>), when in diff mode.</p>
</div></td> </div></td>
@ -948,7 +951,7 @@
<section id="return-values"> <section id="return-values">
<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> <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> <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%"> <table class="longtable ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Key</p></th> <tr class="row-odd"><th class="head"><p>Key</p></th>
<th class="head"><p>Description</p></th> <th class="head"><p>Description</p></th>
@ -960,8 +963,8 @@
<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> <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> </div></td>
<td><div class="ansible-option-cell"><p>Representation of user federation after module execution.</p> <td><div class="ansible-option-cell"><p>Representation of user federation after module execution.</p>
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> on success</p> <p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> on success</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;config&quot;:</span> <span class="pre">{&quot;allowPasswordAuthentication&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;cachePolicy&quot;:</span> <span class="pre">&quot;DEFAULT&quot;,</span> <span class="pre">&quot;enabled&quot;:</span> <span class="pre">&quot;true&quot;,</span> <span class="pre">&quot;kerberosRealm&quot;:</span> <span class="pre">&quot;EXAMPLE.COM&quot;,</span> <span class="pre">&quot;keyTab&quot;:</span> <span class="pre">&quot;/etc/krb5.keytab&quot;,</span> <span class="pre">&quot;priority&quot;:</span> <span class="pre">&quot;0&quot;,</span> <span class="pre">&quot;serverPrincipal&quot;:</span> <span class="pre">&quot;HTTP/host.example.com&#64;EXAMPLE.COM&quot;,</span> <span class="pre">&quot;updateProfileFirstLogin&quot;:</span> <span class="pre">&quot;false&quot;},</span> <span class="pre">&quot;id&quot;:</span> <span class="pre">&quot;cf52ae4f-4471-4435-a0cf-bb620cadc122&quot;,</span> <span class="pre">&quot;mappers&quot;:</span> <span class="pre">[],</span> <span class="pre">&quot;name&quot;:</span> <span class="pre">&quot;kerberos&quot;,</span> <span class="pre">&quot;parentId&quot;:</span> <span class="pre">&quot;myrealm&quot;,</span> <span class="pre">&quot;providerId&quot;:</span> <span class="pre">&quot;kerberos&quot;,</span> <span class="pre">&quot;providerType&quot;:</span> <span class="pre">&quot;org.keycloak.storage.UserStorageProvider&quot;}</span></code></p> <p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">{&quot;config&quot;:</span> <span class="pre">{&quot;allowPasswordAuthentication&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;cachePolicy&quot;:</span> <span class="pre">&quot;DEFAULT&quot;,</span> <span class="pre">&quot;enabled&quot;:</span> <span class="pre">&quot;true&quot;,</span> <span class="pre">&quot;kerberosRealm&quot;:</span> <span class="pre">&quot;EXAMPLE.COM&quot;,</span> <span class="pre">&quot;keyTab&quot;:</span> <span class="pre">&quot;/etc/krb5.keytab&quot;,</span> <span class="pre">&quot;priority&quot;:</span> <span class="pre">&quot;0&quot;,</span> <span class="pre">&quot;serverPrincipal&quot;:</span> <span class="pre">&quot;HTTP/host.example.com&#64;EXAMPLE.COM&quot;,</span> <span class="pre">&quot;updateProfileFirstLogin&quot;:</span> <span class="pre">&quot;false&quot;},</span> <span class="pre">&quot;id&quot;:</span> <span class="pre">&quot;cf52ae4f-4471-4435-a0cf-bb620cadc122&quot;,</span> <span class="pre">&quot;mappers&quot;:</span> <span class="pre">[],</span> <span class="pre">&quot;name&quot;:</span> <span class="pre">&quot;kerberos&quot;,</span> <span class="pre">&quot;parentId&quot;:</span> <span class="pre">&quot;myrealm&quot;,</span> <span class="pre">&quot;providerId&quot;:</span> <span class="pre">&quot;kerberos&quot;,</span> <span class="pre">&quot;providerType&quot;:</span> <span class="pre">&quot;org.keycloak.storage.UserStorageProvider&quot;}</span></code></p>
</div></td> </div></td>
</tr> </tr>
<tr class="row-odd"><td><div class="ansible-option-cell"> <tr class="row-odd"><td><div class="ansible-option-cell">
@ -969,8 +972,8 @@
<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> <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> </div></td>
<td><div class="ansible-option-cell"><p>Representation of existing user federation.</p> <td><div class="ansible-option-cell"><p>Representation of existing user federation.</p>
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> always</p> <p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</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;config&quot;:</span> <span class="pre">{&quot;allowKerberosAuthentication&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;authType&quot;:</span> <span class="pre">&quot;simple&quot;,</span> <span class="pre">&quot;batchSizeForSync&quot;:</span> <span class="pre">&quot;1000&quot;,</span> <span class="pre">&quot;bindCredential&quot;:</span> <span class="pre">&quot;**********&quot;,</span> <span class="pre">&quot;bindDn&quot;:</span> <span class="pre">&quot;cn=directory</span> <span class="pre">reader&quot;,</span> <span class="pre">&quot;cachePolicy&quot;:</span> <span class="pre">&quot;DEFAULT&quot;,</span> <span class="pre">&quot;changedSyncPeriod&quot;:</span> <span class="pre">&quot;-1&quot;,</span> <span class="pre">&quot;connectionPooling&quot;:</span> <span class="pre">&quot;true&quot;,</span> <span class="pre">&quot;connectionUrl&quot;:</span> <span class="pre">&quot;ldaps://ldap.example.com:636&quot;,</span> <span class="pre">&quot;debug&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;editMode&quot;:</span> <span class="pre">&quot;READ_ONLY&quot;,</span> <span class="pre">&quot;enabled&quot;:</span> <span class="pre">&quot;true&quot;,</span> <span class="pre">&quot;fullSyncPeriod&quot;:</span> <span class="pre">&quot;-1&quot;,</span> <span class="pre">&quot;importEnabled&quot;:</span> <span class="pre">&quot;true&quot;,</span> <span class="pre">&quot;pagination&quot;:</span> <span class="pre">&quot;true&quot;,</span> <span class="pre">&quot;priority&quot;:</span> <span class="pre">&quot;0&quot;,</span> <span class="pre">&quot;rdnLDAPAttribute&quot;:</span> <span class="pre">&quot;uid&quot;,</span> <span class="pre">&quot;searchScope&quot;:</span> <span class="pre">&quot;1&quot;,</span> <span class="pre">&quot;syncRegistrations&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;trustEmail&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;useKerberosForPasswordAuthentication&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;useTruststoreSpi&quot;:</span> <span class="pre">&quot;ldapsOnly&quot;,</span> <span class="pre">&quot;userObjectClasses&quot;:</span> <span class="pre">&quot;inetOrgPerson,</span> <span class="pre">organizationalPerson&quot;,</span> <span class="pre">&quot;usernameLDAPAttribute&quot;:</span> <span class="pre">&quot;uid&quot;,</span> <span class="pre">&quot;usersDn&quot;:</span> <span class="pre">&quot;ou=Users,dc=example,dc=com&quot;,</span> <span class="pre">&quot;uuidLDAPAttribute&quot;:</span> <span class="pre">&quot;entryUUID&quot;,</span> <span class="pre">&quot;validatePasswordPolicy&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;vendor&quot;:</span> <span class="pre">&quot;other&quot;},</span> <span class="pre">&quot;id&quot;:</span> <span class="pre">&quot;01122837-9047-4ae4-8ca0-6e2e891a765f&quot;,</span> <span class="pre">&quot;mappers&quot;:</span> <span class="pre">[{&quot;config&quot;:</span> <span class="pre">{&quot;always.read.value.from.ldap&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;is.mandatory.in.ldap&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;ldap.attribute&quot;:</span> <span class="pre">&quot;mail&quot;,</span> <span class="pre">&quot;read.only&quot;:</span> <span class="pre">&quot;true&quot;,</span> <span class="pre">&quot;user.model.attribute&quot;:</span> <span class="pre">&quot;email&quot;},</span> <span class="pre">&quot;id&quot;:</span> <span class="pre">&quot;17d60ce2-2d44-4c2c-8b1f-1fba601b9a9f&quot;,</span> <span class="pre">&quot;name&quot;:</span> <span class="pre">&quot;email&quot;,</span> <span class="pre">&quot;parentId&quot;:</span> <span class="pre">&quot;01122837-9047-4ae4-8ca0-6e2e891a765f&quot;,</span> <span class="pre">&quot;providerId&quot;:</span> <span class="pre">&quot;user-attribute-ldap-mapper&quot;,</span> <span class="pre">&quot;providerType&quot;:</span> <span class="pre">&quot;org.keycloak.storage.ldap.mappers.LDAPStorageMapper&quot;}],</span> <span class="pre">&quot;name&quot;:</span> <span class="pre">&quot;myfed&quot;,</span> <span class="pre">&quot;parentId&quot;:</span> <span class="pre">&quot;myrealm&quot;,</span> <span class="pre">&quot;providerId&quot;:</span> <span class="pre">&quot;ldap&quot;,</span> <span class="pre">&quot;providerType&quot;:</span> <span class="pre">&quot;org.keycloak.storage.UserStorageProvider&quot;}</span></code></p> <p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">{&quot;config&quot;:</span> <span class="pre">{&quot;allowKerberosAuthentication&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;authType&quot;:</span> <span class="pre">&quot;simple&quot;,</span> <span class="pre">&quot;batchSizeForSync&quot;:</span> <span class="pre">&quot;1000&quot;,</span> <span class="pre">&quot;bindCredential&quot;:</span> <span class="pre">&quot;**********&quot;,</span> <span class="pre">&quot;bindDn&quot;:</span> <span class="pre">&quot;cn=directory</span> <span class="pre">reader&quot;,</span> <span class="pre">&quot;cachePolicy&quot;:</span> <span class="pre">&quot;DEFAULT&quot;,</span> <span class="pre">&quot;changedSyncPeriod&quot;:</span> <span class="pre">&quot;-1&quot;,</span> <span class="pre">&quot;connectionPooling&quot;:</span> <span class="pre">&quot;true&quot;,</span> <span class="pre">&quot;connectionUrl&quot;:</span> <span class="pre">&quot;ldaps://ldap.example.com:636&quot;,</span> <span class="pre">&quot;debug&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;editMode&quot;:</span> <span class="pre">&quot;READ_ONLY&quot;,</span> <span class="pre">&quot;enabled&quot;:</span> <span class="pre">&quot;true&quot;,</span> <span class="pre">&quot;fullSyncPeriod&quot;:</span> <span class="pre">&quot;-1&quot;,</span> <span class="pre">&quot;importEnabled&quot;:</span> <span class="pre">&quot;true&quot;,</span> <span class="pre">&quot;pagination&quot;:</span> <span class="pre">&quot;true&quot;,</span> <span class="pre">&quot;priority&quot;:</span> <span class="pre">&quot;0&quot;,</span> <span class="pre">&quot;rdnLDAPAttribute&quot;:</span> <span class="pre">&quot;uid&quot;,</span> <span class="pre">&quot;searchScope&quot;:</span> <span class="pre">&quot;1&quot;,</span> <span class="pre">&quot;syncRegistrations&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;trustEmail&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;useKerberosForPasswordAuthentication&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;useTruststoreSpi&quot;:</span> <span class="pre">&quot;ldapsOnly&quot;,</span> <span class="pre">&quot;userObjectClasses&quot;:</span> <span class="pre">&quot;inetOrgPerson,</span> <span class="pre">organizationalPerson&quot;,</span> <span class="pre">&quot;usernameLDAPAttribute&quot;:</span> <span class="pre">&quot;uid&quot;,</span> <span class="pre">&quot;usersDn&quot;:</span> <span class="pre">&quot;ou=Users,dc=example,dc=com&quot;,</span> <span class="pre">&quot;uuidLDAPAttribute&quot;:</span> <span class="pre">&quot;entryUUID&quot;,</span> <span class="pre">&quot;validatePasswordPolicy&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;vendor&quot;:</span> <span class="pre">&quot;other&quot;},</span> <span class="pre">&quot;id&quot;:</span> <span class="pre">&quot;01122837-9047-4ae4-8ca0-6e2e891a765f&quot;,</span> <span class="pre">&quot;mappers&quot;:</span> <span class="pre">[{&quot;config&quot;:</span> <span class="pre">{&quot;always.read.value.from.ldap&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;is.mandatory.in.ldap&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;ldap.attribute&quot;:</span> <span class="pre">&quot;mail&quot;,</span> <span class="pre">&quot;read.only&quot;:</span> <span class="pre">&quot;true&quot;,</span> <span class="pre">&quot;user.model.attribute&quot;:</span> <span class="pre">&quot;email&quot;},</span> <span class="pre">&quot;id&quot;:</span> <span class="pre">&quot;17d60ce2-2d44-4c2c-8b1f-1fba601b9a9f&quot;,</span> <span class="pre">&quot;name&quot;:</span> <span class="pre">&quot;email&quot;,</span> <span class="pre">&quot;parentId&quot;:</span> <span class="pre">&quot;01122837-9047-4ae4-8ca0-6e2e891a765f&quot;,</span> <span class="pre">&quot;providerId&quot;:</span> <span class="pre">&quot;user-attribute-ldap-mapper&quot;,</span> <span class="pre">&quot;providerType&quot;:</span> <span class="pre">&quot;org.keycloak.storage.ldap.mappers.LDAPStorageMapper&quot;}],</span> <span class="pre">&quot;name&quot;:</span> <span class="pre">&quot;myfed&quot;,</span> <span class="pre">&quot;parentId&quot;:</span> <span class="pre">&quot;myrealm&quot;,</span> <span class="pre">&quot;providerId&quot;:</span> <span class="pre">&quot;ldap&quot;,</span> <span class="pre">&quot;providerType&quot;:</span> <span class="pre">&quot;org.keycloak.storage.UserStorageProvider&quot;}</span></code></p>
</div></td> </div></td>
</tr> </tr>
<tr class="row-even"><td><div class="ansible-option-cell"> <tr class="row-even"><td><div class="ansible-option-cell">
@ -978,8 +981,8 @@
<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> <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> </div></td>
<td><div class="ansible-option-cell"><p>Message as to what action was taken.</p> <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"><strong class="ansible-option-returned-bold">Returned:</strong> always</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;No</span> <span class="pre">changes</span> <span class="pre">required</span> <span class="pre">to</span> <span class="pre">user</span> <span class="pre">federation</span> <span class="pre">164bb483-c613-482e-80fe-7f1431308799.&quot;</span></code></p> <p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">&quot;No</span> <span class="pre">changes</span> <span class="pre">required</span> <span class="pre">to</span> <span class="pre">user</span> <span class="pre">federation</span> <span class="pre">164bb483-c613-482e-80fe-7f1431308799.&quot;</span></code></p>
</div></td> </div></td>
</tr> </tr>
<tr class="row-odd"><td><div class="ansible-option-cell"> <tr class="row-odd"><td><div class="ansible-option-cell">
@ -987,8 +990,8 @@
<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> <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> </div></td>
<td><div class="ansible-option-cell"><p>Representation of proposed user federation.</p> <td><div class="ansible-option-cell"><p>Representation of proposed user federation.</p>
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> always</p> <p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</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;config&quot;:</span> <span class="pre">{&quot;allowKerberosAuthentication&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;authType&quot;:</span> <span class="pre">&quot;simple&quot;,</span> <span class="pre">&quot;batchSizeForSync&quot;:</span> <span class="pre">&quot;1000&quot;,</span> <span class="pre">&quot;bindCredential&quot;:</span> <span class="pre">&quot;**********&quot;,</span> <span class="pre">&quot;bindDn&quot;:</span> <span class="pre">&quot;cn=directory</span> <span class="pre">reader&quot;,</span> <span class="pre">&quot;cachePolicy&quot;:</span> <span class="pre">&quot;DEFAULT&quot;,</span> <span class="pre">&quot;connectionPooling&quot;:</span> <span class="pre">&quot;true&quot;,</span> <span class="pre">&quot;connectionUrl&quot;:</span> <span class="pre">&quot;ldaps://ldap.example.com:636&quot;,</span> <span class="pre">&quot;debug&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;editMode&quot;:</span> <span class="pre">&quot;READ_ONLY&quot;,</span> <span class="pre">&quot;enabled&quot;:</span> <span class="pre">&quot;true&quot;,</span> <span class="pre">&quot;importEnabled&quot;:</span> <span class="pre">&quot;true&quot;,</span> <span class="pre">&quot;pagination&quot;:</span> <span class="pre">&quot;true&quot;,</span> <span class="pre">&quot;priority&quot;:</span> <span class="pre">&quot;0&quot;,</span> <span class="pre">&quot;rdnLDAPAttribute&quot;:</span> <span class="pre">&quot;uid&quot;,</span> <span class="pre">&quot;searchScope&quot;:</span> <span class="pre">&quot;1&quot;,</span> <span class="pre">&quot;syncRegistrations&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;trustEmail&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;useKerberosForPasswordAuthentication&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;useTruststoreSpi&quot;:</span> <span class="pre">&quot;ldapsOnly&quot;,</span> <span class="pre">&quot;userObjectClasses&quot;:</span> <span class="pre">&quot;inetOrgPerson,</span> <span class="pre">organizationalPerson&quot;,</span> <span class="pre">&quot;usernameLDAPAttribute&quot;:</span> <span class="pre">&quot;uid&quot;,</span> <span class="pre">&quot;usersDn&quot;:</span> <span class="pre">&quot;ou=Users,dc=example,dc=com&quot;,</span> <span class="pre">&quot;uuidLDAPAttribute&quot;:</span> <span class="pre">&quot;entryUUID&quot;,</span> <span class="pre">&quot;validatePasswordPolicy&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;vendor&quot;:</span> <span class="pre">&quot;other&quot;},</span> <span class="pre">&quot;name&quot;:</span> <span class="pre">&quot;ldap&quot;,</span> <span class="pre">&quot;providerId&quot;:</span> <span class="pre">&quot;ldap&quot;,</span> <span class="pre">&quot;providerType&quot;:</span> <span class="pre">&quot;org.keycloak.storage.UserStorageProvider&quot;}</span></code></p> <p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">{&quot;config&quot;:</span> <span class="pre">{&quot;allowKerberosAuthentication&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;authType&quot;:</span> <span class="pre">&quot;simple&quot;,</span> <span class="pre">&quot;batchSizeForSync&quot;:</span> <span class="pre">&quot;1000&quot;,</span> <span class="pre">&quot;bindCredential&quot;:</span> <span class="pre">&quot;**********&quot;,</span> <span class="pre">&quot;bindDn&quot;:</span> <span class="pre">&quot;cn=directory</span> <span class="pre">reader&quot;,</span> <span class="pre">&quot;cachePolicy&quot;:</span> <span class="pre">&quot;DEFAULT&quot;,</span> <span class="pre">&quot;connectionPooling&quot;:</span> <span class="pre">&quot;true&quot;,</span> <span class="pre">&quot;connectionUrl&quot;:</span> <span class="pre">&quot;ldaps://ldap.example.com:636&quot;,</span> <span class="pre">&quot;debug&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;editMode&quot;:</span> <span class="pre">&quot;READ_ONLY&quot;,</span> <span class="pre">&quot;enabled&quot;:</span> <span class="pre">&quot;true&quot;,</span> <span class="pre">&quot;importEnabled&quot;:</span> <span class="pre">&quot;true&quot;,</span> <span class="pre">&quot;pagination&quot;:</span> <span class="pre">&quot;true&quot;,</span> <span class="pre">&quot;priority&quot;:</span> <span class="pre">&quot;0&quot;,</span> <span class="pre">&quot;rdnLDAPAttribute&quot;:</span> <span class="pre">&quot;uid&quot;,</span> <span class="pre">&quot;searchScope&quot;:</span> <span class="pre">&quot;1&quot;,</span> <span class="pre">&quot;syncRegistrations&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;trustEmail&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;useKerberosForPasswordAuthentication&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;useTruststoreSpi&quot;:</span> <span class="pre">&quot;ldapsOnly&quot;,</span> <span class="pre">&quot;userObjectClasses&quot;:</span> <span class="pre">&quot;inetOrgPerson,</span> <span class="pre">organizationalPerson&quot;,</span> <span class="pre">&quot;usernameLDAPAttribute&quot;:</span> <span class="pre">&quot;uid&quot;,</span> <span class="pre">&quot;usersDn&quot;:</span> <span class="pre">&quot;ou=Users,dc=example,dc=com&quot;,</span> <span class="pre">&quot;uuidLDAPAttribute&quot;:</span> <span class="pre">&quot;entryUUID&quot;,</span> <span class="pre">&quot;validatePasswordPolicy&quot;:</span> <span class="pre">&quot;false&quot;,</span> <span class="pre">&quot;vendor&quot;:</span> <span class="pre">&quot;other&quot;},</span> <span class="pre">&quot;name&quot;:</span> <span class="pre">&quot;ldap&quot;,</span> <span class="pre">&quot;providerId&quot;:</span> <span class="pre">&quot;ldap&quot;,</span> <span class="pre">&quot;providerType&quot;:</span> <span class="pre">&quot;org.keycloak.storage.UserStorageProvider&quot;}</span></code></p>
</div></td> </div></td>
</tr> </tr>
</tbody> </tbody>

4
main/roles/keycloak_quarkus.html
View file

@ -126,7 +126,7 @@
<tbody> <tbody>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_version</span></code></p></td> <tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_version</span></code></p></td>
<td class="text-left"><p>keycloak.org package version</p></td> <td class="text-left"><p>keycloak.org package version</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">22.0.3</span></code></p></td> <td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">22.0.4</span></code></p></td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
@ -326,7 +326,7 @@
</tr> </tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_version</span></code></p></td> <tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_version</span></code></p></td>
<td class="text-left"><p>keycloak.org package version</p></td> <td class="text-left"><p>keycloak.org package version</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">22.0.3</span></code></p></td> <td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">22.0.4</span></code></p></td>
</tr> </tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_dest</span></code></p></td> <tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_dest</span></code></p></td>
<td class="text-left"><p>Installation root path</p></td> <td class="text-left"><p>Installation root path</p></td>

2
main/searchindex.js
View file

File diff suppressed because one or more lines are too long