Groups

A Group is a powerful tool for permissions and user management on Files.com. Users can belong to multiple groups.

All permissions can be managed via Groups, and Groups can also be synced to your identity platform via LDAP or SCIM.

Files.com's Group Admin feature allows you to define Group Admins, who then have access to add and remove users within their groups.

List Groups

Command

files-cli groups list

Output

Outputs a list of Group objects according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Folder Admin permissions.

Flags

Flag	Description
--ids= string	Comma-separated list of group ids to include in results.
--include-parent-site-groups boolean	Include groups from the parent site.

Additional Arguments

Example Request

files-cli groups list

Show Group

Command

files-cli groups find

Output

Outputs a Group object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Folder Admin permissions.

Flags

Flag	Description
--id= int64 Required	Group ID.

Example Request

files-cli groups find \
  --id=1

Create Group

Command

files-cli groups create

Output

Outputs a Group object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

Flag	Default	Description
--notes= string		Group notes.
--user-ids= string		A list of user ids. If sent as a string, should be comma-delimited.
--admin-ids= string		A list of group admin user ids. If sent as a string, should be comma-delimited.
--ai-assistant-personality-id= int64		AI Assistant Personality ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user or Partner assignment overrides it.
--ftp-permission boolean	`false`	If true, users in this group can use FTP to login. This will override a false value of `ftp_permission` on the user level.
--sftp-permission boolean	`false`	If true, users in this group can use SFTP to login. This will override a false value of `sftp_permission` on the user level.
--dav-permission boolean	`false`	If true, users in this group can use WebDAV to login. This will override a false value of `dav_permission` on the user level.
--restapi-permission boolean	`false`	If true, users in this group can use the REST API to login. This will override a false value of `restapi_permission` on the user level.
--desktop-configuration-profile-id= int64		Desktop Configuration Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
--integration-centric-profile-id= int64		Integration Centric Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
--allowed-ips= string		A list of allowed IPs if applicable. Newline delimited
--name= string Required		Group name.
--workspace-id= int64	`0`	Workspace ID

Example Request

files-cli groups create \
  --name="name"

Update Group

Command

files-cli groups update

Output

Outputs a Group object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

Flag	Description
--id= int64 Required	Group ID.
--notes= string	Group notes.
--user-ids= string	A list of user ids. If sent as a string, should be comma-delimited.
--admin-ids= string	A list of group admin user ids. If sent as a string, should be comma-delimited.
--ai-assistant-personality-id= int64	AI Assistant Personality ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user or Partner assignment overrides it.
--ftp-permission boolean	If true, users in this group can use FTP to login. This will override a false value of `ftp_permission` on the user level.
--sftp-permission boolean	If true, users in this group can use SFTP to login. This will override a false value of `sftp_permission` on the user level.
--dav-permission boolean	If true, users in this group can use WebDAV to login. This will override a false value of `dav_permission` on the user level.
--restapi-permission boolean	If true, users in this group can use the REST API to login. This will override a false value of `restapi_permission` on the user level.
--desktop-configuration-profile-id= int64	Desktop Configuration Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
--integration-centric-profile-id= int64	Integration Centric Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
--allowed-ips= string	A list of allowed IPs if applicable. Newline delimited
--name= string	Group name.

Example Request

files-cli groups update \
  --id=1 \
  --notes="example"

Delete Group

Command

files-cli groups delete

Output

No output is returned.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

Flag	Description
--id= int64 Required	Group ID.

Example Request

files-cli groups delete \
  --id=1

The Group Object

Some of the commands above return a Group object. The attributes of this object are listed below.

Attribute	Description
id int64	Group ID
name string	Group name
allowed_ips string	A list of allowed IPs if applicable. Newline delimited
admin_ids string	Comma-delimited list of user IDs who are group administrators (separated by commas)
notes string	Notes about this group
user_ids string	Comma-delimited list of user IDs who belong to this group (separated by commas)
usernames string	Comma-delimited list of usernames who belong to this group (separated by commas)
ai_assistant_personality_id int64	AI Assistant Personality ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user or Partner assignment overrides it.
ftp_permission boolean	If true, users in this group can use FTP to login. This will override a false value of `ftp_permission` on the user level.
sftp_permission boolean	If true, users in this group can use SFTP to login. This will override a false value of `sftp_permission` on the user level.
dav_permission boolean	If true, users in this group can use WebDAV to login. This will override a false value of `dav_permission` on the user level.
restapi_permission boolean	If true, users in this group can use the REST API to login. This will override a false value of `restapi_permission` on the user level.
desktop_configuration_profile_id int64	Desktop Configuration Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
integration_centric_profile_id int64	Integration Centric Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
site_id int64	Site ID
workspace_id int64	Workspace ID

Groups

List Groups

Command

Output

Authorization Requirement

Flags

Additional Arguments

Pagination

Sorting

Filtering

Show Group

Command

Output

Authorization Requirement

Flags

Create Group

Command

Output

Authorization Requirement

Flags

Update Group

Command

Output

Authorization Requirement

Flags

Delete Group

Command

Output

Authorization Requirement

Flags

The Group Object