Sign in

v4

latestSwagger 2.02026-08-0343714211.7 MB
permissions
Permissions

Create Permission

Create Permission

post/permissions

Response

The Permissions object.

idinteger

Permission ID

pathstring

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 multiple groups

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

Recursive: does this permission apply to subfolders?

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
}