Query user groups by using ListGroups - Resource Access Management - Alibaba Cloud - Resource Access Management

Queries the list of user groups by calling the ListGroups operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ram:ListGroups

get

*Group

acs:ram:*:{#accountId}:group/*

None

Request parameters

Parameter	Type	Required	Description	Example
Marker	string	No	The token for querying the next page of results. You do not need to specify `Marker` for the first API call. If the total number of returned entries exceeds the `MaxItems` limit during the first API call, the data is truncated and only `MaxItems` entries are returned. In this case, the `IsTruncated` response parameter is `true` and a `Marker` is returned. You can use the `Marker` returned from the previous call to continue calling the API with the other request parameters unchanged to query the truncated data. You can repeat this process until `IsTruncated` is `false`, which indicates that all data has been queried.	EXAMPLE
MaxItems	integer	No	The maximum number of entries per page. Valid values: 1 to 100. Default value: 100.	100

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	065527AA-2F2E-AD7C-7484-F2626CFE4934
Groups	object
Group	array<object>	The user group information.
	object	The user group information.
GroupId	string	The user group ID.	g-FpMEHiMysofp****
UpdateDate	string	The update time in UTC. The time is in the `YYYY-MM-DDThh:mm:ssZ` format.	2015-01-23T12:33:18Z
GroupName	string	The user group name.	Dev-Team
Comments	string	The comment.	Development team
CreateDate	string	The creation time in UTC. The time is in the `YYYY-MM-DDThh:mm:ssZ` format.	2015-01-23T12:33:18Z
IsTruncated	boolean	Indicates whether the returned results are truncated. Valid values: true false	true
Marker	string	The token for querying the next page of results. Note This parameter is returned only when `IsTruncated` is `true`.	EXAMPLE

Examples

Success response

JSON format

{
  "RequestId": "065527AA-2F2E-AD7C-7484-F2626CFE4934",
  "Groups": {
    "Group": [
      {
        "GroupId": "g-FpMEHiMysofp****",
        "UpdateDate": "2015-01-23T12:33:18Z",
        "GroupName": "Dev-Team",
        "Comments": "Development team",
        "CreateDate": "2015-01-23T12:33:18Z"
      }
    ]
  },
  "IsTruncated": true,
  "Marker": "EXAMPLE"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.