syncope-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ma...@apache.org
Subject [3/3] syncope git commit: reorganized doc files, SYNCOPE-722
Date Wed, 02 Dec 2015 09:19:45 GMT
reorganized doc files, SYNCOPE-722


Project: http://git-wip-us.apache.org/repos/asf/syncope/repo
Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/715e1d39
Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/715e1d39
Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/715e1d39

Branch: refs/heads/master
Commit: 715e1d39938614f84cd516e417eceaf777ca924d
Parents: e044394
Author: massi <massimiliano.perrone@tirasa.net>
Authored: Wed Dec 2 10:19:18 2015 +0100
Committer: massi <massimiliano.perrone@tirasa.net>
Committed: Wed Dec 2 10:19:18 2015 +0100

----------------------------------------------------------------------
 src/main/asciidoc/cli-configuration.adoc     | 172 -------
 src/main/asciidoc/cli-connector.adoc         | 259 -----------
 src/main/asciidoc/cli-domain.adoc            |  95 ----
 src/main/asciidoc/cli-entitlement.adoc       | 140 ------
 src/main/asciidoc/cli-group.adoc             | 206 ---------
 src/main/asciidoc/cli-info.adoc              |  52 ---
 src/main/asciidoc/cli-installation.adoc      | 181 --------
 src/main/asciidoc/cli-introduction.adoc      |  34 --
 src/main/asciidoc/cli-logger.adoc            | 250 ----------
 src/main/asciidoc/cli-notification.adoc      | 116 -----
 src/main/asciidoc/cli-policy.adoc            | 166 -------
 src/main/asciidoc/cli-question.adoc          |  77 ----
 src/main/asciidoc/cli-realm.adoc             | 111 -----
 src/main/asciidoc/cli-report.adoc            | 251 ----------
 src/main/asciidoc/cli-resource.adoc          | 208 ---------
 src/main/asciidoc/cli-role.adoc              | 149 ------
 src/main/asciidoc/cli-schema.adoc            | 303 ------------
 src/main/asciidoc/cli-task.adoc              | 315 -------------
 src/main/asciidoc/cli-user.adoc              | 535 ----------------------
 src/main/asciidoc/cli.adoc                   |  57 ---
 src/main/asciidoc/cli/cli-configuration.adoc | 172 +++++++
 src/main/asciidoc/cli/cli-connector.adoc     | 259 +++++++++++
 src/main/asciidoc/cli/cli-domain.adoc        |  95 ++++
 src/main/asciidoc/cli/cli-entitlement.adoc   | 140 ++++++
 src/main/asciidoc/cli/cli-group.adoc         | 206 +++++++++
 src/main/asciidoc/cli/cli-info.adoc          |  52 +++
 src/main/asciidoc/cli/cli-installation.adoc  | 181 ++++++++
 src/main/asciidoc/cli/cli-introduction.adoc  |  34 ++
 src/main/asciidoc/cli/cli-logger.adoc        | 250 ++++++++++
 src/main/asciidoc/cli/cli-notification.adoc  | 116 +++++
 src/main/asciidoc/cli/cli-policy.adoc        | 166 +++++++
 src/main/asciidoc/cli/cli-question.adoc      |  77 ++++
 src/main/asciidoc/cli/cli-realm.adoc         | 111 +++++
 src/main/asciidoc/cli/cli-report.adoc        | 251 ++++++++++
 src/main/asciidoc/cli/cli-resource.adoc      | 208 +++++++++
 src/main/asciidoc/cli/cli-role.adoc          | 149 ++++++
 src/main/asciidoc/cli/cli-schema.adoc        | 303 ++++++++++++
 src/main/asciidoc/cli/cli-task.adoc          | 315 +++++++++++++
 src/main/asciidoc/cli/cli-user.adoc          | 535 ++++++++++++++++++++++
 src/main/asciidoc/cli/cli.adoc               |  57 +++
 src/main/asciidoc/reference-guide.adoc       |   2 +-
 41 files changed, 3678 insertions(+), 3678 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/syncope/blob/715e1d39/src/main/asciidoc/cli-configuration.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-configuration.adoc b/src/main/asciidoc/cli-configuration.adoc
