[{"label":"Latest (v1.0)","version":"latest"}]
csp
Get Logged In User Groups On Organization By Organization ID
DescriptionGet Principal User Groups Information Within the Specified Organization
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| All Roles | ✔️ | ❌ |
Request
URLURL
https://{api_host}/csp/gateway/am/api/loggedin/user/orgs/{orgId}/groups
Path Parameters
Path Parameters
string
orgId
Required
Unique identifier (GUID) of the organization.
Parameter Serialization Style:
simple Explode:false
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse 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
}
]
}
Errors
CspErrorResponse
401
The user is not authorized to use the API
CspErrorResponse
403
The user is forbidden to use the API
CspErrorResponse
404
No user with given token exists | Organization not found
CspErrorResponse
429
The user has sent too many requests
CspErrorResponse
500
An unexpected error has occurred while processing the request
Code Samples
cURL Command
curl https://{api_host}/csp/gateway/am/api/loggedin/user/orgs/{orgId}/groups
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-required-roles: any
x-slo-tier: TIER2
[{"label":"Latest (v1.0)","version":"latest"}]
csp
