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

XML Element

<filescom:list-groups />

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator, a Workspace Administrator for the relevant workspace, or a Folder Administrator for the relevant folder.

Example Operation

<filescom:list-groups config-ref="FilesCom" />

Example Response Payload

[
  {
    "id": 1,
    "name": "owners",
    "allowedIps": "10.0.0.0/8\n127.0.0.1",
    "adminIds": "1",
    "notes": "example",
    "userIds": "1",
    "usernames": "user",
    "aiAssistantPersonalityId": 1,
    "ftpPermission": true,
    "sftpPermission": true,
    "davPermission": true,
    "restapiPermission": true,
    "s3CompatibleEndpointPermission": true,
    "desktopConfigurationProfileId": 1,
    "integrationCentricProfileId": 1,
    "siteId": 1,
    "workspaceId": 1
  }
]

Show Group

XML Element

<filescom:show-group />

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator, a Workspace Administrator for the relevant workspace, or a Folder Administrator for the relevant folder.

Parameter	Description
id Long Required	Group ID.

Example Operation

<filescom:show-group config-ref="FilesCom" id="1" />

Example Response Payload

{
  "id": 1,
  "name": "owners",
  "allowedIps": "10.0.0.0/8\n127.0.0.1",
  "adminIds": "1",
  "notes": "example",
  "userIds": "1",
  "usernames": "user",
  "aiAssistantPersonalityId": 1,
  "ftpPermission": true,
  "sftpPermission": true,
  "davPermission": true,
  "restapiPermission": true,
  "s3CompatibleEndpointPermission": true,
  "desktopConfigurationProfileId": 1,
  "integrationCentricProfileId": 1,
  "siteId": 1,
  "workspaceId": 1
}

Create Group

XML Element

<filescom:create-group />

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

Parameter	Description
name String Required	Group name.
notes String	Group notes.
userIds String	A list of user ids. If sent as a string, should be comma-delimited.
adminIds String	A list of group admin user ids. If sent as a string, should be comma-delimited.

Example Operation

<filescom:create-group config-ref="FilesCom"
 name="name"
 notes="example"
 userIds="1"
 adminIds="1"
/>

Example Response Payload

{
  "id": 1,
  "name": "owners",
  "allowedIps": "10.0.0.0/8\n127.0.0.1",
  "adminIds": "1",
  "notes": "example",
  "userIds": "1",
  "usernames": "user",
  "aiAssistantPersonalityId": 1,
  "ftpPermission": true,
  "sftpPermission": true,
  "davPermission": true,
  "restapiPermission": true,
  "s3CompatibleEndpointPermission": true,
  "desktopConfigurationProfileId": 1,
  "integrationCentricProfileId": 1,
  "siteId": 1,
  "workspaceId": 1
}

Update Group

XML Element

<filescom:update-group />

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

Parameter	Description
id Long Required	Group ID.
notes String	Group notes.
userIds String	A list of user ids. If sent as a string, should be comma-delimited.
adminIds String	A list of group admin user ids. If sent as a string, should be comma-delimited.
name String	Group name.

Example Operation

<filescom:update-group config-ref="FilesCom"
 id="1"
 notes="example"
 userIds="1"
 adminIds="1"
 name="owners"
/>

Example Response Payload

{
  "id": 1,
  "name": "owners",
  "allowedIps": "10.0.0.0/8\n127.0.0.1",
  "adminIds": "1",
  "notes": "example",
  "userIds": "1",
  "usernames": "user",
  "aiAssistantPersonalityId": 1,
  "ftpPermission": true,
  "sftpPermission": true,
  "davPermission": true,
  "restapiPermission": true,
  "s3CompatibleEndpointPermission": true,
  "desktopConfigurationProfileId": 1,
  "integrationCentricProfileId": 1,
  "siteId": 1,
  "workspaceId": 1
}

Delete Group

XML Element

<filescom:delete-group />

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

Parameter	Description
id Long Required	Group ID.

Example Operation

<filescom:delete-group config-ref="FilesCom" id="1" />