Use SearchUser to search for users - Drive and Photo Service - Alibaba Cloud - Drive and Photo Service

Searches for users.

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 syntax

POST /v2/user/search HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
domain_id	string	Yes	The domain ID.
body	object	No	The request body.
nick_name	string	No	The user's nickname. The maximum length is 128 characters.	pdsuer
nick_name_for_fuzzy	string	No	A keyword for a fuzzy search of nicknames. The maximum length is 128 characters.	la
user_name	string	No	The user's name. The maximum length is 128 characters.	pds
phone	string	No	The user's phone number.	13900001111
email	string	No	The user's email address.	123@pds.com
status	string	No	The status of the user. `disabled`: The user is disabled. `enabled`: The user is enabled. Valid values: disabled : disabled enabled : enabled	enabled
role	string	No	The role of the user. Valid values: `superadmin`: super administrator `admin`: administrator `user`: regular user Valid values: superadmin : super administrator admin : administrator user : user	user
marker	string	No	The pagination marker. Results are returned in alphabetical order, starting from the entry that follows the marker. If this parameter is not specified, the query starts from the beginning of the list. Default value: None	NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
limit	integer	No	The maximum number of users to return per page. Valid values: 1 to 100. Default value: 100.	100

Response elements

Element	Type	Description	Example
	object	The response data.
next_marker	string	The token to retrieve the next page of results. This parameter is empty when there are no more results to return.	NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
items	array	A list of users.
	User	The user information.

Examples

Success response

JSON format

{
  "next_marker": "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg",
  "items": [
    {
      "domain_id": "bj1",
      "user_id": "c9b7a5aa04d14ae3867fdc886fa01da4",
      "avatar": "http://aa.com/1.jpg",
      "created_at": 1639762579768,
      "updated_at": 1639762579768,
      "email": "a@aliyunpds.com",
      "nick_name": "001",
      "phone": "13900001111",
      "role": "user",
      "status": "enabled",
      "user_name": "pds",
      "description": "vipuser",
      "default_drive_id": "1",
      "creator": "user1",
      "last_login_time": 0,
      "last_refresh_token_time": 0,
      "user_data": {
        "key": ""
      }
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.