View Role List
- Print
- PDF
View Role List
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
View the list of roles.
API
- GET /roles
Requests
Parameters
| Parameters | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| searchColumn | N | String | roleName, roleType, nrn | Search column roleName, roleType, nrn |
| searchWord | N | String | Search keywords | |
| page | N | int | Page number (default value: 0) | |
| size | N | int | Result list size (default value: 10) |
Response
{
"hasNext": "boolean",
"hasPrevious": "boolean",
"isFirst": "boolean",
"isLast": "boolean",
"items": [
{
"active": "boolean",
"createTime": "string",
"descCont": "string",
"lastUseTime": "string",
"modifiedTime": "string",
"nrn": "string",
"roleName": "string",
"roleNo": "string",
"roleType": "string"
"sessionExpirationSec": "integer"
}
],
"page": "integer",
"totalItems": "integer",
"totalPages": "integer"
}
| Item | Type | Description | Remarks |
|---|---|---|---|
| hasNext | boolean | Whether there is a next page | |
| hasPrevious | boolean | Whether there is a previous page | |
| isFirst | boolean | Whether this is the first page | |
| isLast | boolean | Whether this is the last page | |
| items | array | ||
| items.active | boolean | Role status (true: enabled, false: disabled) | |
| items.createTime | string | Created: 2019-08-10T13:21:00Z | |
| items.descCont | string | Role description (max: 300 bytes) | |
| items.lastUseTime | string | Last used: 2019-08-10T13:21:00Z | |
| items.modifiedTime | string | Last modified: 2019-08-10T13:21:00Z | |
| items.nrn | string | Role nrn | |
| items.roleName | string | Role name | |
| items.roleNo | string | Role No | |
| items.roleType | string | Role type (available: Server, Account) | |
| items.sessionExpirationSec | integer | Session expiration time (available: 600,1800,3600,10800) | |
| page | integer | Page number | |
| totalItems | integer | Total number of items | |
| totalPages | integer | Total number of pages |
Was this article helpful?