All Products
Search
Document Center

Quick BI:ListWorkspaceRoleUsers

Last Updated:Nov 04, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Get user list under the specified workspace role.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
quickbi-public:ListWorkspaceRoleUserslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RoleIdlongYes

Workspace role ID, including predefined roles and custom roles:

  • 25: Workspace Administrator (predefined role)
  • 26: Developer (predefined role)
  • 27: Analyst (predefined role)
  • 30: Viewer (predefined role)
  • Custom roles: The corresponding role ID for custom roles
25
WorkspaceIdstringNo

The ID of the workspace. This parameter is optional. If you do not set this parameter, the roles of all workspaces are returned.

726bee5a-****-43e1-9a8e-b550f0120f35
PageNumintegerNo

Current page number for pagination:

  • Starting value: 1
  • Default value: 1
1
PageSizeintegerNo

Number of items per page for pagination:

  • Default value: 10
  • Maximum value: 1000
10
KeywordstringNo

Keyword for the user's nickname.

test

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

Request ID.

D787E1A3-A93C-424A-B626-C2B05DF8D885
Resultobject

Returns the list of users under the specified workspace role.

Dataarray<object>

User list.

Dataobject

User details.

NickNamestring

Nickname of the organization member.

Test user
UserIdstring

UserID of the organization member in Quick BI.

b5d8fd9348cc4327****afb604
WorkspaceIdstring

Workspace ID.

7350a155-0e94-4c6c-8620-57bbec38****
WorkspaceNamestring

Workspace name.

Test space
PageNuminteger

Page number.

1
PageSizeinteger

Number of items per page as set in the request.

10
TotalNuminteger

Total number of items.

1
TotalPagesinteger

Total number of pages.

1
Successboolean

Indicates whether the request was successful. Possible values:

  • true: The request was successful.
  • false: The request failed.
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "NickName": "Test user",
        "UserId": "b5d8fd9348cc4327****afb604\n",
        "WorkspaceId": "7350a155-0e94-4c6c-8620-57bbec38****",
        "WorkspaceName": "Test space"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  },
  "Success": true
}

Error codes

HTTP status codeError codeError message
400Invalid.WorkspaceThe workspace is not owned by the organization.
400User.Role.NotExistUser role not exist: %s.

For a list of error codes, visit the Service error codes.