提供经过身份验证的用户网域目录中的网域个人资料和网域联系人的列表。
指定
后,自上次同步以来删除的资源将作为 syncToken
设置为 true 的用户返回。PersonMetadata.deleted
如果指定了
或 pageToken
,所有其他请求参数都必须与首次调用匹配。syncToken
写入的传播请求可能会延迟几分钟。增量同步不适用于写入后读取的用例。
请参阅列出已更改的目录中的用法示例。
HTTP 请求
GET https://people.googleapis.com/v1/people:listDirectoryPeople
网址采用 gRPC 转码语法。
查询参数
参数 | |
---|---|
readMask |
必需。一个字段掩码,用于限制返回每个人的字段。您可以指定多个字段,只需用英文逗号分隔即可。有效值包括:
|
sources[] |
必需。要返回的目录来源。 |
mergeSources[] |
(可选)当通过经过验证的联接键(例如电子邮件地址或电话号码)连接时,要合并到目录来源的其他数据。 |
pageSize |
(可选)回复中包含的人数。有效值介于 1 到 1000 之间(含 1 和 1000)。如果未设置或设置为 0,则默认为 100。 |
pageToken |
(可选)从上一个响应 进行分页时,提供给 |
requestSyncToken |
(可选)响应是否应返回 如需详细了解同步行为,请访问 |
syncToken |
(可选)从之前的响应 在同步时,提供给 如需详细了解同步行为,请访问 |
请求正文
请求正文必须为空。
响应正文
如果成功,响应正文将包含结构如下的数据:
对经过身份验证的用户的网域目录的请求的响应。
JSON 表示法 |
---|
{
"people": [
{
object ( |
字段 | |
---|---|
people[] |
网域目录中人员列表。 |
nextPageToken |
可作为 |
nextSyncToken |
一个令牌,可作为 |
授权范围
需要以下 OAuth 作用域:
https://www.googleapis.com/auth/directory.readonly
如需了解详情,请参阅授权指南。