FIfiles
permissions
Permissions

Create Permission

Changed on

Create Permission

post/permissions

Request

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

Request body multipart/form-data

pathstring required

Folder path

group_idinteger

Group ID. Provide group_name or group_id

group_idsstring

Group IDs when the Permission requires membership in every listed group. If sent as a string, it should be comma-delimited.

permissionstring

Permission type. Can be admin, full, readonly, writeonly, list, or history

recursiveboolean

Apply to subfolders recursively? Must be true for admin Permissions.

partner_idinteger

Partner ID if this Permission belongs to a partner.

user_idinteger

User ID. Provide username or user_id

usernamestring

User username. Provide username or user_id

group_namestring

Group name. Provide group_name or group_id

site_idinteger

Site ID. If not provided, will default to current site. Used when creating a permission for a child site.

Response

The Permissions object.

idinteger

Permission ID

pathstring

Folder path

user_idinteger

User ID

usernamestring

Username (if applicable)

group_idinteger

Group ID

group_namestring

Group name (if applicable)

group_idsinteger[]

Group IDs when this Permission requires membership in every listed group.

group_namesstring[]

Group names when this permission requires multiple groups

partner_idinteger

Partner ID (if applicable)

partner_namestring

Partner name (if applicable)

permission'full' | 'readonly' | 'writeonly' | 'list' | 'history' | 'admin' | 'bundle' | 'site_admin' | 'readonly_site_admin' | 'previewonly'

Permission type. See the table referenced in the documentation for an explanation of each permission.

recursiveboolean

Whether this Permission applies to subfolders. Must be true for admin Permissions.

site_idinteger

Site ID

Example response

{
  "id": 1,
  "path": "example",
  "user_id": 1,
  "username": "user",
  "group_name": "example",
  "group_ids": [
    1
  ],
  "group_names": [
    "example"
  ],
  "partner_id": 1,
  "partner_name": "Acme Corp.",
  "permission": "full",
  "recursive": true,
  "site_id": 1
}

Changes