ListUsers API.

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

请求示例

POST /?Action=ListUsers&Version=2025-10-30 HTTP/1.1
Host: cis-control-test.ivolces.com:30190
Content-Type: application/json; charset=UTF-8
X-Date: 20251118T070625Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251118/cn-beijing/id/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "UserPoolUid": "example",
  "PageNumber": 1,
  "PageSize": 10,
  "Filter": {
    "PhoneNumber": "example",
    "Email": "example",
    "PreferredUsername": "example",
    "Name": "example",
    "GivenName": "example",
    "FamilyName": "example",
    "MiddleName": "example",
    "Nickname": "example",
    "Website": "example",
    "Gender": "example",
    "LatestBrowser": "example",
    "Connection": "example",
    "Locale": "example"
  },
  "SortField": "CreateTime",
  "SortDirection": "Desc"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20251124152245154231009076159C72",
    "Action": "ListUsers",
    "Version": "2025-10-30",
    "Service": "id",
    "Region": "cn-beijing"
  },
  "Result": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 1,
    "Data": [
      {
        "UserState": "CONFIRMED",
        "Uid": "example",
        "Sub": "example",
        "Zoneinfo": "example",
        "Birthdate": "example",
        "Gender": "example",
        "Website": "example",
        "Picture": "example",
        "Profile": "example",
        "MiddleName": "example",
        "FamilyName": "example",
        "GivenName": "example",
        "Nickname": "example",
        "PhoneNumber": "example",
        "PreferredUsername": "example",
        "Email": "example",
        "Name": "example",
        "Connection": "example",
        "NumLogins": 1,
        "CreateTime": "2025-09-15T07:59:24Z",
        "UpdateTime": "2025-09-15T07:59:24Z",
        "LatestLogin": "example",
        "LatestBrowser": "example",
        "Locale": "example",
        "UserMetadata": "example",
        "PhoneNumberVerified": true,
        "EmailVerified": true
      }
    ]
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。