Retrieves information about Employee Identity and Access Management (EIAM) groups by page.
Try it now
Test
RAM authorization
Request syntax
GET /v2/{instanceId}/{applicationId}/groups HTTP/1.1Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| instanceId |
string |
Yes |
The instance ID. |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| applicationId |
string |
Yes |
The application ID. |
app_mkv7rgt4d7i4u7zqtzev2mxxxx |
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 |
| groupNameStartWith |
string |
No |
The prefix of the group name. |
group_xxx |
| nextToken |
string |
No |
nextToken |
NTxxx |
| maxResults |
integer |
No |
The number of entries per page. Default value: 20. |
20 |
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 |
| groupId |
string |
The group ID. |
group_ufdsasn35ea5lmthk267xxxxx |
| groupName |
string |
The group name. |
name_test |
| description |
string |
The group description. |
description_demo |
| groupExternalId |
string |
The external ID of the group. |
group_ufdsasn35ea5lmthk267xxxxx |
| groupSourceType |
string |
The source type of the group. Valid values: build_in, ding_talk, ad, and ldap. |
build_in |
| groupSourceId |
string |
The source ID of the group. |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| createTime |
integer |
The time when the group was created. The value is a UNIX timestamp. Unit: milliseconds. |
1652085686179 |
| updateTime |
integer |
The time when the group was last updated. The value is a UNIX timestamp. Unit: milliseconds. |
1652085686179 |
| nextToken |
string |
The start position of the query. If this parameter is left empty, the query starts from the beginning. |
NTxxx |
| maxResults |
integer |
The maximum number of entries returned. |
20 |
Examples
Success response
JSON format
{
"totalCount": 1000,
"data": [
{
"instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"groupId": "group_ufdsasn35ea5lmthk267xxxxx",
"groupName": "name_test",
"description": "description_demo",
"groupExternalId": "group_ufdsasn35ea5lmthk267xxxxx",
"groupSourceType": "build_in",
"groupSourceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"createTime": 1652085686179,
"updateTime": 1652085686179
}
],
"nextToken": "NTxxx",
"maxResults": 20
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.