ListResourceServerScopes - Identity as a Service - Alibaba Cloud Documentation Center

Queries the list of scope permissions under a specified ResourceServer by using a cursor.

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

list

*ResourceServerScope

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

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
NextToken	string	No	The pagination token (NextToken) used to retrieve the next page of results. Set this parameter to the NextToken value returned in the previous API call. Leave this parameter empty for the first query.	NTxxxxxexample
MaxResults	integer	No	The number of entries per page in a paged query.	20
ApplicationId	string	Yes	The application ID.	app_mkv7rgt4d7i4u7zqtzev2mxxxx
ResourceServerScopeName	string	No	The scope permission name.	读取全部用户
ResourceServerScopeValue	string	No	The scope permission value.	User:Write:ALL
PreviousToken	string	No	The pagination token for the previous page. Set this parameter to the PreviousToken value returned in the previous API call.	PTxxxxxexample
ResourceServerScopeType	string	No	The scope permission type. Valid values: urn:alibaba:idaas:resourceserver:scope:application : Machine permission. urn:alibaba:idaas:resourceserver:scope:application_delegated : urn:alibaba:idaas:resourceserver:scope:application_delegated urn:alibaba:idaas:resourceserver:scope:delegated : User permission.	urn:alibaba:idaas:resourceserver:scope:delegated
AuthorizationType	string	No	The authorization type. Valid values: authorize_required : Manual authorization. default_all : Automatic authorization.	authorize_required
ResourceServerScopeIds	array	No	The list of scope permission IDs.
	string	No	The scope permission ID.	ress_neg35flu6byysxwutaxu3dxxxx

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCount	integer	The total number of entries in the list.	100
NextToken	string	The pagination token for the next page.	NTxxxexample
MaxResults	integer	The number of entries per page in a paged query.	20
ResourceServerScopes	array<object>	The list of scope permissions under the ResourceServer.
	object
InstanceId	string	The instance ID.	idaas_xxxxxxxxxxx
ApplicationId	string	The application ID.	app_xxxxxxxxxxx
ResourceServerScopeId	string	The scope permission ID.	rss_xxxxxxxxxxx
ResourceServerScopeName	string	The scope permission name.	读取全部用户
ResourceServerScopeValue	string	The scope permission value.	User:Write:ALL
ResourceServerScopeType	string	The scope permission type.	urn:alibaba:idaas:resourceserver:scope:delegated
AuthorizationType	string	The authorization type. Valid values: authorize_required : Manual authorization. default_all : Automatic authorization.	authorize_required
PreviousToken	string	The pagination token for the previous page.	PTxxxexample

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "NextToken": "NTxxxexample",
  "MaxResults": 20,
  "ResourceServerScopes": [
    {
      "InstanceId": "idaas_xxxxxxxxxxx",
      "ApplicationId": "app_xxxxxxxxxxx",
      "ResourceServerScopeId": "rss_xxxxxxxxxxx",
      "ResourceServerScopeName": "读取全部用户",
      "ResourceServerScopeValue": "User:Write:ALL",
      "ResourceServerScopeType": "urn:alibaba:idaas:resourceserver:scope:delegated",
      "AuthorizationType": "authorize_required"
    }
  ],
  "PreviousToken": "PTxxxexample"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.