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

Get User Groups By User ID And Organization ID

Description

Get user groups by userId

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Organization Owner ✔️ ✔️

Request

Request

URL

URL


get
https://{api_host}/csp/gateway/am/api/v2/users/{userId}/orgs/{orgId}/groups
Copy

Path Parameters

Path Parameters

string
userId Required

The unique identifier of the user, on behalf of which the token was issued.

Parameter Serialization Style: simple Explode:false

string
orgId Required

Unique identifier (GUID) of the organization.

Parameter Serialization Style: simple Explode:false

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns UserGroupsResponse of type application/json
{
	"groups": [
		{
			"description": "string",
			"displayName": "string",
			"domain": "string",
			"groupType": "USER_GROUP",
			"id": "string",
			"ownerOrgId": "string",
			"sharedOrgIds": [
				"string"
			],
			"usersCount": 0
		}
	]
}
array of GroupDto
groups Optional

Set of user groups information.

Errors

Errors

401

The user is not authorized to use the API


403

The user is forbidden to use the API


404

User not found | Organization 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/v2/users/{userId}/orgs/{orgId}/groups
Vendor Extensions

Vendor Extensions

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


Feedback

Was this page helpful?