You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@syncope.apache.org by il...@apache.org on 2015/12/16 18:05:46 UTC

svn commit: r1720391 [2/5] - in /syncope/site/2.0.0-SNAPSHOT: docs/getting-started.html docs/getting-started.pdf docs/reference-guide.html docs/reference-guide.pdf release-process.html rest/2.0/schema_1_syncope1.html rest/2.0/syncope.wadl

Modified: syncope/site/2.0.0-SNAPSHOT/docs/reference-guide.html
URL: http://svn.apache.org/viewvc/syncope/site/2.0.0-SNAPSHOT/docs/reference-guide.html?rev=1720391&r1=1720390&r2=1720391&view=diff
==============================================================================
--- syncope/site/2.0.0-SNAPSHOT/docs/reference-guide.html (original)
+++ syncope/site/2.0.0-SNAPSHOT/docs/reference-guide.html Wed Dec 16 17:05:45 2015
@@ -431,10 +431,9 @@ body.book #toc,body.book #preamble,body.
 <ul class="sectlevel1">
 <li><a href="#introduction">1. Introduction</a>
 <ul class="sectlevel2">
-<li><a href="#strong-open-source-strong-what-does-it-mean">1.1. <strong>Open Source</strong>: what does it mean?</a></li>
-<li><a href="#digital-identity">1.2. Digital identity</a></li>
-<li><a href="#a-bit-of-history">1.3. A bit of history</a></li>
-<li><a href="#follow-us">1.4. Follow us</a></li>
+<li><a href="#digital-identity">1.1. Digital identity</a></li>
+<li><a href="#a-bit-of-history">1.2. A bit of history</a></li>
+<li><a href="#follow-us">1.3. Follow us</a></li>
 </ul>
 </li>
 <li><a href="#identity-and-access-management">2. Identity and Access Management</a>
@@ -527,20 +526,12 @@ body.book #toc,body.book #preamble,body.
 <ul class="sectlevel3">
 <li><a href="#prerequisites">5.1.1. Prerequisites</a></li>
 <li><a href="#usage">5.1.2. Usage</a></li>
-<li><a href="#installer">5.1.3. Installer</a>
-<ul class="sectlevel4">
-<li><a href="#prerequisites-2">Prerequisites</a></li>
-<li><a href="#running">Running</a></li>
-<li><a href="#installation-step-by-step">Installation step by step</a></li>
-</ul>
-</li>
-<li><a href="#installer-2">5.1.4. Installer</a>
-<ul class="sectlevel4">
-<li><a href="#prerequisites-3">Prerequisites</a></li>
-<li><a href="#running-2">Running</a></li>
-<li><a href="#installation-step-by-step-2">Installation step by step</a></li>
+<li><a href="#maven">5.1.3. Maven</a></li>
 </ul>
 </li>
+<li><a href="#debian-packages">5.2. Debian packages</a>
+<ul class="sectlevel3">
+<li><a href="#components">5.2.1. Components</a></li>
 </ul>
 </li>
 </ul>
@@ -562,134 +553,73 @@ body.book #toc,body.book #preamble,body.
 <li><a href="#connector-command">6.2.3. Connector command</a>
 <ul class="sectlevel4">
 <li><a href="#help-message-2">Help message</a></li>
-<li><a href="#details-option">Details option</a></li>
-<li><a href="#list-option">List option</a></li>
-<li><a href="#list-bundles-option">List bundles option</a></li>
-<li><a href="#list-configuration-properties-option">List configuration properties option</a></li>
-<li><a href="#read-option">Read option</a></li>
-<li><a href="#delete-option">Delete option</a></li>
+<li><a href="#options">Options</a></li>
 </ul>
 </li>
 <li><a href="#question-command">6.2.4. Question command</a>
 <ul class="sectlevel4">
 <li><a href="#help-message-3">Help message</a></li>
-<li><a href="#list-option-2">List option</a></li>
-<li><a href="#read-option-2">Read option</a></li>
-<li><a href="#delete-option-2">Delete option</a></li>
+<li><a href="#options-2">Options</a></li>
 </ul>
 </li>
 <li><a href="#role-command">6.2.5. Role command</a>
 <ul class="sectlevel4">
 <li><a href="#help-message-4">Help message</a></li>
-<li><a href="#details-option-2">Details option</a></li>
-<li><a href="#list-option-3">List option</a></li>
-<li><a href="#read-option-3">Read option</a></li>
-<li><a href="#delete-option-3">Delete option</a></li>
+<li><a href="#options-3">Options</a></li>
 </ul>
 </li>
 <li><a href="#configuration-command">6.2.6. Configuration command</a>
 <ul class="sectlevel4">
 <li><a href="#help-message-5">Help message</a></li>
-<li><a href="#get-option">Get option</a></li>
-<li><a href="#read-option-4">Read option</a></li>
-<li><a href="#update-option">Update option</a></li>
-<li><a href="#delete-option-4">Delete option</a></li>
-<li><a href="#export-option">Export option</a></li>
+<li><a href="#options-4">Options</a></li>
 </ul>
 </li>
 <li><a href="#logger-command">6.2.7. Logger command</a>
 <ul class="sectlevel4">
 <li><a href="#help-message-6">Help message</a></li>
-<li><a href="#details-option-3">Details option</a></li>
-<li><a href="#list-option-4">List option</a></li>
-<li><a href="#read-option-5">Read option</a></li>
-<li><a href="#update-option-2">Update option</a></li>
-<li><a href="#update-all-option">Update all option</a></li>
-<li><a href="#create-option">Create option</a></li>
-<li><a href="#delete-option-5">Delete option</a></li>
+<li><a href="#options-5">Options</a></li>
 </ul>
 </li>
 <li><a href="#task-command">6.2.8. Task command</a>
 <ul class="sectlevel4">
 <li><a href="#help-message-7">Help message</a></li>
-<li><a href="#details-option-4">Details option</a></li>
-<li><a href="#list-option-5">List option</a></li>
-<li><a href="#list-running-jobs">List running jobs</a></li>
-<li><a href="#list-scheduled-jobs">List scheduled jobs</a></li>
-<li><a href="#read-option-6">Read option</a></li>
-<li><a href="#read-execution-option">Read execution option</a></li>
-<li><a href="#delete-option-6">Delete option</a></li>
-<li><a href="#delete-execution-option">Delete execution option</a></li>
-<li><a href="#execute-option">Execute option</a></li>
+<li><a href="#options-6">Options</a></li>
 </ul>
 </li>
 <li><a href="#notification-command">6.2.9. Notification command</a>
 <ul class="sectlevel4">
 <li><a href="#help-message-8">Help message</a></li>
-<li><a href="#list-option-6">List option</a></li>
-<li><a href="#read-option-7">Read option</a></li>
-<li><a href="#delete-option-7">Delete option</a></li>
+<li><a href="#options-7">Options</a></li>
 </ul>
 </li>
 <li><a href="#schema-command">6.2.10. Schema command</a>
 <ul class="sectlevel4">
 <li><a href="#help-message-9">Help message</a></li>
-<li><a href="#details-option-5">Details option</a></li>
-<li><a href="#list-all-option">List all option</a></li>
-<li><a href="#list-plain-option">List plain option</a></li>
-<li><a href="#list-derived-option">List derived option</a></li>
-<li><a href="#list-virtual-option">List virtual option</a></li>
-<li><a href="#read-option-8">Read option</a></li>
-<li><a href="#delete-option-8">Delete option</a></li>
+<li><a href="#options-8">Options</a></li>
 </ul>
 </li>
 <li><a href="#user-command">6.2.11. User command</a>
 <ul class="sectlevel4">
 <li><a href="#help-message-10">Help message</a></li>
-<li><a href="#details-option-6">Details option</a></li>
-<li><a href="#list-option-7">List option</a></li>
-<li><a href="#get-user-key-option">Get user key option</a></li>
-<li><a href="#get-username-option">Get username option</a></li>
-<li><a href="#read-by-user-id-option">Read by user id option</a></li>
-<li><a href="#read-by-username-option">Read by username option</a></li>
-<li><a href="#search-by-attribute-option">Search by attribute option</a></li>
-<li><a href="#search-by-role-option">Search by role option</a></li>
-<li><a href="#search-by-resource-option">Search by resource option</a></li>
-<li><a href="#delete-option-9">Delete option</a></li>
-<li><a href="#delete-by-attribute-option">Delete by attribute option</a></li>
-<li><a href="#delete-all-option">Delete all option</a></li>
+<li><a href="#options-9">Options</a></li>
 </ul>
 </li>
 <li><a href="#report-command">6.2.12. Report command</a>
 <ul class="sectlevel4">
 <li><a href="#help-message-11">Help message</a></li>
-<li><a href="#details-option-7">Details option</a></li>
-<li><a href="#list-all-option-2">List all option</a></li>
-<li><a href="#list-reports-execution-option">List reports execution option</a></li>
-<li><a href="#read-option-9">Read option</a></li>
-<li><a href="#read-report-executions-option">Read report executions option</a></li>
-<li><a href="#delete-option-10">Delete option</a></li>
-<li><a href="#delete-report-executions-option">Delete report executions option</a></li>
-<li><a href="#execute-option-2">Execute option</a></li>
-<li><a href="#export-execution-option">Export execution option</a></li>
+<li><a href="#options-10">Options</a></li>
 </ul>
 </li>
 <li><a href="#resource-command">6.2.13. Resource command</a>
 <ul class="sectlevel4">
 <li><a href="#help-message-12">Help message</a></li>
-<li><a href="#details-option-8">Details option</a></li>
-<li><a href="#list-option-8">List option</a></li>
-<li><a href="#read-option-10">Read option</a></li>
-<li><a href="#delete-option-11">Delete option</a></li>
+<li><a href="#options-11">Options</a></li>
 </ul>
 </li>
 <li><a href="#policy-command">6.2.14. Policy command</a>
 <ul class="sectlevel4">
 <li><a href="#help-message-13">Help message</a></li>
-<li><a href="#details-option-9">Details option</a></li>
-<li><a href="#list-option-9">List option</a></li>
-<li><a href="#read-option-11">Read option</a></li>
-<li><a href="#delete-option-12">Delete option</a></li>
+<li><a href="#options-12">Options</a></li>
 </ul>
 </li>
 <li><a href="#info-command">6.2.15. Info command</a>
