Use QueryUserList to retrieve organization members - Quick BI - Alibaba Cloud - Quick BI

Queries the list of organization members.

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 for the username or nickname of the organization member.	test
PageNum	integer	No	The page number of the organization member list. Minimum value: 1 Default value: 1	1
PageSize	integer	No	The number of rows per page for a paged query. Default value: 10 Maximum value: 1000	10

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
RequestId	string	The request ID.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	The paginated result of the user list. The detailed information of organization members is stored in the Data response parameter.
Data	array<object>	The list of users returned by the request.
	object	The list of users returned by the request.
AccountId	string	The Alibaba Cloud account ID. For users who are not added through RAM self-service reading, the Alibaba Cloud account ID can be obtained only after they log on.	1355********
AccountName	string	The Alibaba Cloud account name.	test
AdminUser	boolean	Indicates whether the organization administrator role is bound. Valid values: true: Yes. false: No. Important This parameter is deprecated. Use the RoleIdList parameter instead.	true
AuthAdminUser	boolean	Indicates whether the permission management administrator role is attached. Valid values: true: Yes. false: No. Important This parameter is expired and no longer recommended. Use the RoleIdList parameter instead.	true
JoinedDate	integer	The date when the member joined the organization. This value is a UNIX timestamp in milliseconds.	1718691704000
LastLoginTime	integer	The last logon time. This value is a UNIX timestamp in milliseconds.	1718761320681
NickName	string	The nickname of the organization member.	test
RoleIdList	array	The list of organization role IDs bound to the user.
	integer	The organization role ID. A maximum of three role IDs are supported, including but not limited to the following preset roles: Organization administrator (preset role): 111111111 Permission management administrator (preset role): 111111112 Regular user (preset role): 111111113	111111111
UserId	string	The user ID in Quick BI.	fe67f61a35a94b7da1a34ba174a7****
UserType	integer	The user type of the organization member. Valid values: 1: developer 2: visitor 3: analyst	1
IsDeleted	boolean	The user status. Valid values: false: activated true: deactivated	false
CopilotModules	array	The intelligent module quota of the user. qreport: Q report qExploreNum: Q explore edition smartQAskNum: Q data query smartQDevNum: Q builder
	string	The intelligent module quota.	qreport
PageNum	integer	The page number.	1
PageSize	integer	The number of rows per page specified in the request.	10
TotalNum	integer	The total number of rows.	1
TotalPages	integer	The total number of pages.	1

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "AccountId": "1355********",
        "AccountName": "test",
        "AdminUser": true,
        "AuthAdminUser": true,
        "JoinedDate": 1718691704000,
        "LastLoginTime": 1718761320681,
        "NickName": "test",
        "RoleIdList": [
          111111111
        ],
        "UserId": "fe67f61a35a94b7da1a34ba174a7****",
        "UserType": 1,
        "IsDeleted": false,
        "CopilotModules": [
          "qreport "
        ]
      }
    ],
    "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.