On This Page
Overview
This portion of the CLI exposes the ability to manage users, groups, and roles. For more information about access controls, visit the access control documentation.
Permissions
List the Permissions
The permissions are listed out by the category to which they belong.
parameter | description | required | default |
|---|---|---|---|
search | Retrieve permissions that match the search criteria | optional |
Example 1: List all the permission categories and permissions
In the following example, the authentication parameters are provided within the configuration file. See the authentication section for more information.
Command
skysync-cli permissions list
Example results
ID Category Name 4f363d230da046108b00a4586ce75055 Connections List Connections, Manage Connections, Read Content, Write/Delete Content a2f88280c80c475a908d44ea752c0d94 Jobs List Jobs, Manage Jobs, Control Jobs (i.e. Start/Stop/Pause), Manage Templates, List Remote Sites, Manage Remote Sites, Invoke Remote Sites, Establish Remote Sites ab70847b71c042b1bae66461f5dda04c Security List Users and Groups, Manage Users and Groups, Manage Access Rights
Example results (JSON)
[
{
"id": "4f363d230da046108b00a4586ce75055",
"name": "Connections",
"permissions": [
{
"name": "List Connections",
"id": "47c6cd5954f041df8d79e1972cc1ce3b"
},
{
"name": "Manage Connections",
"id": "294eee9539354739b194da1a879bc163"
},
{
"name": "Read Content",
"id": "0a92ab0e02414a51b03497490df76ada"
},
{
"name": "Write/Delete Content",
"id": "989d1df3d6af47afadb0a74e42efc92c"
}
]
},
{
"id": "a2f88280c80c475a908d44ea752c0d94",
"name": "Jobs",
"permissions": [
{
"name": "List Jobs",
"id": "bbd25a404cdc4e01baabd0b79394cbd8"
},
{
"name": "Manage Jobs",
"id": "d9507ec76bf7414aa8a74a0c88c32a48"
},
{
"name": "Control Jobs (i.e. Start/Stop/Pause)",
"id": "3560a25976504967bcd48a7e668a07a8"
},
{
"name": "Manage Templates",
"id": "86b29346112b48528f8e4aeed0137262"
},
{
"name": "List Remote Sites",
"id": "ffee260e389a42f7b23ce75b46b79e2e"
},
{
"name": "Manage Remote Sites",
"id": "5e97f402d6b14a599eeba998d5d63044"
},
{
"name": "Invoke Remote Sites",
"id": "64ce9e42a7ac402086bf229c346bc533"
},
{
"name": "Establish Remote Sites",
"id": "1f0d640960f949bda50f1eed7a7fa9ba"
}
]
},
{
"id": "ab70847b71c042b1bae66461f5dda04c",
"name": "Security",
"permissions": [
{
"name": "List Users and Groups",
"id": "915fb2c972a3479ab3272b62507b7300"
},
{
"name": "Manage Users and Groups",
"id": "e7e4f17053fa41489dfb026d18d6bc40"
},
{
"name": "Manage Access Rights",
"id": "5a16a060c35d467882c007979926bdfe"
}
]
}
]
Example 2: List permissions with the "manage" in the name
In the following example, the authentication parameters are provided within the configuration file. See the authentication section for more information.
Command
skysync-cli permissions list --search manage
Example results
ID Category Name 4f363d230da046108b00a4586ce75055 Connections Manage Connections a2f88280c80c475a908d44ea752c0d94 Jobs Manage Jobs, Manage Templates, Manage Remote Sites ab70847b71c042b1bae66461f5dda04c Security Manage Users and Groups, Manage Access Rights
Example results (JSON)
[
{
"id": "4f363d230da046108b00a4586ce75055",
"name": "Connections",
"permissions": [
{
"name": "Manage Connections",
"id": "294eee9539354739b194da1a879bc163"
}
]
},
{
"id": "a2f88280c80c475a908d44ea752c0d94",
"name": "Jobs",
"permissions": [
{
"name": "Manage Jobs",
"id": "d9507ec76bf7414aa8a74a0c88c32a48"
},
{
"name": "Manage Templates",
"id": "86b29346112b48528f8e4aeed0137262"
},
{
"name": "Manage Remote Sites",
"id": "5e97f402d6b14a599eeba998d5d63044"
}
]
},
{
"id": "ab70847b71c042b1bae66461f5dda04c",
"name": "Security",
"permissions": [
{
"name": "Manage Users and Groups",
"id": "e7e4f17053fa41489dfb026d18d6bc40"
},
{
"name": "Manage Access Rights",
"id": "5a16a060c35d467882c007979926bdfe"
}
]
}
]
Show a Permission Category
This command will show the details of the specified permission category.
parameter | description | required | default |
|---|---|---|---|
id | The ID of the permission category for which details will be shown | required |
The parameters within the two curly braces (including the braces) will need to be replaced with valid values.
Command with variables
skysync-cli permissions show {{permissionsCategoryID}}
Command with example values
skysync-cli groups show ab70847b71c042b1bae66461f5dda04c
Example results
ID ab70847b71c042b1bae66461f5dda04c Category Security Name List Users and Groups, Manage Users and Groups, Manage Access Rights
Example results (JSON)
[
{
"id": "ab70847b71c042b1bae66461f5dda04c",
"name": "Security",
"permissions": [
{
"name": "List Users and Groups",
"id": "915fb2c972a3479ab3272b62507b7300"
},
{
"name": "Manage Users and Groups",
"id": "e7e4f17053fa41489dfb026d18d6bc40"
},
{
"name": "Manage Access Rights",
"id": "5a16a060c35d467882c007979926bdfe"
}
]
}
]
Roles
List the Roles
parameter | description | required | default |
|---|---|---|---|
search | Retrieve roles that match the search criteria | optional | |
offset | Search offset | optional | 0 |
limit | Search page size | optional | 20 |
Example 1: List all the roles
In the following example, the authentication parameters are provided within the configuration file. See the authentication section for more information.
Command
skysync-cli roles list
Example results
ID Name 58c52f0a513e47b687b0f43ef40c3333 Job Administrators
Example results (JSON)
[
{
"id": "58c52f0a513e47b687b0f43ef40c3333",
"name": "Job Administrators"
}
]
Example 2: List roles with "administrator" in the name
In the following example, the authentication parameters are provided within the configuration file. See the authentication section for more information.
Command
skysync-cli roles list --search "administrator"
Example 3: List the roles skipping the first 5
In the following example, the authentication parameters are provided within the configuration file. See the authentication section for more information.
Command
skysync-cli roles list --offset=5
Example 4: List only 5 roles
In the following example, the authentication parameters are provided within the configuration file. See the authentication section for more information.
Command
skysync-cli roles list --limit 5
Show a Role
This command will show the details of the specified role.
parameter | description | required | default |
|---|---|---|---|
id | The ID of the role for which details will be shown | required |
The parameters within the two curly braces (including the braces) will need to be replaced with valid values.
Command with variables
skysync-cli roles show {{id}}
Command with example values
skysync-cli roles show 58c52f0a513e47b687b0f43ef40c3333
Example results
ID 58c52f0a513e47b687b0f43ef40c3333 Name Job Administrators Permissions Control Jobs (i.e. Start/Stop/Pause), List Jobs, Manage Jobs
Example results (JSON)
[
{
"id": "58c52f0a513e47b687b0f43ef40c3333",
"name": "Job Administrators",
"permissions": [
{
"name": "Control Jobs (i.e. Start/Stop/Pause)",
"id": "3560a25976504967bcd48a7e668a07a8"
},
{
"name": "List Jobs",
"id": "bbd25a404cdc4e01baabd0b79394cbd8"
},
{
"name": "Manage Jobs",
"id": "d9507ec76bf7414aa8a74a0c88c32a48"
}
]
}
]
If the ID entered does not correspond to an existing role, for example, if the ID is mistyped, the expected output is the following.
Expected results
ID Name Permissions
Expected results (JSON)
null
Create a Role
This command provides the ability to create a role.
parameter | description | required | default |
|---|---|---|---|
name | Name of the role | required | |
permissions | A comma separated list of the IDs of the permissions (not permission categories) that belong to this role |
Example 1: Create a new role
In the following example, the authentication parameters are provided within the configuration file. See the authentication section for more information. The parameters within the two curly braces (including the braces) will need to be replaced with valid values.
Command with variables
skysync-cli roles add {{roleName}}
Command with sample values
skysync-cli roles add testRole
Example results
ID 865bb398aa1440fdb0cb680b2a6d30b3 Name testRole
Example results (JSON)
[
{
"id": "bd7b54fc421d4596860ec4b643d55948",
"name": "testRole"
}
]
Example 2: Create a new role with permissions
In the following example, the authentication parameters are provided within the configuration file. See the authentication section for more information. The parameters within the two curly braces (including the braces) will need to be replaced with valid values.
Command with variables
skysync-cli roles add {{roleName}} --permissions {{permissionsID}}, {{permissionsID}}, ...
Command with sample values
skysync-cli roles add testRole --permissions 915fb2c972a3479ab3272b62507b7300,ffee260e389a42f7b23ce75b46b79e2e
Groups
List the Groups
parameter | description | required | default |
|---|---|---|---|
parent | Retrieve groups that belong to this parent group | optional | |
search, q | Retrieve groups that match the search criteria | optional | |
offset | Search offset | optional | 0 |
limit | Search page size | optional | 20 |
Example 1: List all the groups
In the following example, the authentication parameters are provided within the configuration file. See the authentication section for more information.
Command
skysync-cli groups list
Example results
ID Name Type d39d8ac9d43f44e4b92607cca5c27ecf Tenant 1 owner
Example results (JSON)
[
{
"id": "d39d8ac9d43f44e4b92607cca5c27ecf",
"name": "Tenant 1",
"type": "owner"
}
]
Example 2: List groups with the "Tenant 1" in the name
In the following example, the authentication parameters are provided within the configuration file. See the authentication section for more information.
Command
skysync-cli groups list --search "Tenant 1"
Example 3: List the groups skipping the first 5
In the following example, the authentication parameters are provided within the configuration file. See the authentication section for more information.
Command
skysync-cli groups list --offset=5
Example 3: List the groups belonging to a specified parent group
In the following example, the authentication parameters are provided within the configuration file. See the authentication section for more information. The parameters within the two curly braces (including the braces) will need to be replaced with valid values.
Command
skysync-cli groups list --parent={{parentGroupID}}
Show a Group
This command will show the details of the specified group.
parameter | description | required | default |
|---|---|---|---|
id | The ID of the group for which details will be shown | required |
The parameters within the two curly braces (including the braces) will need to be replaced with valid values.
Command with variables
skysync-cli groups show {{id}}
Command with example values
skysync-cli groups show d39d8ac9d43f44e4b92607cca5c27ecf
Example results
ID d39d8ac9d43f44e4b92607cca5c27ecf Name Tenant 1.1 Parent Tenant 1
Example results (JSON)
[
{
"id": "d39d8ac9d43f44e4b92607cca5c27ecf",
"name": "Tenant 1.1",
"parent": {
"name": "Tenant 1",
"id": "16acfe4815854d8c9adfc132c9c283a0"
}
]
If the ID entered does not correspond to an existing group, for example, if the ID is mistyped, the expected output is the following.
Expected results
ID Name Parent
Expected results (JSON)
null
Create a Group
This command provides the ability to create a group.
parameter | description | required | default |
|---|---|---|---|
name | Name of the group | required | |
parent | The ID of the parent ownership group |
Example 1: Create a new group
In the following example, the authentication parameters are provided within the configuration file. See the authentication section for more information. The parameters within the two curly braces (including the braces) will need to be replaced with valid values.
Command with variables
skysync-cli groups add {{groupName}}
Command with example values
skysync-cli groups add "Tenant 1"
Example results
ID 74fb6f13b5c049c993536df30fe351f1 Name Tenant 1
Example results (JSON)
[
{
"id": "74fb6f13b5c049c993536df30fe351f1",
"name": "Tenant 1"
}
]
Example 2: Create a new group with a parent
In the following example, the authentication parameters are provided within the configuration file. See the authentication section for more information. The parameters within the two curly braces (including the braces) will need to be replaced with valid values.
Command with variables
skysync-cli groups add {{groupName}} --parent {{parentGroupID}}
Command with example values
skysync-cli groups add "Tenant 1.1" --parent d39d8ac9d43f44e4b92607cca5c27ecf
Example results
ID 74fb6f13b5c049c993536df30fe351f1 Name Tenant 1.1
Example results (JSON)
[
{
"id": "74fb6f13b5c049c993536df30fe351f1",
"name": "Tenant 1.1"
}
]
Users
List the Users
parameter | description | required | default |
|---|---|---|---|
active | Only retrieve active users | optional | |
search, q | Retrieve the users that match the search criteria | optional | |
offset | Search offset | optional | 0 |
limit | Search page size | optional | 20 |
Example 1: List all the users
In the following example, the authentication parameters are provided within the configuration file. See the authentication section for more information.
Command
skysync-cli users list
Example results
ID Login Name E-Mail Enabled Group 1ca2185affce4146befc2a397393af22 admin Administrator true 4d8958f9b7d54bf7b70333531c5d3f3c tenant1 Tenant 1 true Tenant 1
Example results (JSON)
[
{
"id": "1ca2185affce4146befc2a397393af22",
"login": "admin",
"name": "Administrator",
"disabled": false
},
{
"id": "4d8958f9b7d54bf7b70333531c5d3f3c",
"login": "tenant1",
"name": "Tenant 1",
"disabled": false,
"group": {
"name": "Tenant 1",
"id": "d39d8ac9d43f44e4b92607cca5c27ecf"
}
}
]
Example 2: List users with an email address of "test@example.com"
In the following example, the authentication parameters are provided within the configuration file. See the authentication section for more information.
Command
skysync-cli users list -q test@example.com
Example 3: List users by status
Users can be retrieved based on a given status. The status can be either "active" or "disabled." The example below shows retrieving all active users. The authentication parameters are provided within the configuration file. See the authentication section for more information.
Command
skysync-cli users list --status=active
Example 4: List the users skipping the first 5
In the following example, the authentication parameters are provided within the configuration file. See the authentication section for more information.
Command
skysync-cli users list --offset=5
Show a User
This command will show the details of the specified user.
parameter | description | required | default |
|---|---|---|---|
id | The ID of the user for which details will be shown | required |
The parameters within the two curly braces (including the braces) will need to be replaced with valid values.
Command with variables
skysync-cli users show {{id}}
Command with example values
skysync-cli users show 5a45d35b4a82472795d239d06012cde8
Example results
ID 5a45d35b4a82472795d239d06012cde8 Login user Name user E-Mail user@test.com Enabled true Group Tenant 1.4 Roles Job Administrators Permissions Control Jobs (i.e. Start/Stop/Pause), List Jobs, Manage Jobs
Example results (JSON)
[
{
"id": "5a45d35b4a82472795d239d06012cde8",
"login": "user",
"name": "user",
"email": "user@test.com",
"disabled": false,
"group": {
"name": "Tenant 1.4",
"id": "16acfe4815854d8c9adfc132c9c283a0"
},
"roles": [
{
"name": "Job Administrators",
"id": "58c52f0a513e47b687b0f43ef40c3333"
}
],
"permissions": [
{
"name": "Control Jobs (i.e. Start/Stop/Pause)",
"id": "3560a25976504967bcd48a7e668a07a8"
},
{
"name": "List Jobs",
"id": "bbd25a404cdc4e01baabd0b79394cbd8"
},
{
"name": "Manage Jobs",
"id": "d9507ec76bf7414aa8a74a0c88c32a48"
}
]
}
]
If the ID entered does not correspond to an existing user, for example, if the user was already deleted, the expected output is the following.
Expected results
ID Login Name E-Mail Enabled true Group Roles Permissions
Expected results (JSON)
null
Create a User
This command provides the ability to create a user.
parameter | description | required | default |
|---|---|---|---|
new-user-username | Login username for the new user | required | |
new-user-password | Password for the new user | required | |
new-user-email | The e-mail address for the new user | optional | |
new-user-display-name | The display name for the new user | optional | |
new-user-group | The ID of the group to which the new user will belong | optional | |
new-user-roles | A comma separated list of the IDs of the roles to which the new user will belong | optional |
Example 1: Create a new user
In the following example, the authentication parameters are provided within the configuration file. See the authentication section for more information. The parameters within the two curly braces (including the braces) will need to be replaced with valid values.
Command with variables
skysync-cli users add {{username}} {{password}} --new-user-email {{emailAddress}} --new-user-display-name {{displayName}} --new-user-group {{groupID}} --new-user-roles {{role1ID}},{{rol2ID}},...
Command with example values
skysync-cli users add user1 somePassword --new-user-email user1@example.com --new-user-display-name User1 --new-user-group 4d8958f9b7d54bf7b70333531c5d3f3c --new-user-roles 58c52f0a513e47b687b0f43ef40c3333,0f08d24ee50b42f1a1fb56497d0cabc9
Example results
ID 93d88143ee7248d28c95d0adc6ac863c Login user1 Name User1 E-Mail user1@example.com Enabled true
Example results (JSON)
[
{
"id": "93d88143ee7248d28c95d0adc6ac863c",
"login": "user1",
"name": "User1",
"email": "user1@example.com",
"disabled": false
}
]
Delete a User
This command will delete the specified user
parameter | description | required | default |
|---|---|---|---|
id | The ID of the user to be deleted | required |
The parameters within the two curly braces (including the braces) will need to be replaced with valid values.
Command with variables
skysync-cli users delete {{id}}
Command with example values
skysync-cli users delete 5dc531df34554edd96c31272262ad950
If the ID entered does not correspond to an existing connection, for example, if the user was already deleted, the expected output is the following.
Expected results
The user could not be deleted.
The response is only available in the default format. If JSON output is specified, no output will be provided.
Password Administration
Click here for more information about this feature.
Changing the Current User's Password
This command will change the current user's password
parameter | description | required | default |
|---|---|---|---|
old-password | The original password for the current user | required | |
new-password | The new password for the current user | required |
The parameters within the two curly braces (including the braces) will need to be replaced with valid values.
Command with variables
skysync-cli users password change {{old-password}} {{new-password}}
Command with example values
skysync-cli users password change oldPassword newPassword
Sample expected results
ID 4d8958f9b7d54bf7b70333531c5d3f3c
Sample expected results (JSON)
[
{
"id": "4d8958f9b7d54bf7b70333531c5d3f3c"
}
]
Resetting a Users Password
This command will reset the specified user's password
parameter | description | required | default |
|---|---|---|---|
id | The ID for the user for which the password is being reset | required | |
new-password | The new password for the current user | required |
The parameters within the two curly braces (including the braces) will need to be replaced with valid values.
Command with variables
skysync-cli users password reset {{userID}} {{new-password}}
Command with example values
skysync-cli users password reset 4d8958f9b7d54bf7b70333531c5d3f3c newPassword
Sample expected results
ID 4d8958f9b7d54bf7b70333531c5d3f3c
Sample expected results (JSON)
[
{
"id": "4d8958f9b7d54bf7b70333531c5d3f3c"
}
]