Use QueryUserList to retrieve organization members - Quick BI

Queries the members of an organization.

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:QueryUserList

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Keyword	string	No	The keyword of the username or nickname of the organization member.	测试用户
PageNum	integer	No	Current page number for organization member list: Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of rows per page in a paged query. Default value: 10. Maximum value: 1,000.	10

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request is successful. Valid values: true: The request was successful. false: The request failed.	true
RequestId	string	The ID of the request.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	The pagination result of the user list is returned. The detailed information list of organization members is stored in the response parameter Data.
Data	array<object>	Returns the list of requested users.
	object
AccountId	string	The ID of the Alibaba Cloud account.	1355********
AccountName	string	The name of the Alibaba Cloud account that corresponds to the member.	测试用户
AdminUser	boolean	Indicates whether the organization administrator. Valid values: true false	true
AuthAdminUser	boolean	Indicate whether the RAM user is a permission administrator. Valid values: true false	true
JoinedDate	integer	Join Date	1718691704000
LastLoginTime	integer	Last login time.	1718761320681
NickName	string	The nickname of the organization member.	测试用户
RoleIdList	array	List of organization role IDs bound to the user.
	integer	Organization role IDs, up to three, including but not limited to pre-defined organization roles: Organization Administrator (pre-defined role): 111111111 - Permission Administrator (pre-defined role): 111111112 - Regular User (pre-defined role): 111111113	111111111
UserId	string	The UserID in the Quick BI.	fe67f61a35a94b7da1a34ba174a7****
UserType	integer	The role type of the organization member. Valid values: 1 : developer 2 : visitors 3 : Analyst	1
IsDeleted	boolean	User status: Active - false Inactive - true	false
PageNum	integer	The page number of the returned page.	1
PageSize	integer	The number of rows per page set when the interface is requested.	10
TotalNum	integer	The total number of rows in the table.	1
TotalPages	integer	The total number of pages returned.	1

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "AccountId": "1355********",
        "AccountName": "测试用户",
        "AdminUser": true,
        "AuthAdminUser": true,
        "JoinedDate": 1718691704000,
        "LastLoginTime": 1718761320681,
        "NickName": "测试用户",
        "RoleIdList": [
          111111111
        ],
        "UserId": "fe67f61a35a94b7da1a34ba174a7****",
        "UserType": 1,
        "IsDeleted": false
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.