All Products
Search
Document Center

Data Lake Formation:ListRoleUsers

Last Updated:Sep 22, 2025

Retrieves the list of users for a role.

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/roles/users/list HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

rolePrincipal

string

No

The resource descriptor of the role.

acs:dlf::[accountId]:role/role_name

pageToken

string

No

The token to retrieve the next page of results. If the response does not return a token, pass an empty string ("").

""

maxResults

integer

No

The number of entries per page.

10

Response elements

Element

Type

Description

Example

object

The response body.

users

array

A list of users.

User

The user information.

nextPageToken

string

The token to retrieve the next page of results. If null is returned, all results have been retrieved.

E8ABEB1C3DB893D16576269017992F57

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.