List user roles
Returns a list of available user roles (e.g., Manager, Collaborator, Downloader, Viewer, Uploader), including each role's name, rank, and type.
Parameters
Query Parameters
name
Optional
string
Role name
name:contains
Optional
string
Role name. Search for results that contain the specified characters in this parameter.
disabled
Optional
boolean
Whether Role is disabled
type
Optional
string
Filter roles by type. Accepted values: d, f.
orderBy
Optional
string[]
Sorting options
with
Optional
string
With parameters
mode
Optional
string
Determines the detail level of the response body.
Responses
List of user roles retrieved successfully.
id
integer
Role ID
name
string
Role name
rank
integer
Role rank
type
string
Role type
Request blocked by WAF
Empty response body.
Shell
curl -X GET \
"https://{instance}.kiteworks.com/rest/roles" \
-H "Authorization: Bearer YOUR_TOKEN"Python
import requests
url = "https://{instance}.kiteworks.com/rest/roles"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Responses
{
"data": [
{
"id": 1,
"name": "Manager",
"rank": 1,
"type": "d"
},
{
"id": 2,
"name": "Collaborator",
"rank": 2,
"type": "d"
}
]
}
// Error - No Body
Get a role
Returns the details of the specified role, including its name, rank, and type.
Parameters
Path Parameters
id
Required
integer
ID of the role to be retrieved
Responses
Role details retrieved successfully.
id
integer
Role ID
name
string
Role name
rank
integer
Role rank
type
string
Role type
Request blocked by WAF
Empty response body.
Shell
curl -X GET \
"https://{instance}.kiteworks.com/rest/roles/:id" \
-H "Authorization: Bearer YOUR_TOKEN"Python
import requests
id = "VALUE" # ID of the role to be retrieved
url = f"https://{{instance}}.kiteworks.com/rest/roles/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Responses
{
"id": 1,
"name": "Manager",
"rank": 1,
"type": "d"
}
// Error - No Body