ListGroups - Identity as a Service - Alibaba Cloud Documentation Center

Queries information about Employee Identity and Access Management (EIAM) groups by page.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /v2/{instanceId}/{applicationId}/groups HTTP/1.1

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
instanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
applicationId	string	Yes	The application ID.	app_mkv7rgt4d7i4u7zqtzev2mxxxx
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 parameters

Parameter	Type	Description	Example
	object	DeveloperNextTokenResponse
totalCount	long	The total number of entries returned.	1000
data	array<object>	The returned data.
data	object	The returned data.
groupName	string	The group name.	name_test
instanceId	string	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
createTime	long	The time when the group was created. The value is a UNIX timestamp. Unit: milliseconds.	1652085686179
groupId	string	The group ID.	group_ufdsasn35ea5lmthk267xxxxx
groupSourceType	string	The source type of the group. Valid values: build_in, ding_talk, ad, and ldap.	build_in
description	string	The group description.	description_demo
groupSourceId	string	The source ID of the group.	idaas_ue2jvisn35ea5lmthk267xxxxx
updateTime	long	The time when the group was last updated. The value is a UNIX timestamp. Unit: milliseconds.	1652085686179
groupExternalId	string	The external ID of the group.	group_ufdsasn35ea5lmthk267xxxxx
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

Sample success responses

JSONformat

{
  "totalCount": 1000,
  "data": [
    {
      "groupName": "name_test",
      "instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "createTime": 1652085686179,
      "groupId": "group_ufdsasn35ea5lmthk267xxxxx",
      "groupSourceType": "build_in",
      "description": "description_demo",
      "groupSourceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "updateTime": 1652085686179,
      "groupExternalId": "group_ufdsasn35ea5lmthk267xxxxx"
    }
  ],
  "nextToken": "NTxxx",
  "maxResults": 20
}

Error codes

For a list of error codes, visit the Service error codes.