@@ -700,37 +630,25 @@ body.book #toc,body.book #preamble,body.
 <li><a href="#entitlement-command">6.2.16. Entitlement command</a>
 <ul class="sectlevel4">
 <li><a href="#help-message-15">Help message</a></li>
-<li><a href="#list-option-10">List option</a></li>
-<li><a href="#list-role-option">List role option</a></li>
-<li><a href="#read-by-username-option-2">Read by username option</a></li>
-<li><a href="#read-by-userid-option">Read by userid option</a></li>
-<li><a href="#search-by-role-option-2">Search by role option</a></li>
+<li><a href="#options-13">Options</a></li>
 </ul>
 </li>
 <li><a href="#domain-command">6.2.17. Domain command</a>
 <ul class="sectlevel4">
 <li><a href="#help-message-16">Help message</a></li>
-<li><a href="#details-option-10">Details option</a></li>
-<li><a href="#list-option-11">List option</a></li>
-<li><a href="#delete-option-13">Delete option</a></li>
+<li><a href="#options-14">Options</a></li>
 </ul>
 </li>
 <li><a href="#realm-command">6.2.18. Realm command</a>
 <ul class="sectlevel4">
 <li><a href="#help-message-17">Help message</a></li>
-<li><a href="#details-option-11">Details option</a></li>
-<li><a href="#list-option-12">List option</a></li>
+<li><a href="#options-15">Options</a></li>
 </ul>
 </li>
 <li><a href="#group-command">6.2.19. Group command</a>
 <ul class="sectlevel4">
 <li><a href="#help-message-18">Help message</a></li>
-<li><a href="#details-option-12">Details option</a></li>
-<li><a href="#list-option-13">List option</a></li>
-<li><a href="#read-option-12">Read option</a></li>
-<li><a href="#read-attribute-of-type-option">Read attribute of type option</a></li>
-<li><a href="#read-an-attribute-of-type-option">Read an attribute of type option</a></li>
-<li><a href="#delete-option-14">Delete option</a></li>
+<li><a href="#options-16">Options</a></li>
 </ul>
 </li>
 </ul>
@@ -759,7 +677,7 @@ body.book #toc,body.book #preamble,body.
 </ul>
 </li>
 <li><a href="#deploying-in-production">6.5. Deploying in production</a></li>
-<li><a href="#options">6.6. Options</a></li>
+<li><a href="#options-17">6.6. Options</a></li>
 <li><a href="#high-availability">6.7. High-Availability</a></li>
 </ul>
 </li>
@@ -813,88 +731,7 @@ provisioning, and compliance.</p>
 Java EE technology and released under the Apache 2.0 license.</p>
 </div>
 <div class="sect2">
-<h3 id="strong-open-source-strong-what-does-it-mean"><a class="anchor" href="#strong-open-source-strong-what-does-it-mean"></a>1.1. <strong>Open Source</strong>: what does it mean?</h3>
-<div class="paragraph">
-<p>Apache Syncope is one of several identity manager software defined Open Source; but how and why a software
-should be defined Open Source? And, in reality, now that Open Source is quite a brand, what really does it mean?</p>
-</div>
-<div class="paragraph">
-<p>To answer to this question maybe it&#8217;s better to refer to the words of the <a href="https://opensource.org">Open Source Initiave</a>
-about <em>the open source definition</em>:</p>
-</div>
-<div class="paragraph">
-<p>Open source doesn&#8217;t just mean access to the source code. The distribution terms of open-source software must
-comply with the following criteria:</p>
-</div>
-<div class="dlist">
-<dl>
-<dt class="hdlist1"><strong>1. Free Redistribution</strong></dt>
-<dd>
-<p>The license shall not restrict any party from selling or giving away the software as a component of an aggregate
-software distribution containing programs from several different sources. The license shall not require a royalty
-or other fee for such sale.</p>
-</dd>
-<dt class="hdlist1"><strong>2. Source Code</strong></dt>
-<dd>
-<p>The program must include source code, and must allow distribution in source code as well as compiled form. Where
-some form of a product is not distributed with source code, there must be a well-publicized means of obtaining the
-source code for no more than a reasonable reproduction cost preferably, downloading via the Internet without charge.
-The source code must be the preferred form in which a programmer would modify the program. Deliberately obfuscated
-source code is not allowed. Intermediate forms such as the output of a preprocessor or translator are not allowed.</p>
-</dd>
-<dt class="hdlist1"><strong>3. Derived Works</strong></dt>
-<dd>
-<p>The license must allow modifications and derived works, and must allow them to be distributed under the
-same terms as the license of the original software.</p>
-</dd>
-<dt class="hdlist1"><strong>4. Integrity of The Author&#8217;s Source Code</strong></dt>
-<dd>
-<p>The license may restrict source-code from being distributed in modified form only if the license allows the
-distribution of "patch files" with the source code for the purpose of modifying the program at build time.
-The license must explicitly permit distribution of software built from modified source code. The license may require
-derived works to carry a different name or version number from the original software.</p>
-</dd>
-<dt class="hdlist1"><strong>5. No Discrimination Against Persons or Groups</strong></dt>
-<dd>
-<p>The license must not discriminate against any person or group of persons.</p>
-</dd>
-<dt class="hdlist1"><strong>6. No Discrimination Against Fields of Endeavor</strong></dt>
-<dd>
-<p>The license must not restrict anyone from making use of the program in a specific field of endeavor.
-For example, it may not restrict the program from being used in a business, or from being used for genetic research.</p>
-</dd>
-<dt class="hdlist1"><strong>7. Distribution of License</strong></dt>
-<dd>
-<p>The rights attached to the program must apply to all to whom the program is redistributed without the need for
-execution of an additional license by those parties.</p>
-</dd>
-<dt class="hdlist1"><strong>8. License Must Not Be Specific to a Product</strong></dt>
-<dd>
-<p>The rights attached to the program must not depend on the program&#8217;s being part of a particular software distribution.
-If the program is extracted from that distribution and used or distributed within the terms of the program&#8217;s license,
-all parties to whom the program is redistributed should have the same rights as those that are granted in conjunction
-with the original software distribution.</p>
-</dd>
-<dt class="hdlist1"><strong>9. License Must Not Restrict Other Software</strong></dt>
-<dd>
-<p>The license must not place restrictions on other software that is distributed along with the licensed software.
-For example, the license must not insist that all other programs distributed on the same medium must be open-source
-software.</p>
-</dd>
-<dt class="hdlist1"><strong>10. License Must Be Technology-Neutral</strong></dt>
-<dd>
-<p>No provision of the license may be predicated on any individual technology or style of interface.</p>
-</dd>
-</dl>
-</div>
-<div class="paragraph">
-<p>This introduction about the Open Source because, as mentioned before, there are many software defined Open Source but
-more than anyone doesn&#8217;t compy with the list before. On the contrary Apache Syncope is a real Open Source software
-because it is compliant with Open Source criteria.</p>
-</div>
-</div>
-<div class="sect2">
-<h3 id="digital-identity"><a class="anchor" href="#digital-identity"></a>1.2. Digital identity</h3>
+<h3 id="digital-identity"><a class="anchor" href="#digital-identity"></a>1.1. Digital identity</h3>
 <div class="paragraph">
 <p>To briefly introduce what the digital identity means, we report what the <a href="https://en.wikipedia.org/wiki/Digital_identity">Wikipedia</a>
 says about it</p>
@@ -929,7 +766,7 @@ to as an online identity.</p>
 </div>
 </div>
 <div class="sect2">
-<h3 id="a-bit-of-history"><a class="anchor" href="#a-bit-of-history"></a>1.3. A bit of history</h3>
+<h3 id="a-bit-of-history"><a class="anchor" href="#a-bit-of-history"></a>1.2. A bit of history</h3>
 <div class="paragraph">
 <p>Syncope, officially, borns at the end of April 2010 with the first <a href="https://code.google.com/p/syncope/source/detail?r=1">commit</a>
 on the GoogleCode repository.
@@ -948,7 +785,7 @@ have chosen Syncope as their own identit
 </div>
 </div>
 <div class="sect2">
-<h3 id="follow-us"><a class="anchor" href="#follow-us"></a>1.4. Follow us</h3>
+<h3 id="follow-us"><a class="anchor" href="#follow-us"></a>1.3. Follow us</h3>
 <div class="paragraph">
 <p>Syncope offers several ways to be updated with the last release and so on:</p>
 </div>
@@ -1929,3062 +1766,935 @@ configuration directory:</p>
 </div>
 </div>
 <div class="sect3">
-<h4 id="installer"><a class="anchor" href="#installer"></a>5.1.3. Installer</h4>
+<h4 id="maven"><a class="anchor" href="#maven"></a>5.1.3. Maven</h4>
+
+</div>
+</div>
+<div class="sect2">
+<h3 id="debian-packages"><a class="anchor" href="#debian-packages"></a>5.2. Debian packages</h3>
 <div class="paragraph">
-<p>Starting from Apache Syncope 1.2.0 an installer package is <a href="http://syncope.apache.org/downloads.html">available</a>,
-its purpose is to download, configure and deploy a Syncope instance in one of the supported servers.</p>
+<p>Debian packages are available for use with <a href="http://www.debian.org/" target="_blank">Debian GNU / Linux</a>,
+<a href="http://www.ubuntu.com/" target="_blank">Ubuntu</a> and their derivatives.</p>
 </div>
-<div class="sect4">
-<h5 id="prerequisites-2"><a class="anchor" href="#prerequisites-2"></a>Prerequisites</h5>
-<div class="ulist">
-<ul>
-<li>
-<p><a href="http://maven.apache.org/">Apache Maven</a> (version 3.0.3 or higher) installed</p>
-</li>
-<li>
-<p>Configure data source in your application server</p>
-</li>
+<div class="admonitionblock caution">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-caution" title="Caution"></i>
+</td>
+<td class="content">
+<div class="title">Target Audience</div>
+Getting up and running quickly on Debian / Ubuntu.<br>
+<strong>Difficult to extend beyond pre-sets.</strong>
+</td>
+</tr>
+</table>
+</div>
+<div class="dlist">
+<dl>
+<dt class="hdlist1">Download</dt>
+<dd>
+<p><a href="http://syncope.apache.org/downloads.html" target="_blank">Download</a> the latest .deb packages</p>
+</dd>
+<dt class="hdlist1">Prepare</dt>
+<dd>
+<div class="olist arabic">
+<ol class="arabic">
 <li>
