QueryUserInfoByAccount-阿里云帮助中心

Queries user information by Alibaba Cloud ID or Alibaba Cloud account name.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Account	string	Yes	The Alibaba Cloud account name or Alibaba Cloud ID of the user. If you enter an account name: If the organization member is a root account, such as `main_account`, enter the root account name. For example, `main_account`. If the organization member is a RAM user, such as `zhangsan@test.onaliyun.com`, enter the prefix of the username before the at sign (@). For example, `zhangsan`. If you enter an Alibaba Cloud ID: Enter the complete user ID (UID) of the account.	1386587****@163.com
ParentAccountName	string	No	To resolve a "duplicate user" error when querying a RAM user, specify the name of the root account to which the user belongs.	zhangsan@test.onaliyun.com

Response elements

Element	Type	Description	Example
	object	The API response.
RequestId	string	The request ID.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	The user information of the organization member.
AccountId	string	The Alibaba Cloud ID. For users not added through RAM self-service, this ID becomes available only after the user's first login.	135****5848
AccountName	string	The Alibaba Cloud account name. For a RAM user, the domain suffix (the part after the @ symbol) is omitted. For example, for the user `test@test.com`, the value `test` is returned.	1386587****@163.com
AdminUser	boolean	Indicates whether the user is assigned the organization administrator role. Valid values: true: Yes false: No Important This parameter is deprecated. Use the `RoleIdList` parameter instead.	true
AuthAdminUser	boolean	Indicates whether the user is assigned the permission administrator role. Valid values: true: Yes false: No Important This parameter is deprecated. Use the `RoleIdList` parameter instead.	true
Email	string	The user's email address.	1386587****@163.com
NickName	string	The user's nickname.	测试用户
Phone	string	The user's phone number.	1386587****
RoleIdList	array	The IDs of the organization roles assigned to the user.
	integer	The ID of an organization role. A user can be assigned up to 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`: standard 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 intelligent modules for which the user has a quota.
	string	The identifier of the intelligent module. Valid values: `qreport` `qExploreNum` `smartQAskNum` `smartQDevNum`	qreport
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "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"
    ]
  },
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	User.Duplicative	Duplicate users found with account name : %s.	Duplicate users found with account name: %s.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.