[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator

Search Groups

Description

Searches 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

Request

URL

URL


get
https://{api_host}/v1/federation/orgs/{orgId}/groups/search
Copy

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

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response 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 Samples

Code Samples

cURL Command

curl https://{api_host}/v1/federation/orgs/{orgId}/groups/search


Feedback

Was this page helpful?