tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ListGroupsForUser

Last updated: 2023-03-15 10:24:55

1. API Description

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

This API is used to list user groups associated with a user.

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: ListGroupsForUser.
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.
Uid No Integer Sub-user UID
Rp No Integer Number of entries per page; default is 20
Page No Integer Page number; default is 1
SubUin No Integer Sub-account UIN

3. Output Parameters

Parameter Name Type Description
TotalNum Integer Total number of User Groups to which the sub-user has been added
GroupInfo Array of GroupInfo User Group information
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Listing user groups associated with a user

Input Example

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

{
    "Uid": "1001408"
}

Output Example

{
    "Response": {
        "TotalNum": 1,
        "GroupInfo": [
            {
                "GroupId": 2020,
                "GroupName": "test1",
                "CreateTime": "2019-04-03 15:11:34",
                "Remark": "test2"
            }
        ],
        "RequestId": "a614c392-3079-4dab-b819-0ab0563a32f0"
    }
}

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
AuthFailure.UnauthorizedOperation No permission.
FailedOperation Operation failed.
ResourceNotFound.UserNotExist User does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy