ListClientUsers-阿里云帮助中心

Query user information from custom identity sources in your 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:ListClientUsers

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
IdpConfigId	string	Yes	Custom identity source configuration ID.	1071
DepartmentId	string	No	Department ID.	10785
Username	string	No	Username.	张三
Email	string	No	Email address.	johndoe@example.com
MobileNumber	string	No	Mobile phone number without country code.	18980976559
Status	string	No	User enable status. Valid values: Enabled: enabled. Disabled: disabled.	Enabled
CurrentPage	integer	No	Current page number.	1
PageSize	integer	No	Page size.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID.	FEF1144C-95D1-5F7C-81EF-9DB70EA49FCE
Data	object	User information.
TotalNum	integer	Total number of records.	2
DataList	array<object>	List of user information.
	array<object>
Id	string	User ID.	1970
IdpConfigId	string	Custom identity source configuration ID.	1026
Username	string	Username.	张三
UserId	string	Unique user identifier.	su_dead7216****
Description	string	User description.	示例用户
Email	string	Email address.	johndoe@example.com
MobileNumber	string	Mobile phone number without country code.	15800820468
DepartmentId	string	Department ID.	10800
Status	string	User enable status. Valid values: Enabled: enabled. Disabled: disabled.	Disabled
Department	object	Department to which the user belongs.
Id	string	Department ID.	105
Name	string	Department name.	示例部门

Examples

Success response

JSON format

{
  "RequestId": "FEF1144C-95D1-5F7C-81EF-9DB70EA49FCE",
  "Data": {
    "TotalNum": 2,
    "DataList": [
      {
        "Id": "1970",
        "IdpConfigId": "1026",
        "Username": "张三",
        "UserId": "su_dead7216****",
        "Description": "示例用户",
        "Email": "johndoe@example.com",
        "MobileNumber": "15800820468",
        "DepartmentId": "10800",
        "Status": "Disabled",
        "Department": {
          "Id": "105",
          "Name": "示例部门"
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.