[{"label":"Latest (v1.0)","version":"latest"}]
csp

Get Groups In Organizations By Organization ID And Group Search Term

Description

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

Request

URL

URL


get
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups-search
Copy

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

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns SearchGroupsResponse of type application/json
{
	"results": [
		{
			"customRoles": [
				{
					"createdBy": "string",
					"createdDate": "string",
					"expiresAt": 3609941597,
					"lastUpdatedBy": "string",
					"lastUpdatedDate": "string",
					"membershipType": "DIRECT",
					"name": "string",
					"resource": "string"
				}
			],
			"description": "string",
			"displayName": "string",
			"domain": "string",
			"groupType": "USER_GROUP",
			"id": "string",
			"organizationRoles": [
				{
					"createdBy": "string",
					"createdDate": "string",
					"displayName": "string",
					"expiresAt": 3609941597,
					"lastUpdatedBy": "string",
					"lastUpdatedDate": "string",
					"membershipType": "DIRECT",
					"name": "string",
					"resource": "string"
				}
			],
			"ownerOrgId": "string",
			"serviceRoles": [
				{
					"serviceDefinitionId": "string",
					"serviceRoleNames": [
						"string"
					],
					"serviceRoles": [
						{
							"createdBy": "string",
							"createdDate": "string",
							"expiresAt": 3609941597,
							"lastUpdatedBy": "string",
							"lastUpdatedDate": "string",
							"membershipType": "DIRECT",
							"name": "string",
							"resource": "string"
						}
					]
				}
			],
			"sharedOrgIds": [
				"string"
			],
			"usersCount": 0
		}
	]
}
array of ExpandedGroupDto
results Optional

List of groups that are found.

Errors

Errors

400

groupSearchTerm query parameter must be specified


401

The user is not authorized to use the API


403

The user is forbidden to use the API


404

Organization with this identifier is not found.


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups-search?groupSearchTerm=string
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_member,org_owner
x-slo-tier: TIER2


Feedback

Was this page helpful?