RAM Recycle Bin Overview for Deleted Users - RAM - Alibaba Cloud - Resource Access Management

Queries the basic information about all Resource Access Management (RAM) users in the recycle bin.

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

ram:ListUsersInRecycleBin

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Marker	string	No	The `marker`. If part of a previous response is truncated, you can use this parameter to obtain the truncated part.	EXAMPLE
MaxItems	integer	No	The number of entries to return. If a response is truncated because it reaches the value of `MaxItems`, the value of `IsTruncated` will be true. Valid values: 1 to 100. Default value: 100.	100
Filter	string	No	The filter condition that is used to query information about a specified RAM user in the recycle bin. You must specify this parameter in the `UserPrincipalName eq <username>@<AccountAlias>.onaliyun.com` format.	UserPrincipalName eq test@example.onaliyun.com

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	3687BD52-49FD-585B-AB14-CD05B7C76963
IsTruncated	boolean	Indicates whether the response is truncated. Valid values: true false	true
Marker	string	The parameter that is used to obtain the truncated part. It takes effect only when `IsTruncated` is set to `true`.	EXAMPLE
Users	object
User	array<object>	The information about the RAM users.
	object	The information about the RAM user.
UserId	string	The ID of the RAM user.	20732900249392****
UserPrincipalName	string	The logon name of the RAM user.	test@example.onaliyun.com
DisplayName	string	The display name of the RAM user.	test@example.onaliyun.com
CreateDate	string	The time when the RAM user was created.	2020-10-12T09:12:00Z
RecycleDate	string	The time when the RAM user was deleted and moved to the recycle bin.	2020-10-15T09:12:00Z
DeleteDate	string	The time when the RAM user will be permanently deleted from the recycle bin.	2020-11-15T09:12:00Z

Examples

Success response

JSON format

{
  "RequestId": "3687BD52-49FD-585B-AB14-CD05B7C76963",
  "IsTruncated": true,
  "Marker": "EXAMPLE",
  "Users": {
    "User": [
      {
        "UserId": "20732900249392****",
        "UserPrincipalName": "test@example.onaliyun.com",
        "DisplayName": "test@example.onaliyun.com",
        "CreateDate": "2020-10-12T09:12:00Z",
        "RecycleDate": "2020-10-15T09:12:00Z",
        "DeleteDate": "2020-11-15T09:12:00Z"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.