FIfiles
groups
Groups

Create Group

Changed on

Create Group

post/groups

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/groups
  • Auth
    none declared

Request body multipart/form-data

notesstring

Group notes.

user_idsstring

A list of user ids. If sent as a string, should be comma-delimited.

admin_idsstring

A list of group admin user ids. If sent as a string, should be comma-delimited.

ai_assistant_personality_idinteger

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_permissionboolean

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_permissionboolean

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_permissionboolean

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_permissionboolean

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.

s3_compatible_endpoint_permissionboolean

If true, users in this group can access the S3-compatible endpoint. This will override a false value of s3_compatible_endpoint_permission on the user level. Defaults to false.

desktop_configuration_profile_idinteger

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_idinteger

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_ipsstring

A list of allowed IPs if applicable. Newline delimited

namestring required

Group name.

workspace_idinteger

Workspace ID

Example request

{
  "ai_assistant_personality_id": 1,
  "ftp_permission": true,
  "sftp_permission": true,
  "dav_permission": true,
  "restapi_permission": true,
  "s3_compatible_endpoint_permission": true,
  "desktop_configuration_profile_id": 1,
  "integration_centric_profile_id": 1,
  "allowed_ips": "10.0.0.0/8\n127.0.0.1"
}

Response

The Groups object.

idinteger

Group ID

namestring

Group name

allowed_ipsstring

A list of allowed IPs if applicable. Newline delimited

admin_idsstring

Comma-delimited list of user IDs who are group administrators (separated by commas)

notesstring

Notes about this group

user_idsstring

Comma-delimited list of user IDs who belong to this group (separated by commas)

usernamesstring

Comma-delimited list of usernames who belong to this group (separated by commas)

ai_assistant_personality_idinteger

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_permissionboolean

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_permissionboolean

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_permissionboolean

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_permissionboolean

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.

s3_compatible_endpoint_permissionboolean

If true, users in this group can access the S3-compatible endpoint. This will override a false value of s3_compatible_endpoint_permission on the user level. Defaults to false.

desktop_configuration_profile_idinteger

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_idinteger

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_idinteger

Site ID

workspace_idinteger

Workspace ID

Example response

{
  "id": 1,
  "name": "owners",
  "allowed_ips": "10.0.0.0/8\n127.0.0.1",
  "admin_ids": "1",
  "notes": "example",
  "user_ids": "1",
  "usernames": "user",
  "ai_assistant_personality_id": 1,
  "ftp_permission": true,
  "sftp_permission": true,
  "dav_permission": true,
  "restapi_permission": true,
  "s3_compatible_endpoint_permission": true,
  "desktop_configuration_profile_id": 1,
  "integration_centric_profile_id": 1,
  "site_id": 1
}

Changes