[{"label":"Latest (v1.0)","version":"latest"}]
csp
Get User Groups By User Email And Organization ID
DescriptionGet user groups by account identifier
Access Policy
Role | User Accounts | Service Accounts (Client Credentials Applications) |
---|---|---|
Organization Admin | ✔️ | ✔️ |
Organization Owner | ✔️ | ✔️ |
Request
URLURL
https://{api_host}/csp/gateway/am/api/users/{acct}/orgs/{orgId}/groups
Path Parameters
Path Parameters
string
acct
Required
The identifier of the user, configured to log in to the Identity provider.
Parameter Serialization Style:
SIMPLE Explode:false
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
User not found | 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/users/{acct}/orgs/{orgId}/groups
[{"label":"Latest (v1.0)","version":"latest"}]
csp