ListGroups - Identity as a Service - Alibaba Cloud Documentation Center

Queries a list of account groups in Identity as a Service (IDaaS) Employee Identity and Access Management (EIAM).

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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
eiam:ListGroups	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
PageNumber	long	No	The number of the page to return.	1
PageSize	long	No	The number of entries to return on each page.	20
GroupIds	array	No	The group IDs.
	string	No	The group ID.	group_d6sbsuumeta4h66ec3il7yxxxx
GroupName	string	No	The name of the group. If you specify this parameter, the query is based on an exact match.	name_test
GroupNameStartsWith	string	No	The prefix of the group name. If you specify this parameter, the query follows the leftmost matching principle.	name
GroupExternalId	string	No	The external ID of the group.	group_external_id

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCount	long	The total number of entries returned. The maximum number of entries returned at a time depends on the value of PageSize.	100
Groups	array<object>	The queried account groups.
Group	object	The information about the array object.
GroupId	string	The group ID.	group_d6sbsuumeta4h66ec3il7yxxxx
GroupName	string	The name of the group.	group_name
Description	string	The description of the group.	test group
GroupExternalId	string	The external ID of the group, which can be used to associate the group with an external system. By default, the external ID is the group ID.	group_d6sbsuumeta4h66ec3il7yxxxx
GroupSourceType	string	The source type of the group. Only build_in may be returned, which indicates that the group was created in IDaaS.	build_in
GroupSourceId	string	The source ID of the group. If the group was imported from other services, this value indicates the external source ID. By default, the source ID is the instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
CreateTime	long	The time at which the group was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1652085686179
UpdateTime	long	The time at which the group was last updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1652085686179
InstanceId	string	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx

Examples

Sample success responses

JSONformat

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "Groups": [
    {
      "GroupId": "group_d6sbsuumeta4h66ec3il7yxxxx",
      "GroupName": "group_name",
      "Description": "test group",
      "GroupExternalId": "group_d6sbsuumeta4h66ec3il7yxxxx",
      "GroupSourceType": "build_in",
      "GroupSourceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "CreateTime": 1652085686179,
      "UpdateTime": 1652085686179,
      "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx"
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history