-<p>Supported container up and running</p>
+<p>Install Apache Tomcat 8 and PostgreSQL</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">sudo apt-get install tomcat8 libpostgresql-jdbc-java postgresql postgresql-client</code></pre>
+</div>
+</div>
 </li>
 <li>
-<p>Supported DBMS up and running</p>
-</li>
-</ul>
-</div>
+<p>Use the PostgreSQL JDBC driver with Tomcat</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">sudo ln -s /usr/share/java/postgresql-jdbc4.jar /usr/share/tomcat8/lib/</code></pre>
 </div>
-<div class="sect4">
-<h5 id="running"><a class="anchor" href="#running"></a>Running</h5>
-<div class="paragraph">
-<p>Just double-click the downloaded JAR file or execute via CLI:</p>
 </div>
+</li>
+<li>
+<p>Replace <code>JAVA_OPTS</code> in <code>/etc/default/tomcat8</code> with the following:</p>
 <div class="listingblock">
 <div class="content">
-<pre class="highlightjs highlight"><code>$ java -jar syncope-installer-*-uber.jar</code></pre>
+<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">JAVA_OPTS="-Djava.awt.headless=true -Dfile.encoding=UTF-8 -server \
+  -Xms1536m -Xmx1536m -XX:NewSize=256m -XX:MaxNewSize=256m
+  -XX:PermSize=256m -XX:MaxPermSize=256m -XX:+DisableExplicitGC"</code></pre>
 </div>
 </div>
+</li>
+</ol>
 </div>
-<div class="sect4">
-<h5 id="installation-step-by-step"><a class="anchor" href="#installation-step-by-step"></a>Installation step by step</h5>
-<div class="imageblock">
+</dd>
+<dt class="hdlist1">Install</dt>
+<dd>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>Stop Tomcat</p>
+<div class="listingblock">
 <div class="content">
-<img src="images/installer-1.png" alt="installer-1">
+<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">sudo service tomcat8 stop</code></pre>
 </div>
 </div>
-<div class="imageblock">
+</li>
+<li>
+<p>Install Apache Syncope core and console via the downloaded packages</p>
+<div class="listingblock">
 <div class="content">
-<img src="images/installer-2.png" alt="installer-2">
+<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">sudo dpkg -i apache-syncope-*.deb</code></pre>
 </div>
 </div>
-<div class="imageblock">
+</li>
+<li>
+<p>Create a database for use with Apache Syncope</p>
+<div class="listingblock">
 <div class="content">
-<img src="images/installer-3.png" alt="installer-3">
+<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">sudo SYNCOPE_USER="syncope" SYNCOPE_PASS="syncope" sh /usr/share/apache-syncope/dbinit-postgresql.sh</code></pre>
 </div>
 </div>
-<div class="imageblock">
+</li>
+<li>
+<p>Start Tomcat</p>
+<div class="listingblock">
 <div class="content">
-<img src="images/installer-4.png" alt="installer-4">
+<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">sudo service tomcat8 start</code></pre>
 </div>
 </div>
-<div class="dlist">
-<dl>
-<dt class="hdlist1">Installation path</dt>
-<dd>
-<div class="ulist">
-<ul>
-<li>
-<p>installation path: is the directory where Syncope overlay will be created</p>
 </li>
-</ul>
+</ol>
 </div>
 </dd>
 </dl>
 </div>
-<div class="imageblock">
-<div class="content">
-<img src="images/installer-5.png" alt="installer-5">
+<div class="sect3">
+<h4 id="components"><a class="anchor" href="#components"></a>5.2.1. Components</h4>
+<div class="admonitionblock caution">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-caution" title="Caution"></i>
+</td>
+<td class="content">
+The following assumes that Apache Tomcat is reachable on host <code>host.domain</code> and port <code>port</code>.
+</td>
+</tr>
+</table>
 </div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 33%;">
+<col style="width: 66%;">
+</colgroup>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Complete REST API reference</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="http://host.domain:port/syncope/index.html" class="bare">http://host.domain:port/syncope/index.html</a></p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="http://swagger.io/" target="_blank">Swagger</a> UI</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="http://host.domain:port/syncope/swagger/" class="bare">http://host.domain:port/syncope/swagger/</a></p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Administration console</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="http://host.domain:port/syncope-console/" class="bare">http://host.domain:port/syncope-console/</a><br></p></td>
+</tr>
+</tbody>
+</table>
 </div>
-<div class="dlist">
-<dl>
-<dt class="hdlist1">Maven</dt>
-<dd>
-<div class="ulist">
-<ul>
-<li>
-<p><strong>Maven home directory:</strong> is the Maven home directory;</p>
-</li>
-<li>
-<p><strong>Group ID:</strong> something like 'com.mycompany' - maven overlay property;</p>
-</li>
-<li>
-<p><strong>Artifact ID:</strong> something like 'myproject' - maven overlay property;</p>
-</li>
-<li>
-<p><strong>Secret Key:</strong> Provide any pseudo-random, 16 character length, string here that will be used in the generated project for AES ciphering;</p>
-</li>
-<li>
-<p><strong>Anonimous Key:</strong> - Provide any pseudo-random, 16 character length, string here that will be used in the generated project for AES ciphering;</p>
-</li>
-<li>
-<p><strong>Configuration directory:</strong> where Syncope configuration files are stored;</p>
-</li>
-<li>
-<p><strong>Log directory:</strong> where Syncope logs are stored;</p>
-</li>
-<li>
-<p><strong>Bundle directory:</strong> where ConnId bundles are stored;</p>
-</li>
-<li>
-<p><strong>Syncope version:</strong> the project version that would be to install.</p>
-</li>
-</ul>
 </div>
-</dd>
-</dl>
 </div>
-<div class="imageblock">
-<div class="content">
-<img src="images/installer-6.png" alt="installer-6">
 </div>
+<div class="sect1">
+<h2 id="working-with-apache-syncope"><a class="anchor" href="#working-with-apache-syncope"></a>6. Working with Apache Syncope</h2>
+<div class="sectionbody">
+<div class="sect2">
+<h3 id="using-the-admin-console"><a class="anchor" href="#using-the-admin-console"></a>6.1. Using the Admin Console</h3>
+
+</div>
+<div class="sect2">
+<h3 id="cli"><a class="anchor" href="#cli"></a>6.2. CLI</h3>
+<div class="sect3">
+<h4 id="introduction-2"><a class="anchor" href="#introduction-2"></a>6.2.1. Introduction</h4>
+<div class="paragraph">
+<p>A brief introduction about this document and the examples you will find reading it.</p>
+</div>
+<div class="paragraph">
+<p>Once you have downloaded and unzipped the zip file containing the scripts, you will find a lib directory and
+two script files, a .bat and a .sh one, called <em>syncopeadm</em>. You will use one of these files, depending on your operating system.</p>
+</div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-note" title="Note"></i>
+</td>
+<td class="content">
+Every example described in this document is executed on a linux machine with a <em>debug environment</em>.
+</td>
+</tr>
+</table>
+</div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-note" title="Note"></i>
+</td>
+<td class="content">
+Wikipedia suggests that a <a href="https://en.wikipedia.org/wiki/Command-line_interface">command line interface</a> (CLI)
+is a means of interacting with a computer program, where the user (or client) issues commands to the program
+in the form of successive lines of text (command lines). In our case the CLI tool is the way to call, more or less,
+every Syncope core command through a shell.
+</td>
+</tr>
+</table>
+</div>
+</div>
+<div class="sect3">
+<h4 id="installation-command"><a class="anchor" href="#installation-command"></a>6.2.2. Installation command</h4>
+<div class="paragraph">
+<p>The installation process creates a file, called <em>cli.properties</em>, used by the script to call the Apache Syncope
+REST API services with the right credentials.</p>
+</div>
+<div class="paragraph">
+<p>The properties file will contain content similar to:</p>
 </div>
-<div class="dlist">
-<dl>
-<dt class="hdlist1">Syncope options</dt>
-<dd>
 <div class="ulist">
 <ul>
 <li>
-<p><strong>Swagger:</strong> check if you want to install Swagger UI;</p>
+<p><strong>syncope.rest.services</strong>=http://localhost:9080/syncope/rest</p>
 </li>
 <li>
-<p><strong>Camel:</strong> check if you want to install Camel provisioning;</p>
+<p><strong>syncope.admin.user</strong>=admin</p>
 </li>
 <li>
-<p><strong>Activiti workflow modeler:</strong> check if you want to install Activiti modeler (default is true);</p>
+<p><strong>syncope.admin.password</strong>=QePSFVTnzwQowM4ohhaUYcE6aW47MVZ/</p>
 </li>
 </ul>
 </div>
-</dd>
-</dl>
-</div>
-<div class="imageblock">
-<div class="content">
-<img src="images/installer-7.png" alt="installer-7">
-</div>
+<div class="paragraph">
+<p>where the properties are:</p>
 </div>
 <div class="dlist">
 <dl>
-<dt class="hdlist1">Database</dt>
+<dt class="hdlist1">syncope.rest.services</dt>
 <dd>
-<div class="ulist">
-<ul>
-<li>
-<p>DBMS where Syncope will be installed;</p>
-</li>
-</ul>
-</div>
+<p>the URL where the Apache Syncope REST API services are listening;</p>
+</dd>
+<dt class="hdlist1">syncope.admin.user</dt>
+<dd>
+<p>the user with the permission to call the Syncope APIs;</p>
+</dd>
+<dt class="hdlist1">syncope.admin.password</dt>
+<dd>
+<p>the user password;</p>
 </dd>
 </dl>
 </div>
-<div class="imageblock">
+<div class="paragraph">
+<p>as can be seen, the user password is encrypted. This is only to avoid that another user could
+read an admin password.</p>
+</div>
+<div class="sect4">
+<h5 id="help-message"><a class="anchor" href="#help-message"></a>Help message</h5>
+<div class="listingblock">
 <div class="content">
