tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeUser

Last updated: 2024-11-25 16:56:47

    1. API Description

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

    This API is used to query the user information with multiple conditions.

    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: DescribeUser.
    Version Yes String Common Params. The value used for this API: 2022-03-31.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    UserStoreId Yes String User directory ID
    Pageable Yes Pageable Pagination data
    Filters.N No Array of QueryUserFilter Query condition (propertycode and propertykey)
    Original No Boolean Whether the plaintext is returned
    Sort No Sort Sorting configuration

    3. Output Parameters

    Parameter Name Type Description
    Total Integer The total number of returned results.
    Note: this field may return null, indicating that no valid values can be obtained.
    Pageable Pageable Pagination object
    Note: this field may return null, indicating that no valid values can be obtained.
    Content Array of User User List
    Note: this field may return null, indicating that no valid values can be obtained.
    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 Querying the user information

    querying the user information

    Input Example

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

{
    "UserStoreId": "2c3aca3b****************a7efe88e",
    "Pageable": {
        "PageSize": 10,
        "PageNumber": 5
    },
    "Filters": [
        {
            "PropertyKey": "nickname",
            "PropertyValue": "nick name",
            "Logic": true,
            "OperateLogic": "abc"
        }
    ],
    "Original": true,
    "Sort": {
        "PropertyKey": "nickname",
        "Order": "decs"
    }
}

    Output Example

    {
    "Response": {
        "Total": 100,
        "Pageable": {
            "PageSize": 10,
            "PageNumber": 5
        },
        "Content": [
            {
                "UserId": "53e25c3****************e4eb5bd1",
                "UserName": "zhangsan",
                "PhoneNumber": "132****0000",
                "Email": "132****@qq.com",
                "LastSignOn": 1711002933442,
                "CreatedDate": 1718332940956,
                "Status": "NORMAL",
                "UserDataSourceEnum": "ADMIN",
                "Nickname": "nickname",
                "Address": "address",
                "Birthdate": 1706682491339,
                "UserGroups": [
                    "6cd22e51****************f6f7cb81"
                ],
                "LastModifiedDate": 1722420973329,
                "CustomAttributes": [
                    {
                        "Name": "k",
                        "Value": "v",
                        "Type": "STRING"
                    }
                ],
                "ResidentIdentityCard": "123456789012345678",
                "QqOpenId": "qqopenid",
                "QqUnionId": "qqunionid",
                "WechatOpenId": "wechatopenid",
                "WechatUnionId": "wechatunionid",
                "AlipayUserId": "alipayuserid",
                "WeComUserId": "wecomuserid",
                "Description": "user1",
                "Name": "name",
                "Locale": "locale",
                "Gender": "male",
                "IdentityVerificationMethod": "-",
                "IdentityVerified": true,
                "Job": "employee",
                "Nationality": "nationality",
                "Primary": true,
                "Zone": "zone",
                "AlreadyFirstLogin": true,
                "TenantId": "tenantId",
                "UserStoreId": "2c3aca3b****************a7efe88e",
                "Version": 0,
                "LockType": "-",
                "LockTime": 0,
                "IndexedAttribute1": "value1",
                "IndexedAttribute2": "value2",
                "IndexedAttribute3": "value3",
                "IndexedAttribute4": "value4",
                "IndexedAttribute5": "value5"
            }
        ],
        "RequestId": "e2e9e8aa********************9ab34c6e"
    }
}

    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 A CAM signature/authentication error occurred.
    DryRunOperation DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used.
    FailedOperation The operation failed.
    FailedOperation.InvalidTenant The tenant is invalid.
    FailedOperation.InvalidUserStore The user pool is invalid.
    FailedOperation.QueryUsersParameterMustInWhitelist The query condition must contain at least one of the followings: userName, phoneNumber, email, userGroup, alipayUserId, wechatOpenId,wechatUnionId, qqOpenId, qqUnionId,lastModifiedDate, indexedAttribute1, indexedAttribute2,indexedAttribute3, indexedAttribute4, indexedAttribute5.
    FailedOperation.QueryUsersParameterRepeat The conditions can not duplicate.
    FailedOperation.QueryUsersSortParameterMustInWhitelist The PropertyKey of Sort must include one of the followings: id, userName, phoneNumber, email, userGroup, alipayUserId, wechatOpenId,wechatUnionId, qqOpenId, qqUnionId,lastModifiedDate, indexedAttribute1, indexedAttribute2,indexedAttribute3, indexedAttribute4, indexedAttribute5.
    FailedOperation.QuotaLimitExceeded The quota is exceeded. Contact customer service.
    InternalError An internal error occurred.
    InternalError.UnknownError An unknown error occurred.
    InvalidParameter The parameter is incorrect.
    InvalidParameter.ParameterIllegal The request parameter is invalid.
    InvalidParameterValue The parameter value is incorrect.
    LimitExceeded The quota limit is exceeded.
    MissingParameter The parameter is missing.
    OperationDenied The operation was denied.
    RequestLimitExceeded The number of requests exceeds the frequency limit.
    RequestLimitExceeded.FrequentRequest Too many requests. Try again later.
    RequestLimitExceeded.RepeatRequest Repeated request. Try again later.
    ResourceInUse The resource is in use.
    ResourceInsufficient The resource is insufficient.
    ResourceNotFound The resource does not exist.
    ResourceUnavailable The resource is unavailable.
    ResourcesSoldOut The resources have been sold out.
    UnauthorizedOperation The operation is unauthorized.
    UnauthorizedOperation.TenantNotActivated The service is not activated.
    UnknownParameter The parameter is unknown.
    UnsupportedOperation The operation is not supported.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy