Search local users assigned to role
Searches for local users assigned to the specified role and returns user information.
This topic includes the following sections:
Request
HTTP method: POST
URL: https://<HOST>:<PORT>/rsso/config/local/role/getassigneduser
Header: For header information, such as required authentication token, see Remedy-SSO-administrator-Login-and-Logout-calls.
Request body properties
Properties | Type | Required | Description | Values | Default value |
---|---|---|---|---|---|
roleName | String | Yes | Role name for searching for users assigned to it | User-provided value | NA |
pageSize | Integer | Yes | The number of user records to be listed per page | User-provided value | -1 |
pageStart | Integer | Yes | The starting page number for the search results | User-provided value | 0 |
pageNumber | Integer | Yes | The total number of pages the search results should contain | User-provided value | 0 |
Example request JSON
"roleName" : "role1",
"pageSize" : "40",
"pageStart" : "1",
"pageNumber" : "1"
}
Response
If successful, this method returns local users who are assigned to the specified role.
Response body properties
Property | Description |
---|---|
code | Status code (see Status codes and messages) |
msg | Status |
data | List of users that match the submitted query |
Example response JSON
"msg":"OK",
"data":["user1"]
}
Status codes and messages
For more details about HTTP response codes, see HTTP response codes.
HTTP code | Message (msg) | Description |
---|---|---|
200 | OK | Request succeeded |
400 |
| Bad request Some causes are
|
401 |
| Unauthorized |
Related topics
Search-local-users-not-assigned-to-role