http://git-wip-us.apache.org/repos/asf/syncope/blob/75387d7a/src/main/asciidoc/cli/schema.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/cli/schema.adoc b/src/main/asciidoc/cli/schema.adoc deleted file mode 100644 index 41f7a45..0000000 --- a/src/main/asciidoc/cli/schema.adoc +++ /dev/null @@ -1,303 +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. -// - -==== Schema command -The schema command serves retrieves information about the schema categories. - -===== 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 ----- - -===== Details option -This option shows a table with some details about the schemas and their categories. - -[source] --- -$ ./syncopeadm.sh schema --details --- - -[source] --- - -You are running: schema --details - -############################## -# # -# SCHEMAS DETAILS # -# # -############################## -# # # -# DETAIL # VALUE # -# # # -############################## -# # # -# total number # 57 # -# plain schema # 44 # -# derived schema # 10 # -# virtual schema # 3 # -# # # -############################## - --- - -===== List all option -Running the command with this option you will see the list of all (PLAIN, DERIVED, VIRTUAL) schemas configured. - -[source] --- -$ ./syncopeadm.sh schema --list-all --- - -===== List plain option -Running the command with this option you will see the list of the plain schemas available in Syncope. - -[source] --- -$ ./syncopeadm.sh schema --list-plain --- - -[source] --- - -You are running: schema --list-plain - -################################################################ -# # -# PLAIN SCHEMAS # -# # -################################################################ -# # # # -# SCHEMA KEY # TYPE # MANDATORY # -# # # # -################################################################ -# # # # -# password.cipher.algorithm # String # true # -# notificationjob.cronExpression # String # false # -# notification.maxRetries # Long # true # -# token.length # Long # true # -# token.expireTime # Long # true # -# selfRegistration.allowed # Boolean # true # -# passwordReset.allowed # Boolean # true # -# passwordReset.securityQuestion # Boolean # true # -# authentication.statuses # String # true # -# log.lastlogindate # Boolean # true # -# tasks.interruptMaxRetries # Long # true # -# return.password.value # Boolean # false # -# admin.user.layout # String # false # -# self.user.layout # String # false # -# admin.group.layout # String # false # -# self.group.layout # String # false # -# admin.membership.layout # String # false # -# self.membership.layout # String # false # -# fullname # String # true # -# userId # String # true # -# loginDate # Date # false # -# firstname # String # false # -# surname # String # true # -# type # String # false # -# email # String # false # -# activationDate # Date # false # -# uselessReadonly # String # false # -# cool # Boolean # false # -# gender # Enum # false # -# aLong # Long # false # -# makeItDouble # Long # false # -# obscure # Encrypted # false # -# photo # Binary # false # -# icon # String # false # -# show # Boolean # false # -# rderived_sx # String # false # -# rderived_dx # String # false # -# title # String # false # -# subscriptionDate # Date # false # -# mderived_sx # String # false # -# mderived_dx # String # false # -# postalAddress # String # false # -# model # String # false # -# location # String # false # -# # # # -################################################################ - --- - -===== List derived option -Running the command with this option you will see the list of the derived schemas available in Syncope with -their expressions. - -[source] --- -$ ./syncopeadm.sh schema --list-derived --- - -[source] --- - -You are running: schema --list-derived - -####################################################################################### -# # -# DERIVED SCHEMAS # -# # -####################################################################################### -# # # -# SCHEMA KEY # EXPRESSION # -# # # -####################################################################################### -# # # -# csvuserid # firstname + ',' + surname # -# cn # surname + ', ' + firstname # -# noschema # surname + ', ' + notfound # -# info # username + ' - ' + creationDate + '[' + failedLogins + ']' # -# rderiveddata # rderived_sx + '-' + rderived_dx # -# displayProperty # icon + ': ' + show # -# rderToBePropagated # rderived_sx + '-' + rderived_dx # -# rderivedschema # rderived_sx + '-' + rderived_dx # -# mderiveddata # mderived_sx + '-' + mderived_dx # -# mderToBePropagated # mderived_sx + '-' + mderived_dx # -# # # -####################################################################################### - --- - -===== List virtual option -Running the command with this option you will see the list of the virtual schemas available in Syncope. - -[source] --- -$ ./syncopeadm.sh schema --list-virtual --- - -[source] --- - -You are running: schema --list-virtual - -################################## -# # -# VIRTUAL SCHEMAS # -# # -################################## -# # # -# SCHEMA KEY # READONLY # -# # # -################################## -# # # -# virtualReadOnly # true # -# rvirtualdata # false # -# virtualdata # false # -# # # -################################## - --- - -===== Read option -The option to read all the information of a specified schema. - -[source] --- -$ ./syncopeadm.sh schema --read {SCHEMA-TYPE} {SCHEMA-KEY} - Schema type: PLAIN / DERIVED / VIRTUAL --- - -Unlike the list option, the read option shows the schema passed as input and, in case of PLAIN category, the full -attributes of the schema. - -[source] --- - -You are running: schema --read PLAIN email - - > SCHEMA ID: email - type: String - any type class: minimal user - conversion pattern: null - mandatory condition: false - mime type: null - validator class: org.apache.syncope.core.persistence.jpa.attrvalue.validation.EmailAddressValidator - cipher algorithm: - --- -[source] --- - -You are running: schema --read DERIVED info - -############################################################################### -# # -# DERIVED SCHEMAS # -# # -############################################################################### -# # # -# SCHEMA KEY # EXPRESSION # -# # # -############################################################################### -# # # -# info # username + ' - ' + creationDate + '[' + failedLogins + ']' # -# # # -############################################################################### - --- -[source] --- - -You are running: schema --read VIRTUAL virtualReadOnly - -################################## -# # -# VIRTUAL SCHEMAS # -# # -################################## -# # # -# SCHEMA KEY # READONLY # -# # # -################################## -# # # -# virtualReadOnly # true # -# # # -################################## - --- - -===== Delete option -The option to delete a specified schema. - -[source] --- -$ ./syncopeadm.sh schema --delete {SCHEMA-TYPE} {SCHEMA-KEY} - Schema type: PLAIN / DERIVED / VIRTUAL --- - -The delete option, as can be imagined, tries to remove a specified schema. -[source] --- - - Schema {SCHEMA-KEY} successfully deleted ---
http://git-wip-us.apache.org/repos/asf/syncope/blob/75387d7a/src/main/asciidoc/cli/task.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/cli/task.adoc b/src/main/asciidoc/cli/task.adoc deleted file mode 100644 index fb1f573..0000000 --- a/src/main/asciidoc/cli/task.adoc +++ /dev/null @@ -1,315 +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. -// - -==== Task command -The Task command retrieves information about the Task configuration in Apache Syncope. - -===== Help message -[source,bash] ----- -Usage: task [options] - Options: - --help - --details - --list - Syntax: --list {TASK-TYPE} - Task type: NOTIFICATION / PROPAGATION / PUSH / SCHEDULED / SYNCHRONIZATION - --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 ----- - -===== Details option -This option shows a table with some details about tasks and jobs. - -[source] --- -$ ./syncopeadm.sh task --details --- - -[source] --- - -You are running: task --details - -############################################################## -# # -# TASKS DETAILS # -# # -############################################################## -# # # -# DETAIL # VALUE # -# # # -############################################################## -# # # -# total number # 28 # -# notification tasks # 1 # -# notification tasks not executed # 1 # -# propagation tasks # 5 # -# propagation tasks not executed # 3 # -# push tasks # 11 # -# push tasks not executed # 11 # -# scheduled tasks # 1 # -# scheduled tasks not executed # 1 # -# synchronization tasks # 10 # -# synchronization tasks not executed # 10 # -# synchronization tasks with full reconciliation # 5 # -# running jobs # 0 # -# scheduled jobs # 1 # -# # # -############################################################## - --- - -===== List option -Running the command with this option you will see the list of selected tasks type with their information. - -[source] --- -$ ./syncopeadm.sh - task --list {TASK-TYPE} - Task type: NOTIFICATION / PROPAGATION / PUSH / SCHEDULED / SYNCHRONIZATION --- - -[source] --- - -You are running: task --list SCHEDULED - - - Scheduled task key: 5 - name: SampleJob Task - cron expression: 0 0 0 1 * ? - description: null - start date: null - end date: null - last execution: null - next execution: Tue Dec 01 00:00:00 CET 2015 - latest execution status: - job delegate class: org.apache.syncope.fit.core.reference.TestSampleJobDelegate - --- - -The last snippet code shows the information of the scheduled tasks. - -===== List running jobs -Running the command with this option you will see the list of the actual running jobs. - -[source] --- -$ ./syncopeadm.sh task --list-running-jobs --- - -[source] --- - - There are NO running jobs available --- - -===== List scheduled jobs -Running the command with this option you will see the list of the actual scheduled jobs. - -[source] --- -$ ./syncopeadm.sh task --list-scheduled-jobs --- - -[source] --- - EXECUTIONS: - - task execution key: 0 - task: 5 - message: - ############### <BEGIN MESSAGE> ############### - message: null - ############### <END MESSAGE> ############### - status: NORMAL - start date: Fri Nov 27 15:11:23 CET 2015 - end date: null --- - -===== Read option -The option to read all the information of specified tasks. - -[source] --- -$ ./syncopeadm.sh task --read {TASK-ID} {TASK-ID} [...] --- - -Unlike the list option, the read option shows only the tasks passed as input. Below the commad to read the task with -id 13 -[source] --- -You are running: task --read 13 - - - Push task key: 13 - name: Export on resource-testdb2 - resource: resource-testdb2 - cron expression: null - description: null - is perform create: true - is perform delete: true - is perform update: true - is sync status: true - start date: null - end date: null - last execution: null - next execution: null - latest execution status: - filters: {GROUP=name==_NO_ONE_, USER=surname==Vivaldi} - delegate class: null - action class: [] - matching rule: IGNORE - not matching rule: ASSIGN --- - -===== Read execution option -The option to read all the information of executions task. - -[source] --- -$ ./syncopeadm.sh task --read-execution {TASK-EXEC-ID} {TASK-EXEC-ID} [...] --- - -===== Delete option -The option to delete specified tasks. - -[source] --- -$ ./syncopeadm.sh task --delete {TASK-ID} TASK-ID} [...] --- - -The delete option, as can be imagined, tries to remove specified tasks. -[source] --- - - task {TASK-ID} successfully deleted --- - -===== Delete execution option -The option to delete specified execution tasks. -[source] --- -$ ./syncopeadm.sh task --delete {TASK-EXEC-ID} {TASK-EXEC-ID} [...] --- - -The delete option, as can be imagined, tries to remove specified execution tasks. -[source] --- - - task {TASK-EXEC-ID} successfully deleted --- - -===== Execute option -The option to execute specified execution tasks. -[source] --- -$ ./syncopeadm.sh task --execute {TASK-ID} {DRY-RUN} - Dry run: true / false --- - -For instance, executing the PUSH task with id 13 in dry run mode the result is -[source] --- - You are running: task --execute 13 false - EXECUTIONS: - - task execution key: 0 - task: 13 - message: - ############### <BEGIN MESSAGE> ############### - message: Job fired; waiting for results... - ############### <END MESSAGE> ############### - status: JOB_FIRED - start date: Fri Nov 27 16:02:24 CET 2015 - end date: null --- -then reading again the task id you will find the execution results among the other task information -[source] --- -- Push task key: 13 - name: Export on resource-testdb2 - resource: resource-testdb2 - cron expression: null - description: null - is perform create: true - is perform delete: true - is perform update: true - is sync status: true - start date: Fri Nov 27 16:02:24 CET 2015 - end date: Fri Nov 27 16:02:26 CET 2015 - last execution: null - next execution: null - latest execution status: SUCCESS - filters: {GROUP=name==_NO_ONE_, USER=surname==Vivaldi} - delegate class: null - action class: [] - matching rule: IGNORE - not matching rule: ASSIGN - EXECUTIONS: - - task execution key: 15 - task: 13 - message: - ############### <BEGIN MESSAGE> ############### - message: Users [created/failures]: 1/0 [updated/failures]: 0/0 [deleted/failures]: 0/0 [no operation/ignored]: 0/0 -Groups [created/failures]: 0/0 [updated/failures]: 0/0 [deleted/failures]: 0/0 [no operation/ignored]: 0/0 -Any objects [created/failures]: 0/0 [updated/failures]: 0/0 [deleted/failures]: 0/0 [no operation/ignored]: 0/0 - -Users created: -CREATE SUCCESS (id/name): 3/vivaldi - -Users updated: - -Users deleted: - -Users no operation: - -Users ignored: - - -Groups created: - -Groups updated: - -Groups deleted: - -Groups no operation: - -Groups ignored: - - -Any objects created: - -Any objects updated: - -Any objects deleted: - -Any objects no operation: - -Any objects ignored: - - ############### <END MESSAGE> ############### - status: SUCCESS - start date: Fri Nov 27 16:02:24 CET 2015 - end date: Fri Nov 27 16:02:26 CET 2015 --- http://git-wip-us.apache.org/repos/asf/syncope/blob/75387d7a/src/main/asciidoc/cli/user.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/cli/user.adoc b/src/main/asciidoc/cli/user.adoc deleted file mode 100644 index ed2715c..0000000 --- a/src/main/asciidoc/cli/user.adoc +++ /dev/null @@ -1,533 +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. -// - -==== User command -The user command retrieves information about the users. - -===== 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 - Syntax: --read {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} ----- - -===== Details option -This option shows a table with some details about the users. - -[source] --- -$ ./syncopeadm.sh user --details --- - -[source] --- - -You are running: user --details - -################################# -# # -# USERS DETAILS # -# # -################################# -# # # -# DETAIL # VALUE # -# # # -################################# -# # # -# Total number # 5 # -# Active # 5 # -# Suspended # 0 # -# Without resources # 0 # -# Without roles # 2 # -# # # -################################# - --- - -===== 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. - -[source] --- -$ ./syncopeadm.sh user --list --- -[source] --- -You are running: user --list - -This operation might produce very large output. Do you want to continue? [yes/no] -yes - - > USER ID: 2 - username: verdi - realm: / - status: active - RESOURCES: - - ws-target-resource-list-mappings-1 - - ws-target-resource-list-mappings-2 - ROLES: - creation date: Wed Oct 20 11:00:00 CEST 2010 - change password date: null - PLAIN ATTRIBUTES: - fullname: [Giuseppe Verdi] - firstname: [Giuseppe] - surname: [Verdi] - userId: [ve...@apache.org] - email: [ve...@syncope.org] - DERIVED ATTRIBUTES: - info: [verdi - 2010-10-20T11:00:00+0200[0]] - is readonly. - noschema: [Verdi, ] - is readonly. - cn: [Verdi, Giuseppe] - is readonly. - VIRTUAL ATTRIBUTES: - creator: admin - last modifier: admin - token: null - token expiration time: null - last change: Wed Oct 20 11:00:00 CEST 2010 - last login: null - failed logins: 0 -RELATIONSHIPS: - security question id: null - security question answer id: null - --- - -===== Get user key option -The option to get the user key starting from a username. - -[source] --- -$ ./syncopeadm.sh user --get-user-key {USERNAME} --- - -[source] --- -You are running: user --get-user-key rossini - - - rossini user ID is 1 --- - -===== Get username option -The option to get the username starting from a user id. - -[source] --- -$ ./syncopeadm.sh user --get-user-key {USER-ID} --- - -[source] --- -You are running: user --get-username 1 - - - 1 username is rossini --- - -===== Read by user id option -The option to read user information by their user id. - -[source] --- -$ ./syncopeadm.sh user --read {USER-ID} {USER-ID} [...] --- - -[source] --- - -You are running: user --read 1 - - > USER ID: 1 - username: rossini - realm: /even - status: active - RESOURCES: - - resource-testdb2 - - ws-target-resource-2 - ROLES: - - Other - creation date: Wed Oct 20 11:00:00 CEST 2010 - change password date: null - PLAIN ATTRIBUTES: - type: [G] - fullname: [Gioacchino Rossini] - firstname: [Gioacchino] - surname: [Rossini] - userId: [ross...@apache.org] - loginDate: [2009-05-26, 2010-05-26] - DERIVED ATTRIBUTES: - info: [rossini - 2010-10-20[0]] - is readonly. - noschema: [Rossini, ] - is readonly. - cn: [Rossini, Gioacchino] - is readonly. - VIRTUAL ATTRIBUTES: - creator: admin - last modifier: admin - token: null - token expiration time: null - last change: Wed Oct 20 11:00:00 CEST 2010 - last login: null - failed logins: 0 -RELATIONSHIPS: - security question id: null - security question answer id: null - --- - -===== Read by username option -The option to read user information by their username. - -[source] --- -$ ./syncopeadm.sh user --read {USERNAME} {USERNAME} [...] --- - -[source] --- - -You are running: user --read rossini - - > USER ID: 1 - username: rossini - realm: /even - status: active - RESOURCES: - - resource-testdb2 - - ws-target-resource-2 - ROLES: - - Other - creation date: Wed Oct 20 11:00:00 CEST 2010 - change password date: null - PLAIN ATTRIBUTES: - type: [G] - fullname: [Gioacchino Rossini] - firstname: [Gioacchino] - surname: [Rossini] - userId: [ross...@apache.org] - loginDate: [2009-05-26, 2010-05-26] - DERIVED ATTRIBUTES: - info: [rossini - 2010-10-20[0]] - is readonly. - noschema: [Rossini, ] - is readonly. - cn: [Rossini, Gioacchino] - is readonly. - VIRTUAL ATTRIBUTES: - creator: admin - last modifier: admin - token: null - token expiration time: null - last change: Wed Oct 20 11:00:00 CEST 2010 - last login: null - failed logins: 0 -RELATIONSHIPS: - security question id: null - security question answer id: null - --- - -===== Search by attribute option -The option to search a list of users with a common attribute. - -[source] --- -$ ./syncopeadm.sh user --search-by-attribute {REALM} {ATTR-NAME}={ATTR-VALUE} --- - -For instance if you want to search the active users under the root realm: - -[source] --- - -You are running: user --search-by-attribute / status=active - - > USER ID: 2 - username: verdi - realm: / - status: active - RESOURCES: - - ws-target-resource-list-mappings-1 - - ws-target-resource-list-mappings-2 - ROLES: - creation date: Wed Oct 20 11:00:00 CEST 2010 - change password date: null - PLAIN ATTRIBUTES: - fullname: [Giuseppe Verdi] - firstname: [Giuseppe] - surname: [Verdi] - userId: [ve...@apache.org] - email: [ve...@syncope.org] - DERIVED ATTRIBUTES: - info: [verdi - 2010-10-20T11:00:00+0200[0]] - is readonly. - noschema: [Verdi, ] - is readonly. - cn: [Verdi, Giuseppe] - is readonly. - VIRTUAL ATTRIBUTES: - creator: admin - last modifier: admin - token: null - token expiration time: null - last change: Wed Oct 20 11:00:00 CEST 2010 - last login: null - failed logins: 0 -RELATIONSHIPS: - security question id: null - security question answer id: null - - > USER ID: 3 - username: vivaldi - realm: / - status: active - RESOURCES: - - ws-target-resource-delete - - ws-target-resource-1 - - ws-target-resource-2 -[...] --- - -===== Search by role option -The option to search a list of users with a specified role. - -[source] --- -$ ./syncopeadm.sh user --search-by-role {REALM} {ROLE-NAME} --- - -[source] --- - -You are running: user --search-by-role / Other - - > USER ID: 1 - username: rossini - realm: /even - status: active - RESOURCES: - - resource-testdb2 - - ws-target-resource-2 - ROLES: - - Other - creation date: Wed Oct 20 11:00:00 CEST 2010 - change password date: null - PLAIN ATTRIBUTES: - type: [G] - fullname: [Gioacchino Rossini] - firstname: [Gioacchino] - surname: [Rossini] - userId: [ross...@apache.org] - loginDate: [2009-05-26, 2010-05-26] - DERIVED ATTRIBUTES: - info: [rossini - 2010-10-20[0]] - is readonly. - noschema: [Rossini, ] - is readonly. - cn: [Rossini, Gioacchino] - is readonly. - VIRTUAL ATTRIBUTES: - creator: admin - last modifier: admin - token: null - token expiration time: null - last change: Wed Oct 20 11:00:00 CEST 2010 - last login: null - failed logins: 0 -RELATIONSHIPS: - security question id: null - security question answer id: null - --- - -===== Search by resource option -The option to search a list of users with a specified resource. - -[source] --- -$ ./syncopeadm.sh user --search-by-resource {REALM} {RESOURCE-NAME} --- - -[source] --- - -You are running: user --search-by-resource / ws-target-resource-2 - - > USER ID: 3 - username: vivaldi - realm: / - status: active - RESOURCES: - - ws-target-resource-delete - - ws-target-resource-1 - - ws-target-resource-2 - ROLES: - creation date: Wed Oct 20 11:00:00 CEST 2010 - change password date: null - PLAIN ATTRIBUTES: - firstname: [Antonio] - surname: [Vivaldi] - fullname: [Antonio Vivaldi] - userId: [viva...@apache.org] - email: [viva...@syncope.org] - type: [F] - DERIVED ATTRIBUTES: - cn: [Vivaldi, Antonio] - is readonly. - noschema: [Vivaldi, ] - is readonly. - info: [vivaldi - 2010-10-20T11:00:00+0200[0]] - is readonly. - VIRTUAL ATTRIBUTES: - creator: admin - last modifier: admin - token: null - token expiration time: null - last change: Wed Oct 20 11:00:00 CEST 2010 - last login: null - failed logins: 0 -RELATIONSHIPS: - security question id: null - security question answer id: null - - > USER ID: 1 - username: rossini - realm: /even - status: active - RESOURCES: - - resource-testdb2 - - ws-target-resource-2 - ROLES: - - Other - creation date: Wed Oct 20 11:00:00 CEST 2010 - change password date: null - PLAIN ATTRIBUTES: - type: [G] - fullname: [Gioacchino Rossini] - firstname: [Gioacchino] - surname: [Rossini] - userId: [ross...@apache.org] - loginDate: [2009-05-26, 2010-05-26] - DERIVED ATTRIBUTES: - info: [rossini - 2010-10-20[0]] - is readonly. - noschema: [Rossini, ] - is readonly. - cn: [Rossini, Gioacchino] - is readonly. - VIRTUAL ATTRIBUTES: - creator: admin - last modifier: admin - token: null - token expiration time: null - last change: Wed Oct 20 11:00:00 CEST 2010 - last login: null - failed logins: 0 -RELATIONSHIPS: - security question id: null - security question answer id: null - --- - -===== Delete option -The option to delete a specified user. - -[source] --- -$ ./syncopeadm.sh user --delete {{USER-ID} {USER-ID} [...] --- - -The delete option, as can be imagined, tries to remove a specified user. -[source] --- - - User {USER-ID} successfully deleted --- - -===== Delete by attribute option -The option to delete the users with a common attribute. - -[source] --- -$ ./syncopeadm.sh user --delete-by-attribute {REALM} {ATTR-NAME}={ATTR-VALUE} --- - -[source] --- - You are running: user --delete-by-attribute / surname=Rossini - - - Deleted users: 1 --- - -===== Delete all option -The option to delete all users of the realm passed as input. - -[source] --- -$ ./syncopeadm.sh user --delete-all {REALM} --- - -The delete option, as can be imagined, tries to remove every user under the specified realm. - -[NOTE] -To run this operation the system asks you again for the admin credential. - -[source] --- -You are running: user --delete-all / - -Running this operation you will delete all the realm users managed by Syncope, are you sure? [yes/no] -yes - -Username: -admin - -Password: -password -Deleting process started - - - Deleted users: 2 - -######################### -# # -# USERS NOT DELETED # -# # -######################### -# # # -# USER ID # CAUSE # -# # # -######################### -# # # -# 5 # FAILURE # -# # # -######################### - --- - -The output is composed of two parts. The first one is the number of deleted users; the second one is a table with the users (user id) who aren't removed. - -To know the reason why the deletion failed you need to run the command with the standard delete option. - -[source] --- -You are running: user --delete 5 - - - Error: GroupOwnership [6 director] --- http://git-wip-us.apache.org/repos/asf/syncope/blob/75387d7a/src/main/asciidoc/concepts/concepts.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/concepts/concepts.adoc b/src/main/asciidoc/concepts/concepts.adoc new file mode 100644 index 0000000..2798816 --- /dev/null +++ b/src/main/asciidoc/concepts/concepts.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. +// +== Concepts + +=== Data model + +==== Schema + +==== Attributes + +==== Users, Groups and Any objects + +==== Realms + +==== Domains + +=== Tasks + +=== Provisioning + +==== Connectors + +==== Resources + +==== Propagation, Push & Synchronization + +=== Policies + +==== Account + +==== Password + +==== Push + +==== Synchronization + +=== Workflow and Approval + +=== Notifications + +=== Reports + +=== Audit + +=== Delegated Administration \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/75387d7a/src/main/asciidoc/extensions/extensions.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/extensions/extensions.adoc b/src/main/asciidoc/extensions/extensions.adoc new file mode 100644 index 0000000..7da12d7 --- /dev/null +++ b/src/main/asciidoc/extensions/extensions.adoc @@ -0,0 +1,21 @@ +// +// 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 + +=== Apache Camel \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/75387d7a/src/main/asciidoc/iam/accessmanager.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/iam/accessmanager.adoc b/src/main/asciidoc/iam/accessmanager.adoc new file mode 100644 index 0000000..4235694 --- /dev/null +++ b/src/main/asciidoc/iam/accessmanager.adoc @@ -0,0 +1,23 @@ +// +// 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. +// +=== Access Managers +As briefly mentioned before, an access manager is not an identity manager. An access management software manages above all +the authentication on a given environment. It provides the methods, generally called authentication module, to manage +the user authentication, the latter based on various identification system as the password, the fingerprint or based on +various protocols as SAML and OAuth 2.0. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/75387d7a/src/main/asciidoc/iam/iam.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/iam/iam.adoc b/src/main/asciidoc/iam/iam.adoc index a781255..f0417d5 100644 --- a/src/main/asciidoc/iam/iam.adoc +++ b/src/main/asciidoc/iam/iam.adoc @@ -27,44 +27,10 @@ environment providing some kind of credentials; on the countray the identity man profile and its life cicle. Apache Syncope is an identity manager. -=== Identity Stores -An identity store is the place where the digital identity are stored. Of course there are various store types, the most -famous are: +include::identitystores.adoc[] -* Microsoft Active Directory; -* LDAP -** OpenLDAP; -** FreeIPA; -** ForgeRock OpenDJ; -** 389 Directory Server; -* DBMS -** MySQL -** PostgreSQL -** Oracle -* ... +include::provisioningengines.adoc[] -From Apache Syncope point of view, an identity stores is viewed as an integrated resource with a communication based -on the identity connectors. +include::accessmanager.adoc[] -=== Provisioning Engines -A provisioning engine is a software able to execute some operation on the profile of a digital identity. -Precisely this operation could be run to manage a user life cicle, the _CRUD_ operation to persiste the user on an -identity store: - -* Create -* Read -* Update -* Delete - -or could be the operations albe to modify the user profile in order to activate or deactivate its digital identity, or -could be the operations to add or remove a role from an user profile to achieve the RBAC (Role-based access control) -in an enviroment and so on. Definitely a provisioning angine manages the digital identity user profile in a centralized -way. - -=== Access Managers -As briefly mentioned before, an access manager is not an identity manager. An access management software manages above all -the authentication on a given environment. It provides the methods, generally called authentication module, to manage -the user authentication, the latter based on various identification system as the password, the fingerprint or based on -various protocols as SAML and OAuth 2.0. - -=== The Complete Picture \ No newline at end of file +include::thecompletepicture.adoc[] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/75387d7a/src/main/asciidoc/iam/identitystores.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/iam/identitystores.adoc b/src/main/asciidoc/iam/identitystores.adoc new file mode 100644 index 0000000..103be19 --- /dev/null +++ b/src/main/asciidoc/iam/identitystores.adoc @@ -0,0 +1,36 @@ +// +// 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. +// +=== Identity Stores +An identity store is the place where the digital identity are stored. Of course there are various store types, the most +famous are: + +* Microsoft Active Directory; +* LDAP +** OpenLDAP; +** FreeIPA; +** ForgeRock OpenDJ; +** 389 Directory Server; +* DBMS +** MySQL +** PostgreSQL +** Oracle +* ... + +From Apache Syncope point of view, an identity stores is viewed as an integrated resource with a communication based +on the identity connectors. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/75387d7a/src/main/asciidoc/iam/provisioningengines.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/iam/provisioningengines.adoc b/src/main/asciidoc/iam/provisioningengines.adoc new file mode 100644 index 0000000..946cadd --- /dev/null +++ b/src/main/asciidoc/iam/provisioningengines.adoc @@ -0,0 +1,32 @@ +// +// 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. +// +=== Provisioning Engines +A provisioning engine is a software able to execute some operation on the profile of a digital identity. +Precisely this operation could be run to manage a user life cicle, the _CRUD_ operation to persiste the user on an +identity store: + +* Create +* Read +* Update +* Delete + +or could be the operations albe to modify the user profile in order to activate or deactivate its digital identity, or +could be the operations to add or remove a role from an user profile to achieve the RBAC (Role-based access control) +in an enviroment and so on. Definitely a provisioning angine manages the digital identity user profile in a centralized +way. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/75387d7a/src/main/asciidoc/iam/thecompletepicture.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/iam/thecompletepicture.adoc b/src/main/asciidoc/iam/thecompletepicture.adoc new file mode 100644 index 0000000..5264ebf --- /dev/null +++ b/src/main/asciidoc/iam/thecompletepicture.adoc @@ -0,0 +1,19 @@ +// +// 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. +// +=== The Complete Picture \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/75387d7a/src/main/asciidoc/reference-guide.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide.adoc b/src/main/asciidoc/reference-guide.adoc index 250e87f..d34d1e8 100644 --- a/src/main/asciidoc/reference-guide.adoc +++ b/src/main/asciidoc/reference-guide.adoc @@ -54,87 +54,23 @@ provisioning, and compliance. include::introduction/introduction.adoc[] +// miss one paraghraph include::iam/iam.adoc[] -== Architecture +// TO DO +include::architecture/architecture.adoc[] -=== Design Principles +// TO DO +include::concepts/concepts.adoc[] -=== Implementation Guidelines +// TO DO (CLI and restful: done) +include::workingwithapachesyncope/workingwithapachesyncope.adoc[] -== Concepts +// TO DO +include::extensions/extensions.adoc[] -=== Data model - -==== Schema - -==== Attributes - -==== Users, Groups and Any objects - -==== Realms - -==== Domains - -=== Tasks - -=== Provisioning - -==== Connectors - -==== Resources - -==== Propagation, Push & Synchronization - -=== Policies - -==== Account - -==== Password - -==== Push - -==== Synchronization - -=== Workflow and Approval - -=== Notifications - -=== Reports - -=== Audit - -=== Delegated Administration - -== Working with Apache Syncope - -=== Using the Admin Console - -=== CLI -include::cli/cli.adoc[] - -=== RESTful services -include::restfulservices/restful-services.adoc[] - -=== Customization - -==== Core - -==== Console - -==== New extensions - -=== Deploying in production - -=== Options - -=== High-Availability - -== Extensions - -=== Apache Camel - -== Use Cases +// TO DO +include::usecases/usecases.adoc[] // Chapters will be placed in separate .adoc files in the same directory //include::XXX.adoc[] http://git-wip-us.apache.org/repos/asf/syncope/blob/75387d7a/src/main/asciidoc/restfulservices/client-library.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/restfulservices/client-library.adoc b/src/main/asciidoc/restfulservices/client-library.adoc deleted file mode 100644 index 018027e..0000000 --- a/src/main/asciidoc/restfulservices/client-library.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. -// - -==== 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/75387d7a/src/main/asciidoc/restfulservices/restful-reference.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/restfulservices/restful-reference.adoc b/src/main/asciidoc/restfulservices/restful-reference.adoc deleted file mode 100644 index 73bcf83..0000000 --- a/src/main/asciidoc/restfulservices/restful-reference.adoc +++ /dev/null @@ -1,62 +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. -// -==== 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 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] http://git-wip-us.apache.org/repos/asf/syncope/blob/75387d7a/src/main/asciidoc/restfulservices/restful-services.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/restfulservices/restful-services.adoc b/src/main/asciidoc/restfulservices/restful-services.adoc deleted file mode 100644 index 3ebd519..0000000 --- a/src/main/asciidoc/restfulservices/restful-services.adoc +++ /dev/null @@ -1,29 +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. -// -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/75387d7a/src/main/asciidoc/usecases/usecases.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/usecases/usecases.adoc b/src/main/asciidoc/usecases/usecases.adoc new file mode 100644 index 0000000..aa10511 --- /dev/null +++ b/src/main/asciidoc/usecases/usecases.adoc @@ -0,0 +1,19 @@ +// +// 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/75387d7a/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 new file mode 100644 index 0000000..e573f12 --- /dev/null +++ b/src/main/asciidoc/workingwithapachesyncope/cli/cli.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. +// +=== 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/75387d7a/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 new file mode 100644 index 0000000..2ad6490 --- /dev/null +++ b/src/main/asciidoc/workingwithapachesyncope/cli/configuration.adoc @@ -0,0 +1,171 @@ +// +// 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} + +---- + +===== Get option +This get option shows a table with the Syncope configuration. + +[source] +-- +$ ./syncopeadm.sh configuration --get +-- + +[source] +-- + +You are running: configuration --get + +######################################################## +# # +# SYNCOPE CONFIGURATION # +# # +######################################################## +# # # +# ATTRIBUTE # VALUE # +# # # +######################################################## +# # # +# password.cipher.algorithm # SHA1 # +# notificationjob.cronExpression # 0/20 * * * * ? # +# notification.maxRetries # 3 # +# token.length # 256 # +# token.expireTime # 60 # +# selfRegistration.allowed # true # +# passwordReset.allowed # true # +# passwordReset.securityQuestion # true # +# authentication.statuses # created, active # +# log.lastlogindate # true # +# tasks.interruptMaxRetries # 20 # +# return.password.value # false # +# # # +######################################################## + +-- + +===== Read option +The option to read the value of specified configuration attributes. + +[source] +-- +$ ./syncopeadm.sh configuration --read {CONF-NAME} {CONF-NAME} [...] +-- + +[source] +-- + +You are running: configuration --read passwordReset.allowed + +##################################### +# # +# SYNCOPE CONFIGURATION # +# # +##################################### +# # # +# ATTRIBUTE # VALUE # +# # # +##################################### +# # # +# passwordReset.allowed # true # +# # # +##################################### + +-- + +===== Update option +The option to update a value of specified configuration attributes. + +[source] +-- +$ ./syncopeadm.sh configuration --update {CONF-NAME}={CONF-VALUE} {CONF-NAME}={CONF-VALUE} [...] +-- + +[source] +-- + +You are running: configuration --update passwordReset.allowed=false + +##################################### +# # +# UPDATED CONFIGURATION ATTRIBUTES # +# # +##################################### +# # # +# ATTRIBUTE # VALUE # +# # # +##################################### +# # # +# passwordReset.allowed # false # +# # # +##################################### + +-- + +===== Delete option +The option to delete specified configuration attributes. + +[source] +-- +$ ./syncopeadm.sh configuration --delete {CONF-NAME} {CONF-NAME} [...] +-- + +The delete option, as can be imagined, tries to remove the specified configurations. The output will be something like: +[source] +-- + - Configuration {CONF-NAME} successfully deleted +-- + +===== Export option +The option to export the Syncope configuration to a specified directory. + +[source] +-- +$ ./syncopeadm.sh - Usage: configuration --export {WHERE-DIR} +-- + +[source,xml] +---- +<?xml version="1.0" encoding="UTF-8" standalone="no"?><dataset> +<RELATIONSHIPTYPE DESCRIPTION="Models the act that an object is included in another" NAME="inclusion"/> +<RELATIONSHIPTYPE NAME="neighborhood"/> +<PASSWORDPOLICY ALLOWNULLPASSWORD="1" DESCRIPTION="a password policy" HISTORYLENGTH="1" ID="2" TYPE="PASSWORD"/> +<PASSWORDPOLICY ALLOWNULLPASSWORD="1" DESCRIPTION="sample password policy" HISTORYLENGTH="0" ID="4" TYPE="PASSWORD"/> +<PASSWORDPOLICY ALLOWNULLPASSWORD="0" DESCRIPTION="sample password policy" HISTORYLENGTH="0" ID="8" TYPE="PASSWORD"/> + +[...] +---- http://git-wip-us.apache.org/repos/asf/syncope/blob/75387d7a/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 new file mode 100644 index 0000000..51b622d --- /dev/null +++ b/src/main/asciidoc/workingwithapachesyncope/cli/connector.adoc @@ -0,0 +1,259 @@ +// +// 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} [...] +---- + +===== Details option +This option shows a table with some details about connectors and bundles. + +[source] +-- +$ ./syncopeadm.sh connector --details +-- + +[source] +-- + +You are running: connector --details + +###################################### +# # +# CONNECTORS DETAILS # +# # +###################################### +# # # +# DETAIL # VALUE # +# # # +###################################### +# # # +# Total number # 9 # +# With create capability # 8 # +# With delete capability # 7 # +# With search capability # 8 # +# With sync capability # 4 # +# With update capability # 8 # +# Bundles number # 8 # +# # # +###################################### + +-- + +Total number:: + number of created connectors; +With create capability:: + number of connectors configured with create capability; +With delete capability:: + number of connectors configured with delete capability; +With search capability:: + number of connectors configured with search capability; +With sync capability:: + number of connectors configured with sync capability; +With update capability:: + number of connectors configured with update capability; +Bundles number:: + number of bundles read by Syncope. + +===== List option +Running the command with this option you will see the list of connectors with their configuration. + +[source] +-- +$ ./syncopeadm.sh connector --list +-- + +[source] +-- + +You are running: connector --list + + > CONNECTOR ID: 108 + bundle name: net.tirasa.connid.bundles.db.scriptedsql + connector name: net.tirasa.connid.bundles.db.scriptedsql.ScriptedSQLConnector + display name: Scripted SQL + location: connid://testconnectorserver@localhost:4554 + version: 2.2.3-SNAPSHOT + timeout: 10 + CAPABILITIES: + - CREATE + - SEARCH + - DELETE + - UPDATE + - SYNC + CONFIGURATION: + name: enableEmptyString + values: [false] + type: boolean + display name: Enable writing empty string + help message: <b>Enable writing empty string</b><br/>Select to enable support for writing an empty strings, instead of a NULL value, in character based columns defined as not-null in the table schema. This option does not influence the way strings are written for Oracle based tables. By default empty strings are written as a NULL value. + order: 12 + default values: [false] + confidential: false + required: false + overridable: false + + name: autoCommit + values: [true] + type: boolean + display name: autoCommit + help message: autoCommit + order: 0 + default values: [true] + confidential: false + required: false + overridable: false + + name: testScriptFileName + values: [/home/massi/Lavoro/syncopeMaster/fit/core-reference/target/test-classes/scriptedsql/TestScript.groovy] + type: java.lang.String + display name: testScriptFileName + help message: testScriptFileName + order: 0 + default values: [] + confidential: false + required: false + overridable: true + +-- + +The last code snippet shows a part of the screen output. Basically you can read the configuration about every connector +configured in Syncope. + +===== List bundles option +Running the command with this option you will see the list of the bundles available in Syncope. + +[source] +-- +$ ./syncopeadm.sh connector --list-bundles +-- + +[source] +-- + +You are running: connector --list-bundles + + > BUNDLE NAME: net.tirasa.connid.bundles.soap + connector name: net.tirasa.connid.bundles.soap.WebServiceConnector + display name: net.tirasa.connid.bundles.soap.WebServiceConnector + location: file:/home/massi/Lavoro/syncopeMaster/fit/core-reference/target/bundles/ + version: 1.4.0-SNAPSHOT + > BUNDLE NAME: net.tirasa.connid.bundles.db.scriptedsql + connector name: net.tirasa.connid.bundles.db.scriptedsql.ScriptedSQLConnector + display name: Scripted SQL Connector + location: file:/home/massi/Lavoro/syncopeMaster/fit/core-reference/target/bundles/ + version: 2.2.3-SNAPSHOT + > BUNDLE NAME: net.tirasa.connid.bundles.ldap + connector name: net.tirasa.connid.bundles.ldap.LdapConnector + display name: net.tirasa.connid.bundles.ldap.LdapConnector + location: file:/home/massi/Lavoro/syncopeMaster/fit/core-reference/target/bundles/ + version: 1.5.0-SNAPSHOT + > BUNDLE NAME: net.tirasa.connid.bundles.ad + connector name: net.tirasa.connid.bundles.ad.ADConnector + display name: net.tirasa.connid.bundles.ad.ADConnector + location: file:/home/massi/Lavoro/syncopeMaster/fit/core-reference/target/bundles/ + version: 1.3.0-SNAPSHOT + > BUNDLE NAME: net.tirasa.connid.bundles.db.table + connector name: net.tirasa.connid.bundles.db.table.DatabaseTableConnector + display name: Database Table Connector + location: file:/home/massi/Lavoro/syncopeMaster/fit/core-reference/target/bundles/ + version: 2.2.3-SNAPSHOT + > BUNDLE NAME: net.tirasa.connid.bundles.csvdir + connector name: net.tirasa.connid.bundles.csvdir.CSVDirConnector + display name: net.tirasa.connid.bundles.csvdir.CSVDirConnector + location: file:/home/massi/Lavoro/syncopeMaster/fit/core-reference/target/bundles/ + version: 0.8.2 + > BUNDLE NAME: net.tirasa.connid.bundles.db.table + connector name: net.tirasa.connid.bundles.db.table.DatabaseTableConnector + display name: Database Table Connector + location: connid://testconnectorserver@localhost:4554 + version: 2.2.3-SNAPSHOT + > BUNDLE NAME: net.tirasa.connid.bundles.db.scriptedsql + connector name: net.tirasa.connid.bundles.db.scriptedsql.ScriptedSQLConnector + display name: Scripted SQL Connector + location: connid://testconnectorserver@localhost:4554 + version: 2.2.3-SNAPSHOT + +-- + +The most useful information is: + +location:: + where the bundle is, it could be on the same server where Syncope is deployed or on a remote one linked by +connid protocol; +version:: + the bundle version; + +===== List configuration properties option +This option lists the configuration of specified connectors. + +[source] +-- +$ ./syncopeadm.sh connector --list-configuration-properties {CONNECTOR-ID} {CONNECTOR-ID} [...] +-- + +The output is the configuration of the connectors passed as input. + +===== Read option +The option to read all the information of specified connectors. + +[source] +-- +$ ./syncopeadm.sh connector --read {CONNECTOR-ID} {CONNECTOR-ID} [...] +-- + +Unlike the list option, the read one shows only the connectors passed as input. + +===== Delete option +The option to delete a specified connector. + +[source] +-- +$ ./syncopeadm.sh connector --delete {CONNECTOR-ID} {CONNECTOR-ID} [...] +-- + +The delete option, as can be imagined, tries to remove a specified connector. This operation works only if the +connector isn't associated with a resource. +If the connector isn't associated to anything the output will be +[source] +-- + - Connector {CONNECTOR-ID} successfully deleted +-- + +otherwise the output will be something like: +[source] +-- + - Error: AssociatedResources [ws-target-resource-nopropagation, ws-target-resource-nopropagation2] +-- http://git-wip-us.apache.org/repos/asf/syncope/blob/75387d7a/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 new file mode 100644 index 0000000..8d4db83 --- /dev/null +++ b/src/main/asciidoc/workingwithapachesyncope/cli/domain.adoc @@ -0,0 +1,95 @@ +// +// 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} [...] +---- + +===== Details option +This option shows a table with domain amount. + +[source] +-- +$ ./syncopeadm.sh domain --details +-- + +[source] +-- + +You are running: domain --details + +############################ +# # +# DOMAINS DETAILS # +# # +############################ +# # # +# DETAIL # VALUE # +# # # +############################ +# # # +# Total number # 1 # +# # # +############################ + +-- + +===== List option +Running the command with this option you will see the list of the domains. + +[source] +-- +$ ./syncopeadm.sh domain --list +-- + +[source] +-- + +You are running: domain --list + + > DOIMAIN NAME: Two + chiper algorithm: SHA + +-- + +===== Delete option +The option to delete a specified domain. + +[source] +-- +$ ./syncopeadm.sh domain --delete {DOMAIN-NAME} {DOMAIN-NAME} [...] +-- + +The delete option, as can be imagined, tries to remove a specified domain. +The output will be something like: +[source] +-- + - Domain {DOMAIN-NAME} successfully deleted +-- http://git-wip-us.apache.org/repos/asf/syncope/blob/75387d7a/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 new file mode 100644 index 0000000..e9a615a --- /dev/null +++ b/src/main/asciidoc/workingwithapachesyncope/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 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} +---- + +===== List option +Running the command with this option you will see the list of the entitlements. + +[source] +-- +$ ./syncopeadm.sh entitlement --list +-- + +[source] +-- + +You are running: 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 running: 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 running: 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 running: 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 running: entitlement --search-by-role Other + +- SCHEMA_READ +- GROUP_READ +- WORKFLOW_FORM_CLAIM +-- http://git-wip-us.apache.org/repos/asf/syncope/blob/75387d7a/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 new file mode 100644 index 0000000..f71ccb4 --- /dev/null +++ b/src/main/asciidoc/workingwithapachesyncope/cli/group.adoc @@ -0,0 +1,206 @@ +// +// 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} [...] +---- + +===== Details option +This option shows a table with the amount of available groups and some additional information. + +[source] +-- +$ ./syncopeadm.sh group --details +-- + +[source] +-- + +You are running: group --details + +################################## +# # +# GROUPS DETAILS # +# # +################################## +# # # +# DETAIL # VALUE # +# # # +################################## +# # # +# Total number # 16 # +# Without resources # 10 # +# Without attributes # 0 # +# On root realm # 14 # +# On the other realm # 2 # +# # # +################################## + +-- + +===== List option +Running the command with this option you will see the list of the groups. + +[source] +-- +$ ./syncopeadm.sh group --list +-- + +[source] +-- + +You are running: group --list + + > GROUP ID: 1 + name: root + type: GROUP + realm: / + status: null + user owner: null + group owner: null + RESOURCES: + PLAIN ATTRIBUTES: + - icon: [niceIcon] + + - show: [true] + + - rderived_sx: [sx] + + - rderived_dx: [dx] + + DERIVED ATTRIBUTES: + - displayProperty: [niceIcon: true] - is readonly + + - rderiveddata: [sx-dx] - is readonly + + - rderivedschema: [sx-dx] - is readonly + + - rderToBePropagated: [sx-dx] - is readonly + + VIRTUAL ATTRIBUTES: + [...] + +-- + +===== Read option +The option to read the group passed as input. + +[source] +-- +$ ./syncopeadm.sh group --read {GROUP-ID} {GROUP-ID} [...] +-- + +[source] +-- + +You are running: group --read 15 + + > GROUP ID: 15 + name: additional + type: GROUP + realm: /even + status: null + user owner: null + group owner: null + RESOURCES: + PLAIN ATTRIBUTES: + DERIVED ATTRIBUTES: + - displayProperty: [: ] - is readonly + + - rderToBePropagated: [-] - is readonly + + - rderiveddata: [-] - is readonly + + - rderivedschema: [-] - is readonly + + VIRTUAL ATTRIBUTES: + +-- + +===== Read attribute of type option +The option to read the specified attribute type of the group passed as input. + +[source] +-- +$ ./syncopeadm.sh group --read-attr-by-schema-type {GROUP-ID} {SCHEMA-TYPE} + Schema type: PLAIN / DERIVED / VIRTUAL +-- + +[source] +-- + +You are running: group --read-attr-by-schema-type 15 DERIVED + - displayProperty: [: ] - is readonly + + - rderToBePropagated: [-] - is readonly + + - rderiveddata: [-] - is readonly + + - rderivedschema: [-] - is readonly + +-- + +===== Read an attribute of type option +The option to read the specified attribute name of the group passed as input. + +[source] +-- +$ ./syncopeadm.sh group --read-attr-by-schema {GROUP-ID} {SCHEMA-TYPE} {SCHEMA-NAME} + Schema type: PLAIN / DERIVED / VIRTUAL +-- + +[source] +-- + +You are running: group --read-attr-by-schema 12 PLAIN title + - title: [r12] + +-- + +===== Delete option +The option to delete a specified group. + +[source] +-- +$ ./syncopeadm.sh group --delete {GROUP-ID} {GROUP-ID} [...] +-- + +The delete option, as can be imagined, tries to remove a specified group. +The output will be something like: +[source] +-- + - Group {GROUP-ID} successfully deleted +-- http://git-wip-us.apache.org/repos/asf/syncope/blob/75387d7a/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 new file mode 100644 index 0000000..9806110 --- /dev/null +++ b/src/main/asciidoc/workingwithapachesyncope/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 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 +----
