ListUsers-阿里云帮助中心

Queries the users for the current Alibaba Cloud account.

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

csas:ListUsers

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CurrentPage	integer	Yes	The page number. Valid values: 1 to 10,000.	1
PageSize	integer	Yes	The number of entries per page. Valid values: 1 to 500.	10
FuzzyUsername	string	No	The username for a fuzzy match. The value must be 1 to 128 characters long and can contain Chinese characters, letters, digits, periods (.), underscores (_), hyphens (-), asterisks (*), at signs (@), and spaces.	王先生
PreciseUsername	string	No	The username for an exact match. The value must be 1 to 128 characters long and can contain Chinese characters, letters, digits, periods (.), underscores (_), hyphens (-), asterisks (*), at signs (@), and spaces.	王先生@alibaba.com
SaseUserIds	array	No	An array of user IDs.
	string	No	The user ID. You can obtain this ID by calling the `ListUsers` operation.	su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****
Status	string	No	The status of the user. Valid values: Enabled: The user is enabled. Disabled: The user is disabled. Valid values: Enabled : Enabled Disabled : Disabled	Enabled
Department	string	No	The user's department. The value must be 1 to 128 characters long and can contain Chinese characters, letters, digits, periods (.), commas (,), semicolons (;), hyphens (-), underscores (_), slashes (/), at signs (@), and spaces.	测试部

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	5FEF5CFA-14CC-5DE5-BD1F-AFFE0996E71D
TotalNum	string	The total number of users.	1
Users	array<object>	An array of user objects.
	object	A user object.
Username	string	The username.	王先生
SaseUserId	string	The user ID.	su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****
Department	string	The user's department.	测试部
Email	string	The user's email address.	a***@example.net
Phone	string	The user's phone number.	1381111****
Status	string	The user status. Valid values: Enabled : Enabled Disabled : Disabled	Enabled
IdpName	string	The name of the Identity Provider (IdP).	飞书
FullDepartment	array	A list of full department paths.
	string	A full department path.	SASE/dept1/test dept2

Examples

Success response

JSON format

{
  "RequestId": "5FEF5CFA-14CC-5DE5-BD1F-AFFE0996E71D",
  "TotalNum": "1",
  "Users": [
    {
      "Username": "王先生",
      "SaseUserId": "su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****",
      "Department": "测试部",
      "Email": "a***@example.net",
      "Phone": "1381111****",
      "Status": "Enabled",
      "IdpName": "飞书",
      "FullDepartment": [
        "SASE/dept1/test dept2"
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.