List Application Groups via API to Audit Access - Identity as a Service

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

eiam:ListGroupsForApplication

list

*Application

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
PageNumber	integer	No	The page number of the list.	1
PageSize	integer	No	The number of entries per page.	20
ApplicationId	string	Yes	The application ID.	app_mkv7rgt4d7i4u7zqtzev2mxxxx
GroupIds	array	No	A list of group IDs. You can specify up to 100 group IDs in a single operation.	group_miu8e4t4d7i4u7uwezgr54xxxx
	string	No	The group ID.	group_miu8e4t4d7i4u7uwezgr54xxxx
ApplicationRoleId	string	No	The application role ID.	app_role_mkv7rgt4ds8d8v0qtzev2mxxxx

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCount	integer	The total number of entries.	100
Groups	array<object>	The list of groups.
	array<object>	The ID of the group.
GroupId	string	The group ID.	group_miu8e4t4d7i4u7uwezgr54xxxx
ApplicationRoles	array<object>	The list of application roles. This parameter is not returned for SAML applications.
	object	The application role object.
ApplicationRoleId	string	The ID of the application role.	app_role_mkv7rgt4ds8d8v0qtzev2mxxxx

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "Groups": [
    {
      "GroupId": "group_miu8e4t4d7i4u7uwezgr54xxxx",
      "ApplicationRoles": [
        {
          "ApplicationRoleId": "app_role_mkv7rgt4ds8d8v0qtzev2mxxxx"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.