[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator
Search Groups
DescriptionSearches for federation groups by name within an organization. The search criteria is captured in the searchTerm parameter. Search results are paginated and returned as GroupDto object.
Request
URLURL
https://console.navigator.vmware.com/cphub/api/auth/v1/federation/orgs/{orgId}/groups/search
Path Parameters
Path Parameters
string
orgId
Required
Unique identifier (GUID) of the organization.
Query Parameters
Query Parameters
string
pageLimit
Optional
- Maximum number of groups to return in response. Defaults to 100
string
pageStart
Optional
- Start index of records to fetch. Defaults to 1
string
searchTerm
Optional
- This parameter is mandatory parameter, the results will be filtered based on the given string value
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
PagedResponseGroups
of type application/json
This response body class contains all of the following:
PagedEntityDetails, InlinePagedResponseGroups1
No error details were provided in the OpenAPI specification.
Code SamplesCode Samples
cURL Command
curl https://console.navigator.vmware.com/cphub/api/auth/v1/federation/orgs/{orgId}/groups/search
[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator
