Search Groups Using GET

Search Groups Using GET

In this case the PagedResponse.results field will contain Group object. See the Group model for reference.

Request
URI
GET
https://{api_host}//cava-s-182-041.eng.vmware.com/csp/gateway/am/api/groups/search
COPY
Query Parameters
string
idpId
Optional

This parameter is included for CSP compatibility and its value is ignored.

integer
pageLimit
Optional

The index of the first element of the page. One based.

integer
pageStart
Optional

The number of results per page.

string
searchTerm
Required

The search term, uses 'contains' filter on the group displayName attribute.

Responses
200

OK

Returns PagedResponse_Group_ of type(s) */* 
{
    "nextLink": "string",
    "prevLink": "string",
    "results": [
        {
            "displayName": "string",
            "domain": "string",
            "id": "string",
            "usersCount": 0
        }
    ],
    "totalResults": 0
}
string
nextLink
Optional

URL to the next page of results.

string
prevLink
Optional

URL to the previous page of result.

array of Group
results
Optional

The list of results.

integer As int32 As int32
totalResults
Optional

The total number of results on all pages.


On This Page
Group Controller Operations
GET
Search Groups Using GET