/v1/permissionItems/deleteItems
—
delete

Delete permission items from a workspace. This operation removes existing permission grants or denials. You can delete permissions by specifying the exact criteria (target, entity, action) or use broader criteria to delete multiple permission items at once. The deletion is processed as a long-running job.

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
DeletePermissionItemsEndpointParams

Parameters for deleting permission items from a workspace.

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

Input for deleting a permission item. At least one target (targetId, filepath, folderpath, or workspaceRootname) must be specified.

{
targetId?: string | Array<string>
filepath?: string | Array<string>
folderpath?: string | Array<string>
workspaceRootname?: string
action?: string | Array<string>
access?: boolean
entityId?: string | Array<string>
}
200 — Response Headers
HttpEndpointResponseHeaders_ContentType_ContentLength

FieldTypeRequiredDescription
Content-TypestringYes

HTTP JSON response content type

Example: application/json

Content-LengthstringYes

HTTP response content length in bytes

Example: 1024

200 — Response Body
MultipleLongRunningJobResult

Response for operations that spawn multiple background jobs

{
jobIds: Array<string>
}
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
}