Query Authorization Rules with ListAuthorizationRules API - EIAM

Lists authorization rules.

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:ListAuthorizationRules

list

*AuthorizationRule

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	idaas_ue2jvisn35ea5lmthk267xxxxx
NextToken	string	No	The token that identifies the start of the next page of results. If you do not specify this parameter, the system returns the first page of results.	NTxxxxxexample
MaxResults	integer	No	The maximum number of entries to return on each page. If you do not specify this parameter, the default value is 20. The maximum value is 100.	20
Filter	array<object>	No	The filter conditions.
	object	No	The filter condition.
Name	string	No	The name of the field to filter. Valid values: AuthorizationRuleId: the ID of the authorization rule. AuthorizationRuleNameStartWith: the leftmost characters of the authorization rule name.	AuthorizationRuleId
Value	array	No	The list of values for the field to filter.
	string	No	The value of the field to filter.	arrule_01kf143ug06fg7m9f43u7vahxxxx

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCount	integer	The total number of entries in the list.	100
NextToken	string	The token returned by this call. Use it in the next call to retrieve the next page of results.	NTxxxexample
MaxResults	integer	The number of entries per page.	20
AuthorizationRules	array<object>	The list of authorization rules.
	object	The authorization rule object.
InstanceId	string	The ID of the instance.	idaas_ue2jvisn35ea5lmthk267xxxxx
AuthorizationRuleId	string	The ID of the authorization rule.	arrule_01kf143ug06fg7m9f43u7vahxxxx
AuthorizationRuleName	string	The name of the authorization rule.	test-name
Status	string	The status of the authorization rule. Valid values: enabled disabled	enabled
ProjectId	string	The ID of the project associated with the authorization rule.	iprj_system_default
AuthorizationResourceScope	string	The scope of resources to authorize. Valid values: global: global resources in the project custom: resources in a specific project	global
AuthorizationRuleCreationType	string	The type of authorization rule creation. Valid values: system_init: created by the system user_custom: created by a user	user_custom
AuthorizationRuleSubjectScope	string	The scope of subjects for the authorization rule. Valid values: shared: applies to all subjects, such as accounts and applications exclusive: applies only to a specific subject	shared
AuthorizationRuleSubjectType	string	The type of subject associated with the authorization rule. This parameter takes effect only when AuthorizationRuleSubjectScope is exclusive. Valid values: application user	user
AuthorizationRuleSubjectId	string	The ID of the subject associated with the authorization rule.	user_d6sbsuumeta4h66ec3il7yxxxx
Description	string	The description of the authorization rule.	this is a test
CreateTime	integer	The time when the authorization rule was created, in Unix timestamp format. Unit: milliseconds.	1652085686179
UpdateTime	integer	The time when the authorization rule was last updated, in Unix timestamp format. Unit: milliseconds.	1652085686179

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "NextToken": "NTxxxexample",
  "MaxResults": 20,
  "AuthorizationRules": [
    {
      "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "AuthorizationRuleId": "arrule_01kf143ug06fg7m9f43u7vahxxxx",
      "AuthorizationRuleName": "test-name",
      "Status": "enabled",
      "ProjectId": "iprj_system_default",
      "AuthorizationResourceScope": "global",
      "AuthorizationRuleCreationType": "user_custom",
      "AuthorizationRuleSubjectScope": "shared",
      "AuthorizationRuleSubjectType": "user",
      "AuthorizationRuleSubjectId": "user_d6sbsuumeta4h66ec3il7yxxxx",
      "Description": "this is a test",
      "CreateTime": 1652085686179,
      "UpdateTime": 1652085686179
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.