Sign in

v4

latestSwagger 2.02026-08-0343714211.7 MB
users
Permissions

List Permissions

List Permissions

get/users/{user_id}/permissions

Path parameters

user_idstring required

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are site_id, group_id, path, user_id, partner_id or id.

If set, return records where the specified field is equal to the supplied value. Valid fields are path, group_id, partner_id or user_id. Valid field combinations are [ group_id, path ], [ partner_id, path ], [ user_id, path ], [ user_id, group_id ], [ user_id, group_id, path ], [ user_id, group_id, partner_id ] or [ user_id, group_id, partner_id, path ].

If set, return records where the specified field is prefixed by the supplied value. Valid fields are path.

pathstring

Permission path. If provided, will scope all permissions(including upward) to this path.

include_groupsboolean

If searching by user or group, also include user's permissions that are inherited from its groups?

group_idstring
partner_idstring

Response

A list of Permissions objects.

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
  }
]