GetUser

Download PDF

Last updated: 2022-05-19 14:11:30

Download PDF

1. API Description

Domain name for API request: cam.tencentcloudapi.com.

This API is used to query sub-users.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: GetUser.
Version	Yes	String	Common Params. The value used for this API: 2019-01-16.
Region	No	String	Common Params. This parameter is not required for this API.
Name	Yes	String	Sub-user username

3. Output Parameters

Parameter Name	Type	Description
Uin	Integer	Sub-user UIN
Name	String	Sub-user username
Uid	Integer	Sub-user UID
Remark	String	Sub-user remarks Note: This field may return `null`, indicating that no valid values can be obtained.
ConsoleLogin	Integer	Whether the sub-user can log in to the console. `0`: No; `1`: Yes.
PhoneNum	String	Mobile number
CountryCode	String	Country/Area code
Email	String	Email
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying sub-users

Input Example

https://cam.tencentcloudapi.com/?Action=GetUser
&Name=test124
&<Common request parameters>

Output Example

{
  "Response": {
    "Uin": 100000546533,
    "Name": "test124",
    "Uid": 1001774,
    "Remark": "test",
    "ConsoleLogin": 1,
    "PhoneNum": "10086",
    "CountryCode": "86",
    "Email": "123@qq.com",
    "RequestId": "33674182-e53d-416b-b6ce-bd7e7536b5d6"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation	Operation failed.
ResourceNotFound.UserNotExist	User does not exist.

tencent cloud

Tencent Cloud Partner Network

Become a Partner

International Partner Academy

Recent Pages

GetUser

1. API Description

2. Input Parameters

3. Output Parameters