Lists the groups that an EIAM user is a member of.
Try it now
Test
RAM authorization
Request syntax
GET /v2/{instanceId}/{applicationId}/users/{userId}/actions/listGroupsForUser HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Authorization |
string |
Yes |
The authentication information. Format: Bearer ${access_token}. Example: Bearer ATxxxx. |
Bearer xxxx |
| instanceId |
string |
Yes |
The instance ID. |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| applicationId |
string |
Yes |
The application ID. |
app_mkv7rgt4d7i4u7zqtzev2mxxxx |
| userId |
string |
Yes |
The user ID. |
user_d6sbsuumeta4h66ec3il7yxxxx |
| nextToken |
string |
No |
The token to retrieve the next page of results. Leave this parameter empty to query from the first page. |
NTxxx |
| maxResults |
integer |
No |
The number of entries per page. Default value: 20. |
20 |
Response parameters
|
Parameter |
Type |
Description |
Example |
|
object |
The response object. |
||
| totalCount |
integer |
The total number of entries. |
1000 |
| data |
array<object> |
The data object. |
|
|
object |
The data object. |
||
| instanceId |
string |
The instance ID. |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| groupId |
string |
The group ID. |
user_d6sbsuumeta4h66ec3il7yxxxx |
| groupMemberRelationSourceType |
string |
The source type of the group membership. |
build_in |
| groupMemberRelationSourceId |
string |
The source ID of the group membership. |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| nextToken |
string |
The token to retrieve the next page of results. If this parameter is not returned, all results have been returned. |
NTxxx |
| maxResults |
integer |
The maximum number of entries returned on each page. |
20 |
Examples
Success response
JSON format
{
"totalCount": 1000,
"data": [
{
"instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"groupId": "user_d6sbsuumeta4h66ec3il7yxxxx",
"groupMemberRelationSourceType": "build_in",
"groupMemberRelationSourceId": "idaas_ue2jvisn35ea5lmthk267xxxxx"
}
],
"nextToken": "NTxxx",
"maxResults": 20
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.