Skip to main content
POST
/
organizations
/
{organizationName}
/
workspaces
/
{workspaceName}
/
documents
/
{documentPath}
/
permissions
{
  "userGroupId": "<string>",
  "permission": "editor",
  "inheritedPermission": "manager",
  "message": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Path Parameters

​
organizationName
string
required

The unique identifier of the organization

​
workspaceName
string
required

The unique identifier of the workspace

​
documentPath
string
required

The path to the document within the workspace

Query Parameters

​
requestPermission
boolean
default:false

Indicates that the user is requesting access to the resource

Body

application/json

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

​
userGroupId
string

User or group identifier pattern (user must be valid email address, group is standard identifier)

​
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 created successfully

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

​
userGroupId
string

User or group identifier pattern (user must be valid email address, group is standard identifier)

​
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

⌘I