QueryUserInfoByAccount - Quick BI - Alibaba Cloud Documentation Center

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.

Queries user information based on the Alibaba Cloud ID or Alibaba Cloud account name.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
quickbi-public:QueryUserInfoByAccount	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Account	string	Yes	Enter the name or ID of the Alibaba Cloud account that you want to query. When you enter an account name: If the organization user is a master account, such as main_account, the query account format is master account. That is, the main account main_account to be entered. If the organization user is a RAM user, such as a zhangsan@test.onaliyun.com, the query account format is the head of the RAM user, that is, the RAM user to be entered is zhangsan. ID: Enter the UID of the account to query the account information.	1386587****@163.com
ParentAccountName	string	No	When a duplicate error occurs while querying the sub-account, enter the primary account's username, for example, zhangsan@test.onaliyun.com.	zhangsan@test.onaliyun.com

Response parameters

Parameter	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 returned organization user information.
UserType	integer	The role type of the organization member. Valid values: 1 : developer 2 : visitors 3 : Analyst	1
Email	string	The email address of the user.	1386587****@163.com
UserId	string	The UserID in the Quick BI.	fe67f61a35a94b7da1a34ba174a7****
AuthAdminUser	boolean	Whether you are a permission administrator. Valid values: true false	true
AccountId	string	The ID of the Alibaba Cloud account.	135****5848
NickName	string	The nickname of the account.	Test user
AdminUser	boolean	Whether you are an administrator of the organization. Valid values: true false	true
Phone	string	The phone number of the alert contact.	1386587****
AccountName	string	The name of the Alibaba Cloud account that corresponds to the member. (If you use a RAM user, the domain name information that follows @ is removed. For example, if you use a test@test.com, test is returned.)	1386587****@163.com
RoleIdList	array	List of organization role IDs bound to the user.
RoleIdList	long	Organization role IDs, up to 3, including but not limited to the pre-defined organization roles: Organization Administrator (pre-defined role): 111111111 - Permission Administrator (pre-defined role): 111111112 - Regular User (pre-defined role): 111111113	111111111

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "UserType": 1,
    "Email": "1386587****@163.com",
    "UserId": "fe67f61a35a94b7da1a34ba174a7****",
    "AuthAdminUser": true,
    "AccountId": "135****5848",
    "NickName": "Test user\n",
    "AdminUser": true,
    "Phone": "1386587****",
    "AccountName": "1386587****@163.com",
    "RoleIdList": [
      111111111
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	UserInfo.Error	The personal information is invalid.	The personal information is invalid.
400	Internal.System.Error	An internal system error occurred.	An internal system error occurred.
400	User.Duplicative	Duplicate users found with account name : %s.	Duplicate users found with account name: %s.

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

Change history

Change time	Summary of changes	Operation
2024-06-27	The Error code has changed	View Change Details
2024-02-26	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details