-<img src="images/installer-8.png" alt="installer-8">
+<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">Usage: install [options]
+  Options:
+    --help
+    --setup
+    --setup-debug</code></pre>
 </div>
 </div>
-<div class="dlist">
-<dl>
-<dt class="hdlist1">Database settings</dt>
-<dd>
-<div class="ulist">
-<ul>
-<li>
-<p>Depends on DBMS selected (in the example: PostgreSQL)</p>
-<div class="ulist">
-<ul>
-<li>
-<p>Database JDBS url;</p>
-</li>
-<li>
-<p>Database user;</p>
-</li>
-<li>
-<p>Database password;</p>
-</li>
-</ul>
 </div>
-</li>
-</ul>
+<div class="sect4">
+<h5 id="run-the-installation"><a class="anchor" href="#run-the-installation"></a>Run the installation</h5>
+<div class="paragraph">
+<p>After the zip file is unzipped you can start with CLI client using the syncopeadm file.
+If you tried to run a CLI command before the installation process, the script returns</p>
 </div>
-</dd>
-</dl>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code> - Error: It seems you need to first setup the CLI client. Run install --setup.</code></pre>
 </div>
-<div class="imageblock">
+</div>
+<div class="paragraph">
+<p>So, as suggested, you have to run the install command to use the CLI:</p>
+</div>
+<div class="listingblock">
 <div class="content">
-<img src="images/installer-9.png" alt="installer-9">
+<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh install --setup</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>A successful result will be:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">You are running: install --setup
+
+###############################################
+#                                             #
+# Welcome to Syncope CLI installation process #
+#                                             #
+###############################################
+
+Path to config files of Syncope CLI client will be: ./
+- File system permission checked
+
+Syncope server schema [http/https]: http
+Syncope server hostname [e.g. localhost]: localhost
+Syncope server port [e.g. 8080]: 9080
+Syncope server rest context [e.g. /syncope/rest/]: /syncope/rest
+Syncope admin user: admin
+Syncope admin password: password
+Installation parameters checked on Syncope core version: 2.0.0-SNAPSHOT
+
+###############################################
+#                                             #
+#           Installation successful           #
+#     now you can use Syncope CLI client      #
+#                                             #
+###############################################</code></pre>
 </div>
 </div>
+<div class="paragraph">
+<p>During the installation you have to provide:</p>
+</div>
 <div class="dlist">
 <dl>
-<dt class="hdlist1">Application server</dt>
+<dt class="hdlist1">Syncope server schema</dt>
+<dd>
+<p>the http protocol used by the Apache Syncope core, it will be http or https;</p>
+</dd>
+<dt class="hdlist1">Syncope server hostname</dt>
+<dd>
+<p>the hostname where the core is deployed;</p>
+</dd>
+<dt class="hdlist1">Syncope server port</dt>
+<dd>
+<p>the port where the services are listening;</p>
+</dd>
+<dt class="hdlist1">Syncope server rest context</dt>
+<dd>
+<p>the context where the rest services are deployed (/syncope/rest is the default);</p>
+</dd>
+<dt class="hdlist1">Syncope admin user</dt>
+<dd>
+<p>the user with the permission to call the Syncope APIs;</p>
+</dd>
+<dt class="hdlist1">Syncope admin password</dt>
 <dd>
+<p>the user password.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="sect4">
+<h5 id="installation-error"><a class="anchor" href="#installation-error"></a>Installation error</h5>
+<div class="paragraph">
+<p>Various error messages are possible on installation. Here are some sample error messages:</p>
+</div>
 <div class="ulist">
 <ul>
 <li>
-<p>Container where Syncope will be deployed;</p>
+<p>Syncope unreachable (or wrong address):</p>
 </li>
 </ul>
 </div>
-</dd>
-</dl>
-</div>
-<div class="imageblock">
+<div class="listingblock">
 <div class="content">
-<img src="images/installer-10.png" alt="installer-10">
+<pre class="highlightjs highlight"><code>Provided address :http://localhost:9080/syncope/rest
+
+###############################################
+#                                             #
+#       Provided address is unreachable!      #
+#         Check it and if it is wrong         #
+#        START the installation AGAIN!        #
+#                                             #
+###############################################</code></pre>
 </div>
 </div>
-<div class="dlist">
-<dl>
-<dt class="hdlist1">Application server settings</dt>
-<dd>
 <div class="ulist">
 <ul>
 <li>
-<p>Depends on container selected (in the example: Tomcat)
-Remember to configure right DataSource on it and to configure Tomcat user like:</p>
+<p>Authentication failed:</p>
 </li>
 </ul>
 </div>
-</dd>
-</dl>
-</div>
 <div class="listingblock">
 <div class="content">
-<pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;?xml version='1.0' encoding='utf-8'?&gt;
-&lt;tomcat-users&gt;
-&lt;role rolename="manager-gui"/&gt;
-&lt;role rolename="manager-script"/&gt;
-&lt;role rolename="manager-jmx"/&gt;
-&lt;role rolename="manager-status"/&gt;
-&lt;user username="manager" password="s3cret" roles="manager-script"/&gt;
-&lt;/tomcat-users&gt;</code></pre>
-</div>
-</div>
-<div class="imageblock">
-<div class="content">
-<img src="images/installer-11.png" alt="installer-11">
-</div>
+<pre class="highlightjs highlight"><code>###############################################
+#                                             #
+#   Username or password provided are wrong   #
+#        START the installation AGAIN!        #
+#                                             #
+###############################################</code></pre>
 </div>
-<div class="imageblock">
-<div class="content">
-<img src="images/installer-12.png" alt="installer-12">
 </div>
+<div class="paragraph">
+<p>As the message suggests you have to start the installation again when this error occurrs.</p>
 </div>
-<div class="imageblock">
-<div class="content">
-<img src="images/installer-13.png" alt="installer-13">
 </div>
+<div class="sect4">
+<h5 id="debug-installation"><a class="anchor" href="#debug-installation"></a>Debug installation</h5>
+<div class="paragraph">
+<p>To work with the debug environment provided by Syncope we added a particular installation option for it.
+It enough to run the script with the --setup-debug option</p>
 </div>
-<div class="imageblock">
+<div class="listingblock">
 <div class="content">
-<img src="images/installer-14.png" alt="installer-14">
-</div>
+<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh install --setup-debug</code></pre>
 </div>
-<div class="paragraph">
-<p>The latest images shows how the installer print some feedback directly on the GUI or following the log</p>
 </div>
 <div class="listingblock">
 <div class="content">
-<pre class="highlightjs highlight"><code>/var/tmp/syncope_2_0_0/install.log</code></pre>
+<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">You are running: install --setup-debug
+
+###############################################
+#                                             #
+# Welcome to Syncope CLI installation process #
+#                                             #
+###############################################
+
+Path to config files of Syncope CLI client will be: ./
+- File system permission checked
+
+Installation parameters checked on Syncope core version: 2.0.0-SNAPSHOT
+
+###############################################
+#                                             #
+#           Installation successful           #
+#     now you can use Syncope CLI client      #
+#                                             #
+###############################################</code></pre>
 </div>
 </div>
 </div>
 </div>
 <div class="sect3">
-<h4 id="installer-2"><a class="anchor" href="#installer-2"></a>5.1.4. Installer</h4>
+<h4 id="connector-command"><a class="anchor" href="#connector-command"></a>6.2.3. Connector command</h4>
 <div class="paragraph">
-<p>Starting from Apache Syncope 1.2.0 an installer package is <a href="http://syncope.apache.org/downloads.html">available</a>,
-its purpose is to download, configure and deploy a Syncope instance in one of the supported servers.</p>
-</div>
-<div class="sect4">
-<h5 id="prerequisites-3"><a class="anchor" href="#prerequisites-3"></a>Prerequisites</h5>
-<div class="ulist">
-<ul>
-<li>
-<p><a href="http://maven.apache.org/">Apache Maven</a> (version 3.0.3 or higher) installed</p>
-</li>
-<li>
-<p>Configure data source in your application server</p>
-</li>
-<li>
-<p>Supported container up and running</p>
-</li>
-<li>
-<p>Supported DBMS up and running</p>
-</li>
-</ul>
-</div>
+<p>The connector command serves to retrieve information about the connector configuration in Apache Syncope.</p>
 </div>
 <div class="sect4">
-<h5 id="running-2"><a class="anchor" href="#running-2"></a>Running</h5>
-<div class="paragraph">
-<p>Just double-click the downloaded JAR file or execute via CLI:</p>
-</div>
+<h5 id="help-message-2"><a class="anchor" href="#help-message-2"></a>Help message</h5>
 <div class="listingblock">
 <div class="content">
-<pre class="highlightjs highlight"><code>$ java -jar syncope-installer-*-uber.jar</code></pre>
+<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">Usage: connector [options]
+  Options:
+    --help
+    --details
+    --list
+    --list-bundles
+    --list-configuration-properties
+       Syntax: --list-configuration-properties {CONNECTOR-ID} {CONNECTOR-ID} [...]
+    --read
+       Syntax: --read {CONNECTOR-ID} {CONNECTOR-ID} [...]
+    --delete
+       Syntax: --delete {CONNECTOR-ID} {CONNECTOR-ID} [...]</code></pre>
 </div>
 </div>
 </div>
 <div class="sect4">
-<h5 id="installation-step-by-step-2"><a class="anchor" href="#installation-step-by-step-2"></a>Installation step by step</h5>
-<div class="imageblock">
-<div class="content">
-<img src="images/installer-1.png" alt="installer-1">
-</div>
-</div>
-<div class="imageblock">
-<div class="content">
-<img src="images/installer-2.png" alt="installer-2">
-</div>
-</div>
-<div class="imageblock">
-<div class="content">
-<img src="images/installer-3.png" alt="installer-3">
-</div>
-</div>
-<div class="imageblock">
-<div class="content">
-<img src="images/installer-4.png" alt="installer-4">
-</div>
-</div>
-<div class="dlist">
-<dl>
-<dt class="hdlist1">Installation path</dt>
-<dd>
-<div class="ulist">
-<ul>
-<li>
-<p>installation path: is the directory where Syncope overlay will be created</p>
-</li>
-</ul>
-</div>
-</dd>
-</dl>
-</div>
-<div class="imageblock">
-<div class="content">
-<img src="images/installer-5.png" alt="installer-5">
-</div>
-</div>
+<h5 id="options"><a class="anchor" href="#options"></a>Options</h5>
 <div class="dlist">
 <dl>
