Search for Role
Search for a role based on the input filter condition. A role is a logical entity to group one or more Access Control Functions. The response could be one or more resource(s) matching the input.
URL: /role-search
Type: POST
Parameter
| Param Type | Name | Description | Field Type |
|---|---|---|---|
| Header | sessionId ** | Session Id received after login | string |
| Query | Gwkey | Tenant Key. Needed only in case of multitenant installations | string |
| Query | gwsource** | Source from which the request is triggered (for example, web, external) | String |
| Payload | filterValue | Input filter value string to filter the role. | String |
| Payload | sortColumn | Column by which the output has to be sorted | String |
| Payload | startIndex | Start index to show in output in case if there are more than one matching records | Integer |
| Payload | maxSize | The number of records to return in a response. maxSize is starting from the start index | Integer |
| Payload | sortOrder | The order to sort. Possible values are asc and desc | String |
** - Mandatory value
Possible Response Message and Code
| HTTP Code | Description | Response Message |
|---|---|---|
| 200 | OK | Matching results found for the given input. |
| 404 | OK | No matching records found. |
| 400 | Bad request | Invalid sortColumn |