mirror of
https://github.com/ansible-middleware/keycloak.git
synced 2026-07-25 08:55:04 +00:00
1303 lines
99 KiB
HTML
1303 lines
99 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" data-content_root="../">
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
<meta content="2.24.0" name="antsibull-docs" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>keycloak_userprofile – Allows managing Keycloak User Profiles — Keycloak Ansible Collection documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=41de9001" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/antsibull-minimal.css" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/ansible-basic-sphinx-ext.css" />
|
||
|
||
|
||
<script src="../_static/jquery.js?v=5d32c60e"></script>
|
||
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
||
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
|
||
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||
<script src="../_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="Role Index" href="../roles/index.html" />
|
||
<link rel="prev" title="keycloak_user_rolemapping – Allows administration of Keycloak user_rolemapping with the Keycloak API" href="keycloak_user_rolemapping.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="../index.html" class="icon icon-home">
|
||
Keycloak Ansible Collection
|
||
</a>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="../README.html">Ansible Collection - middleware_automation.keycloak</a></li>
|
||
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Plugin Index</a><ul class="current">
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_authentication.html">keycloak_authentication – Configure authentication in Keycloak</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_authentication_flow.html">keycloak_authentication_flow – Allows administration of Keycloak authentication flows via Keycloak API</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_authentication_required_actions.html">keycloak_authentication_required_actions – Allows administration of Keycloak authentication required actions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_authentication_v2.html">keycloak_authentication_v2 – Configure authentication flows in Keycloak in an idempotent and safe manner.</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_authz_authorization_scope.html">keycloak_authz_authorization_scope – Allows administration of Keycloak client authorization scopes using Keycloak API</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_authz_custom_policy.html">keycloak_authz_custom_policy – Allows administration of Keycloak client custom Javascript policies using Keycloak API</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_authz_permission.html">keycloak_authz_permission – Allows administration of Keycloak client authorization permissions using Keycloak API</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_authz_permission_info.html">keycloak_authz_permission_info – Query Keycloak client authorization permissions information</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_client.html">keycloak_client – Allows administration of Keycloak clients using Keycloak API</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_client_rolemapping.html">keycloak_client_rolemapping – Allows administration of Keycloak client_rolemapping with the Keycloak API</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_client_rolescope.html">keycloak_client_rolescope – Allows administration of Keycloak client roles scope to restrict the usage of certain roles to a other specific client applications</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_client_scope.html">keycloak_client_scope – Allows administration of Keycloak client scopes via Keycloak API</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_client_scope_rolemappings.html">keycloak_client_scope_rolemappings – Allows administration of Keycloak client scope scope mappings to restrict the usage of certain roles to specific client scopes</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_client_scope_type.html">keycloak_client_scope_type – Set the type of a client scope in a realm or client using the Keycloak API</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_clientsecret_info.html">keycloak_clientsecret_info – Retrieve client secret using Keycloak API</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_clientsecret_regenerate.html">keycloak_clientsecret_regenerate – Regenerate Keycloak client secret using Keycloak API</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_clienttemplate.html">keycloak_clienttemplate – Allows administration of Keycloak client templates using Keycloak API</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_component.html">keycloak_component – Allows administration of Keycloak components using Keycloak API</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_component_info.html">keycloak_component_info – Retrieve component info in Keycloak</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_group.html">keycloak_group – Allows administration of Keycloak groups using Keycloak API</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_identity_provider.html">keycloak_identity_provider – Allows administration of Keycloak identity providers using Keycloak API</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_realm.html">keycloak_realm – Allows administration of Keycloak realm using Keycloak API</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_realm_info.html">keycloak_realm_info – Allows obtaining Keycloak realm public information using Keycloak API</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_realm_key.html">keycloak_realm_key – Allows administration of Keycloak realm keys using Keycloak API</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_realm_keys_metadata_info.html">keycloak_realm_keys_metadata_info – Allows obtaining Keycloak realm keys metadata using Keycloak API</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_realm_localization.html">keycloak_realm_localization – Allows management of Keycloak realm localization overrides via the Keycloak API</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_realm_rolemapping.html">keycloak_realm_rolemapping – Allows administration of Keycloak realm role mappings into groups with the Keycloak API</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_role.html">keycloak_role – Allows administration of Keycloak roles using Keycloak API</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_user.html">keycloak_user – Create and configure a user in Keycloak</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_user_execute_actions_email.html">keycloak_user_execute_actions_email – Send a Keycloak execute-actions email to a user</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_user_federation.html">keycloak_user_federation – Allows administration of Keycloak user federations using Keycloak API</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keycloak_user_rolemapping.html">keycloak_user_rolemapping – Allows administration of Keycloak user_rolemapping with the Keycloak API</a></li>
|
||
<li class="toctree-l2 current"><a class="current reference internal" href="#">keycloak_userprofile – Allows managing Keycloak User Profiles</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#synopsis">Synopsis</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#parameters">Parameters</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#attributes">Attributes</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#notes">Notes</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#examples">Examples</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#return-values">Return Values</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#authors">Authors</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../roles/index.html">Role Index</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../CHANGELOG.html">Changelog</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../developing.html">Developing</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../developing.html#contributor-s-guidelines">Contributor’s Guidelines</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../testing.html">Testing</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../releasing.html">Releasing</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Middleware collections</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/keycloak/main/">Keycloak / Red Hat Single Sign-On</a></li>
|
||
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/infinispan/main/">Infinispan / Red Hat Data Grid</a></li>
|
||
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/wildfly/main/">Wildfly / Red Hat JBoss EAP</a></li>
|
||
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/jws/main/">Tomcat / Red Hat JWS</a></li>
|
||
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/amq/main/">ActiveMQ / Red Hat AMQ Broker</a></li>
|
||
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/amq_streams/main/">Kafka / Red Hat AMQ Streams</a></li>
|
||
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/common/main/">Ansible Middleware utilities</a></li>
|
||
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/ansible_collections_jcliff/main/">JCliff</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="../index.html">Keycloak Ansible Collection</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item"><a href="index.html">Plugin Index</a></li>
|
||
<li class="breadcrumb-item active">keycloak_userprofile – Allows managing Keycloak User Profiles</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="../_sources/plugins/keycloak_userprofile.rst.txt" rel="nofollow"> View page source</a>
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<span class="target" id="ansible-collections-middleware-automation-keycloak-keycloak-userprofile-module"></span><section id="keycloak-userprofile-allows-managing-keycloak-user-profiles">
|
||
<h1>keycloak_userprofile – Allows managing Keycloak User Profiles<a class="headerlink" href="#keycloak-userprofile-allows-managing-keycloak-user-profiles" title="Link to this heading"></a></h1>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/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 use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">middleware_automation.keycloak.keycloak_userprofile</span></code>.</p>
|
||
</div>
|
||
<p class="ansible-version-added">New in middleware_automation.keycloak 3.0.0</p>
|
||
<nav class="contents local" id="contents">
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||
<li><p><a class="reference internal" href="#parameters" id="id2">Parameters</a></p></li>
|
||
<li><p><a class="reference internal" href="#attributes" id="id3">Attributes</a></p></li>
|
||
<li><p><a class="reference internal" href="#notes" id="id4">Notes</a></p></li>
|
||
<li><p><a class="reference internal" href="#examples" id="id5">Examples</a></p></li>
|
||
<li><p><a class="reference internal" href="#return-values" id="id6">Return Values</a></p></li>
|
||
</ul>
|
||
</nav>
|
||
<section id="synopsis">
|
||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
|
||
<ul class="simple">
|
||
<li><p>This module allows you to create, update, or delete Keycloak User Profiles using the Keycloak API. You can also customize the “Unmanaged Attributes” with it.</p></li>
|
||
<li><p>The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at <a class="reference external" href="https://www.keycloak.org/docs-api/24.0.5/rest-api/index.html">https://www.keycloak.org/docs-api/24.0.5/rest-api/index.html</a>. For compatibility reasons, the module also accepts the camelCase versions of the options.</p></li>
|
||
</ul>
|
||
</section>
|
||
<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>
|
||
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
|
||
<thead>
|
||
<tr class="row-odd">
|
||
<th class="head"><p>Parameter</p></th>
|
||
<th class="head"><p>Comments</p></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-auth_client_id"></div>
|
||
<p class="ansible-option-title"><strong>auth_client_id</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-auth_client_id" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">string</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell">
|
||
<p>OpenID Connect <em>client_id</em> to authenticate to the API with.</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">"admin-cli"</code></p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-auth_client_secret"></div>
|
||
<p class="ansible-option-title"><strong>auth_client_secret</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-auth_client_secret" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">string</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell">
|
||
<p>Client Secret to use in conjunction with <em>auth_client_id</em> (if required).</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-auth_keycloak_url"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-url"></div>
|
||
<p class="ansible-option-title"><strong>auth_keycloak_url</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-auth_keycloak_url" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: url</span></p>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">string</span>
|
||
/ <span class="ansible-option-required">required</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell">
|
||
<p>URL to the Keycloak instance.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-auth_password"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-password"></div>
|
||
<p class="ansible-option-title"><strong>auth_password</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-auth_password" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: password</span></p>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">string</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell">
|
||
<p>Password to authenticate for API access with.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-auth_realm"></div>
|
||
<p class="ansible-option-title"><strong>auth_realm</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-auth_realm" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">string</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell">
|
||
<p>Keycloak realm name to authenticate to for API access.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-auth_username"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-username"></div>
|
||
<p class="ansible-option-title"><strong>auth_username</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-auth_username" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: username</span></p>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">string</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell">
|
||
<p>Username to authenticate for API access with.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config"></div>
|
||
<p class="ansible-option-title"><strong>config</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">dictionary</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell">
|
||
<p>The configuration of the User Profile Provider.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig"></div>
|
||
<p class="ansible-option-title"><strong>kc_user_profile_config</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: kcUserProfileConfig</span></p>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">list</span>
|
||
/ <span class="ansible-option-elements">elements=dictionary</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>Define a declarative User Profile. See EXAMPLES for more context.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes"></div>
|
||
<p class="ansible-option-title"><strong>attributes</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">list</span>
|
||
/ <span class="ansible-option-elements">elements=dictionary</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>A list of attributes to be included in the User Profile.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/annotations"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/annotations"></div>
|
||
<p class="ansible-option-title"><strong>annotations</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/annotations" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">dictionary</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>Annotations for the attribute.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/display_name"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/display_name"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/displayName"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/displayName"></div>
|
||
<p class="ansible-option-title"><strong>display_name</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/display_name" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: displayName</span></p>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">string</span>
|
||
/ <span class="ansible-option-required">required</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The display name of the attribute.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/group"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/group"></div>
|
||
<p class="ansible-option-title"><strong>group</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/group" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">string</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>Specifies the User Profile group where this attribute is added.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/multivalued"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/multivalued"></div>
|
||
<p class="ansible-option-title"><strong>multivalued</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/multivalued" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">boolean</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>Whether the attribute can have multiple values.</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||
<ul class="simple">
|
||
<li><p><code class="ansible-value literal notranslate ansible-option-default-bold"><strong>false</strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">true</code></p></li>
|
||
</ul>
|
||
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/name"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/name"></div>
|
||
<p class="ansible-option-title"><strong>name</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/name" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">string</span>
|
||
/ <span class="ansible-option-required">required</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The name of the attribute.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/permissions"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/permissions"></div>
|
||
<p class="ansible-option-title"><strong>permissions</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/permissions" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">dictionary</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The permissions for viewing and editing the attribute.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/permissions/edit"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/permissions/edit"></div>
|
||
<p class="ansible-option-title"><strong>edit</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/permissions/edit" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">list</span>
|
||
/ <span class="ansible-option-elements">elements=string</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The roles that can edit the attribute.</p>
|
||
<p>Supported values are <code class="ansible-value literal notranslate">admin</code> and <code class="ansible-value literal notranslate">user</code>.</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">["admin", "user"]</code></p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/permissions/view"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/permissions/view"></div>
|
||
<p class="ansible-option-title"><strong>view</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/permissions/view" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">list</span>
|
||
/ <span class="ansible-option-elements">elements=string</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The roles that can view the attribute.</p>
|
||
<p>Supported values are <code class="ansible-value literal notranslate">admin</code> and <code class="ansible-value literal notranslate">user</code>.</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">["admin", "user"]</code></p>
|
||
</div></td>
|
||
</tr>
|
||
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/required"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/required"></div>
|
||
<p class="ansible-option-title"><strong>required</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/required" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">dictionary</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The roles that require this attribute.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/required/roles"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/required/roles"></div>
|
||
<p class="ansible-option-title"><strong>roles</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/required/roles" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">list</span>
|
||
/ <span class="ansible-option-elements">elements=string</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The roles for which this attribute is required.</p>
|
||
<p>Supported values are <code class="ansible-value literal notranslate">admin</code> and <code class="ansible-value literal notranslate">user</code>.</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">["user"]</code></p>
|
||
</div></td>
|
||
</tr>
|
||
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/selector"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/selector"></div>
|
||
<p class="ansible-option-title"><strong>selector</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/selector" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">dictionary</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>Selector when the attribute should be added.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/selector/scopes"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/selector/scopes"></div>
|
||
<p class="ansible-option-title"><strong>scopes</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/selector/scopes" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">list</span>
|
||
/ <span class="ansible-option-elements">elements=string</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>Scopes to which the attribute should be added.</p>
|
||
</div></td>
|
||
</tr>
|
||
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/validations"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/validations"></div>
|
||
<p class="ansible-option-title"><strong>validations</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/validations" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">dictionary</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The validations to be applied to the attribute.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/validations/double"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/validations/double"></div>
|
||
<p class="ansible-option-title"><strong>double</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/validations/double" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">dictionary</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The double validation for the attribute.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/validations/email"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/validations/email"></div>
|
||
<p class="ansible-option-title"><strong>email</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/validations/email" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">dictionary</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The email validation for the attribute.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/validations/integer"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/validations/integer"></div>
|
||
<p class="ansible-option-title"><strong>integer</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/validations/integer" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">dictionary</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The integer validation for the attribute.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/validations/iso_date"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/validations/iso_date"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/validations/isoDate"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/validations/isoDate"></div>
|
||
<p class="ansible-option-title"><strong>iso_date</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/validations/iso_date" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: isoDate</span></p>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">dictionary</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The iso-date validation for the attribute.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/validations/length"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/validations/length"></div>
|
||
<p class="ansible-option-title"><strong>length</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/validations/length" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">dictionary</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The length validation for the attribute.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/validations/length/max"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/validations/length/max"></div>
|
||
<p class="ansible-option-title"><strong>max</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/validations/length/max" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">integer</span>
|
||
/ <span class="ansible-option-required">required</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The maximum length of the attribute.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/validations/length/min"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/validations/length/min"></div>
|
||
<p class="ansible-option-title"><strong>min</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/validations/length/min" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">integer</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The minimum length of the attribute.</p>
|
||
</div></td>
|
||
</tr>
|
||
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/validations/local_date"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/validations/local_date"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/validations/localDate"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/validations/localDate"></div>
|
||
<p class="ansible-option-title"><strong>local_date</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/validations/local_date" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: localDate</span></p>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">dictionary</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The local-date validation for the attribute.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/validations/multivalued"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/validations/multivalued"></div>
|
||
<p class="ansible-option-title"><strong>multivalued</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/validations/multivalued" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">dictionary</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The multivalued validation for the attribute.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/validations/multivalued/max"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/validations/multivalued/max"></div>
|
||
<p class="ansible-option-title"><strong>max</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/validations/multivalued/max" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">integer</span>
|
||
/ <span class="ansible-option-required">required</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The maximum amount of values of the attribute.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/validations/multivalued/min"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/validations/multivalued/min"></div>
|
||
<p class="ansible-option-title"><strong>min</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/validations/multivalued/min" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">integer</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The minimum amount of values of the attribute.</p>
|
||
</div></td>
|
||
</tr>
|
||
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/validations/options"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/validations/options"></div>
|
||
<p class="ansible-option-title"><strong>options</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/validations/options" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">dictionary</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>Validation to ensure the attribute matches one of the provided options.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/validations/pattern"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/validations/pattern"></div>
|
||
<p class="ansible-option-title"><strong>pattern</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/validations/pattern" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">dictionary</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The pattern validation for the attribute using regular expressions.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/validations/person_name_prohibited_characters"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/validations/person_name_prohibited_characters"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/validations/personNameProhibitedCharacters"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/validations/personNameProhibitedCharacters"></div>
|
||
<p class="ansible-option-title"><strong>person_name_prohibited_characters</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/validations/person_name_prohibited_characters" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: personNameProhibitedCharacters</span></p>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">dictionary</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The prohibited characters validation for person name attributes.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/validations/up_username_not_idn_homograph"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/validations/up_username_not_idn_homograph"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/validations/upUsernameNotIdnHomograph"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/validations/upUsernameNotIdnHomograph"></div>
|
||
<p class="ansible-option-title"><strong>up_username_not_idn_homograph</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/validations/up_username_not_idn_homograph" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: upUsernameNotIdnHomograph</span></p>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">dictionary</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The validation to prevent IDN homograph attacks in usernames.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/validations/uri"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/validations/uri"></div>
|
||
<p class="ansible-option-title"><strong>uri</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/validations/uri" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">dictionary</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The URI validation for the attribute.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/validations/username_prohibited_characters"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/validations/username_prohibited_characters"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/attributes/validations/usernameProhibitedCharacters"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/attributes/validations/usernameProhibitedCharacters"></div>
|
||
<p class="ansible-option-title"><strong>username_prohibited_characters</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/attributes/validations/username_prohibited_characters" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: usernameProhibitedCharacters</span></p>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">dictionary</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The prohibited characters validation for the username attribute.</p>
|
||
</div></td>
|
||
</tr>
|
||
|
||
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/groups"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/groups"></div>
|
||
<p class="ansible-option-title"><strong>groups</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/groups" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">list</span>
|
||
/ <span class="ansible-option-elements">elements=dictionary</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>A list of attribute groups to be included in the User Profile.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/groups/annotations"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/groups/annotations"></div>
|
||
<p class="ansible-option-title"><strong>annotations</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/groups/annotations" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">dictionary</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The annotations included in the group.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/groups/display_description"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/groups/display_description"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/groups/displayDescription"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/groups/displayDescription"></div>
|
||
<p class="ansible-option-title"><strong>display_description</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/groups/display_description" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: displayDescription</span></p>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">string</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The display description for the group.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/groups/display_header"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/groups/display_header"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/groups/displayHeader"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/groups/displayHeader"></div>
|
||
<p class="ansible-option-title"><strong>display_header</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/groups/display_header" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: displayHeader</span></p>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">string</span>
|
||
/ <span class="ansible-option-required">required</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The display header for the group.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/groups/name"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/groups/name"></div>
|
||
<p class="ansible-option-title"><strong>name</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/groups/name" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">string</span>
|
||
/ <span class="ansible-option-required">required</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>The name of the group.</p>
|
||
</div></td>
|
||
</tr>
|
||
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/unmanaged_attribute_policy"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/unmanaged_attribute_policy"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kc_user_profile_config/unmanagedAttributePolicy"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-config/kcUserProfileConfig/unmanagedAttributePolicy"></div>
|
||
<p class="ansible-option-title"><strong>unmanaged_attribute_policy</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-config/kc_user_profile_config/unmanaged_attribute_policy" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: unmanagedAttributePolicy</span></p>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">string</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
||
<p>Policy for unmanaged attributes.</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||
<ul class="simple">
|
||
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">"ENABLED"</code></p></li>
|
||
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">"ADMIN_EDIT"</code></p></li>
|
||
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">"ADMIN_VIEW"</code></p></li>
|
||
</ul>
|
||
|
||
</div></td>
|
||
</tr>
|
||
|
||
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-connection_timeout"></div>
|
||
<p class="ansible-option-title"><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>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell">
|
||
<p>Controls the HTTP connections timeout period (in seconds) to Keycloak API.</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">10</code></p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-http_agent"></div>
|
||
<p class="ansible-option-title"><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>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell">
|
||
<p>Configures the HTTP User-Agent header.</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">"Ansible"</code></p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-parent_id"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-parentId"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-realm"></div>
|
||
<p class="ansible-option-title"><strong>parent_id</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-parent_id" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: parentId, realm</span></p>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">string</span>
|
||
/ <span class="ansible-option-required">required</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell">
|
||
<p>The parent ID of the realm key. In practice the ID (name) of the realm.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-provider_id"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-providerId"></div>
|
||
<p class="ansible-option-title"><strong>provider_id</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-provider_id" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: providerId</span></p>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">string</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell">
|
||
<p>The name of the provider ID for the key (supported value is <code class="ansible-value literal notranslate">declarative-user-profile</code>).</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||
<ul class="simple">
|
||
<li><p><code class="ansible-value literal notranslate ansible-option-default-bold"><strong>"declarative-user-profile"</strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||
</ul>
|
||
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-provider_type"></div>
|
||
<div class="ansibleOptionAnchor" id="parameter-providerType"></div>
|
||
<p class="ansible-option-title"><strong>provider_type</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-provider_type" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: providerType</span></p>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">string</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell">
|
||
<p>Component type for User Profile (only supported value is <code class="ansible-value literal notranslate">org.keycloak.userprofile.UserProfileProvider</code>).</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||
<ul class="simple">
|
||
<li><p><code class="ansible-value literal notranslate ansible-option-default-bold"><strong>"org.keycloak.userprofile.UserProfileProvider"</strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||
</ul>
|
||
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-refresh_token"></div>
|
||
<p class="ansible-option-title"><strong>refresh_token</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-refresh_token" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">string</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell">
|
||
<p>Authentication refresh token for Keycloak API.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-state"></div>
|
||
<p class="ansible-option-title"><strong>state</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">string</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell">
|
||
<p>State of the User Profile provider.</p>
|
||
<p>On <code class="ansible-value literal notranslate">present</code>, the User Profile provider is created if it does not yet exist, or updated with the parameters you provide.</p>
|
||
<p>On <code class="ansible-value literal notranslate">absent</code>, the User Profile provider is removed if it exists.</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||
<ul class="simple">
|
||
<li><p><code class="ansible-value literal notranslate ansible-option-default-bold"><strong>"present"</strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">"absent"</code></p></li>
|
||
</ul>
|
||
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-token"></div>
|
||
<p class="ansible-option-title"><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>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell">
|
||
<p>Authentication token for Keycloak API.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-validate_certs"></div>
|
||
<p class="ansible-option-title"><strong>validate_certs</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-validate_certs" title="Permalink to this option"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">boolean</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell">
|
||
<p>Verify TLS certificates (do not disable this in production).</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||
<ul class="simple">
|
||
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">false</code></p></li>
|
||
<li><p><code class="ansible-value literal notranslate ansible-option-default-bold"><strong>true</strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||
</ul>
|
||
|
||
</div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></section>
|
||
<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>
|
||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||
<thead>
|
||
<tr class="row-odd"><th class="head"><p>Attribute</p></th>
|
||
<th class="head"><p>Support</p></th>
|
||
<th class="head"><p>Description</p></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="attribute-action_group"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-userprofile-module-attribute-action-group"><strong>action_group</strong></p>
|
||
<a class="ansibleOptionLink" href="#attribute-action_group" title="Permalink to this attribute"></a></div></td>
|
||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-property">Action group:</strong> <strong class="ansible-attribute-support-full">middleware_automation.keycloak.keycloak</strong></p>
|
||
<p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 3.0.0</em></p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell"><p>Use <code class="docutils literal notranslate"><span class="pre">group/middleware_automation.keycloak.keycloak</span></code> in <code class="docutils literal notranslate"><span class="pre">module_defaults</span></code> to set defaults for this module.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd"><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-userprofile-module-attribute-check-mode"><strong>check_mode</strong></p>
|
||
<a class="ansibleOptionLink" href="#attribute-check_mode" title="Permalink to this attribute"></a></div></td>
|
||
<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>
|
||
<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>
|
||
</tr>
|
||
<tr class="row-even"><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-userprofile-module-attribute-diff-mode"><strong>diff_mode</strong></p>
|
||
<a class="ansibleOptionLink" href="#attribute-diff_mode" title="Permalink to this attribute"></a></div></td>
|
||
<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>
|
||
<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>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</section>
|
||
<section id="notes">
|
||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Notes</a><a class="headerlink" href="#notes" title="Link to this heading"></a></h2>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<ul class="simple">
|
||
<li><p>Currently, only a single <code class="ansible-value docutils literal notranslate"><span class="pre">declarative-user-profile</span></code> entry is supported for <code class="ansible-option docutils literal notranslate"><strong><span><span class="pre">provider_id</span></span></strong></code> (design of the Keyckoak API). However, there can be multiple <code class="ansible-option docutils literal notranslate"><strong><span><span class="pre">config.kc_user_profile_config[].attributes[]</span></span></strong></code> entries.</p></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="examples">
|
||
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
|
||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create a Declarative User Profile with default settings</span>
|
||
<span class="w"> </span><span class="nt">middleware_automation.keycloak.keycloak_userprofile</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">present</span>
|
||
<span class="w"> </span><span class="nt">parent_id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">master</span>
|
||
<span class="w"> </span><span class="nt">config</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">kc_user_profile_config</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">attributes</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">username</span>
|
||
<span class="w"> </span><span class="nt">displayName</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${username}</span>
|
||
<span class="w"> </span><span class="nt">validations</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">length</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">min</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">3</span>
|
||
<span class="w"> </span><span class="nt">max</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">255</span>
|
||
<span class="w"> </span><span class="nt">username_prohibited_characters</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
|
||
<span class="w"> </span><span class="nt">up_username_not_idn_homograph</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
|
||
<span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
|
||
<span class="w"> </span><span class="nt">permissions</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">view</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">admin</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">user</span>
|
||
<span class="w"> </span><span class="nt">edit</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[]</span>
|
||
<span class="w"> </span><span class="nt">multivalued</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">email</span>
|
||
<span class="w"> </span><span class="nt">displayName</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${email}</span>
|
||
<span class="w"> </span><span class="nt">validations</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">email</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
|
||
<span class="w"> </span><span class="nt">length</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">max</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">255</span>
|
||
<span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
|
||
<span class="w"> </span><span class="nt">required</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">roles</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">user</span>
|
||
<span class="w"> </span><span class="nt">permissions</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">view</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">admin</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">user</span>
|
||
<span class="w"> </span><span class="nt">edit</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[]</span>
|
||
<span class="w"> </span><span class="nt">multivalued</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">firstName</span>
|
||
<span class="w"> </span><span class="nt">displayName</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${firstName}</span>
|
||
<span class="w"> </span><span class="nt">validations</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">length</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">max</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">255</span>
|
||
<span class="w"> </span><span class="nt">person_name_prohibited_characters</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
|
||
<span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
|
||
<span class="w"> </span><span class="nt">required</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">roles</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">user</span>
|
||
<span class="w"> </span><span class="nt">permissions</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">view</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">admin</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">user</span>
|
||
<span class="w"> </span><span class="nt">edit</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[]</span>
|
||
<span class="w"> </span><span class="nt">multivalued</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">lastName</span>
|
||
<span class="w"> </span><span class="nt">displayName</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${lastName}</span>
|
||
<span class="w"> </span><span class="nt">validations</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">length</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">max</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">255</span>
|
||
<span class="w"> </span><span class="nt">person_name_prohibited_characters</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
|
||
<span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
|
||
<span class="w"> </span><span class="nt">required</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">roles</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">user</span>
|
||
<span class="w"> </span><span class="nt">permissions</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">view</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">admin</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">user</span>
|
||
<span class="w"> </span><span class="nt">edit</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[]</span>
|
||
<span class="w"> </span><span class="nt">multivalued</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">testAttribute</span>
|
||
<span class="w"> </span><span class="nt">displayName</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${testAttribute}</span>
|
||
<span class="w"> </span><span class="nt">validations</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">integer</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">min</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">0</span>
|
||
<span class="w"> </span><span class="nt">max</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">255</span>
|
||
<span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
|
||
<span class="w"> </span><span class="nt">required</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">roles</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">user</span>
|
||
<span class="w"> </span><span class="nt">permissions</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">view</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">admin</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">user</span>
|
||
<span class="w"> </span><span class="nt">edit</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[]</span>
|
||
<span class="w"> </span><span class="nt">multivalued</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||
<span class="w"> </span><span class="nt">groups</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">user-metadata</span>
|
||
<span class="w"> </span><span class="nt">displayHeader</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">User metadata</span>
|
||
<span class="w"> </span><span class="nt">displayDescription</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Attributes, which refer to user metadata</span>
|
||
<span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
|
||
|
||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Delete a Keycloak User Profile Provider</span>
|
||
<span class="w"> </span><span class="nt">keycloak_userprofile</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">absent</span>
|
||
<span class="w"> </span><span class="nt">parent_id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">master</span>
|
||
|
||
<span class="c1"># Unmanaged attributes are user attributes not explicitly defined in the User Profile</span>
|
||
<span class="c1"># configuration. By default, unmanaged attributes are "Disabled" and are not</span>
|
||
<span class="c1"># available from any context such as registration, account, and the</span>
|
||
<span class="c1"># administration console. By setting "Enabled", unmanaged attributes are fully</span>
|
||
<span class="c1"># recognized by the server and accessible through all contexts, useful if you are</span>
|
||
<span class="c1"># starting migrating an existing realm to the declarative User Profile</span>
|
||
<span class="c1"># and you don't have yet all user attributes defined in the User Profile configuration.</span>
|
||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Enable Unmanaged Attributes</span>
|
||
<span class="w"> </span><span class="nt">middleware_automation.keycloak.keycloak_userprofile</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">present</span>
|
||
<span class="w"> </span><span class="nt">parent_id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">master</span>
|
||
<span class="w"> </span><span class="nt">config</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">kc_user_profile_config</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">unmanagedAttributePolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ENABLED</span>
|
||
|
||
<span class="c1"># By setting "Only administrators can write", unmanaged attributes can be managed</span>
|
||
<span class="c1"># only through the administration console and API, useful if you have already</span>
|
||
<span class="c1"># defined any custom attribute that can be managed by users but you are unsure</span>
|
||
<span class="c1"># about adding other attributes that should only be managed by administrators.</span>
|
||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Enable ADMIN_EDIT on Unmanaged Attributes</span>
|
||
<span class="w"> </span><span class="nt">middleware_automation.keycloak.keycloak_userprofile</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">present</span>
|
||
<span class="w"> </span><span class="nt">parent_id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">master</span>
|
||
<span class="w"> </span><span class="nt">config</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">kc_user_profile_config</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">unmanagedAttributePolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ADMIN_EDIT</span>
|
||
|
||
<span class="c1"># By setting `Only administrators can view`, unmanaged attributes are read-only</span>
|
||
<span class="c1"># and only available through the administration console and API.</span>
|
||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Enable ADMIN_VIEW on Unmanaged Attributes</span>
|
||
<span class="w"> </span><span class="nt">middleware_automation.keycloak.keycloak_userprofile</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">present</span>
|
||
<span class="w"> </span><span class="nt">parent_id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">master</span>
|
||
<span class="w"> </span><span class="nt">config</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="nt">kc_user_profile_config</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">unmanagedAttributePolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ADMIN_VIEW</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="return-values">
|
||
<h2><a class="toc-backref" href="#id6" 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/projects/ansible/latest/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible v14)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
|
||
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
|
||
<thead>
|
||
<tr class="row-odd">
|
||
<th class="head"><p>Key</p></th>
|
||
<th class="head"><p>Description</p></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="row-even">
|
||
<td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="return-data"></div>
|
||
<p class="ansible-option-title"><strong>data</strong></p>
|
||
<a class="ansibleOptionLink" href="#return-data" title="Permalink to this return value"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">dictionary</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell">
|
||
<p>The data returned by the Keycloak API.</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> when state is present</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd">
|
||
<td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="return-msg"></div>
|
||
<p class="ansible-option-title"><strong>msg</strong></p>
|
||
<a class="ansibleOptionLink" href="#return-msg" title="Permalink to this return value"></a>
|
||
<p class="ansible-option-type-line">
|
||
<span class="ansible-option-type">string</span>
|
||
</p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell">
|
||
<p>The output message generated by the module.</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
|
||
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-value literal notranslate ansible-option-sample">"UserProfileProvider created successfully"</code></p>
|
||
</div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table><section id="authors">
|
||
<h3>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h3>
|
||
<ul class="simple">
|
||
<li><p>Eike Waldt (@yeoldegrove)</p></li>
|
||
</ul>
|
||
</section>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="keycloak_user_rolemapping.html" class="btn btn-neutral float-left" title="keycloak_user_rolemapping – Allows administration of Keycloak user_rolemapping with the Keycloak API" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="../roles/index.html" class="btn btn-neutral float-right" title="Role Index" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2026, Red Hat, Inc..</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |