ListAuthorizationRules - Identity as a Service - Alibaba Cloud Documentation Center

Query 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 instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
NextToken	string	No	The token that marks the start of the next page. If not provided, the query starts from the first page by default.	NTxxxxxexample
MaxResults	integer	No	The maximum number of records per page. If not provided, the default value is 20. The maximum value is 100.	20
Filter	array<object>	No	Filter conditions.
	object	No	Filter conditions.
Name	string	No	The name of the filter field. Valid values: AuthorizationRuleId: The authorization rule ID. AuthorizationRuleNameStartWith: The left-match value of the authorization rule name.	AuthorizationRuleId
Value	array	No	The list of values for the filter field.
	string	No	The value of the filter field.	arrule_01kf143ug06fg7m9f43u7vahxxxx

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCount	integer	The total number of items in the list.	100
NextToken	string	The query credential (token) returned by this call, used for the next paged query.	NTxxxexample
MaxResults	integer	The number of rows per page for paged queries.	20
AuthorizationRules	array<object>	A list of authorization rules.
	object	The authorization rule data object.
InstanceId	string	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
AuthorizationRuleId	string	The authorization rule ID.	arrule_01kf143ug06fg7m9f43u7vahxxxx
AuthorizationRuleName	string	The authorization rule name.	test-name
Status	string	The status of the authorization rule. Valid values: enabled: Enabled. disabled: Disabled.	enabled
ProjectId	string	The project ID associated with the authorization rule.	iprj_system_default
AuthorizationResourceScope	string	Authorization resource scope. Options: global: Global resources for the project. custom: Resources within the specified project scope.	global
AuthorizationRuleCreationType	string	The creation type of the authorization rule. Valid values: system_init: System created. user_custom: User created.	user_custom
AuthorizationRuleSubjectScope	string	The scope of the authorization rule subject. Enumeration type: shared (supports all subjects, including accounts and applications), exclusive (exclusive type).
AuthorizationRuleSubjectType	string	The type of the authorization rule subject. Enumeration type: application (application), user (account).
AuthorizationRuleSubjectId	string	The authorization rule subject ID, which corresponds to the subject ID of the subject type.
Description	string	The description of the authorization rule.	this is a test
CreateTime	integer	The creation time in Unix timestamp format, in milliseconds.	1652085686179
UpdateTime	integer	The last update time in Unix timestamp format, in 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": "",
      "AuthorizationRuleSubjectType": "",
      "AuthorizationRuleSubjectId": "",
      "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.