tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

UpdateUser

Last updated: 2024-11-27 21:24:26

1. API Description

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

This API is used to modify user information.

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: UpdateUser.
Version Yes String Common Params. The value used for this API: 2021-03-31.
Region No String Common Params. This parameter is not required.
ZoneId Yes String Space ID.
UserId Yes String User ID.
NewFirstName No String First name of the user.
NewLastName No String Last name of the user.
NewDisplayName No String Display name of the user.
NewDescription No String User description.
NewEmail No String Email address of the user.

3. Output Parameters

Parameter Name Type Description
UserInfo UserInfo User information
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 Modifying the User Information

This example shows you how to modify the user information

Input Example

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

{
    "ZoneId": "z-343nh23kn",
    "UserId": "u-3324sfdds",
    "NewFirstName": "test",
    "NewLastName": "test",
    "NewDisplayName": "test",
    "NewDescription": "this is user.",
    "NewEmail": "test@example.com"
}

Output Example

{
    "Response": {
        "UserInfo": {
            "UserName": "test",
            "FirstName": "test",
            "LastName": "test",
            "DisplayName": "test",
            "Description": "this is user",
            "Email": "test@example.com",
            "UserStatus": "test",
            "UserType": "Manual",
            "UserId": "u-33sjadjsk",
            "CreateTime": "2024-01-01 12:12:12",
            "UpdateTime": "2024-01-01 12:12:12"
        },
        "RequestId": "e297543a-80de-4039-83c8-34545s45"
    }
}

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

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.IdentityCenterNotOpen The CIC service is not enabled.
FailedOperation.ManualUserNotUpdate Manually created users cannot be updated.
FailedOperation.SynchronizedUserNotUpdate The synchronized user cannot be modified.
FailedOperation.ZoneIdNotExist The user zoneId of the CIC service does not exist.
InvalidParameter.EmailAlreadyExists The email address already exists.
ResourceNotFound.UserNotExist The user does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy