Get Groups In Organizations By Organization ID And Group Search Term
Search groups in organization having display name which “contains” search term.
Search results limited to first 20 results. Please refine the search term for accurate results.
Organization members will receive basic group information. Organization owners will additionally receive role details of the groups.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Member | ✔️ | ✔️ |
| Organization Owner | ✔️ | ✔️ |
Request
URLURL
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups-search
Path Parameters
Path Parameters
string
orgId
Required
Unique identifier (GUID) of the organization.
Parameter Serialization Style:simple Explode:false
Query Parameters
Query Parameters
string
groupSearchTerm
Required
The string to be searched within groups’ display name.
Parameter Serialization Style:form Explode:true
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
SearchGroupsResponse of type application/json
{
"results": [
{
"customRoles": [
{
"expiresAt": 3609941597,
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
],
"description": "string",
"displayName": "string",
"domain": "string",
"groupType": "USER_GROUP",
"id": "string",
"organizationRoles": [
{
"displayName": "string",
"expiresAt": 3609941597,
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
],
"ownerOrgId": "string",
"serviceRoles": [
{
"serviceDefinitionId": "string",
"serviceRoleNames": [
"string"
],
"serviceRoles": [
{
"expiresAt": 3609941597,
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
]
}
],
"sharedOrgIds": [
"string"
],
"usersCount": 0
}
]
}
Errors
Code Samples
Code Samples
cURL Command
curl https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups-search?groupSearchTerm=string
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_member,org_owner
x-slo-tier: TIER2
On This Page
Organization Operations
post