-<dt class="hdlist1">Maven</dt>
+<dt class="hdlist1">--details</dt>
 <dd>
-<div class="ulist">
-<ul>
-<li>
-<p><strong>Maven home directory:</strong> is the Maven home directory;</p>
-</li>
-<li>
-<p><strong>Group ID:</strong> something like 'com.mycompany' - maven overlay property;</p>
-</li>
-<li>
-<p><strong>Artifact ID:</strong> something like 'myproject' - maven overlay property;</p>
-</li>
-<li>
-<p><strong>Secret Key:</strong> Provide any pseudo-random, 16 character length, string here that will be used in the generated project for AES ciphering;</p>
-</li>
-<li>
-<p><strong>Anonimous Key:</strong> - Provide any pseudo-random, 16 character length, string here that will be used in the generated project for AES ciphering;</p>
-</li>
-<li>
-<p><strong>Configuration directory:</strong> where Syncope configuration files are stored;</p>
-</li>
-<li>
-<p><strong>Log directory:</strong> where Syncope logs are stored;</p>
-</li>
-<li>
-<p><strong>Bundle directory:</strong> where ConnId bundles are stored;</p>
-</li>
-<li>
-<p><strong>Syncope version:</strong> the project version that would be to install.</p>
-</li>
-</ul>
-</div>
+<p>This option shows a table with some details about connectors and bundles.</p>
 </dd>
-</dl>
-</div>
-<div class="imageblock">
-<div class="content">
-<img src="images/installer-6.png" alt="installer-6">
-</div>
-</div>
-<div class="dlist">
-<dl>
-<dt class="hdlist1">Syncope options</dt>
+<dt class="hdlist1">--list</dt>
 <dd>
-<div class="ulist">
-<ul>
-<li>
-<p><strong>Swagger:</strong> check if you want to install Swagger UI;</p>
-</li>
-<li>
-<p><strong>Camel:</strong> check if you want to install Camel provisioning;</p>
-</li>
-<li>
-<p><strong>Activiti workflow modeler:</strong> check if you want to install Activiti modeler (default is true);</p>
-</li>
-</ul>
-</div>
+<p>Running the command with this option you will see the list of connectors with their configuration.</p>
 </dd>
-</dl>
-</div>
-<div class="imageblock">
-<div class="content">
-<img src="images/installer-7.png" alt="installer-7">
-</div>
-</div>
-<div class="dlist">
-<dl>
-<dt class="hdlist1">Database</dt>
+<dt class="hdlist1">--list-bundles</dt>
 <dd>
-<div class="ulist">
-<ul>
-<li>
-<p>DBMS where Syncope will be installed;</p>
-</li>
-</ul>
-</div>
+<p>Running the command with this option you will see the list of the bundles available in Syncope.</p>
 </dd>
-</dl>
-</div>
-<div class="imageblock">
-<div class="content">
-<img src="images/installer-8.png" alt="installer-8">
-</div>
-</div>
-<div class="dlist">
-<dl>
-<dt class="hdlist1">Database settings</dt>
+<dt class="hdlist1">--list-configuration-properties</dt>
 <dd>
-<div class="ulist">
-<ul>
-<li>
-<p>Depends on DBMS selected (in the example: PostgreSQL)</p>
-<div class="ulist">
-<ul>
-<li>
-<p>Database JDBS url;</p>
-</li>
-<li>
-<p>Database user;</p>
-</li>
-<li>
-<p>Database password;</p>
-</li>
-</ul>
-</div>
-</li>
-</ul>
-</div>
+<p>This option lists the configuration of specified connectors.</p>
 </dd>
-</dl>
-</div>
-<div class="imageblock">
-<div class="content">
-<img src="images/installer-9.png" alt="installer-9">
-</div>
-</div>
-<div class="dlist">
-<dl>
-<dt class="hdlist1">Application server</dt>
+<dt class="hdlist1">--read</dt>
 <dd>
-<div class="ulist">
-<ul>
-<li>
-<p>Container where Syncope will be deployed;</p>
-</li>
-</ul>
-</div>
+<p>The option to read all the information of specified connectors.</p>
 </dd>
-</dl>
-</div>
-<div class="imageblock">
-<div class="content">
-<img src="images/installer-10.png" alt="installer-10">
-</div>
-</div>
-<div class="dlist">
-<dl>
-<dt class="hdlist1">Application server settings</dt>
+<dt class="hdlist1">--delete</dt>
 <dd>
-<div class="ulist">
-<ul>
-<li>
-<p>Depends on container selected (in the example: Tomcat)
-Remember to configure right DataSource on it and to configure Tomcat user like:</p>
-</li>
-</ul>
-</div>
+<p>The option to delete a specified connector.</p>
 </dd>
 </dl>
 </div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;?xml version='1.0' encoding='utf-8'?&gt;
-&lt;tomcat-users&gt;
-&lt;role rolename="manager-gui"/&gt;
-&lt;role rolename="manager-script"/&gt;
-&lt;role rolename="manager-jmx"/&gt;
-&lt;role rolename="manager-status"/&gt;
-&lt;user username="manager" password="s3cret" roles="manager-script"/&gt;
-&lt;/tomcat-users&gt;</code></pre>
-</div>
-</div>
-<div class="imageblock">
-<div class="content">
-<img src="images/installer-11.png" alt="installer-11">
-</div>
-</div>
-<div class="imageblock">
-<div class="content">
-<img src="images/installer-12.png" alt="installer-12">
-</div>
-</div>
-<div class="imageblock">
-<div class="content">
-<img src="images/installer-13.png" alt="installer-13">
-</div>
-</div>
-<div class="imageblock">
-<div class="content">
-<img src="images/installer-14.png" alt="installer-14">
 </div>
 </div>
+<div class="sect3">
+<h4 id="question-command"><a class="anchor" href="#question-command"></a>6.2.4. Question command</h4>
 <div class="paragraph">
-<p>The latest images shows how the installer print some feedback directly on the GUI or following the log</p>
+<p>The question command gets information about the user question to retrieve their password.</p>
 </div>
+<div class="sect4">
+<h5 id="help-message-3"><a class="anchor" href="#help-message-3"></a>Help message</h5>
 <div class="listingblock">
 <div class="content">
