permissions

1 endpoint
GET/rest/permissions/task/{task_id}

Return the list of permissions available on a task

Returns the list of actions the current user is allowed to perform on the specified task, such as completing or deleting it.

Parameters
Path Parameters
task_id
Required
integer

ID of the task

Query Parameters
id
Optional
integer

Unique action identifier

id:in
Optional
integer

Unique action identifier. Search for results that match any of the specified values for this parameter.

name
Optional
string

Action name

name:contains
Optional
string

Action name. Search for results that contain the specified characters in this parameter.

allowed
Optional
boolean

Determines if one has permissions to perform action

enabled
Optional
boolean

Determines if the given action is available considering the current object state (locked, deleted, etc.).

with
Optional
string

With parameters

mode
Optional
string

Determines the detail level of the response body.

Responses

Task permissions retrieved successfully.

id
integer

Unique identifier for the permission.

name
string

Name of the permission.

allowed
boolean

Indicates whether the permission is granted (True) or denied (False).

Request blocked by WAF

Empty response body.
Shell
curl -X GET \
  "https://{instance}.kiteworks.com/rest/permissions/task/:task_id" \
  -H "Authorization: Bearer YOUR_TOKEN"
Python
import requests

task_id = "VALUE"  # ID of the task

url = f"https://{{instance}}.kiteworks.com/rest/permissions/task/{task_id}"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())
Responses
{ "data": [ { "id": "TASK_COMPLETE", "name": "Complete Task", "allowed": true } ] }
// Error - No Body
Previousnotifications
Nextprofiles