Acquire a list of roles

This is an API function to acquire a list of roles. This API function corresponds to the operation on the screen that is displayed by clicking the [Role] tab after selecting the [Security] on the operation screen of Manager.

Format

curl -X GET --header 'Accept: application/json'

--header 'X-API-KEY:APIKEY'

'http://HOSTNAME:PORTNUMBER/api/v1/user-role?REQUESTINQUERYFORMAT'

Request parameter (Query format)
Item name Request parameter Type Value Default value
Number of pages page Integer

Specify a number from zero.

If the number of pages is 1, specify 0.

0
Number of items per page size Integer   10
Response

{

"content": [

{

"description": "string",

"userRoleId": "string",

"userRoleName": "string"

}

],

"first": true,

"last": true,

"number": 0,

"numberOfElements": 0,

"size": 0,

"sort": [],

"totalElements": 0,

"totalPages": 0

}

Response parameter
Item name Response parameter Type Value
Description content description String Maximum 128 characters
Role ID userRoleId String  
Role Name userRoleName String

• USER: a general user

• ADMIN: an administrator

For details about the parameters for page settings (first, last, number, numberOfElements, size, sort, totalElements, totalPages), see Response parameters for page settings.