QueryUserInfoByUserId-阿里云帮助中心

Queries user information by user ID.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	Yes	The user ID. This is the user ID in Quick BI, not an Alibaba Cloud UID.	fe67f61a35a94b7da1a34ba174a7****

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request failed.	true
RequestId	string	The ID of the request.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	The information about the organization user.
AccountId	string	The Alibaba Cloud account ID.	135****5848
AccountName	string	The Alibaba Cloud account name.	1386587****@163.com
AdminUser	boolean	Indicates whether the organization administrator role is assigned to the user. Valid values: true: The role is assigned. false: The role is not assigned. Important This parameter is deprecated. Use the `RoleIdList` parameter instead.	true
AuthAdminUser	boolean	Indicates whether the permission administrator role is assigned to the user. Valid values: true: The role is assigned. false: The role is not assigned. Important This parameter is deprecated. Use the `RoleIdList` parameter instead.	true
Email	string	The email address of the user.	1386587****@163.com
NickName	string	The nickname of the user.	测试用户
Phone	string	The phone number of the user.	1386587****
RoleIdList	array	The list of organization role IDs that are assigned to the user.
	integer	The ID of the organization role. A user can be assigned a maximum of three roles. The roles include but are not limited to the following predefined roles: `111111111`: organization administrator (predefined role) `111111112`: permission administrator (predefined role) `111111113`: regular user (predefined role)	111111111
UserId	string	The user ID in Quick BI.	fe67f61a35a94b7da1a34ba174a7****
UserType	integer	The user type of the organization member. Valid values: `1`: developer `2`: viewer `3`: analyst	1
CopilotModules	array	The list of `CopilotModules` available to the user.
	string	The Copilot module. Valid values: `qreport`: qreport `qExploreNum`: qExploreNum `smartQAskNum`: smartQAskNum `smartQDevNum`: smartQDevNum	qreport

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "AccountId": "135****5848",
    "AccountName": "1386587****@163.com",
    "AdminUser": true,
    "AuthAdminUser": true,
    "Email": "1386587****@163.com",
    "NickName": "测试用户",
    "Phone": "1386587****",
    "RoleIdList": [
      111111111
    ],
    "UserId": "fe67f61a35a94b7da1a34ba174a7****",
    "UserType": 1,
    "CopilotModules": [
      "qreport"
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.