Queries accounts in an Employee Identity and Access Management (EIAM) group.
Try it now
Test
RAM authorization
Request syntax
GET /v2/{instanceId}/{applicationId}/groups/{groupId}/actions/listUsersForGroup HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| instanceId |
string |
Yes |
The instance ID. |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| applicationId |
string |
Yes |
The application ID. |
app_mkv7rgt4d7i4u7zqtzev2mxxxx |
| groupId |
string |
Yes |
The group ID. |
group_wovwffm62xifdziem7an7xxxxx |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Authorization |
string |
Yes |
The authentication information. The value is in the Bearer ${access_token} format. Example: Bearer ATxxxx. |
Bearer xxxx |
| nextToken |
string |
No |
nextToken |
NTxxx |
| maxResults |
integer |
No |
The number of entries per page. Default value: 20. |
20 |
If you set groupId to iggroup_all, the system queries accounts in all groups.
Response elements
|
Element |
Type |
Description |
Example |
|
object |
DeveloperNextTokenResponse |
||
| totalCount |
integer |
The total number of entries returned. |
1000 |
| data |
array<object> |
The returned data. |
|
|
object |
The returned data. |
||
| instanceId |
string |
The instance ID. |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| userId |
string |
The account ID. |
user_001 |
| nextToken |
string |
A pagination token. If NextToken is empty, no next page exists. |
NTxxx |
| maxResults |
integer |
The maximum number of entries returned. |
20 |
Examples
Success response
JSON format
{
"totalCount": 1000,
"data": [
{
"instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"userId": "user_001"
}
],
"nextToken": "NTxxx",
"maxResults": 20
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.