-<pre class="highlightjs highlight"><code>/var/tmp/syncope_2_0_0/install.log</code></pre>
-</div>
-</div>
-</div>
-</div>
-</div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="working-with-apache-syncope"><a class="anchor" href="#working-with-apache-syncope"></a>6. Working with Apache Syncope</h2>
-<div class="sectionbody">
-<div class="sect2">
-<h3 id="using-the-admin-console"><a class="anchor" href="#using-the-admin-console"></a>6.1. Using the Admin Console</h3>
-
-</div>
-<div class="sect2">
-<h3 id="cli"><a class="anchor" href="#cli"></a>6.2. CLI</h3>
-<div class="sect3">
-<h4 id="introduction-2"><a class="anchor" href="#introduction-2"></a>6.2.1. Introduction</h4>
-<div class="paragraph">
-<p>A brief introduction about this document and the examples you will find reading it.</p>
-</div>
-<div class="paragraph">
-<p>Once you have downloaded and unzipped the zip file containing the scripts, you will find a lib directory and
-two script files, a .bat and a .sh one, called <em>syncopeadm</em>. You will use one of these files, depending on your operating system.</p>
-</div>
-<div class="admonitionblock note">
-<table>
-<tr>
-<td class="icon">
-<i class="fa icon-note" title="Note"></i>
-</td>
-<td class="content">
-Every example described in this document is executed on a linux machine with a <em>debug environment</em>.
-</td>
-</tr>
-</table>
-</div>
-<div class="admonitionblock note">
-<table>
-<tr>
-<td class="icon">
-<i class="fa icon-note" title="Note"></i>
-</td>
-<td class="content">
-Wikipedia suggests that a <a href="https://en.wikipedia.org/wiki/Command-line_interface">command line interface</a> (CLI)
-is a means of interacting with a computer program, where the user (or client) issues commands to the program
-in the form of successive lines of text (command lines). In our case the CLI tool is the way to call, more or less,
-every Syncope core command through a shell.
-</td>
-</tr>
-</table>
-</div>
-</div>
-<div class="sect3">
-<h4 id="installation-command"><a class="anchor" href="#installation-command"></a>6.2.2. Installation command</h4>
-<div class="paragraph">
-<p>The installation process creates a file, called <em>cli.properties</em>, used by the script to call the Apache Syncope
-REST API services with the right credentials.</p>
-</div>
-<div class="paragraph">
-<p>The properties file will contain content similar to:</p>
-</div>
-<div class="ulist">
-<ul>
-<li>
-<p><strong>syncope.rest.services</strong>=http://localhost:9080/syncope/rest</p>
-</li>
-<li>
-<p><strong>syncope.admin.user</strong>=admin</p>
-</li>
-<li>
-<p><strong>syncope.admin.password</strong>=QePSFVTnzwQowM4ohhaUYcE6aW47MVZ/</p>
-</li>
-</ul>
-</div>
-<div class="paragraph">
-<p>where the properties are:</p>
-</div>
-<div class="dlist">
-<dl>
-<dt class="hdlist1">syncope.rest.services</dt>
-<dd>
-<p>the URL where the Apache Syncope REST API services are listening;</p>
-</dd>
-<dt class="hdlist1">syncope.admin.user</dt>
-<dd>
-<p>the user with the permission to call the Syncope APIs;</p>
-</dd>
-<dt class="hdlist1">syncope.admin.password</dt>
-<dd>
-<p>the user password;</p>
-</dd>
-</dl>
-</div>
-<div class="paragraph">
-<p>as can be seen, the user password is encrypted. This is only to avoid that another user could
-read an admin password.</p>
-</div>
-<div class="sect4">
-<h5 id="help-message"><a class="anchor" href="#help-message"></a>Help message</h5>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">Usage: install [options]
-  Options:
-    --help
-    --setup
-    --setup-debug</code></pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="run-the-installation"><a class="anchor" href="#run-the-installation"></a>Run the installation</h5>
-<div class="paragraph">
-<p>After the zip file is unzipped you can start with CLI client using the syncopeadm file.
-If you tried to run a CLI command before the installation process, the script returns</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code> - Error: It seems you need to first setup the CLI client. Run install --setup.</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>So, as suggested, you have to run the install command to use the CLI:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh install --setup</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>A successful result will be:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">You are running: install --setup
-
-###############################################
-#                                             #
-# Welcome to Syncope CLI installation process #
-#                                             #
-###############################################
-
-Path to config files of Syncope CLI client will be: ./
-- File system permission checked
-
-Syncope server schema [http/https]: http
-Syncope server hostname [e.g. localhost]: localhost
-Syncope server port [e.g. 8080]: 9080
-Syncope server rest context [e.g. /syncope/rest/]: /syncope/rest
-Syncope admin user: admin
-Syncope admin password: password
-Installation parameters checked on Syncope core version: 2.0.0-SNAPSHOT
-
-###############################################
-#                                             #
-#           Installation successful           #
-#     now you can use Syncope CLI client      #
-#                                             #
-###############################################</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>During the installation you have to provide:</p>
-</div>
-<div class="dlist">
-<dl>
-<dt class="hdlist1">Syncope server schema</dt>
-<dd>
-<p>the http protocol used by the Apache Syncope core, it will be http or https;</p>
-</dd>
-<dt class="hdlist1">Syncope server hostname</dt>
-<dd>
-<p>the hostname where the core is deployed;</p>
-</dd>
-<dt class="hdlist1">Syncope server port</dt>
-<dd>
-<p>the port where the services are listening;</p>
-</dd>
-<dt class="hdlist1">Syncope server rest context</dt>
-<dd>
-<p>the context where the rest services are deployed (/syncope/rest is the default);</p>
-</dd>
-<dt class="hdlist1">Syncope admin user</dt>
-<dd>
-<p>the user with the permission to call the Syncope APIs;</p>
-</dd>
-<dt class="hdlist1">Syncope admin password</dt>
-<dd>
-<p>the user password.</p>
-</dd>
-</dl>
-</div>
-</div>
-<div class="sect4">
-<h5 id="installation-error"><a class="anchor" href="#installation-error"></a>Installation error</h5>
-<div class="paragraph">
-<p>Various error messages are possible on installation. Here are some sample error messages:</p>
-</div>
-<div class="ulist">
-<ul>
-<li>
-<p>Syncope unreachable (or wrong address):</p>
-</li>
-</ul>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>Provided address :http://localhost:9080/syncope/rest
-
-###############################################
-#                                             #
-#       Provided address is unreachable!      #
-#         Check it and if it is wrong         #
-#        START the installation AGAIN!        #
-#                                             #
-###############################################</code></pre>
-</div>
-</div>
-<div class="ulist">
-<ul>
-<li>
-<p>Authentication failed:</p>
-</li>
-</ul>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>###############################################
-#                                             #
-#   Username or password provided are wrong   #
-#        START the installation AGAIN!        #
-#                                             #
-###############################################</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>As the message suggests you have to start the installation again when this error occurrs.</p>
-</div>
-</div>
-<div class="sect4">
-<h5 id="debug-installation"><a class="anchor" href="#debug-installation"></a>Debug installation</h5>
-<div class="paragraph">
-<p>To work with the debug environment provided by Syncope we added a particular installation option for it.
-It enough to run the script with the --setup-debug option</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh install --setup-debug</code></pre>
-</div>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">You are running: install --setup-debug
-
-###############################################
-#                                             #
-# Welcome to Syncope CLI installation process #
-#                                             #
-###############################################
-
-Path to config files of Syncope CLI client will be: ./
-- File system permission checked
-
-Installation parameters checked on Syncope core version: 2.0.0-SNAPSHOT
-
-###############################################
-#                                             #
-#           Installation successful           #
-#     now you can use Syncope CLI client      #
-#                                             #
-###############################################</code></pre>
-</div>
-</div>
-</div>
-</div>
-<div class="sect3">
-<h4 id="connector-command"><a class="anchor" href="#connector-command"></a>6.2.3. Connector command</h4>
-<div class="paragraph">
-<p>The connector command serves to retrieve information about the connector configuration in Apache Syncope.</p>
-</div>
-<div class="sect4">
-<h5 id="help-message-2"><a class="anchor" href="#help-message-2"></a>Help message</h5>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">Usage: connector [options]
-  Options:
-    --help
-    --details
-    --list
-    --list-bundles
-    --list-configuration-properties
-       Syntax: --list-configuration-properties {CONNECTOR-ID} {CONNECTOR-ID} [...]
-    --read
-       Syntax: --read {CONNECTOR-ID} {CONNECTOR-ID} [...]
-    --delete
-       Syntax: --delete {CONNECTOR-ID} {CONNECTOR-ID} [...]</code></pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="details-option"><a class="anchor" href="#details-option"></a>Details option</h5>
-<div class="paragraph">
-<p>This option shows a table with some details about connectors and bundles.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh connector --details</code></pre>
-</div>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>You are running: connector --details
-
-######################################
-#                                    #
-#         CONNECTORS DETAILS         #
-#                                    #
-######################################
-#                          #         #
-#          DETAIL          #  VALUE  #
-#                          #         #
-######################################
-#                          #         #
-#       Total number       #    9    #
-#  With create capability  #    8    #
-#  With delete capability  #    7    #
-#  With search capability  #    8    #
-#   With sync capability   #    4    #
-#  With update capability  #    8    #
-#      Bundles number      #    8    #
-#                          #         #
-######################################</code></pre>
-</div>
-</div>
-<div class="dlist">
-<dl>
-<dt class="hdlist1">Total number</dt>
-<dd>
-<p>number of created connectors;</p>
-</dd>
-<dt class="hdlist1">With create capability</dt>
-<dd>
-<p>number of connectors configured with create capability;</p>
-</dd>
-<dt class="hdlist1">With delete capability</dt>
-<dd>
-<p>number of connectors configured with delete capability;</p>
-</dd>
-<dt class="hdlist1">With search capability</dt>
-<dd>
-<p>number of connectors configured with search capability;</p>
-</dd>
-<dt class="hdlist1">With sync capability</dt>
-<dd>
-<p>number of connectors configured with sync capability;</p>
-</dd>
-<dt class="hdlist1">With update capability</dt>
-<dd>
-<p>number of connectors configured with update capability;</p>
-</dd>
-<dt class="hdlist1">Bundles number</dt>
-<dd>
-<p>number of bundles read by Syncope.</p>
-</dd>
-</dl>
-</div>
-</div>
-<div class="sect4">
-<h5 id="list-option"><a class="anchor" href="#list-option"></a>List option</h5>
-<div class="paragraph">
-<p>Running the command with this option you will see the list of connectors with their configuration.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh connector --list</code></pre>
-</div>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>You are running: connector --list
-
- &gt; CONNECTOR ID: 108
-    bundle name: net.tirasa.connid.bundles.db.scriptedsql
-    connector name: net.tirasa.connid.bundles.db.scriptedsql.ScriptedSQLConnector
-    display name: Scripted SQL
-    location: connid://testconnectorserver@localhost:4554
-    version: 2.2.3-SNAPSHOT
-    timeout: 10
-    CAPABILITIES:
-       - CREATE
-       - SEARCH
-       - DELETE
-       - UPDATE
-       - SYNC
-    CONFIGURATION:
-       name: enableEmptyString
-       values: [false]
-       type: boolean
-       display name: Enable writing empty string
-       help message: &lt;b&gt;Enable writing empty string&lt;/b&gt;&lt;br/&gt;Select to enable support for writing an empty strings, instead of a NULL value, in character based columns defined as not-null in the table schema. This option does not influence the way strings are written for Oracle based tables. By default empty strings are written as a NULL value.
-       order: 12
-       default values: [false]
-       confidential: false
-       required: false
-       overridable: false
-
-       name: autoCommit
-       values: [true]
-       type: boolean
-       display name: autoCommit
-       help message: autoCommit
-       order: 0
-       default values: [true]
-       confidential: false
-       required: false
-       overridable: false
-
-       name: testScriptFileName
-       values: [/home/massi/Lavoro/syncopeMaster/fit/core-reference/target/test-classes/scriptedsql/TestScript.groovy]
-       type: java.lang.String
-       display name: testScriptFileName
-       help message: testScriptFileName
-       order: 0
-       default values: []
-       confidential: false
-       required: false
-       overridable: true</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>The last code snippet shows a part of the screen output. Basically you can read the configuration about every connector
-configured in Syncope.</p>
-</div>
-</div>
-<div class="sect4">
-<h5 id="list-bundles-option"><a class="anchor" href="#list-bundles-option"></a>List bundles option</h5>
-<div class="paragraph">
-<p>Running the command with this option you will see the list of the bundles available in Syncope.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh connector --list-bundles</code></pre>
-</div>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>You are running: connector --list-bundles
-
- &gt; BUNDLE NAME: net.tirasa.connid.bundles.soap
-    connector name: net.tirasa.connid.bundles.soap.WebServiceConnector
-    display name: net.tirasa.connid.bundles.soap.WebServiceConnector
-    location: file:/home/massi/Lavoro/syncopeMaster/fit/core-reference/target/bundles/
-    version: 1.4.0-SNAPSHOT
- &gt; BUNDLE NAME: net.tirasa.connid.bundles.db.scriptedsql
-    connector name: net.tirasa.connid.bundles.db.scriptedsql.ScriptedSQLConnector
-    display name: Scripted SQL Connector
-    location: file:/home/massi/Lavoro/syncopeMaster/fit/core-reference/target/bundles/
-    version: 2.2.3-SNAPSHOT
- &gt; BUNDLE NAME: net.tirasa.connid.bundles.ldap
-    connector name: net.tirasa.connid.bundles.ldap.LdapConnector
-    display name: net.tirasa.connid.bundles.ldap.LdapConnector
-    location: file:/home/massi/Lavoro/syncopeMaster/fit/core-reference/target/bundles/
-    version: 1.5.0-SNAPSHOT
- &gt; BUNDLE NAME: net.tirasa.connid.bundles.ad
-    connector name: net.tirasa.connid.bundles.ad.ADConnector
-    display name: net.tirasa.connid.bundles.ad.ADConnector
-    location: file:/home/massi/Lavoro/syncopeMaster/fit/core-reference/target/bundles/
-    version: 1.3.0-SNAPSHOT
- &gt; BUNDLE NAME: net.tirasa.connid.bundles.db.table
-    connector name: net.tirasa.connid.bundles.db.table.DatabaseTableConnector
-    display name: Database Table Connector
-    location: file:/home/massi/Lavoro/syncopeMaster/fit/core-reference/target/bundles/
-    version: 2.2.3-SNAPSHOT
- &gt; BUNDLE NAME: net.tirasa.connid.bundles.csvdir
-    connector name: net.tirasa.connid.bundles.csvdir.CSVDirConnector
-    display name: net.tirasa.connid.bundles.csvdir.CSVDirConnector
-    location: file:/home/massi/Lavoro/syncopeMaster/fit/core-reference/target/bundles/
-    version: 0.8.2
- &gt; BUNDLE NAME: net.tirasa.connid.bundles.db.table
-    connector name: net.tirasa.connid.bundles.db.table.DatabaseTableConnector
-    display name: Database Table Connector
-    location: connid://testconnectorserver@localhost:4554
-    version: 2.2.3-SNAPSHOT
- &gt; BUNDLE NAME: net.tirasa.connid.bundles.db.scriptedsql
-    connector name: net.tirasa.connid.bundles.db.scriptedsql.ScriptedSQLConnector
-    display name: Scripted SQL Connector
-    location: connid://testconnectorserver@localhost:4554
-    version: 2.2.3-SNAPSHOT</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>The most useful information is:</p>
-</div>
-<div class="dlist">
-<dl>
-<dt class="hdlist1">location</dt>
-<dd>
-<p>    where the bundle is, it could be on the same server where Syncope is deployed or on a remote one linked by
-connid protocol;</p>
-</dd>
-<dt class="hdlist1">version</dt>
-<dd>
-<p>the bundle version;</p>
-</dd>
-</dl>
-</div>
-</div>
-<div class="sect4">
-<h5 id="list-configuration-properties-option"><a class="anchor" href="#list-configuration-properties-option"></a>List configuration properties option</h5>
-<div class="paragraph">
-<p>This option lists the configuration of specified connectors.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh connector --list-configuration-properties {CONNECTOR-ID} {CONNECTOR-ID} [...]</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>The output is the configuration of the connectors passed as input.</p>
-</div>
-</div>
-<div class="sect4">
-<h5 id="read-option"><a class="anchor" href="#read-option"></a>Read option</h5>
-<div class="paragraph">
-<p>The option to read all the information of specified connectors.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh connector --read {CONNECTOR-ID} {CONNECTOR-ID} [...]</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>Unlike the list option, the read one shows only the connectors passed as input.</p>
-</div>
-</div>
-<div class="sect4">
-<h5 id="delete-option"><a class="anchor" href="#delete-option"></a>Delete option</h5>
-<div class="paragraph">
-<p>The option to delete a specified connector.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh connector --delete {CONNECTOR-ID} {CONNECTOR-ID} [...]</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>The delete option, as can be imagined, tries to remove a specified connector. This operation works only if the
-connector isn&#8217;t associated with a resource.
-If the connector isn&#8217;t associated to anything the output will be</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code> - Connector {CONNECTOR-ID} successfully deleted</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>otherwise the output will be something like:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code> - Error: AssociatedResources [ws-target-resource-nopropagation, ws-target-resource-nopropagation2]</code></pre>
-</div>
-</div>
-</div>
-</div>
-<div class="sect3">
-<h4 id="question-command"><a class="anchor" href="#question-command"></a>6.2.4. Question command</h4>
-<div class="paragraph">
-<p>The question command gets information about the user question to retrieve their password.</p>
-</div>
-<div class="sect4">
-<h5 id="help-message-3"><a class="anchor" href="#help-message-3"></a>Help message</h5>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">Usage: question [options]
-  Options:
-    --help
-    --list
-    --read
-       Syntax: --read {QUESTION-ID} {QUESTION-ID} [...]
-    --delete
-       Syntax: --delete {QUESTION-ID} {QUESTION-ID} [...]</code></pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="list-option-2"><a class="anchor" href="#list-option-2"></a>List option</h5>
-<div class="paragraph">
-<p>Running the command with this option you will see the list of questions with their content.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh question --list</code></pre>
-</div>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>You are running: question --list
-
-  &gt; SECURITY QUESTION ID: 1
-    content: What's your mother's maiden name?</code></pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="read-option-2"><a class="anchor" href="#read-option-2"></a>Read option</h5>
-<div class="paragraph">
-<p>The option to read all the information of specified questions.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh question --read {QUESTION-ID} {QUESTION-ID} [...]</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>Unlike the list option, the read option shows only the questions passed as input.</p>
-</div>
-</div>
-<div class="sect4">
-<h5 id="delete-option-2"><a class="anchor" href="#delete-option-2"></a>Delete option</h5>
-<div class="paragraph">
-<p>The option to delete a specified question.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh question --delete {QUESTION-ID} {QUESTION-ID} [...]</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>The delete option, as can be imagined, tries to remove a specified question.
-The output will be something like:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code> - security question {QUESTION-ID} successfully deleted</code></pre>
-</div>
-</div>
-</div>
-</div>
-<div class="sect3">
-<h4 id="role-command"><a class="anchor" href="#role-command"></a>6.2.5. Role command</h4>
-<div class="paragraph">
-<p>The role command retrieves information about the roles.</p>
-</div>
-<div class="sect4">
-<h5 id="help-message-4"><a class="anchor" href="#help-message-4"></a>Help message</h5>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">Usage: role [options]
-  Options:
-    --help
-    --details
-    --list
-    --read
-       Syntax: --read {ROLE-NAME} {ROLE-NAME} [...]
-    --delete
-       Syntax: --delete {ROLE-NAME} {ROLE-NAME} [...]</code></pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="details-option-2"><a class="anchor" href="#details-option-2"></a>Details option</h5>
-<div class="paragraph">
-<p>This option shows a table with some details about the roles.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh role --details</code></pre>
-</div>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>You are running: role --details
-
-####################################
-#                                  #
-#          ROLES DETAILS           #
-#                                  #
-####################################
-#                        #         #
-#         DETAIL         #  VALUE  #
-#                        #         #
-####################################
-#                        #         #
-#      Total number      #    4    #
-#  Without entitlements  #    0    #
-#                        #         #
-####################################</code></pre>
-</div>
-</div>
-<div class="dlist">
-<dl>
-<dt class="hdlist1">Total number</dt>
-<dd>
-<p>number of created roles;</p>
-</dd>
-<dt class="hdlist1">Without entitlements</dt>
-<dd>
-<p>number of roles without linked entitlements.</p>
-</dd>
-</dl>
-</div>
-</div>
-<div class="sect4">
-<h5 id="list-option-3"><a class="anchor" href="#list-option-3"></a>List option</h5>
-<div class="paragraph">
-<p>Running the command with this option you will see the list of roles with the realm where they are configured and their entitlments.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh role --list</code></pre>
-</div>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>You are running: role --list
-
- &gt; ROLE ID: User reviewer
-    REALMS:
-       - /odd
-       - /even
-    ENTITLEMENTS:
-       - USER_READ
-       - USER_LIST
-       - USER_SEARCH
-    dynamic membership condition: null
-
- &gt; ROLE ID: User manager
-    REALMS:
-       - /
-    ENTITLEMENTS:
-       - WORKFLOW_FORM_SUBMIT
-       - USER_READ
-       - USER_LIST
-       - USER_SEARCH
-       - WORKFLOW_FORM_CLAIM
-    dynamic membership condition: null
-
- &gt; ROLE ID: Other
-    REALMS:
-       - /odd
-    ENTITLEMENTS:
-       - SCHEMA_READ
-       - GROUP_READ
-       - WORKFLOW_FORM_CLAIM
-    dynamic membership condition: null
-
- &gt; ROLE ID: Search for realm evenTwo
-    REALMS:
-       - /even/two
-    ENTITLEMENTS:
-       - USER_READ
-       - USER_SEARCH
-    dynamic membership condition: null</code></pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="read-option-3"><a class="anchor" href="#read-option-3"></a>Read option</h5>
-<div class="paragraph">
-<p>The option to read all the information of specified roles.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh role --read {ROLE-NAME} {ROLE-NAME} [...]</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>Unlike the list option, the read option shows only the roles passed as input.</p>
-</div>
-</div>
-<div class="sect4">
-<h5 id="delete-option-3"><a class="anchor" href="#delete-option-3"></a>Delete option</h5>
-<div class="paragraph">
-<p>The option to delete specified roles.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh role --delete {ROLE-NAME} {ROLE-NAME} [...]</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>The delete option, as can be imagined, tries to remove specified roles.
-The output will be something like:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code> - role {ROLE-NAME} successfully deleted</code></pre>
-</div>
-</div>
-</div>
-</div>
-<div class="sect3">
-<h4 id="configuration-command"><a class="anchor" href="#configuration-command"></a>6.2.6. Configuration command</h4>
-<div class="paragraph">
-<p>The configuration command retrieves information about the Syncope configuration.</p>
-</div>
-<div class="sect4">
-<h5 id="help-message-5"><a class="anchor" href="#help-message-5"></a>Help message</h5>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">Usage: configuration [options]
-  Options:
-    --help
-    --get
-    --read
-       Syntax: --read {CONF-NAME} {CONF-NAME} [...]
-    --update
-       Syntax: --update {CONF-NAME}={CONF-VALUE} {CONF-NAME}={CONF-VALUE} [...]
-    --delete
-       Syntax: --delete {CONF-NAME} {CONF-NAME} [...]
-    --export
-       Syntax: --export {WHERE-DIR}</code></pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="get-option"><a class="anchor" href="#get-option"></a>Get option</h5>
-<div class="paragraph">
-<p>This get option shows a table with the Syncope configuration.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh configuration --get</code></pre>
-</div>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>You are running: configuration --get
-
-########################################################
-#                                                      #
-#                SYNCOPE CONFIGURATION                 #
-#                                                      #
-########################################################
-#                                  #                   #
-#            ATTRIBUTE             #       VALUE       #
-#                                  #                   #
-########################################################
-#                                  #                   #
-#    password.cipher.algorithm     #       SHA1        #
-#  notificationjob.cronExpression  #  0/20 * * * * ?   #
-#     notification.maxRetries      #         3         #
-#           token.length           #        256        #
-#         token.expireTime         #        60         #
-#     selfRegistration.allowed     #       true        #
-#      passwordReset.allowed       #       true        #
-#  passwordReset.securityQuestion  #       true        #
-#     authentication.statuses      #  created, active  #
-#        log.lastlogindate         #       true        #
-#    tasks.interruptMaxRetries     #        20         #
-#      return.password.value       #       false       #
-#                                  #                   #
-########################################################</code></pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="read-option-4"><a class="anchor" href="#read-option-4"></a>Read option</h5>
-<div class="paragraph">
-<p>The option to read the value of specified configuration attributes.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh configuration --read {CONF-NAME} {CONF-NAME} [...]</code></pre>
-</div>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>You are running: configuration --read passwordReset.allowed
-
-#####################################
-#                                   #
-#       SYNCOPE CONFIGURATION       #
-#                                   #
-#####################################
-#                         #         #
-#        ATTRIBUTE        #  VALUE  #
-#                         #         #
-#####################################
-#                         #         #
-#  passwordReset.allowed  #  true   #
-#                         #         #
-#####################################</code></pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="update-option"><a class="anchor" href="#update-option"></a>Update option</h5>
-<div class="paragraph">
-<p>The option to update a value of specified configuration attributes.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh configuration --update {CONF-NAME}={CONF-VALUE} {CONF-NAME}={CONF-VALUE} [...]</code></pre>
-</div>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>You are running: configuration --update passwordReset.allowed=false
-
-#####################################
-#                                   #
-#  UPDATED CONFIGURATION ATTRIBUTES #
-#                                   #
-#####################################
-#                         #         #
-#        ATTRIBUTE        #  VALUE  #
-#                         #         #
-#####################################
-#                         #         #
-#  passwordReset.allowed  #  false  #
-#                         #         #
-#####################################</code></pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="delete-option-4"><a class="anchor" href="#delete-option-4"></a>Delete option</h5>
-<div class="paragraph">
-<p>The option to delete specified configuration attributes.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh configuration --delete {CONF-NAME} {CONF-NAME} [...]</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>The delete option, as can be imagined, tries to remove the specified configurations. The output will be something like:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code> - Configuration {CONF-NAME} successfully deleted</code></pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="export-option"><a class="anchor" href="#export-option"></a>Export option</h5>
-<div class="paragraph">
-<p>The option to export the Syncope configuration to a specified directory.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh  - Usage: configuration --export {WHERE-DIR}</code></pre>
-</div>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;?xml version="1.0" encoding="UTF-8" standalone="no"?&gt;&lt;dataset&gt;
-&lt;RELATIONSHIPTYPE DESCRIPTION="Models the act that an object is included in another" NAME="inclusion"/&gt;
-&lt;RELATIONSHIPTYPE NAME="neighborhood"/&gt;
-&lt;PASSWORDPOLICY ALLOWNULLPASSWORD="1" DESCRIPTION="a password policy" HISTORYLENGTH="1" ID="2" TYPE="PASSWORD"/&gt;
-&lt;PASSWORDPOLICY ALLOWNULLPASSWORD="1" DESCRIPTION="sample password policy" HISTORYLENGTH="0" ID="4" TYPE="PASSWORD"/&gt;
-&lt;PASSWORDPOLICY ALLOWNULLPASSWORD="0" DESCRIPTION="sample password policy" HISTORYLENGTH="0" ID="8" TYPE="PASSWORD"/&gt;
-
-[...]</code></pre>
-</div>
-</div>
-</div>
-</div>
-<div class="sect3">
-<h4 id="logger-command"><a class="anchor" href="#logger-command"></a>6.2.7. Logger command</h4>
-<div class="paragraph">
-<p>The logger command retrieves information about the logger configuration in Apache Syncope.</p>
-</div>
-<div class="sect4">
-<h5 id="help-message-6"><a class="anchor" href="#help-message-6"></a>Help message</h5>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">Usage: logger [options]
-  Options:
-    --help
-    --details
-    --list
-    --read
-       Syntax: --read {LOG-NAME} {LOG-NAME} [...]
-    --update
-       Syntax: --update {LOG-NAME}={LOG-LEVEL} {LOG-NAME}={LOG-LEVEL} [...]
-    --update-all
-       Syntax: --update-all {LOG-LEVEL}
-    --create
-       Syntax: --create {LOG-NAME}={LOG-LEVEL} {LOG-NAME}={LOG-LEVEL} [...]
-    --delete
-       Syntax: --delete {LOG-NAME} {LOG-NAME} [...]</code></pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="details-option-3"><a class="anchor" href="#details-option-3"></a>Details option</h5>
-<div class="paragraph">
-<p>This option shows a table with some details about logger configuration.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh logger --details</code></pre>
-</div>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>You are running: logger --details
-
-############################
-#                          #
-#     LOGGERS DETAILS      #
-#                          #
-############################
-#                #         #
-#     DETAIL     #  VALUE  #
-#                #         #
-############################
-#                #         #
-#  Total number  #   16    #
-#  Set to DEBUG  #    2    #
-#  Set to ERROR  #    3    #
-#  Set to FATAL  #    0    #
-#  Set to INFO   #   11    #
-#   Set to OFF   #    0    #
-#  Set to TRACE  #    0    #
-#  Set to WARN   #    0    #
-#                #         #
-############################</code></pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="list-option-4"><a class="anchor" href="#list-option-4"></a>List option</h5>
-<div class="paragraph">
-<p>Running the command with this option you will see the table of the loggers configuration.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh logger --list</code></pre>
-</div>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>You are running: logger --list
-
-############################################################################
-#                                                                          #
-#                               LIST LOGGERS                               #
-#                                                                          #
-############################################################################
-#                                                                #         #
-#                             LOGGER                             #  LEVEL  #
-#                                                                #         #
-############################################################################
-#                                                                #         #
-#                    org.springframework.web                     #  INFO   #
-#                 org.apache.syncope.core.logic                  #  INFO   #
-#                       net.tirasa.connid                        #  DEBUG  #
-#                           org.quartz                           #  INFO   #
-#              org.apache.syncope.core.persistence               #  INFO   #
-#                          org.activiti                          #  ERROR  #
-#                        org.apache.http                         #  INFO   #
-#                    org.springframework.orm                     #  INFO   #
-#                        org.apache.camel                        #  ERROR  #
-#                         org.apache.cxf                         #  ERROR  #
-#                       org.apache.syncope                       #  INFO   #
-#                     org.identityconnectors                     #  DEBUG  #
-#                      org.springframework                       #  INFO   #
-#              org.apache.syncope.core.provisioning              #  INFO   #
-#                  org.apache.syncope.core.rest                  #  INFO   #
-#  org.apache.syncope.core.provisioning.api.ConnIdBundleManager  #  INFO   #
-#                                                                #         #
-############################################################################</code></pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="read-option-5"><a class="anchor" href="#read-option-5"></a>Read option</h5>
-<div class="paragraph">
-<p>The option to read all the information of specified loggers.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh logger --read {LOG-NAME} {LOG-NAME} [...]</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>Unlike the list option, the read option shows a table with only the loggers passed as input.</p>
-</div>
-</div>
-<div class="sect4">
-<h5 id="update-option-2"><a class="anchor" href="#update-option-2"></a>Update option</h5>
-<div class="paragraph">
-<p>The option to change the value of the logger passed as input.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh logger --update {LOG-NAME}={LOG-LEVEL} {LOG-NAME}={LOG-LEVEL} [...]</code></pre>
-</div>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>You are running: logger --update org.apache.camel=DEBUG
-
-####################################
-#                                  #
-#         UPDATED LOGGERS          #
-#                                  #
-####################################
-#                    #             #
-#       LOGGER       #  NEW LEVEL  #
-#                    #             #
-####################################
-#                    #             #
-#  org.apache.camel  #    DEBUG    #
-#                    #             #
-####################################</code></pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="update-all-option"><a class="anchor" href="#update-all-option"></a>Update all option</h5>
-<div class="paragraph">
-<p>This option is especially helpful in production environment when every log is disabled and you need to change them for a
-while in DEBUG mode.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>$ ./syncopeadm.sh logger --update-all DEBUG</code></pre>
-</div>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code>You are running: logger --update-all DEBUG
-
-################################################################################
-#                                                                              #
-#                               UPDATED LOGGERS                                #
-#                                                                              #
-################################################################################
-#                                                                #             #
-#                             LOGGER                             #  NEW LEVEL  #
-#                                                                #             #
-################################################################################
-#                                                                #             #
-#                    org.springframework.web                     #    DEBUG    #
-#                 org.apache.syncope.core.logic                  #    DEBUG    #
-#                       net.tirasa.connid                        #    DEBUG    #
-#                           org.quartz                           #    DEBUG    #
-#              org.apache.syncope.core.persistence               #    DEBUG    #
-#                          org.activiti                          #    DEBUG    #
-#                        org.apache.http                         #    DEBUG    #
-#                    org.springframework.orm                     #    DEBUG    #
-#                         org.apache.cxf                         #    DEBUG    #
-#                       org.apache.syncope                       #    DEBUG    #
-#                     org.identityconnectors                     #    DEBUG    #
-#                      org.springframework                       #    DEBUG    #
-#              org.apache.syncope.core.provisioning              #    DEBUG    #
-#                  org.apache.syncope.core.rest                  #    DEBUG    #
-#  org.apache.syncope.core.provisioning.api.ConnIdBundleManager  #    DEBUG    #
-#                                                                #             #

[... 3038 lines stripped ...]