Repository: syncope Updated Branches: refs/heads/master 08531e6e6 -> 78204b93e
cli docs: info, entitlement, SYNCOPE-722 Project: http://git-wip-us.apache.org/repos/asf/syncope/repo Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/8875e0fd Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/8875e0fd Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/8875e0fd Branch: refs/heads/master Commit: 8875e0fda8866d1bb8f8b89523eaa4a8bfc8267a Parents: 08531e6 Author: massi <massimiliano.perr...@tirasa.net> Authored: Tue Dec 1 16:38:18 2015 +0100 Committer: massi <massimiliano.perr...@tirasa.net> Committed: Tue Dec 1 16:38:18 2015 +0100 ---------------------------------------------------------------------- src/main/asciidoc/cli-entitlement.adoc | 140 ++++++++++++++++++++++++++++ src/main/asciidoc/cli-info.adoc | 52 +++++++++++ src/main/asciidoc/cli.adoc | 6 +- 3 files changed, 197 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/syncope/blob/8875e0fd/src/main/asciidoc/cli-entitlement.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/cli-entitlement.adoc b/src/main/asciidoc/cli-entitlement.adoc new file mode 100644 index 0000000..c7bc30f --- /dev/null +++ b/src/main/asciidoc/cli-entitlement.adoc @@ -0,0 +1,140 @@ +// +// 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/8875e0fd/src/main/asciidoc/cli-info.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/cli-info.adoc b/src/main/asciidoc/cli-info.adoc new file mode 100644 index 0000000..2186862 --- /dev/null +++ b/src/main/asciidoc/cli-info.adoc @@ -0,0 +1,52 @@ +// +// 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/8875e0fd/src/main/asciidoc/cli.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/cli.adoc b/src/main/asciidoc/cli.adoc index 7f284e7..1b0f4c4 100644 --- a/src/main/asciidoc/cli.adoc +++ b/src/main/asciidoc/cli.adoc @@ -44,4 +44,8 @@ include::cli-report.adoc[] include::cli-resource.adoc[] -include::cli-policy.adoc[] \ No newline at end of file +include::cli-policy.adoc[] + +include::cli-info.adoc[] + +include::cli-entitlement.adoc[] \ No newline at end of file
