AddUserToGroup

最后更新时间:2021-06-15 10:38:55

    1. API Description

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

    This API is used to add users to a user group.

    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 parameter. The value used for this API: AddUserToGroup.
    Version Yes String Common parameter. The value used for this API: 2019-01-16.
    Region No String Common parameter. This parameter is not required for this API.
    Info.N Yes Array of GroupIdOfUidInfo How sub-user UIDs are associated with the ID of the user group they are added to.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Adding user to user group

    Input Example

    
    https://cam.tencentcloudapi.com/?Action=AddUserToGroup
    &Info.0.Uid=1001408
    &Info.0.GroupId=2020
    &<Common request parameters>
    

    Output Example

    
    {
    "Response": {
      "RequestId": "47c4a570-17fa-44a3-8ff6-fe006170c104"
    }
    }
    

    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 Operation failed.
    InvalidParameter.GroupNotExist User Group does not exist.
    InvalidParameter.GroupUserFull Limit on number of sub-users in the user group reached.
    InvalidParameter.UserGroupFull Limit on number of user groups joined by a sub-user reached.
    ResourceNotFound.UserNotExist User does not exist.