Search User Group

This API is used to search / get the details about a user group. The user group can be filtered by the given input.

URL: /usergroup-search

Type: POST

Parameters


Param Type	Name	Description	Field Type
`Header`	sessionId (or) Token	Use either Session Id or Token received after login.	`String`
`Query`	gwkey	Tenant Key. Needed only in case of multi-tenant installations.	`String`
`Query`	gwsource**	Source from which the request is triggered (Eg: 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	Order of sorting. Possible values are asc and desc.	`String`

** - Mandatory value

Possible Response Message and Code


HTTP Code	Description	Response Message
200	Accepted	Matching results found for the given input.
404	Bad request	No matching records found.

Sample Request/Response

Use Case

Get the details about a user group with the name usergroup_1.

Request URL

https://appviewxapi.com/avxapi/usergroup-search?gwkey=f000ca01&gwsource=external

Request Payload

 {
 "payload": {
 "startIndex" : 1,
 "maxSize" :1,
 "sortColumn" : "name",
 "sortOrder":"asc",
 "filterValue" : "admin usergroup"
 }
 }

Response

 {
 "response":{
 "data":[
 {
 "name": "super access",
 "description": "Super access will have the permissions to access all the resources in AppViewX.",
 "state": "A",
 "_id": "super access",
 "_keywords":[
 "super access",
 "Super access will have the permissions to access all the resources in AppViewX.",
 "Enabled"
 ]
 }
 ],
 "totalRecords": 1,
 "obtainedRecords": 1,
 "obtainedRecordRange":{
 "start": 1,
 "end": 1
 }
 },
 "message": "Matching results found for the given input.",
 "appStatusCode": null,
 "tags": null,
 "headers": null
 }