ListApplicationRoles - Identity as a Service - Alibaba Cloud Documentation Center

Retrieves a list of application roles 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
NextToken	string	No	The token used to start the next query. Set this parameter to the value of NextToken that is returned in the last API call. Leave this parameter empty for the first query.	NTxxxxexample
ApplicationId	string	Yes	The application ID.	app_mkv7rgt4d7i4u7zqtzev2mxxxx
MaxResults	integer	No	The number of entries to return on each page.	20
Filter	array<object>	No	The filter conditions.
	object	No	A filter condition.
Name	string	No	The name of the filter condition. Valid values: ApplicationRoleNameStartsWith : Queries application roles by matching the prefix of their names. ApplicationRoleIds : Queries application roles by a list of their IDs.	ApplicationRoleNameStartsWith
Value	array	No	The values of the filter condition.
	string	No	The value of the filter condition.	Admin Role

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCount	integer	The total number of entries returned.	100
NextToken	string	The token used to start the next query.	NTxxxxexample
ApplicationRoles	array<object>	The list of application roles.
	object
InstanceId	string	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
ApplicationId	string	The application ID.	app_mkv7rgt4d7i4u7zqtzev2mxxxx
ApplicationRoleId	string	The application role ID.	approle_01kh2vuo8v9splv8maak1d22rxxxx
ApplicationRoleName	string	The name of the application role.	Admin Role
ApplicationRoleValue	string	The value of the application role.	admin_role
Description	string	The description of the application role.	Admin Role Description
MaxResults	integer	The number of entries returned on each page.	20

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "NextToken": "NTxxxxexample",
  "ApplicationRoles": [
    {
      "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx\n",
      "ApplicationId": "app_mkv7rgt4d7i4u7zqtzev2mxxxx",
      "ApplicationRoleId": "approle_01kh2vuo8v9splv8maak1d22rxxxx",
      "ApplicationRoleName": "Admin Role",
      "ApplicationRoleValue": "admin_role",
      "Description": "Admin Role Description\n"
    }
  ],
  "MaxResults": 20
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.