QueryWorkspaceUserList - list workspace members - Quick BI

Queries the members of a specified workspace.

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

quickbi-public:QueryWorkspaceUserList

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	Workspace ID.	95296e95-ca89-4c7d-8af9-dedf0ad0****
Keyword	string	No	Username keyword to filter workspace members.	分析
PageNum	integer	No	Page number. Valid values: Starting value: 1 Default value: 1	1
PageSize	integer	No	Rows per page. Valid values: Default value: 10 Maximum value: 1000	10

Response elements

Element	Type	Description	Example
	object
Success	boolean	Whether the request succeeded. Valid values: true: The request was successful. false: The request failed.	true
RequestId	string	Request ID.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	Paginated member list. Member details are in the Data parameter.
Data	array<object>	Information about the workspace members.
	array<object>
AccountId	string	Alibaba Cloud account ID.	16020915****8429
AccountName	string	Alibaba Cloud account name.	pop****@aliyunid.test
NickName	string	Nickname.	我就是那个分析师大神
Role	object	Preset role of the workspace member.
RoleCode	string	Preset role code.	role_workspace_admin
RoleId	integer	Preset role ID. Valid values: 25: Workspace Administrator 26: Workspace Developer 27: Workspace Analyst 30: Workspace Viewer	25
RoleName	string	Preset role name.	管理员
UserId	string	Quick BI user ID.	de4bc5f9429141cc8091cdd1c15b****
PageNum	integer	Page number.	1
PageSize	integer	Rows per page.	10
TotalNum	integer	Total number of rows.	1
TotalPages	integer	Total number of pages.	1

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "AccountId": "16020915****8429",
        "AccountName": "pop****@aliyunid.test",
        "NickName": "我就是那个分析师大神",
        "Role": {
          "RoleCode": "role_workspace_admin",
          "RoleId": 25,
          "RoleName": "管理员"
        },
        "UserId": "de4bc5f9429141cc8091cdd1c15b****"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.
400	Workspace.Not.Exist	The group workspace does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.