CreateUserSig

Last updated: 2025-11-11 10:19:51

CreateUserSig

Last updated: 2025-11-11 10:19:51

1. API Description

Domain name for API request: ccc.intl.tencentcloudapi.com.

This API is used to create a user data signature.

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: CreateUserSig.
Version	Yes	String	Common Params. The value used for this API: 2020-02-10.
Region	No	String	Common Params. This parameter is not required.
SdkAppId	Yes	Integer	App ID (required). can be used to view https://console.tencentcloud.com/ccc.
Uid	Yes	String	User ID, must be consistent with the Uid value in the ClientData field.
ExpiredTime	Yes	Integer	Valid period, in seconds, no more than 1 hr.
ClientData	No	String	Signature data of the user. required field. standard JSON format.

3. Output Parameters

Parameter Name	Type	Description
UserSig	String	Signature result.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Generating User Data Signature

Input Example

POST / HTTP/1.1
Host: ccc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateUserSig
<Common request parameters>

{
    "SdkAppId": 1400000000,
    "Uid": "staff1@xxx.com",
    "ClientData": "{\"peerSource\":\"Tencent technology\",\"nickName\":\"penguin No.1\",\"avatarUrl\":\"https://foo.tencent.com/qieyihao.jpeg\",\"uid\":1846526}",
    "ExpiredTime": 3600
}

Output Example

{
    "Response": {
        "RequestId": "48edd236-7ef1-45af-9e12-fc376ba355bf",
        "UserSig": "eJw0jkFPwjAYQP-Ld9Wwfm2HtokHswhK9IBMBtw22uEHbpa1JRrjfzfZ5vW95OX9QP68mtgvR50FrYRSQonrHpKxbaCabAcaEFGmMAhvTqVzZECjZIxPJUc5GjqAho1fJMlpnlfb9iYJx2WZZ*YqnLO1m9Wrh-uXeD48ZR9vkYrl3ZgM1FjQOOXyNkXJ2UCjt10Va9CwLRbH3Xzd7Pi7K5vgqyK97B9n33vxiqY10m4*-1OX-pdPGPz*BQAA--9b7kId"
    }
}

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
InternalError	An internal error occurs.
InternalError.DBError	Internal database access failure.
InvalidParameter	Parameter error.
InvalidParameterValue.InstanceNotExist	The SDKAppID does not exist.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud