Permissions API

The Permissions API allows you to list, set, and remove folder permissions for users and groups in an Egnyte domain. Use this API to programmatically manage access control for folders, including setting permission levels, checking effective permissions, and controlling permission inheritance.

Base URL

https://{domain}.egnyte.com/pubapi/v1/perms
https://{domain}.egnyte.com/pubapi/v2/perms

Authentication

All requests require an OAuth 2.0 Bearer token in the Authorization header:

Authorization: Bearer {access_token}

See Authentication for details on obtaining a token.

Permission Levels

Egnyte supports five permission levels that control what actions users and groups can perform on folders and files:

Get Effective Permissions for a User

Retrieves the effective permissions for a specific user on a given folder. This takes into account both direct user permissions and group memberships, along with permission inheritance. If no username is specified, returns permissions for the authenticated user.

Request

GET /pubapi/v1/perms/user/{username}

Path Parameters

Query Parameters

Example Request

curl -i -X GET "https://{domain}.egnyte.com/pubapi/v1/perms/user/jsmith?folder=/Shared/Documents" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response

200 OK

Example Response

{
  "permission": "Full"
}

Get Folder Permissions

Retrieves all user and group permissions set on a specific folder, including permission inheritance status.

Request

GET /pubapi/v2/perms/{path}

Path Parameters

Example Request

curl -i -X GET "https://{domain}.egnyte.com/pubapi/v2/perms/Shared/Documents" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response

200 OK

Example Response

{
  "userPerms": {
    "jsmith": "Full",
    "ajones": "Viewer"
  },
  "groupPerms": {
    "All Administrators": "Owner",
    "Marketing Team": "Editor"
  },
  "inheritsPermissions": true
}

Set Folder Permissions

Sets or updates permissions for users and groups on a folder. This is a delta API — it only modifies the permissions you specify, leaving other permissions unchanged. To remove a permission, set it to None.

Request

POST /pubapi/v2/perms/{path}

Path Parameters

Request Body

Example Request

curl -i -X POST "https://{domain}.egnyte.com/pubapi/v2/perms/Shared/Documents" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -d '{
  "userPerms": {
    "jsmith": "Viewer",
    "ajones": "Editor"
  },
  "groupPerms": {
    "Project Team": "Full",
    "Contractors": "None"
  }
}'

Response

200 OK

Returns an empty response body on success.

Get Folder Permissions (v1)

Retrieves permissions for specific users and groups on a folder.

Request

GET /pubapi/v1/perms/folder/{path}

Path Parameters

Query Parameters

* At least one of users or groups must be provided.

Example Request

curl -i -X GET "https://{domain}.egnyte.com/pubapi/v1/perms/folder/MyFolder?users=jsmith|ajones&groups=All%20Power%20Users" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response

200 OK

Example Response

{
  "users": [
    {
      "subject": "jsmith",
      "permission": "Full"
    },
    {
      "subject": "ajones",
      "permission": "Viewer"
    }
  ],
  "groups": [
    {
      "subject": "All Power Users",
      "permission": "Editor"
    }
  ]
}

Set Folder Permissions (v1)

Sets the same permission level for multiple users or groups on a folder.

Request

POST /pubapi/v1/perms/folder/{path}

Path Parameters

Request Body

* At least one of users or groups must be provided.

Example Request

curl -i -X POST "https://{domain}.egnyte.com/pubapi/v1/perms/folder/Shared/MyFolder" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -d '{
  "users": [
    "jsmith",
    "ajones"
  ],
  "permission": "Viewer"
}'

Response

200 OK

Returns an empty response body on success.

Error Codes

Code Examples

GET /pubapi/v2/perms/Shared/Documents

curl -i -X GET "https://{domain}.egnyte.com/pubapi/v2/perms/Shared/Documents" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

POST /pubapi/v2/perms/Shared/Documents

curl -i -X POST "https://{domain}.egnyte.com/pubapi/v2/perms/Shared/Documents" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -d '{
  "userPerms": {
    "jsmith": "Viewer",
    "ajones": "Editor"
  },
  "groupPerms": {
    "Project Team": "Full"
  }
}'

Related Resources

• Authentication — How to obtain and refresh OAuth tokens
• File System API — Create, read, update, and delete files and folders
• Group Management API — Manage groups that can be assigned permissions
• User Management API — Manage users that can be assigned permissions