ListUsers - Data Lake Formation - Alibaba Cloud Documentation Center

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

GET /dlf/v1/auth/users/list HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
userName	string	No	The user name.	user_name
type	string	No	The type of the user. Valid values: RAM_USER : A RAM user. RAM_ROLE : A RAM role.	RAM_USER
pageToken	string	No	The pagination token used to retrieve the next page of results. If this parameter is not returned in the response, pass an empty string ("").	""
maxResults	integer	No	The number of entries to return on each page.	10

Response elements

Element	Type	Description	Example
	object	The response body.
users	array	The users.
	User	The user information.
nextPageToken	string	The pagination token used to retrieve the next page of results. A null value indicates that this is the last page of results.	token!

Examples

Success response

JSON format

{
  "users": [
    {
      "createdAt": 0,
      "updatedBy": "",
      "createdBy": "",
      "displayName": "",
      "userName": "",
      "type": "",
      "userId": "",
      "userPrincipal": "",
      "updatedAt": 0
    }
  ],
  "nextPageToken": "E8ABEB1C3DB893D16576269017992F57"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.