http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/domain.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/domain.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/domain.adoc new file mode 100644 index 0000000..b4ab63a --- /dev/null +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/domain.adoc @@ -0,0 +1,46 @@ +// +// 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 retrieves information about the configured domains. + +[discrete] +====== Help message +[source,bash] +---- +Usage: domain [options] + Options: + --help + --details + --list + --delete + Syntax: --delete {DOMAIN-NAME} {DOMAIN-NAME} [...] +---- + +[discrete] +====== Options + +--details:: +This option shows a table with domain amount. + +--list:: +Running the command with this option you will see the list of the domains. + +--delete:: +The option to delete a specified domain.
http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/entitlement.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/entitlement.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/entitlement.adoc new file mode 100644 index 0000000..c5b56cd --- /dev/null +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/entitlement.adoc @@ -0,0 +1,53 @@ +// +// 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 retrieves information about the entitlments. + +[discrete] +====== 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} +---- + +[discrete] +====== Options + +--list:: +Running the command with this option you will see the list of the entitlements. +--list-role:: +Running the command with this option you will see the list of the roles with a certain entitlement. +--read-by-username:: +The option to read the entitlements of the username passed as input. +--read-by-userid:: +The option to read the entitlements of the userid passed as input. +--search-by-role:: +The option to read the entitlements of a certain role. http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/group.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/group.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/group.adoc new file mode 100644 index 0000000..d113eff --- /dev/null +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/group.adoc @@ -0,0 +1,56 @@ +// +// 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 retrieves information about the configured groups. + +[discrete] +====== 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} [...] +---- + +[discrete] +====== Options + +--details:: +This option shows a table with the amount of available groups and some additional information. +--list:: +Running the command with this option you will see the list of the groups. +--read:: +The option to read the group passed as input. +--read-attr-by-schema-type:: +The option to read the specified attribute type of the group passed as input. +--read-attr-by-schema:: +The option to read the specified attribute name of the group passed as input. +--delete:: +The option to delete a specified group. http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/info.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/info.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/info.adoc new file mode 100644 index 0000000..2dd992b --- /dev/null +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/info.adoc @@ -0,0 +1,53 @@ +// +// 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 shows some information about the Syncope installation. + +[discrete] +====== 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 +---- http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/installation.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/installation.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/installation.adoc new file mode 100644 index 0000000..52a42a1 --- /dev/null +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/installation.adoc @@ -0,0 +1,181 @@ +// +// 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. +// + +==== Initial Setup +The installation process creates `cli.properties`, which contains all the required information to invoke the Apache +Syncope REST API services. +The file content looks like the following: + +[source] +syncope.rest.services=http://localhost:9080/syncope/rest +syncope.admin.user=admin +syncope.admin.password=QePSFVTnzwQowM4ohhaUYcE6aW47MVZ/ + +where: + +syncope.rest.services:: + the base URL where the Apache Syncope REST API services are listening; +syncope.admin.user:: + the username which will be used to invoke the Syncope APIs; +syncope.admin.password:: + the password for the admin user configured above. + +As shown above, the password value is encrypted for security reasons. + +[discrete] +====== 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 the installation process, the script returns +[source] +-- + - Error: It seems you need to first setup the CLI client. 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,subs="verbatim,attributes"] +---- + +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: {docVersion} + +############################################### +# # +# 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 where the rest services are deployed (/syncope/rest is the default); +Syncope admin user:: + the user with the permission to call the Syncope APIs; +Syncope admin password:: + the user password. + +===== Installation error +Various error messages are possible on installation. Here are some sample error messages: + +* 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 the installation AGAIN! # +# # +############################################### + +-- + +* Authentication failed: + +[source] +-- + +############################################### +# # +# Username or password provided are wrong # +# START the installation AGAIN! # +# # +############################################### + +-- + +As the message suggests you have to start the installation again when this error occurrs. + + +===== 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-debug +-- +[source,bash,subs="verbatim,attributes"] +---- + +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: {docVersion} + +############################################### +# # +# Installation successful # +# now you can use Syncope CLI client # +# # +############################################### + +---- + http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/logger.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/logger.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/logger.adoc new file mode 100644 index 0000000..76dc6fd --- /dev/null +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/logger.adoc @@ -0,0 +1,61 @@ +// +// 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 retrieves information about the logger configuration in Apache Syncope. + +[discrete] +====== 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} [...] +---- + +[discrete] +====== Options + +--details:: +This option shows a table with some details about logger configuration. +--list:: +Running the command with this option you will see the table of the loggers configuration. +--read:: +The option to read all the information of specified loggers. +--update:: +The option to change the value of the logger passed as input. +--update-all:: +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. +--create:: +For the moment the logger command is one of the few command with a create option to add a new logger configuration. +--delete:: +The option to delete a specified logger. http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/notification.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/notification.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/notification.adoc new file mode 100644 index 0000000..43655f1 --- /dev/null +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/notification.adoc @@ -0,0 +1,45 @@ +// +// 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 retrieves information about the configured notifications. + +[discrete] +====== Help message +[source,bash] +---- +Usage: notification [options] + Options: + --help + --list + --read + Syntax: --read {NOTIFICATION-ID} + --delete + Syntax: --delete {NOTIFICATION-ID} +---- + +[discrete] +====== Options + +--list:: +Running the command with this option you will see the list of notificaitons with their configuration. +--read:: +The option to read all the information of the specified notifications. +--delete:: +The option to delete a specified notification. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/policy.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/policy.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/policy.adoc new file mode 100644 index 0000000..d6f283f --- /dev/null +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/policy.adoc @@ -0,0 +1,50 @@ +// +// 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 retrieves information about the policies for each type. + +[discrete] +====== 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} [...] +---- + +[discrete] +====== Options + +--details:: +This option shows a table with the amount of policies for each type. +--list:: +Running the command with this option you will see the list of the policies. +--read:: +The option to read all the information of a specified policy. +--delete:: +The option to delete a specified policy. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/question.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/question.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/question.adoc new file mode 100644 index 0000000..1451aed --- /dev/null +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/question.adoc @@ -0,0 +1,45 @@ +// +// 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 gets information about the user question to retrieve their password. + +[discrete] +====== Help message +[source,bash] +---- +Usage: question [options] + Options: + --help + --list + --read + Syntax: --read {QUESTION-ID} {QUESTION-ID} [...] + --delete + Syntax: --delete {QUESTION-ID} {QUESTION-ID} [...] +---- + +[discrete] +====== Options + +--list:: +Running the command with this option you will see the list of questions with their content. +--read:: +The option to read all the information of specified questions. +--delete:: +The option to delete a specified question. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/realm.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/realm.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/realm.adoc new file mode 100644 index 0000000..e04e5d5 --- /dev/null +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/realm.adoc @@ -0,0 +1,40 @@ +// +// 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 retrieves information about the configured realm. + +[discrete] +====== Help message +[source,bash] +---- +Usage: realm [options] + Options: + --help + --details + --list +---- + +[discrete] +====== Options + +--details:: +This option shows a table with the amount of the available realms. +--list:: +Running the command with this option you will see the list of the realms. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/report.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/report.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/report.adoc new file mode 100644 index 0000000..7ec96e8 --- /dev/null +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/report.adoc @@ -0,0 +1,68 @@ +// +// 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 retrieves information about the configured reports. + +[discrete] +====== 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 +---- + +[discrete] +====== Options + +--details:: +This option shows a table with some details about the reports and their executions. +--list:: +Running the command with this option you will see the list of configured reports. +--list-jobs:: +Running the command with this option you will see the list of the report executions. +--read:: +The option to read all the information of a specified report. +--read-execution:: +The option to read all the information of a specified report execution. +--delete:: +The option to delete a specified report. +--delete-execution:: +The option to delete a specified report execution. +--execute:: +The option to run a report. +--export-execution-result:: +The option to export an execution in a certain format to see the results. http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/resource.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/resource.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/resource.adoc new file mode 100644 index 0000000..c17c904 --- /dev/null +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/resource.adoc @@ -0,0 +1,48 @@ +// +// 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 retrieves information about the resources. + +[discrete] +====== 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} [...] +---- + +[discrete] +====== Options + +--details:: +This option shows a table with amount of available resources. +--list:: +Running the command with this option you will see the list of resources. +--read:: +The option to read all the information of a specified resource. +--delete:: +The option to delete a specified resource. http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/role.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/role.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/role.adoc new file mode 100644 index 0000000..6f042e6 --- /dev/null +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/role.adoc @@ -0,0 +1,48 @@ +// +// 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 retrieves information about the roles. + +[discrete] +====== 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} [...] +---- + +[discrete] +====== Options + +--details:: +This option shows a table with some details about the roles. +--list:: +Running the command with this option you will see the list of roles with the realm where they are configured and their entitlments. +--read:: +The option to read all the information of specified roles. +--delete:: +The option to delete specified roles. http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/schema.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/schema.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/schema.adoc new file mode 100644 index 0000000..66c682b --- /dev/null +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/schema.adoc @@ -0,0 +1,58 @@ +// +// 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. +// + +===== Schema command +The schema command serves retrieves information about the schema categories. + +[discrete] +====== Help message +[source,bash] +---- +Usage: schema [options] + Options: + --help + --details + --list-all + --list-plain + --list-derived + --list-virtual + --read {SCHEMA-TYPE} {SCHEMA-KEY} + Schema type: PLAIN / DERIVED / VIRTUAL + --delete {SCHEMA-TYPE} {SCHEMA-KEY} + Schema type: PLAIN / DERIVED / VIRTUAL +---- + +[discrete] +====== Options + +--details:: +This option shows a table with some details about the schemas and their categories. +--list-all:: +Running the command with this option you will see the list of all (PLAIN, DERIVED, VIRTUAL) schemas configured. +--list-plain:: +Running the command with this option you will see the list of the plain schemas available in Syncope. +--list-derived:: +Running the command with this option you will see the list of the derived schemas available in Syncope with +their expressions. +--list-virtual:: +Running the command with this option you will see the list of the virtual schemas available in Syncope. +--read:: +The option to read all the information of a specified schema. +--delete:: +The option to delete a specified schema. http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/task.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/task.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/task.adoc new file mode 100644 index 0000000..3dde2ba --- /dev/null +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/task.adoc @@ -0,0 +1,69 @@ +// +// 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. +// + +===== Task command +The Task command retrieves information about the Task configuration in Apache Syncope. + +[discrete] +====== Help message +[source,bash] +---- +Usage: task [options] + Options: + --help + --details + --list + Syntax: --list {TASK-TYPE} + Task type: NOTIFICATION / PROPAGATION / PUSH / SCHEDULED / PULL + --list-running-jobs + --list-scheduled-jobs + --read + Syntax: --read {TASK-ID} {TASK-ID} [...] + --read-execution + Syntax: --read-execution {TASK-EXEC-ID} {TASK-EXEC-ID} [...] + --delete + Syntax: --delete {TASK-ID} {TASK-ID} [...] + --delete-execution + Syntax: --delete-execution {TASK-EXEC-ID} {TASK-EXEC-ID} [...] + --execute + Syntax: --execute {TASK-ID} {DRY-RUN} + Dry run: true / false +---- + +[discrete] +====== Options + +--details:: +This option shows a table with some details about tasks and jobs. +--list:: +Running the command with this option you will see the list of selected tasks type with their information. +--list-scheduled-jobs:: +Running the command with this option you will see the list of the actual scheduled jobs. +--list-running-jobs:: +Running the command with this option you will see the list of the actual runnig jobs. +--read:: +The option to read all the information of a task. +--read-execution:: +The option to read all the information of executions task. +--delete:: +The option to delete specified tasks. +--delete-execution:: +The option to delete specified execution tasks. +--execute:: +The option to execute specified execution tasks. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/user.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/user.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/user.adoc new file mode 100644 index 0000000..e9dcb36 --- /dev/null +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/user.adoc @@ -0,0 +1,81 @@ +// +// 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. +// + +===== User command +The user command retrieves information about the users. + +[discrete] +====== Help message +[source,bash] +---- +Usage: user [options] + Options: + --help + --list + --details + --get-user-key + Syntax: --get-user-key {USERNAME} {USERNAME} [...] + --get-username + Syntax: --get-username {USER-ID} {USER-ID} [...] + --read-by-usernam + Syntax: --read-by-usernam {USERNAME} {USERNAME} [...] + --read-by-userid + Syntax: --read-by-userid {USER-ID} {USER-ID} [...] + --search-by-attribute + Syntax: --search-by-attribute {REALM} {ATTR-NAME}={ATTR-VALUE} + --search-by-role + Syntax: --search-by-role {REALM} {ROLE-ID} + --search-by-resource + Syntax: --search-by-resource {REALM} {RESOURCE-NAME} + --delete + Syntax: --delete {USER-ID} {USER-ID} [...] + --delete-all + Syntax: --delete-all {REALM} + --delete-by-attribute + Syntax: --delete-by-attribute {REALM} {ATTR-NAME}={ATTR-VALUE} +---- + +[discrete] +====== Options + +--details:: +This option shows a table with some details about the users. +-- List option:: +Running the command with this option you will see the list of all users in the environment. However, the system will +ask you a confirmation before execution, because as you can imagine this operation might produce very large output. +--get-user-key:: +The option to get the user key starting from a username. +--get-username:: +The option to get the username starting from a user id. +--read-by-userid:: +The option to read user information by their user id. +--read-by-usernam:: +The option to read user information by their username. +--search-by-attribute:: +The option to search a list of users with a common attribute. +--search-by-role:: +The option to search a list of users with a specified role. +--search-by-resource:: +The option to search a list of users with a specified resource. +--delete +The option to delete a specified user. +--delete-by-attribute +The option to delete the users with a common attribute. +--delete-all +The option to delete all users of the realm passed as input. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/reference-guide/workingwithapachesyncope/restfulservices/client-library.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/restfulservices/client-library.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/restfulservices/client-library.adoc new file mode 100644 index 0000000..018027e --- /dev/null +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/restfulservices/client-library.adoc @@ -0,0 +1,60 @@ +// +// 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. +// + +==== Client library +The Apache Syncope client library, as suggested, is a Java client to work with the Apache Syncope core. + +===== Maven dependency +[source,xml,subs="verbatim,attributes"] +---- +<dependency> + <groupId>org.apache.syncope.client</groupId> + <artifactId>syncope-client-lib</artifactId> + <version>{docVersion}</version> +</dependency> +---- + +===== Instantiation +Basically, all you need is to obtain a SyncopeClient instance via the following statement in order +to set the base REST URL and credentials: + +[source,java] +---- +SyncopeClient client = new SyncopeClientFactoryBean(). + setAddress("http://localhost:9080/syncope/rest/";). + create("admin", "password"); +---- + +and you get enabled for any kind of REST service interaction with Apache Syncope. +You can read the http://syncope.apache.org/apidocs/1.2/org/apache/syncope/common/services/package-summary.html[javadoc] +page for a documented list of available REST services in Apache Syncope. + +===== Usage example +Below a snippet that shows how to use the SyncopeClient to update the logger configuration. +[source,java] +---- +SyncopeClient client = new SyncopeClientFactoryBean(). + setAddress("http://localhost:9080/syncope/rest/";). + create("admin", "password"); +LoggerService loggerService = client.getService(LoggerService.class); + +LoggerTO loggerTO = loggerService.read(LoggerType.LOG, "org.apache.syncope.core.connid"); +loggerTO.setLevel(LoggerLevel.DEBUG); +loggerService.update(LoggerType.LOG, loggerTO); +---- http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/reference-guide/workingwithapachesyncope/restfulservices/restful-reference.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/restfulservices/restful-reference.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/restfulservices/restful-reference.adoc new file mode 100644 index 0000000..3c9c145 --- /dev/null +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/restfulservices/restful-reference.adoc @@ -0,0 +1,74 @@ +// +// 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. +// +==== RESTful reference +If you want to read from the complete descriptive REST reference the URL you need is +[source] +-- +http://localhost:9080/syncope/ +-- +where you can see all the REST resources with their description, the parameters and the reference to the schema, +so you are able to see which attributes and which type are needed to the every service. +Following the same example as before, below two images to show the REST resources of the logger service and another one +for the reference to the schema: + +image::restReferenceLoggerRead.png[restReferenceLoggerRead] + +image::restReferenceLoggerUpdate.png[restReferenceLoggerUpdate] + +image::restSchemaReferenceLogger.png[restSchemaReferenceLogger] + +===== Swagger UI +From the 2.0 version, Syncope offers also the Swagger UI to work with its services. + +The Swagger installation is really simple because you just add the Maven dependency to your core pom.xml file generated +from the archetype operation; the dependency is: +[source, xml] +---- +<dependency> + <groupId>org.apache.syncope.ext</groupId> + <artifactId>syncope-ext-swagger-ui</artifactId> + <version>${syncope.version}</version> +</dependency> +---- + +The swagger interface is available going to the URL +[source] +-- +http://localhost:9080/syncope/swagger/#/ +-- + +Reading from the Swagger http://swagger.io/[website] + +.Swagger +**** +Swagger is a simple yet powerful representation of your RESTful API. With the largest ecosystem of API tooling on +the planet, thousands of developers are supporting Swagger in almost every modern programming language and deployment +environment. With a Swagger-enabled API, you get interactive documentation, client SDK generation and discoverability. + +We created Swagger to help fulfill the promise of APIs. Swagger helps companies like Apigee, Getty Images, Intuit, +LivingSocial, McKesson, Microsoft, Morningstar, and PayPal build the best possible services with RESTful APIs. + +Now in version 2.0, Swagger is more enabling than ever. And it's 100% open source software. + +**** + +To be consistent with the example, below the image shows the Swagger UI used to read the configuration +of _org.apache.syncope.core.rest_ + +image::swaggerLoggerRead.png[swaggerLoggerRead] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/reference-guide/workingwithapachesyncope/restfulservices/restful-services.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/restfulservices/restful-services.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/restfulservices/restful-services.adoc new file mode 100644 index 0000000..758bb74 --- /dev/null +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/restfulservices/restful-services.adoc @@ -0,0 +1,30 @@ +// +// 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. +// +=== RESTful services +The RESTful services is the way how the Syncope core web application receives the input from the clients. +This layer, developed in http://cxf.apache.org/docs/jax-rs.html[Apache CXF 2.0], is usually reachable under the +root context of the deployment. +[source] +-- +http://localhost:9080/syncope/rest +-- + +include::restful-reference.adoc[] + +include::client-library.adoc[] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/reference-guide/workingwithapachesyncope/workingwithapachesyncope.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/workingwithapachesyncope.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/workingwithapachesyncope.adoc new file mode 100644 index 0000000..c8777bf --- /dev/null +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/workingwithapachesyncope.adoc @@ -0,0 +1,51 @@ +// +// 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. +// +== Working with Apache Syncope + +Before moving forward, please ensure to have access to an Apache Syncope running deployment. +You can take a look at the +ifeval::["{backend}" == "html5"] +http://syncope.apache.org/docs/getting-started.html[Apache Syncope Getting Started Guide] +endif::[] +ifeval::["{backend}" == "pdf"] +http://syncope.apache.org/docs/getting-started.pdf[Apache Syncope Getting Started Guide] +endif::[] +to check system requirements and choose among the various options for obtaining Apache Syncope. + +include::adminconsole/adminconsole.adoc[] + +include::cli/cli.adoc[] + +include::restfulservices/restful-services.adoc[] + +=== Customization + +==== Core + +==== Console + +==== Enduser + +==== New extensions + +=== Deploying in production + +==== Options + +==== High-Availability \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/systemRequirements.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/systemRequirements.adoc b/src/main/asciidoc/systemRequirements.adoc deleted file mode 100644 index 4ebe7dc..0000000 --- a/src/main/asciidoc/systemRequirements.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. -// - -== System Requirements - -=== Hardware - -The hardware requirements depend greatly on the given deployment, in particular the total number of -managed entities (users, groups and any objects), their attributes and resources. - - * CPU: dual core, 2 GHz (minimum) - * RAM: 2 GB (minimum) - * Disk: 100 MB (minimum) - -=== Java - -Apache Syncope {docVersion} requires the latest JDK 7 or JDK 8 that is available. - -=== Java EE Container - -Apache Syncope {docVersion} is verified with the following Java EE containers: - - . http://tomcat.apache.org/download-80.cgi[Apache Tomcat 8^] - . https://glassfish.java.net/[Glassfish 4.1^] - . http://www.payara.fish/[Payara Server^] - . http://www.wildfly.org/[Wildfly 9^] - -=== Internal Storage - -Apache Syncope {docVersion} is verified with the recent versions of the following DBMSes, for internal storage: - - . http://www.postgresql.org/[PostgreSQL^] - . https://mariadb.org/[MariaDB^] - . http://www.mysql.com/[MySQL^] - . https://www.oracle.com/database/index.html[Oracle Database^] - . http://www.microsoft.com/en-us/server-cloud/products/sql-server/[MS SQL Server^] http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/usecases/usecases.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/usecases/usecases.adoc b/src/main/asciidoc/usecases/usecases.adoc deleted file mode 100644 index aa10511..0000000 --- a/src/main/asciidoc/usecases/usecases.adoc +++ /dev/null @@ -1,19 +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. -// -== Use cases \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/adminconsole/adminconsole.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/adminconsole/adminconsole.adoc b/src/main/asciidoc/workingwithapachesyncope/adminconsole/adminconsole.adoc deleted file mode 100644 index 6d4a76e..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/adminconsole/adminconsole.adoc +++ /dev/null @@ -1,32 +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. -// -=== Using the Admin Console -include::introduction.adoc[] - -include::dashboard.adoc[] - -include::realms.adoc[] - -include::topology.adoc[] - -include::reports.adoc[] - -include::configuration.adoc[] - -include::extensions.adoc[] http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/adminconsole/configuration.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/adminconsole/configuration.adoc b/src/main/asciidoc/workingwithapachesyncope/adminconsole/configuration.adoc deleted file mode 100644 index 87c4419..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/adminconsole/configuration.adoc +++ /dev/null @@ -1,60 +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 -The configuration tab allows the admin to customize the syncope deployment to fit the needs of the -organization. It provides the following functionality - -Audit:: - -Allows the admin to inspect the functionality of various components of the syncope deployment. - -Logs:: - -The admin can set the level of logs that are to be displayed. For example, the admin can set it -to display only the errors of io.swagger, in which case the warnings and information logs will -not be displayed. - -Notifications:: - -This allows the admin to set events and corresponding templates for mail notification to be sent -to the users. Trace level defines the condition in which an event will trigger the sending of a -notification. Templates for such notifications can also be added and edited using this tab. - -Parameters:: - -Presents the user with a list of key value pairs containing variables used in the syncope -deployment such as token.expireTime and password.cipher.algorithm . These can be edited by the -admin to further customize the deployment. - -Policies:: - -Allows the admin to define rules for account, passwords and pulls. Accounts and password policies -are defined using java classes while pull policies are defined from within the console using -correlation rules. - -Roles:: - -Displays and provides editing functionality for roles and their corresponding entitlements along -with the realms that they are enforced upon. - -Security Question:: - -The admin can use this to define a set of security questions which the endusers can choose from -to allow them to recover their account in case of a forgotten password. http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/adminconsole/dashboard.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/adminconsole/dashboard.adoc b/src/main/asciidoc/workingwithapachesyncope/adminconsole/dashboard.adoc deleted file mode 100644 index 51c3663..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/adminconsole/dashboard.adoc +++ /dev/null @@ -1,56 +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. -// - -===== Dashboard -The dashboard provides an overall view of the current state of the syncope deployment. It -consists of various widgets and tabs that show the different metrics and details of each component -of the syncope deployment. - -image::consoleDashboard.png[console-dashboard] - -Overview:: - -Contains widgets to display - -* Number of users -* Number of groups -* Number of external resource instances available (Printer as a default) -* Number of resources -* Configuration Status: Shows the status of missing or incomplete configurations. -* System Load: Shows the CPU and Memory usage of the syncope deployment on the server. -* User Status: Shows the status of tasks for admin such as provisioning resources to user. -* Users, Groups and Any Objects Distribution - -Control:: - -Allows admin to - -* Run a predefined list of jobs -* View Reconciliation status of recently run jobs - -Extensions:: - -The default syncope installation comes with camel metrics enabled which allows the user to see how -many - -* Users have been activated -* Passwords have been reset -* Objects have been created -* Groups have been created -* Group pulls have been created... http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/adminconsole/extensions.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/adminconsole/extensions.adoc b/src/main/asciidoc/workingwithapachesyncope/adminconsole/extensions.adoc deleted file mode 100644 index 2b67000..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/adminconsole/extensions.adoc +++ /dev/null @@ -1,26 +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. -// - -===== Extensions -The extensions tab shows the extensions installed on the given Apache Syncope deployment. - -Among the available extensions, the one for Apache Camel-based provisioning is often installed: users can inspect the -performance measures for the various routes defined. - -image::consoleCamelExtension.png[console-camel-extension] http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/adminconsole/introduction.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/adminconsole/introduction.adoc b/src/main/asciidoc/workingwithapachesyncope/adminconsole/introduction.adoc deleted file mode 100644 index 6a016cf..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/adminconsole/introduction.adoc +++ /dev/null @@ -1,33 +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 -Once Apache Syncope applications have been deployed, you can go to the following url to access the admin console. -[source] --- -http://host:port/syncope-console/ --- - -where `host` and `port` reflect your Java EE container installation. - -You should be greeted with the following web page. - -image::consoleLogin.png[console-login] - -The default admin password for a fresh installation is "password". Enter your credentials and press Login. http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/adminconsole/realms.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/adminconsole/realms.adoc b/src/main/asciidoc/workingwithapachesyncope/adminconsole/realms.adoc deleted file mode 100644 index 3f9d89f..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/adminconsole/realms.adoc +++ /dev/null @@ -1,63 +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. -// - -===== Realms -The realms tab provides the admin with the power to manage users, groups and any objects, for all any types defined. - -image::realmsUser.png[console-realms-user] - -User:: - -Allows the admin to - -* Create user -* Force password change for user -* Manage resources available to user -* Enable/Disable users -* Clone a user -* Edit user details -* View and edit propagation tasks of user -* View and edit notification tasks of user -* Delete user - -Group:: - -Allows admin to - -* Create group -* Clone a group -* Edit group details -* View, create and edit extensions -* View and edit propagation tasks of group -* View and edit notification tasks of group -* Provision members -* Deprovision members -* Delete group - -Printers:: - -The default syncope installation comes with printers add as a object. This can be reconfigured for -other things such as folders and services. - -* Add a new printer -* Clone a printer entry -* Edit printer details -* View and edit propagation tasks of printer -* View and edit notification tasks of printer -* Delete printer http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/adminconsole/reports.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/adminconsole/reports.adoc b/src/main/asciidoc/workingwithapachesyncope/adminconsole/reports.adoc deleted file mode 100644 index 907b9ae..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/adminconsole/reports.adoc +++ /dev/null @@ -1,32 +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. -// - -===== Reports -The reports tab presents the admin with the reports generated from various jobs run on the syncope -deployment. These reports are displayed using report templates which can be defined for FO, HTML -and CSV formats. This tab also allows the admin to create and edit such templates. - -Missing information: - -* reports can be run several times, each execution can be exported in the supported formats -* reports can be defined by composing reportlet instances -* predefined reportlets are available, more can be developed - -image::consoleReports.png[console-reports] - http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/adminconsole/topology.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/adminconsole/topology.adoc b/src/main/asciidoc/workingwithapachesyncope/adminconsole/topology.adoc deleted file mode 100644 index efbc43f2..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/adminconsole/topology.adoc +++ /dev/null @@ -1,26 +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. -// - -===== Topology -The topology tab provides a mapped view of the available connector bundles, instances and -resources available and configured in the syncope deployment. It also allows the admin to perform -all the actions listed in the realms tab. - -image::consoleTopology.png[console-topology] - http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/cli/cli.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/cli.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/cli.adoc deleted file mode 100644 index e573f12..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/cli/cli.adoc +++ /dev/null @@ -1,56 +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. -// -=== CLI -include::introduction.adoc[] - -include::installation.adoc[] - -include::connector.adoc[] - -include::question.adoc[] - -include::role.adoc[] - -include::configuration.adoc[] - -include::logger.adoc[] - -include::task.adoc[] - -include::notification.adoc[] - -include::schema.adoc[] - -include::user.adoc[] - -include::report.adoc[] - -include::resource.adoc[] - -include::policy.adoc[] - -include::info.adoc[] - -include::entitlement.adoc[] - -include::domain.adoc[] - -include::realm.adoc[] - -include::group.adoc[] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/cli/configuration.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/configuration.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/configuration.adoc deleted file mode 100644 index 31030e5..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/cli/configuration.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. -// - -==== Configuration command -The configuration command retrieves 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} - ----- - -===== Options - ---get:: -This get option shows a table with the Syncope configuration. ---read:: -The option to read the value of specified configuration attributes. ---update:: -The option to update a value of specified configuration attributes. ---delete:: -The option to delete specified configuration attributes. ---export:: -The option to export the Syncope configuration to a specified directory. http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/cli/connector.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/connector.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/connector.adoc deleted file mode 100644 index 4cd8973..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/cli/connector.adoc +++ /dev/null @@ -1,53 +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 information about 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} [...] ----- - -===== Options - ---details:: -This option shows a table with some details about connectors and bundles. ---list:: -Running the command with this option you will see the list of connectors with their configuration. ---list-bundles:: -Running the command with this option you will see the list of the bundles available in Syncope. ---list-configuration-properties:: -This option lists the configuration of specified connectors. ---read:: -The option to read all the information of specified connectors. ---delete:: -The option to delete a specified connector. http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/cli/domain.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/domain.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/domain.adoc deleted file mode 100644 index 0e37976..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/cli/domain.adoc +++ /dev/null @@ -1,44 +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 retrieves information about the configured domains. - -===== Help message -[source,bash] ----- -Usage: domain [options] - Options: - --help - --details - --list - --delete - Syntax: --delete {DOMAIN-NAME} {DOMAIN-NAME} [...] ----- - -===== Options - ---details:: -This option shows a table with domain amount. - ---list:: -Running the command with this option you will see the list of the domains. - ---delete:: -The option to delete a specified domain. http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/cli/entitlement.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/entitlement.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/entitlement.adoc deleted file mode 100644 index b87ce6d..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/cli/entitlement.adoc +++ /dev/null @@ -1,51 +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 retrieves 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} ----- - -===== Options - ---list:: -Running the command with this option you will see the list of the entitlements. ---list-role:: -Running the command with this option you will see the list of the roles with a certain entitlement. ---read-by-username:: -The option to read the entitlements of the username passed as input. ---read-by-userid:: -The option to read the entitlements of the userid passed as input. ---search-by-role:: -The option to read the entitlements of a certain role. http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/cli/group.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/group.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/group.adoc deleted file mode 100644 index e686cf9..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/cli/group.adoc +++ /dev/null @@ -1,54 +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 retrieves 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} [...] ----- - -===== Options - ---details:: -This option shows a table with the amount of available groups and some additional information. ---list:: -Running the command with this option you will see the list of the groups. ---read:: -The option to read the group passed as input. ---read-attr-by-schema-type:: -The option to read the specified attribute type of the group passed as input. ---read-attr-by-schema:: -The option to read the specified attribute name of the group passed as input. ---delete:: -The option to delete a specified group. http://git-wip-us.apache.org/repos/asf/syncope/blob/c95b6ff5/src/main/asciidoc/workingwithapachesyncope/cli/info.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/info.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/info.adoc deleted file mode 100644 index 9806110..0000000 --- a/src/main/asciidoc/workingwithapachesyncope/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 shows 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 -----
