Get All Roles
Returns all existing roles in the service instance with detailed information for each role, including assigned groups and accounts, management properties, permissions, name, ID, description, and the time of the last update and who has done it.
Request
URI
GET
https://{api_host}/api/v2/role
COPY
Query Parameters
integer
offset
Optional
offset
integer
limit
Optional
limit
Responses
200
successful operation
Returns ResponseContainerPagedRoleDTO of type(s) application/json
{
"status": {
"result": "string",
"message": "string",
"code": 0
},
"response": {
"items": [
{
"sampleLinkedGroups": [
"UserGroup Object"
],
"linkedGroupsCount": 0,
"sampleLinkedAccounts": [
"string"
],
"linkedAccountsCount": 0,
"restrictedPermissions": [
"string"
],
"properties": {
"nameEditable": false,
"usersRemovable": false,
"usersAddable": false,
"permsEditable": false,
"deletable": false
},
"permissions": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": 0,
"lastUpdatedMs": 0,
"lastUpdatedAccountId": "string",
"customer": "string"
}
],
"offset": 0,
"limit": 0,
"cursor": "string",
"totalItems": 0,
"moreItems": false,
"sort": {
"ascending": false,
"field": "string",
"default": false
}
}
}