deleted file mode 100644
index 9bb0884..0000000
--- a/src/main/asciidoc/cli-configuration.adoc
+++ /dev/null
@@ -1,172 +0,0 @@
-//
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements.  See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership.  The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License.  You may obtain a copy of the License at
-//
-//   http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied.  See the License for the
-// specific language governing permissions and limitations
-// under the License.
-//
-
-==== Configuration command
-The configuration command serves to retrieve the information about the Syncope configuration.
-
-===== Help message
-[source,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}
-
-----
-
-===== Get option
-This get option shows a table with the Syncope configuration.
-
-[source]
---
-$ ./syncopeadm.sh configuration --get
---
-
-[source]
---
-
-You are runnig: 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       #
-#                                  #                   #
-########################################################
-
---
-
-===== Read option
-The option to read the value of a specified configuration attributes.
-
-[source]
---
-$ ./syncopeadm.sh configuration --read {CONF-NAME} {CONF-NAME} [...]
---
-
-[source]
---
-
-You are runnig: configuration --read passwordReset.allowed 
-
-#####################################
-#                                   #
-#       SYNCOPE CONFIGURATION       #
-#                                   #
-#####################################
-#                         #         #
-#        ATTRIBUTE        #  VALUE  #
-#                         #         #
-#####################################
-#                         #         #
-#  passwordReset.allowed  #  true   #
-#                         #         #
-#####################################
-
---
-
-===== Update option
-The option to update a value of a specified configuration attributes.
-
-[source]
---
-$ ./syncopeadm.sh configuration --update {CONF-NAME}={CONF-VALUE} {CONF-NAME}={CONF-VALUE} [...]
---
-
-[source]
---
-
-You are runnig: configuration --update passwordReset.allowed=false 
-
-#####################################
-#                                   #
-#  UPDATED CONFIGURATION ATTRIBUTES #
-#                                   #
-#####################################
-#                         #         #
-#        ATTRIBUTE        #  VALUE  #
-#                         #         #
-#####################################
-#                         #         #
-#  passwordReset.allowed  #  false  #
-#                         #         #
-#####################################
-
---
-
-===== Delete option
-The option to delete a specified configuration attributes.
-
-[source]
---
-$ ./syncopeadm.sh configuration --delete {CONF-NAME} {CONF-NAME} [...]
---
-
-The delete option, as can be imagined, tries to remove a specified roles. 
-The output will be something like:
-[source]
---
- - Configuration {CONF-NAME} successfully deleted
---
-
-===== Export option
-The option to export the Syncope configuration under specified directory.
-
-[source]
---
-$ ./syncopeadm.sh  - Usage: configuration --export {WHERE-DIR}
---
-
-[source,xml]
-----
-<?xml version="1.0" encoding="UTF-8" standalone="no"?><dataset>
-<RELATIONSHIPTYPE DESCRIPTION="Models the act that an object is included in another" NAME="inclusion"/>
-<RELATIONSHIPTYPE NAME="neighborhood"/>
-<PASSWORDPOLICY ALLOWNULLPASSWORD="1" DESCRIPTION="a password policy" HISTORYLENGTH="1" ID="2" TYPE="PASSWORD"/>
-<PASSWORDPOLICY ALLOWNULLPASSWORD="1" DESCRIPTION="sample password policy" HISTORYLENGTH="0" ID="4" TYPE="PASSWORD"/>
-<PASSWORDPOLICY ALLOWNULLPASSWORD="0" DESCRIPTION="sample password policy" HISTORYLENGTH="0" ID="8" TYPE="PASSWORD"/>
-
-[...]
-----
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/syncope/blob/715e1d39/src/main/asciidoc/cli-connector.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-connector.adoc b/src/main/asciidoc/cli-connector.adoc
deleted file mode 100644
index bf508a5..0000000
--- a/src/main/asciidoc/cli-connector.adoc
+++ /dev/null
@@ -1,259 +0,0 @@
-//
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements.  See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership.  The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License.  You may obtain a copy of the License at
-//
-//   http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied.  See the License for the
-// specific language governing permissions and limitations
-// under the License.
-//
-
-==== Connector command
-The connector command serves to retrieve the information around the connector configuration in Apache Syncope.
-
-===== Help message
-[source,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} [...]
-----
-
-===== Details option
-This option shows a table with some details about connectors and bundles.
-
-[source]
---
-$ ./syncopeadm.sh connector --details
---
-
-[source]
---
-
-You are runnig: 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    #
-#                          #         #
-######################################
-
---
-
-Total number::
-    number of created connectors;
-With create capability::
-    number of connectors configured with create capability;
-With delete capability::
-    number of connectors configured with delete capability;
-With search capability::
-    number of connectors configured with search capability;
-With sync capability::
-    number of connectors configured with sync capability;
-With update capability::
-    number of connectors configured with update capability;
-Bundles number::
-    number of bundles read by Syncope.
-
-===== List option
-Running the command with this option you will see the list of connectors with their configuration.
-
-[source]
---
-$ ./syncopeadm.sh connector --list
---
-
-[source]
---
-
-You are runnig: connector --list 
-
- > 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: <b>Enable writing empty string</b><br/>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
-
---
-
-The last snippet code shows a part of the screen output. Basically you can read the configuration about every connectors
-configured in Syncope.
-
-===== List bundles option
-Running the command with this option you will see the list of the bundles available in Syncope.
-
-[source]
---
-$ ./syncopeadm.sh connector --list-bundles
---
-
-[source]
---
-
-You are runnig: connector --list-bundles 
-
- > 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
- > 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
- > 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
- > 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
- > 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
- > 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
- > 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
- > 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
-
---
-
-The most useful information are:
-
-location::
-    where the bundle is, it could be on the same server where Syncope is deployed or on a remote one linked by 
-connid protocol;
-version:
-    the bundle version;
-
-===== List configuration properties option
-The option to read only the configuration of specified connectors.
-
-[source]
---
-$ ./syncopeadm.sh connector --list-configuration-properties {CONNECTOR-ID} {CONNECTOR-ID} [...]
---
-
-The output is only the configuration of the connectors passed as input.
-
-===== Read option
-The option to read all the information of specified connectors.
-
-[source]
---
-$ ./syncopeadm.sh connector --read {CONNECTOR-ID} {CONNECTOR-ID} [...]
---
-
-Unlike the list option, the read one shows only the connectors passed as input.
-
-===== Delete option
-The option to delete a specified connectors.
-
-[source]
---
-$ ./syncopeadm.sh connector --delete {CONNECTOR-ID} {CONNECTOR-ID} [...]
---
-
-The delete option, as can be imagined, tries to remove a specified connectors. This operation works only if the 
-connector isn't associated to a resource.
-If the connector isn't associated to anything the output will be
-[source]
---
- - Connector {CONNECTOR-ID} successfully deleted
---
-
-otherwise the output will be something like:
-[source]
---
- - Error: AssociatedResources [ws-target-resource-nopropagation, ws-target-resource-nopropagation2]
---
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/syncope/blob/715e1d39/src/main/asciidoc/cli-domain.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-domain.adoc b/src/main/asciidoc/cli-domain.adoc
deleted file mode 100644
index 3ff78d9..0000000
--- a/src/main/asciidoc/cli-domain.adoc
+++ /dev/null
@@ -1,95 +0,0 @@
-//
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements.  See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership.  The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License.  You may obtain a copy of the License at
-//
-//   http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied.  See the License for the
-// specific language governing permissions and limitations
-// under the License.
-//
-
-==== Domain command
-The domain command serves to retrieve the information about the configured domains.
-
-===== Help message
-[source,bash]
-----
-Usage: domain [options]
-  Options:
-    --help 
-    --details 
-    --list 
-    --delete 
-       Syntax: --delete {DOMAIN-NAME} {DOMAIN-NAME} [...]
-----
-
-===== Details option
-This option shows a table with domain amount.
-
-[source]
---
-$ ./syncopeadm.sh domain --details
---
-
-[source]
---
-
-You are runnig: domain --details 
-
-############################
-#                          #
-#     DOMAINS DETAILS      #
-#                          #
-############################
-#                #         #
-#     DETAIL     #  VALUE  #
-#                #         #
-############################
-#                #         #
-#  Total number  #    1    #
-#                #         #
-############################
-
---
-
-===== List option
-Running the command with this option you will see the list of the domains.
-
-[source]
---
-$ ./syncopeadm.sh domain --list 
---
-
-[source]
---
-
-You are runnig: domain --list 
-
- > DOIMAIN NAME: Two
-    chiper algorithm: SHA
-
---
-
-===== Delete option
-The option to delete a specified domain.
-
-[source]
---
-$ ./syncopeadm.sh domain --delete {DOMAIN-NAME} {DOMAIN-NAME} [...]
---
-
-The delete option, as can be imagined, tries to remove a specified domain. 
-The output will be something like:
-[source]
---
- - Domain {DOMAIN-NAME} successfully deleted
---
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/syncope/blob/715e1d39/src/main/asciidoc/cli-entitlement.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-entitlement.adoc b/src/main/asciidoc/cli-entitlement.adoc
deleted file mode 100644
index c7bc30f..0000000
--- a/src/main/asciidoc/cli-entitlement.adoc
+++ /dev/null
@@ -1,140 +0,0 @@
-//
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements.  See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership.  The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License.  You may obtain a copy of the License at
-//
-//   http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied.  See the License for the
-// specific language governing permissions and limitations
-// under the License.
-//
-
-==== Entitlement command
-The entitlement command serves to retrieve the information about the entitlments.
-
-===== Help message
-[source,bash]
-----
-Usage: entitlement [options]
-  Options:
-    --help 
-    --list
-    --list-role
-       Syntax: --list-role {ENTITLEMENT-NAME}
-    --read-by-username
-       Syntax: --read-by-username {USERNAME}
-    --read-by-userid
-       Syntax: --read-by-userid {USER-ID}
-    --search-by-role
-       Syntax: --search-by-role {ROLE-ID}
-----
-
-===== List option
-Running the command with this option you will see the list of the entitlements.
-
-[source]
---
-$ ./syncopeadm.sh entitlement --list
---
-
-[source]
---
-
-You are runnig: entitlement --list 
-
-- CONNECTOR_READ
-- NOTIFICATION_DELETE
-- ANYTYPE_UPDATE
-- RELATIONSHIPTYPE_UPDATE
-- SCHEMA_CREATE
-[...]
-
---
-
-===== List role option
-Running the command with this option you will see the list of the roles with a certain entitlement.
-
-[source]
---
-$ ./syncopeadm.sh entitlement --list
---
-
-[source]
---
-
-You are runnig: entitlement --list-role PRINTER_DELETE 
-
- > ROLE ID: Search for realm evenTwo
-    REALMS: 
-       - /even/two
-
- > ROLE ID: User manager
-    REALMS: 
-       - /
-
- > ROLE ID: User reviewer
-    REALMS: 
-       - /odd
-       - /even
-
- > ROLE ID: Other
-    REALMS: 
-       - /odd
-
---
-
-===== Read by username option
-The option to read the entitlements of the username passed as input.
-
-[source]
---
-$ ./syncopeadm.sh entitlement --read-by-username {USERNAME}
---
-[source]
---
-You are runnig: entitlement --read-by-username rossini 
-
-- GROUP_READ
-- SCHEMA_READ
-- WORKFLOW_FORM_CLAIM
---
-
-===== Read by userid option
-The option to read the entitlements of the userid passed as input.
-
-[source]
---
-$ ./syncopeadm.sh entitlement --read-by-userid {USER-ID}
---
-[source]
---
-You are runnig: entitlement --read-by-userid 5 
-
-- USER_READ
-- USER_SEARCH
---
-
-===== Search by role option
-The option to read the entitlements of a certain role.
-
-[source]
---
-$ ./syncopeadm.sh entitlement --search-by-role {ROLE-ID}
---
-
-[source]
---
-You are runnig: entitlement --search-by-role Other 
-
-- SCHEMA_READ
-- GROUP_READ
-- WORKFLOW_FORM_CLAIM
---
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/syncope/blob/715e1d39/src/main/asciidoc/cli-group.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-group.adoc b/src/main/asciidoc/cli-group.adoc
deleted file mode 100644
index c9a41a2..0000000
--- a/src/main/asciidoc/cli-group.adoc
+++ /dev/null
@@ -1,206 +0,0 @@
-//
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements.  See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership.  The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License.  You may obtain a copy of the License at
-//
-//   http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied.  See the License for the
-// specific language governing permissions and limitations
-// under the License.
-//
-
-==== Group command
-The group command serves to retrieve the information about the configured groups.
-
-===== Help message
-[source,bash]
-----
-Usage: group [options]
-  Options:
-    --help 
-    --details 
-    --list 
-    --read 
-       Syntax: --read {GROUP-ID} {GROUP-ID} [...]
-    --read-attr-by-schema-type {GROUP-ID} {SCHEMA-TYPE}
-       Schema type: PLAIN / DERIVED / VIRTUAL
-    --read-attr-by-schema {GROUP-ID} {SCHEMA-TYPE} {SCHEMA-NAME}
-       Schema type: PLAIN / DERIVED / VIRTUAL
-    --delete 
-       Syntax: --delete {GROUP-ID} {GROUP-ID} [...]
-----
-
-===== Details option
-This option shows a table with group amount and some information.
-
-[source]
---
-$ ./syncopeadm.sh group --details
---
-
-[source]
---
-
-You are runnig: group --details 
-
-##################################
-#                                #
-#         GROUPS DETAILS         #
-#                                #
-##################################
-#                      #         #
-#        DETAIL        #  VALUE  #
-#                      #         #
-##################################
-#                      #         #
-#     Total number     #   16    #
-#  Without resources   #   10    #
-#  Without attributes  #    0    #
-#    On root realm     #   14    #
-#  On the other realm  #    2    #
-#                      #         #
-##################################
-
---
-
-===== List option
-Running the command with this option you will see the list of the groups.
-
-[source]
---
-$ ./syncopeadm.sh group --list 
---
-
-[source]
---
-
-You are runnig: group --list 
-
- > GROUP ID: 1
-    name: root
-    type: GROUP
-    realm: /
-    status: null
-    user owner: null
-    group owner: null
-    RESOURCES: 
-    PLAIN ATTRIBUTES: 
-     - icon: [niceIcon]
-
-     - show: [true]
-
-     - rderived_sx: [sx]
-
-     - rderived_dx: [dx]
-
-    DERIVED ATTRIBUTES: 
-     - displayProperty: [niceIcon: true] - is readonly
-
-     - rderiveddata: [sx-dx] - is readonly
-
-     - rderivedschema: [sx-dx] - is readonly
-
-     - rderToBePropagated: [sx-dx] - is readonly
-
-    VIRTUAL ATTRIBUTES: 
-    [...]
-
---
-
-===== Read option
-The option to read the group passed as input.
-
-[source]
---
-$ ./syncopeadm.sh group --read {GROUP-ID} {GROUP-ID} [...] 
---
-
-[source]
---
-
-You are runnig: group --read 15 
-
- > GROUP ID: 15
-    name: additional
-    type: GROUP
-    realm: /even
-    status: null
-    user owner: null
-    group owner: null
-    RESOURCES: 
-    PLAIN ATTRIBUTES: 
-    DERIVED ATTRIBUTES: 
-     - displayProperty: [: ] - is readonly
-
-     - rderToBePropagated: [-] - is readonly
-
-     - rderiveddata: [-] - is readonly
-
-     - rderivedschema: [-] - is readonly
-
-    VIRTUAL ATTRIBUTES: 
-
---
-
-===== Read attribute of type option
-The option to read the specified attribute type of the group passed as input.
-
-[source]
---
-$ ./syncopeadm.sh  group --read-attr-by-schema-type {GROUP-ID} {SCHEMA-TYPE}
-   Schema type: PLAIN / DERIVED / VIRTUAL
---
-
-[source]
---
-
-You are runnig: group --read-attr-by-schema-type 15 DERIVED 
-     - displayProperty: [: ] - is readonly
-
-     - rderToBePropagated: [-] - is readonly
-
-     - rderiveddata: [-] - is readonly
-
-     - rderivedschema: [-] - is readonly
-
---
-
-===== Read an attribute of type option
-The option to read the specified attribute name of the group passed as input.
-
-[source]
---
-$ ./syncopeadm.sh  group --read-attr-by-schema {GROUP-ID} {SCHEMA-TYPE} {SCHEMA-NAME}
-   Schema type: PLAIN / DERIVED / VIRTUAL
---
-
-[source]
---
-
-You are runnig: group --read-attr-by-schema 12 PLAIN title 
-     - title: [r12]
-
---
-
-===== Delete option
-The option to delete a specified group.
-
-[source]
---
-$ ./syncopeadm.sh group --delete {GROUP-ID} {GROUP-ID} [...]
---
-
-The delete option, as can be imagined, tries to remove a specified group. 
-The output will be something like:
-[source]
---
- - Group {GROUP-ID} successfully deleted
---
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/syncope/blob/715e1d39/src/main/asciidoc/cli-info.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-info.adoc b/src/main/asciidoc/cli-info.adoc
deleted file mode 100644
index 2186862..0000000
--- a/src/main/asciidoc/cli-info.adoc
+++ /dev/null
@@ -1,52 +0,0 @@
-//
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements.  See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership.  The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License.  You may obtain a copy of the License at
-//
-//   http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied.  See the License for the
-// specific language governing permissions and limitations
-// under the License.
-//
-
-==== Info command
-The info command serves to show some information about the Syncope installation.
-
-===== Help message
-[source,bash]
-----
-Usage: info [options]
-  Options:
-    --version
-    --pwd-reset-allowed
-    --pwd-reset-with-question
-    --self-reg-allowed
-    --provisioning-manager-classes
-    --workflow-adapter-classes
-    --account-rules-classes
-    --connid-locations
-    --reconciliation-filter-builders
-    --logic-actions
-    --mail-templates
-    --mapping-item-transformers
-    --password-rules
-    --propagation-actions
-    --push-actions
-    --push-correlation-actions
-    --reportlets
-    --sync-actions
-    --sync-correlation-rules
-    --task-jobs
-    --validators
-    --password-generator
-    --vir-attr-cache
-    --help
-----
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/syncope/blob/715e1d39/src/main/asciidoc/cli-installation.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-installation.adoc b/src/main/asciidoc/cli-installation.adoc
deleted file mode 100644
index 1f93808..0000000
--- a/src/main/asciidoc/cli-installation.adoc
+++ /dev/null
@@ -1,181 +0,0 @@
-//
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements.  See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership.  The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License.  You may obtain a copy of the License at
-//
-//   http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied.  See the License for the
-// specific language governing permissions and limitations
-// under the License.
-//
-
-==== Installation command
-The installation process serves to create a file, called _cli.properties_, uses by the script to call the Apache Syncope
-REST API services with the right credentials.
-
-The obtained file will be something like
- 
-* *syncope.rest.services*=http://localhost:9080/syncope/rest
-* *syncope.admin.user*=admin
-* *syncope.admin.password*=QePSFVTnzwQowM4ohhaUYcE6aW47MVZ/
-
-where the properties are:
-
-syncope.rest.services::
-    is the URL where the Apache Syncope REST API services listening;
-syncope.admin.user::
-    is the user with the right permissions to call the Syncope APIs;
-syncope.admin.password::
-    is the user password;
-
-as you can read, the user password is encrypted. This only to add a security level to avoid that another user could 
-read an admin password.
-
-===== Help message
-[source,bash]
-----
-Usage: install [options]
-  Options:
-    --help 
-    --setup
-    --setup-debug
-----
-
-===== Run the installation
-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 installation process the script returns
-[source]
---
- - Error: It seems you need to setup the CLI client before. Run install --setup.
---
-
-So, as suggested, you have to run the install command to use the CLI:
-[source]
---
-$ ./syncopeadm.sh install --setup
---
-
-A successful result will be:
-[source,bash]
-----
-
-You are runnig: 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      #
-#                                             #
-###############################################
-
-----
-
-During the installation you have to provide:
-
-Syncope server schema::
-    the http protocol used by the Apache Syncope core, it will be http or https;
-Syncope server hostname::
-    the hostname where the core is deployed;
-Syncope server port::
-    the port where the services are listening;
-Syncope server rest context::
-    the context wherewith the rest services are deployed (/syncope/rest is the default one);
-Syncope admin user::
-    the user with the right permissions to call the Syncope APIs;
-Syncope admin password::
-    the user password.
-
-===== Installation error
-The causes to get an error may be different, below some result samples.
-
-* Syncope unreachable (or wrong address):
-
-[source]
---
-
-Provided address :http://localhost:9080/syncope/rest
-
-###############################################
-#                                             #
-#       Provided address is unreachable!      #
-#         Check it and if it is wrong         #
-#        START AGAIN the installation!        #
-#                                             #
-###############################################
-
---
-
-* Authentication failed:
-
-[source]
---
-
-###############################################
-#                                             #
-#   Username or password provided are wrong   #
-#        START AGAIN the installation!        #
-#                                             #
-###############################################
-
---
-
-As the message suggested you have to start again the installation when error occurred.
-
-
-===== Debug installation
-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
-[source]
---
-$ ./syncopeadm.sh install --setup
---
-[source,bash]
-----
-
-You are runnig: 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      #
-#                                             #
-###############################################
-
-----
-

