文档

ListOfficeSiteUsers - 查询AD用户信息

更新时间:

查询AD办公网络(原工作区)对接AD域后获取的AD用户信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。

cn-hangzhou
Filterstring

模糊查询字符串。

*jin*
OfficeSiteIdstring

办公网络 ID。仅支持基于企业 AD 账号的办公网络。

cn-hangzhou+dir-363353****
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。

caeba0bbb2be03f84eb48b699f0a4883
MaxResultsinteger

分页查询时每页行数。

  • 最大值:100。
  • 默认值:10。
10
OUPathstring

指定的 AD 域组织单元。

example.com/Domain Controllers

返回参数

名称类型描述示例值
object

返回信息集合。

NextTokenstring

下一个查询开始的 Token,NextToken 为空表示没有下一个。

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

请求 ID。

269BDB16-2CD8-4865-84BD-11C40BC21DB0
Usersobject []

AD 用户名组成的数组。
如果企业 AD 中的用户只有 Administrator 和 Guest,没有其他用户,则将返回空的 User 数组。

EndUserstring

AD 用户名。

Alice
DisplayNamestring

显示名称。

Alice

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "269BDB16-2CD8-4865-84BD-11C40BC21DB0",
  "Users": [
    {
      "EndUser": "Alice",
      "DisplayName": "Alice"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2021-08-19OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:OUPath
2021-08-19OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