ListUsers - 查询用户列表--云身份中心-火山引擎

文档中心

导航

ListUsers - 查询用户列表

最近更新时间：2025.03.21 11:10:03首次发布时间：2025.03.21 11:10:03

查询用户列表

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListUsers	要执行的操作，取值：ListUsers。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
PageSize	Integer	否	10	单页数量
PageNumber	Integer	否	1	页数
QueryString	String	否	name	过滤参数。搜索用户名/显示名.
UserName	String	否	username	用户名匹配
Source	String	否	Manual	数据源类型 Manual: 手动创建 Sync：身份源同步

返回参数

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

参数	类型	示例值	描述
PageNumber	Integer	1	页数
Users	Array of Object	"Users": [ { "UserId": "EmqnzDiD", "UserName": "x6dg", "DisplayName": "NztHMMIXMk0", "Description": "t", "CreatedTime": "2006-01-02T15:04:05Z07:00", "UpdatedTime": "2006-01-02T15:04:05Z07:00", "Source": "4TY9XP1NPh", "Email": "fJ", "Phone": "G", "IdentityType": "fPWS1zTB6Bf" } ],	用户列表
Total	Long	100	总数
PageSize	Integer	10	页大小

请求示例

POST /?Action=ListUsers&Version=2023-01-01 HTTP/1.1
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250309T151547Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250309/cn-beijing/cloudidentity/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "PageSize": 10,
  "PageNumber": 1,
  "QueryString": "UBvZwtIybBU",
  "UserName": "xSp",
  "Source": "FM"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250317111445063044113238BECF92",
    "Action": "ListUsers",
    "Version": "2023-01-01",
    "Service": "cloudidentity",
    "Region": "cn-beijing"
  },
  "Result": {
    "PageNumber": 1,
    "Users": [
      {
        "UserId": "1",
        "UserName": "username",
        "DisplayName": "displayname",
        "Source": "数据源类型\nManual: 手动创建\nSync：身份源同步",
        "CreatedTime": "2006-01-02T15:04:05Z07:00",
        "UpdatedTime": "2006-01-02T15:04:05Z07:00",
        "Description": "description",
        "Email": "email",
        "Phone": "phone"
      }
    ],
    "Total": 100,
    "PageSize": 10
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	ServiceStatusException	Can not perform action[%s] when service is %s	企业身份中心实例不可用
400	PermissionError	No permission to perform action[%s] on resource %s	没有接口权限
400	InvalidParam	The parameter %v[%v] is invalid	无效参数
500	InternalError	Unknown internal error: %v	服务内部错误