http://git-wip-us.apache.org/repos/asf/syncope/blob/715e1d39/src/main/asciidoc/cli-introduction.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-introduction.adoc b/src/main/asciidoc/cli-introduction.adoc
deleted file mode 100644
index e7bf329..0000000
--- a/src/main/asciidoc/cli-introduction.adoc
+++ /dev/null
@@ -1,34 +0,0 @@
-//
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements.  See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership.  The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License.  You may obtain a copy of the License at
-//
-//   http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied.  See the License for the
-// specific language governing permissions and limitations
-// under the License.
-//
-
-==== Introduction
-A brief introduction about this document and the examples you will find reading it.
-
-Once you downloaded and uzipped the zip file containing the scripts, you will find a lib directory and the 
-two script files, a .bat and a .sh one, called _syncopeadm_. According with your operating system you will use 
-one of them.
-
-[NOTE]
-Every examples of this document is executed on a linux machine with _debug environment_ up.
-
-[NOTE]
-As the Wikipedia page suggests a https://en.wikipedia.org/wiki/Command-line_interface[command line interface] (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 commands through a shell.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/syncope/blob/715e1d39/src/main/asciidoc/cli-logger.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-logger.adoc b/src/main/asciidoc/cli-logger.adoc
deleted file mode 100644
index 83b93c0..0000000
--- a/src/main/asciidoc/cli-logger.adoc
+++ /dev/null
@@ -1,250 +0,0 @@
-//
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements.  See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership.  The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License.  You may obtain a copy of the License at
-//
-//   http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied.  See the License for the
-// specific language governing permissions and limitations
-// under the License.
-//
-
-==== Logger command
-The logger command serves to retrieve the information about the logger configuration in Apache Syncope.
-
-===== Help message
-[source,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} [...]
-----
-
-===== Details option
-This option shows a table with some details about logger configuration.
-
-[source]
---
-$ ./syncopeadm.sh logger --details
---
-
-[source]
---
-
-You are runnig: 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    #
-#                #         #
-############################
-
---
-
-===== List option
-Running the command with this option you will see the table of the loggers configuration.
-
-[source]
---
-$ ./syncopeadm.sh logger --list
---
-
-[source]
---
-
-You are runnig: 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   #
-#                                                                #         #
-############################################################################
-
---
-
-===== Read option
-The option to read all the information of specified loggers.
-
-[source]
---
-$ ./syncopeadm.sh logger --read {LOG-NAME} {LOG-NAME} [...]
---
-
-Unlike the list option, the read one shows a table with only the loggers passed as input.
-
-===== Update option
-The option to change the value of the logger passed as input.
-
-[source]
---
-$ ./syncopeadm.sh logger --update {LOG-NAME}={LOG-LEVEL} {LOG-NAME}={LOG-LEVEL} [...]
---
-
-[source]
---
-
-You are runnig: logger --update org.apache.camel=DEBUG 
-
-####################################
-#                                  #
-#         UPDATED LOGGERS          #
-#                                  #
-####################################
-#                    #             #
-#       LOGGER       #  NEW LEVEL  #
-#                    #             #
-####################################
-#                    #             #
-#  org.apache.camel  #    DEBUG    #
-#                    #             #
-####################################
-
---
-
-===== Update all option
-This option is especially helpful in production environment when every log is disable and you need to change them for a 
-while in DEBUG mode.
-
-[source]
---
-$ ./syncopeadm.sh logger --update-all DEBUG
---
-
-[source]
---
-
-You are runnig: 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    #
-#                                                                #             #
-################################################################################
-
---
-
-===== Create option
-For the moment the logger command is one of the few command with a create option to add a new logger configuration.
-
-[source]
---
-$ ./syncopeadm.sh logger --create net.tirasa=ERROR
---
-
-[source]
---
-
-You are runnig: logger --create net.tirasa=ERROR 
-
-##############################
-#                            #
-#      UPDATED LOGGERS       #
-#                            #
-##############################
-#              #             #
-#    LOGGER    #  NEW LEVEL  #
-#              #             #
-##############################
-#              #             #
-#  net.tirasa  #    ERROR    #
-#              #             #
-##############################
-
---
-
-===== Delete option
-The option to delete a specified logger.
-
-[source]
---
-$ ./syncopeadm.sh logger --delete {LOG-NAME} {LOG-NAME} [...]
---
-
-[source]
---
-
-You are runnig: logger --delete org.apache.camel 
-
- - Logger org.apache.camel successfully deleted
-
---
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/syncope/blob/715e1d39/src/main/asciidoc/cli-notification.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-notification.adoc b/src/main/asciidoc/cli-notification.adoc
deleted file mode 100644
index d25beb1..0000000
--- a/src/main/asciidoc/cli-notification.adoc
+++ /dev/null
@@ -1,116 +0,0 @@
-//
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements.  See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership.  The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License.  You may obtain a copy of the License at
-//
-//   http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied.  See the License for the
-// specific language governing permissions and limitations
-// under the License.
-//
-
-==== Notification command
-The notification command serves to retrieve the information about the configured notification.
-
-===== Help message
-[source,bash]
-----
-Usage: notification [options]
-  Options:
-    --help 
-    --list 
-    --read 
-       Syntax: --read {NOTIFICATION-ID} 
-    --delete 
-       Syntax: --delete {NOTIFICATION-ID}
-----
-
-===== List option
-Running the command with this option you will see the list of notificaitons with their configuration.
-
-[source]
---
-$ ./syncopeadm.sh notification --list
---
-
-[source]
---
-
-You are runnig: notification --list 
-
- > NOTIFICATION ID: 1
-    events: [[CUSTOM]:[]:[]:[requestPasswordReset]:[SUCCESS]]
-    sender: admin@syncope.apache.org
-    subject: Password Reset request
-    recipients: null
-    recipient attribute name: email
-    template: requestPasswordReset
-    abouts: {USER=token!=$null}
-    recipient attribute types: UserPlainSchema
-    static recipient: []
-    trace level: FAILURES
-    active: true
-    self as recipient: true
-
- > NOTIFICATION ID: 2
-    events: [[CUSTOM]:[]:[]:[confirmPasswordReset]:[SUCCESS]]
-    sender: admin@syncope.apache.org
-    subject: Password Reset successful
-    recipients: null
-    recipient attribute name: email
-    template: confirmPasswordReset
-    abouts: {}
-    recipient attribute types: UserPlainSchema
-    static recipient: []
-    trace level: FAILURES
-    active: true
-    self as recipient: true
-
- > NOTIFICATION ID: 10
-    events: [[CUSTOM]:[]:[]:[unexisting1]:[FAILURE], [CUSTOM]:[]:[]:[unexisting2]:[SUCCESS]]
-    sender: test@syncope.apache.org
-    subject: Test subject
-    recipients: $groups==7
-    recipient attribute name: email
-    template: test
-    abouts: {USER=fullname==*o*;fullname==*i*}
-    recipient attribute types: UserPlainSchema
-    static recipient: []
-    trace level: FAILURES
-    active: true
-    self as recipient: false
-
---
-
-===== Read option
-The option to read all the information of specified notification.
-
-[source]
---
-$ ./syncopeadm.sh notification --read {NOTIFICATION-ID} {NOTIFICATION-ID} [...]
---
-
-Unlike the list option, the read one shows only the notifications passed as input.
-
-===== Delete option
-The option to delete a specified notification.
-
-[source]
---
-$ ./syncopeadm.sh notification --delete {NOTIFICATION-ID} {NOTIFICATION-ID} [...]
---
-
-The delete option, as can be imagined, tries to remove a specified notification. 
-The output will be something like:
-[source]
---
- - security notification {NOTIFICATION-ID} successfully deleted
---
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/syncope/blob/715e1d39/src/main/asciidoc/cli-policy.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-policy.adoc b/src/main/asciidoc/cli-policy.adoc
deleted file mode 100644
index af51145..0000000
--- a/src/main/asciidoc/cli-policy.adoc
+++ /dev/null
@@ -1,166 +0,0 @@
-//
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements.  See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership.  The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License.  You may obtain a copy of the License at
-//
-//   http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied.  See the License for the
-// specific language governing permissions and limitations
-// under the License.
-//
-
-==== Policy command
-The policy command serves to retrieve the information about the policies for each type.
-
-===== Help message
-[source,bash]
-----
-Usage: policy [options]
-  Options:
-    --help 
-    --details 
-    --list 
-       Syntax: --list-policy {POLICY-TYPE} 
-          Policy type: ACCOUNT / PASSWORD / SYNC / PUSH
-    --read 
-       Syntax: --read {POLICY-ID} {POLICY-ID} [...]
-    --delete 
-       Syntax: --delete {POLICY-ID} {POLICY-ID} [...]
-----
-
-===== Details option
-This option shows a table with policies amount for each type.
-
-[source]
---
-$ ./syncopeadm.sh policy --details
---
-
-[source]
---
-
-You are runnig: policy --details 
-
-#################################
-#                               #
-#       POLICIES DETAILS        #
-#                               #
-#################################
-#                     #         #
-#       DETAIL        #  VALUE  #
-#                     #         #
-#################################
-#                     #         #
-#    total number     #    9    #
-#  account policies   #    2    #
-#  password policies  #    3    #
-#    sync policies    #    4    #
-#    push policies    #    0    #
-#                     #         #
-#################################
-
---
-
-===== List option
-Running the command with this option you will see the list of the policies.
-
-[source]
---
-$ ./syncopeadm.sh Usage: policy --list {POLICY-TYPE}
-   Policy type: ACCOUNT / PASSWORD / SYNC / PUSH
---
-
-[source]
---
-
-You are runnig: policy --list SYNC 
-
- > KEY: 1
-    type: SYNC
-    description: a sync policy
-    resources : []
-    realms : []
-
- > KEY: 3
-    type: SYNC
-    description: sync policy 2
-    resources : [resource-csv]
-    realms : []
-    conflict resolution action: ALL
-    correlation rule : {USER=["username","firstname"]}
-
- > KEY: 7
-    type: SYNC
-    description: sync policy 1
-    resources : []
-    realms : []
-    conflict resolution action: IGNORE
-    correlation rule : {}
-
- > KEY: 9
-    type: SYNC
-    description: sync policy for java rule
-    resources : [ws-target-resource-2]
-    realms : []
-    conflict resolution action: IGNORE
-    correlation rule : {}
-
---
-
-===== Read option
-The option to read all the information of specified policy.
-
-[source]
---
-$ ./syncopeadm.sh policy --read {POLICY-ID} {POLICY-ID} [...]
---
-
-Unlike the list option, the read one shows only the policy passed as input.
-[source]
---
-You are runnig: policy --read 6 
-
- > KEY: 6
-    type: ACCOUNT
-    description: sample account policy
-    resources : []
-    realms : [/odd]
-    max authentication attempts : 3
-    propagation suspension : false
-    RULES : 
-       > class : [org.apache.syncope.common.lib.policy.DefaultAccountRuleConf@708a538f[
-  maxLength=0
-  minLength=4
-  pattern=<null>
-  allUpperCase=false
-  allLowerCase=false
-  wordsNotPermitted=[]
-  schemasNotPermitted=[]
-  prefixesNotPermitted=[notpermitted1, notpermitted2]
-  suffixesNotPermitted=[]
-  name=org.apache.syncope.common.lib.policy.DefaultAccountRuleConf
-]]
---
-
-===== Delete option
-The option to delete a specified policy.
-
-[source]
---
-$ ./syncopeadm.sh policy --delete {POLICY-ID} {POLICY-ID} [...]
---
-
-The delete option, as can be imagined, tries to remove a specified policy. 
-The output will be something like:
-[source]
---
- - Policy {POLICY-ID} successfully deleted
---
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/syncope/blob/715e1d39/src/main/asciidoc/cli-question.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-question.adoc b/src/main/asciidoc/cli-question.adoc
deleted file mode 100644
index c9ef57b..0000000
--- a/src/main/asciidoc/cli-question.adoc
+++ /dev/null
@@ -1,77 +0,0 @@
-//
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements.  See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership.  The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License.  You may obtain a copy of the License at
-//
-//   http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied.  See the License for the
-// specific language governing permissions and limitations
-// under the License.
-//
-
-==== Question command
-The question command serves to retrieve the information about the user question to retrieve his password.
-
-===== Help message
-[source,bash]
-----
-Usage: question [options]
-  Options:
-    --help 
-    --list 
-    --read 
-       Syntax: --read {QUESTION-ID} {QUESTION-ID} [...]
-    --delete 
-       Syntax: --delete {QUESTION-ID} {QUESTION-ID} [...]
-----
-
-===== List option
-Running the command with this option you will see the list of questions with their content.
-
-[source]
---
-$ ./syncopeadm.sh question --list
---
-
-[source]
---
-
-You are runnig: question --list 
-
-  > SECURITY QUESTION ID: 1
-    content: What's your mother's maiden name?
-
---
-
-===== Read option
-The option to read all the information of specified questions.
-
-[source]
---
-$ ./syncopeadm.sh question --read {QUESTION-ID} {QUESTION-ID} [...]
---
-
-Unlike the list option, the read one shows only the questions passed as input.
-
-===== Delete option
-The option to delete a specified questions.
-
-[source]
---
-$ ./syncopeadm.sh question --delete {QUESTION-ID} {QUESTION-ID} [...]
---
-
-The delete option, as can be imagined, tries to remove a specified questions. 
-The output will be something like:
-[source]
---
- - security question {QUESTION-ID} successfully deleted
---
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/syncope/blob/715e1d39/src/main/asciidoc/cli-realm.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-realm.adoc b/src/main/asciidoc/cli-realm.adoc
deleted file mode 100644
index 2b6855b..0000000
--- a/src/main/asciidoc/cli-realm.adoc
+++ /dev/null
@@ -1,111 +0,0 @@
-//
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements.  See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership.  The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License.  You may obtain a copy of the License at
-//
-//   http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied.  See the License for the
-// specific language governing permissions and limitations
-// under the License.
-//
-
-==== Realm command
-The realm command serves to retrieve the information about the configured realm.
-
-===== Help message
-[source,bash]
-----
-Usage: realm [options]
-  Options:
-    --help 
-    --details 
-    --list
-----
-
-===== Details option
-This option shows a table with realm amount.
-
-[source]
---
-$ ./syncopeadm.sh realm --details
---
-
-[source]
---
-
-You are runnig: realm --details 
-
-############################
-#                          #
-#      REALMS DETAILS      #
-#                          #
-############################
-#                #         #
-#     DETAIL     #  VALUE  #
-#                #         #
-############################
-#                #         #
-#  Total number  #    4    #
-#                #         #
-############################
-
---
-
-===== List option
-Running the command with this option you will see the list of the realms.
-
-[source]
---
-$ ./syncopeadm.sh realm --list 
---
-
-[source]
---
-
-You are runnig: realm --list 
-
- > REALM ID: 1
-    name: /
-    full path: /
-    actions: []
-    templates: {}
-    parent id: 0
-    account policy id: null
-    password policy id: 4
-
- > REALM ID: 2
-    name: odd
-    full path: /odd
-    actions: []
-    templates: {}
-    parent id: 1
-    account policy id: 6
-    password policy id: 4
-
- > REALM ID: 3
-    name: even
-    full path: /even
-    actions: []
-    templates: {}
-    parent id: 1
-    account policy id: null
-    password policy id: 4
-
- > REALM ID: 4
-    name: two
-    full path: /even/two
-    actions: []
-    templates: {}
-    parent id: 3
-    account policy id: 5
-    password policy id: 2
-
---
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/syncope/blob/715e1d39/src/main/asciidoc/cli-report.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-report.adoc b/src/main/asciidoc/cli-report.adoc
deleted file mode 100644
index 48ee95a..0000000
--- a/src/main/asciidoc/cli-report.adoc
+++ /dev/null
@@ -1,251 +0,0 @@
-//
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements.  See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership.  The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License.  You may obtain a copy of the License at
-//
-//   http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied.  See the License for the
-// specific language governing permissions and limitations
-// under the License.
-//
-
-==== Report command
-The report command serves to retrieve the information about the configured reports.
-
-===== Help message
-[source,bash]
-----
-Usage: report [options]
-  Options:
-    --help 
-    --details
-    --list 
-    --list-jobs 
-    --read 
-       Syntax: --read {REPORT-ID} {REPORT-ID} [...] 
-    --delete 
-       Syntax: --delete {REPORT-ID} {REPORT-ID} [...]
-    --execute 
-       Syntax: --execute {REPORT-ID} 
-    --read-execution 
-       Syntax: --read-execution {EXECUTION-ID} {EXECUTION-ID} [...]
-    --delete-execution 
-       Syntax: --delete-execution {EXECUTION-ID} {EXECUTION-ID} [...]
-    --export-execution-result 
-       Syntax: --export-execution-result {EXECUTION-ID} {EXECUTION-ID} [...] {FORMAT}
-          Format: CSV / HTML / PDF / XML / RTF
-----
-
-===== Details option
-This option shows a table with some details about the reports and their executions.
-
-[source]
---
-$ ./syncopeadm.sh report --details
---
-
-[source]
---
-
-You are runnig: report --details 
-
-##############################
-#                            #
-#      REPORTS DETAILS       #
-#                            #
-##############################
-#                  #         #
-#      DETAIL      #  VALUE  #
-#                  #         #
-##############################
-#                  #         #
-#  Total numbers   #    1    #
-#  Never executed  #    0    #
-#                  #         #
-##############################
-
---
-
-===== List all option
-Running the command with this option you will see the list of report configured.
-
-[source]
---
-$ ./syncopeadm.sh report --list
---
-[source]
---
-You are runnig: report --list 
-
- > REPORT ID: 1
-    name: test
-    cron expression: null
-    latest execution status: SUCCESS
-    start date: Sun Feb 26 15:40:04 CET 2012
-    end date: Sun Feb 26 15:41:04 CET 2012
-    CONF:
-       name: testUserReportlet
-       features: [key, username, workflowId, status, creationDate, lastLoginDate, changePwdDate, passwordHistorySize, failedLoginCount, memberships, resources]
-       plain attributes: [fullname, gender]
-       derived attributes: [cn]
-       virtual attributes: [virtualdata]
-       matching condition: null
-    EXECUTION:
-       REPORT EXEC ID: 1
-       status: SUCCESS
-       message: null
-       start date: Sun Feb 26 15:40:04 CET 2012
-       end date: Sun Feb 26 15:41:04 CET 2012
-       report id: 1
---
-
-===== List reports execution option
-Running the command with this option you will see the list of the report execution executed.
-
-[source]
---
-$ ./syncopeadm.sh report --list-jobs
---
-
-[source]
---
-
-You are runnig: report --list-jobs 
-       
-       REPORT EXEC ID: 0
-       status: Not Scheduled
-       message: null
-       start date: null
-       end date: null
-       report id: 1
-
---
-
-===== Read option
-The option to read all the information of specified report.
-
-[source]
---
-$ ./syncopeadm.sh report --read {REPORT-ID} {REPORT-ID} [...]
---
-
-[source]
---
-You are runnig: report --read 1 
-
- > REPORT ID: 1
-    name: test
-    cron expression: null
-    latest execution status: SUCCESS
-    start date: Sun Feb 26 15:40:04 CET 2012
-    end date: Sun Feb 26 15:41:04 CET 2012
-    CONF:
-       name: testUserReportlet
-       features: [key, username, workflowId, status, creationDate, lastLoginDate, changePwdDate, passwordHistorySize, failedLoginCount, memberships, resources]
-       plain attributes: [fullname, gender]
-       derived attributes: [cn]
-       virtual attributes: [virtualdata]
-       matching condition: null
-    EXECUTION:
-       REPORT EXEC ID: 1
-       status: SUCCESS
-       message: null
-       start date: Sun Feb 26 15:40:04 CET 2012
-       end date: Sun Feb 26 15:41:04 CET 2012
-       report id: 1
---
-
-===== Read report executions option
-The option to read all the information of specified report execution.
-
-[source]
---
-$ ./syncopeadm.sh rreport --read-execution {EXECUTION-ID} {EXECUTION-ID} [...]
---
-
-[source]
---
-You are runnig: report --read-execution 1 
-       
-       REPORT EXEC ID: 1
-       status: SUCCESS
-       message: null
-       start date: Sun Feb 26 15:40:04 CET 2012
-       end date: Sun Feb 26 15:41:04 CET 2012
-       report id: 1
---
-
-===== Delete option
-The option to delete a specified report.
-
-[source]
---
-$ ./syncopeadm.sh report --delete {REPORT-ID} {REPORT-ID} [...]
---
-
-The delete option, as can be imagined, tries to remove a specified report.
-[source]
---
- - Report {REPORT-ID} successfully deleted
---
-
-===== Delete report executions option
-The option to delete a specified report execution.
-
-[source]
---
-$ ./syncopeadm.sh report --delete-execution {EXECUTION-ID} {EXECUTION-ID} [...]
---
-
-The delete option, as can be imagined, tries to remove a specified report execution.
-[source]
---
- - Report execution {EXECUTION-ID} successfully deleted
-
-===== Execute option
-The option to run a report.
-
-[source]
---
-$ ./syncopeadm.sh report --execute {REPORT-ID}
---
-
-[source]
---
-You are runnig: report --execute 1 
-
- - Report 1executed.
-
-
- - Run --read 1 to see the results.
---
-
-As you can read, after the execution, if the result is positive, you have to read the report to know the execution 
-results.
-
-===== Export execution option
-The option to export an execution in a certain format to see the results.
-
-[NOTE]
-At the moment only the XML format is supported.
-
-[source]
---
-$ ./syncopeadm.sh eport --export-execution-result {EXECUTION-ID} {EXECUTION-ID} [...] {FORMAT}
-          Format: CSV / HTML / PDF / XML / RTF
---
-
-[source]
---
-You are runnig: report --export-execution-result 101 XML 
-
- - export_101.xml created.
---
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/syncope/blob/715e1d39/src/main/asciidoc/cli-resource.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-resource.adoc b/src/main/asciidoc/cli-resource.adoc
deleted file mode 100644
index 10d31b4..0000000
--- a/src/main/asciidoc/cli-resource.adoc
+++ /dev/null
@@ -1,208 +0,0 @@
-//
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements.  See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership.  The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License.  You may obtain a copy of the License at
-//
-//   http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied.  See the License for the
-// specific language governing permissions and limitations
-// under the License.
-//
-
-==== Resource command
-The resource command serves to retrieve the information about the resources.
-
-===== Help message
-[source,bash]
-----
-Usage: resource [options]
-  Options:
-    --help 
-    --details 
-    --list 
-    --read 
-       Syntax: --read {RESOURCE-NAME} {RESOURCE-NAME} [...]
-    --delete 
-       Syntax: --delete {RESOURCE-NAME} {RESOURCE-NAME} [...]
-----
-
-===== Details option
-This option shows a table with resource amount.
-
-[source]
---
-$ ./syncopeadm.sh resource --details
---
-
-[source]
---
-
-You are runnig: resource --details 
-
-#############################
-#                           #
-#     RESOURCES DETAILS     #
-#                           #
-#############################
-#                 #         #
-#     DETAIL      #  VALUE  #
-#                 #         #
-#############################
-#                 #         #
-#  Total numbers  #   19    #
-#                 #         #
-#############################
-
---
-
-Total number::
-    number of resources;
-
-===== List option
-Running the command with this option you will see the list of the resources.
-
-[source]
---
-$ ./syncopeadm.sh resource --list
---
-
-[source]
---
-
-You are runnig: resource --list 
-
- > RESOURCE ID: ws-target-resource-1
-    connector dispaly name: ConnInstance100
-    etag value: 1287565200000
-    connector id: 100
-    account policy id: null
-    password policy id: null
-    sync policy id: null
-    creator: admin
-    creation date: Wed Oct 20 11:00:00 CEST 2010
-    last modifier: admin
-    last change date: Wed Oct 20 11:00:00 CEST 2010
-    propagation actions class: []
-    propagation priority: 1
-    PROVISIONS:
-       provision id: 15
-       any type: USER
-       object class: __ACCOUNT__
-       sync token: null
-       virtual schema: []
-       MAPPING: 
-          ConnObjectLink: null
-          MAPPING ITEM: 
-             mapping key: 99
-             mapping item type: UserKey
-             internal attribute name: id
-             external attribute name: userId
-             mandatory condition: true
-             transformers class: []
-             purpose: PROPAGATION
-             connector object key: true
-             password: false
-
-             mapping key: 100
-             mapping item type: UserPlainSchema
-             internal attribute name: email
-             external attribute name: email
-             mandatory condition: true
-             transformers class: []
-             purpose: PROPAGATION
-             connector object key: false
-             password: false
-
-             mapping key: 101
-             mapping item type: UserPlainSchema
-             internal attribute name: surname
-             external attribute name: surname
-             mandatory condition: true
-             transformers class: []
-             purpose: PROPAGATION
-             connector object key: false
-             password: false
-
-             mapping key: 102
-             mapping item type: Password
-             internal attribute name: password
-             external attribute name: __PASSWORD__
-             mandatory condition: true
-             transformers class: []
-             purpose: PROPAGATION
-             connector object key: false
-             password: true
-
-             mapping key: 335
-             mapping item type: UserPlainSchema
-             internal attribute name: surname
-             external attribute name: fullname
-             mandatory condition: true
-             transformers class: []
-             purpose: PROPAGATION
-             connector object key: false
-             password: false
-
-             mapping key: 336
-             mapping item type: UserPlainSchema
-             internal attribute name: type
-             external attribute name: type
-             mandatory condition: true
-             transformers class: []
-             purpose: PROPAGATION
-             connector object key: false
-             password: false
-
-             mapping key: 337
-             mapping item type: UserPlainSchema
-             internal attribute name: firstname
-             external attribute name: name
-             mandatory condition: false
-             transformers class: []
-             purpose: NONE
-             connector object key: false
-             password: false
-
-    create trace level: ALL
-    delete trace level: ALL
-    update trace level: ALL
-    sync trace level: ALL
-    enforce mandatory condition: false
-    override capabilities: false
-    random password if not provided: false
-    [...]
-    
---
-
-===== Read option
-The option to read all the information of specified resource.
-
-[source]
---
-$ ./syncopeadm.sh resource --read {RESOURCE-NAME} {RESOURCE-NAME} [...]
---
-
-Unlike the list option, the read one shows only the resources passed as input.
-
-===== Delete option
-The option to delete a specified resource.
-
-[source]
---
-$ ./syncopeadm.sh resource --delete {RESOURCE-NAME} {RESOURCE-NAME} [...]
---
-
-The delete option, as can be imagined, tries to remove a specified resources. 
-The output will be something like:
-[source]
---
- - Resource {RESOURCE-NAME} successfully deleted
---
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/syncope/blob/715e1d39/src/main/asciidoc/cli-role.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-role.adoc b/src/main/asciidoc/cli-role.adoc
deleted file mode 100644
index cc3f244..0000000
--- a/src/main/asciidoc/cli-role.adoc
+++ /dev/null
@@ -1,149 +0,0 @@
-//
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements.  See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership.  The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License.  You may obtain a copy of the License at
-//
-//   http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied.  See the License for the
-// specific language governing permissions and limitations
-// under the License.
-//
-
-==== Role command
-The role command serves to retrieve the information about the roles.
-
-===== Help message
-[source,bash]
-----
-Usage: role [options]
-  Options:
-    --help 
-    --details 
-    --list 
-    --read 
-       Syntax: --read {ROLE-NAME} {ROLE-NAME} [...]
-    --delete 
-       Syntax: --delete {ROLE-NAME} {ROLE-NAME} [...]
-----
-
-===== Details option
-This option shows a table with some details about the roles.
-
-[source]
---
-$ ./syncopeadm.sh role --details
---
-
-[source]
---
-
-You are runnig: role --details 
-
-####################################
-#                                  #
-#          ROLES DETAILS           #
-#                                  #
-####################################
-#                        #         #
-#         DETAIL         #  VALUE  #
-#                        #         #
-####################################
-#                        #         #
-#      Total number      #    4    #
-#  Without entitlements  #    0    #
-#                        #         #
-####################################
-
---
-
-Total number::
-    number of created roles;
-Without entitlements::
-    number of roles without linked entitlments.
-
-===== List option
-Running the command with this option you will see the list of roles with the realm where are configured 
-and their entitlments.
-
-[source]
---
-$ ./syncopeadm.sh role --list
---
-
-[source]
---
-
-You are runnig: role --list 
-
- > ROLE ID: User reviewer
-    REALMS: 
-       - /odd
-       - /even
-    ENTITLEMENTS:
-       - USER_READ
-       - USER_LIST
-       - USER_SEARCH
-    dynamic membership condition: null
-
- > ROLE ID: User manager
-    REALMS: 
-       - /
-    ENTITLEMENTS:
-       - WORKFLOW_FORM_SUBMIT
-       - USER_READ
-       - USER_LIST
-       - USER_SEARCH
-       - WORKFLOW_FORM_CLAIM
-    dynamic membership condition: null
-
- > ROLE ID: Other
-    REALMS: 
-       - /odd
-    ENTITLEMENTS:
-       - SCHEMA_READ
-       - GROUP_READ
-       - WORKFLOW_FORM_CLAIM
-    dynamic membership condition: null
-
- > ROLE ID: Search for realm evenTwo
-    REALMS: 
-       - /even/two
-    ENTITLEMENTS:
-       - USER_READ
-       - USER_SEARCH
-    dynamic membership condition: null
-
---
-
-===== Read option
-The option to read all the information of specified roles.
-
-[source]
---
-$ ./syncopeadm.sh role --read {ROLE-NAME} {ROLE-NAME} [...]
---
-
-Unlike the list option, the read one shows only the roles passed as input.
-
-===== Delete option
-The option to delete a specified roles.
-
-[source]
---
-$ ./syncopeadm.sh role --delete {ROLE-NAME} {ROLE-NAME} [...]
---
-
-The delete option, as can be imagined, tries to remove a specified roles. 
-The output will be something like:
-[source]
---
- - role {ROLE-NAME} successfully deleted
---
\ No newline at end of file


Mime
View raw message