Skip to main content
PATCH
/
organizations
/
{organizationName}
/
workspaces
/
{workspaceName}
/
documents
/
{documentPath}
/
permissions
/
{userGroupId}
Error
A valid request URL is required to generate request examples
{
  "userGroupId": "<string>",
  "permission": "editor",
  "inheritedPermission": "manager",
  "message": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
organizationName
string
required

The unique identifier of the organization Standard identifier pattern for resource names

​
workspaceName
string
required

The unique identifier of the workspace Standard identifier pattern for resource names

​
documentPath
string
required

The path to the document within the workspace Path pattern supporting slashes, dots, and dashes

​
userGroupId
string
required

The unique identifier of the user or group A resource identifier that uniquely identifies either a user or a group within the system. This identifier is used throughout the API for permission management and access control.

Format:

  • For users: user:{email} or user:{userId}
  • For groups: group:{groupName}

Body

application/json

Represents a permission assignment for a user or group within a document

​
userGroupId
string

A resource identifier that uniquely identifies either a user or a group within the system. This identifier is used throughout the API for permission management and access control.

Format:

  • For users: user:{email} or user:{userId}
  • For groups: group:{groupName}
​
permission
enum<string>

The role/permission level granted to the user or group

Available options:
editor,
viewer
​
inheritedPermission
enum<string>

The permission level inherited from parent workspace

Available options:
manager,
viewer
​
message
string

Optional message or note about the permission assignment

​
createdAt
string<date-time>

ISO 8601 timestamp indicating when the permission was created

​
updatedAt
string<date-time>

ISO 8601 timestamp indicating when the permission was last modified

Response

Document permission updated successfully

Represents a permission assignment for a user or group within a document

​
userGroupId
string

A resource identifier that uniquely identifies either a user or a group within the system. This identifier is used throughout the API for permission management and access control.

Format:

  • For users: user:{email} or user:{userId}
  • For groups: group:{groupName}
​
permission
enum<string>

The role/permission level granted to the user or group

Available options:
editor,
viewer
​
inheritedPermission
enum<string>

The permission level inherited from parent workspace

Available options:
manager,
viewer
​
message
string

Optional message or note about the permission assignment

​
createdAt
string<date-time>

ISO 8601 timestamp indicating when the permission was created

​
updatedAt
string<date-time>

ISO 8601 timestamp indicating when the permission was last modified