/v1/permissionItems/addItems
—
post

Add permission items to a workspace. Permission items define what actions entities (users, permission groups, or agent tokens) can or cannot perform on specific targets (files, folders, or workspace resources). Each permission item specifies: - A target (what resource the permission applies to) - An entity (who the permission applies to) - An action (what operation is being permitted/denied) - Access level (grant or deny)

Path Parameters
Not Applicable
Request Headers
HttpEndpointRequestHeaders_AuthRequired_JsonContentType

FieldTypeRequiredDescription
AuthorizationstringYes

Access token

Example: Bearer <token>

Content-TypestringYes

HTTP JSON request content type

Example: application/json

Request Query
Not Applicable
Request Body
AddPermissionItemsEndpointParams

Parameters for adding permission items to a workspace.

{
workspaceId?: string
items: Array<PermissionItemInput>
}
PermissionItemInput

Input for creating a new permission item. Must specify target (targetId, filepath, folderpath, or workspaceRootname), entity, action, and access level.

{
targetId?: string | Array<string>
filepath?: string | Array<string>
folderpath?: string | Array<string>
workspaceRootname?: string
access: boolean
entityId: string | Array<string>
action: string | Array<string>
}
200 — Response Headers
Not Applicable
200 — Response Body
Not Applicable
4XX or 5XX — Response Headers
HttpEndpointResponseHeaders_ContentType_ContentLength

FieldTypeRequiredDescription
Content-TypestringYes

HTTP JSON response content type

Example: application/json

Content-LengthstringYes

HTTP response content length in bytes

4XX or 5XX — Response Body
EndpointErrorResult

Endpoint error result

{
errors?: Array<ExternalError>
}
ExternalError

{
message: string
}