资源:User
您可以通过 Directory API 创建和管理账号的用户、用户别名和用户 Google 个人资料照片。有关常见任务的更多信息,请参阅用户账号开发者指南和用户别名开发者指南。
JSON 表示法 |
---|
{
"id": string,
"primaryEmail": string,
"password": value,
"hashFunction": string,
"isAdmin": boolean,
"isDelegatedAdmin": boolean,
"agreedToTerms": boolean,
"suspended": boolean,
"changePasswordAtNextLogin": boolean,
"ipWhitelisted": boolean,
"name": {
object ( |
字段 | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
用户的唯一 ID。用户 |
||||||||||||||||||||||||||||||||||||||||||
primaryEmail |
用户的主电子邮件地址。在创建用户账号的请求中,必须提供此属性。 |
||||||||||||||||||||||||||||||||||||||||||
password |
存储用户账号的密码。创建用户账号时,必须提供用户的密码值。在更新用户时,此属性是可选的,只有在用户更新账号密码时才应提供。密码值绝不会在 API 的响应正文中返回。 |
||||||||||||||||||||||||||||||||||||||||||
hashFunction |
存储
如果前缀中包含轮次,则轮次不得超过 10,000。 |
||||||||||||||||||||||||||||||||||||||||||
isAdmin |
仅限输出。表示具有超级用户权限的用户。只能在让用户成为管理员操作(makeAdmin 方法)中修改 |
||||||||||||||||||||||||||||||||||||||||||
isDelegatedAdmin |
仅限输出。指明用户是否为委派管理员。 |
||||||||||||||||||||||||||||||||||||||||||
agreedToTerms |
仅限输出。如果用户已完成首次登录并接受了《服务条款》协议,则此属性的值为 |
||||||||||||||||||||||||||||||||||||||||||
suspended |
指明用户是否已被暂停。 |
||||||||||||||||||||||||||||||||||||||||||
changePasswordAtNextLogin |
指明用户是否在下次登录时更改密码。当用户通过第三方身份提供方登录时,此设置不适用。 |
||||||||||||||||||||||||||||||||||||||||||
ipWhitelisted |
如果为 |
||||||||||||||||||||||||||||||||||||||||||
name |
保存用户的姓氏和姓氏,以及只读 |
||||||||||||||||||||||||||||||||||||||||||
kind |
仅限输出。API 资源的类型。对于用户资源,值为 |
||||||||||||||||||||||||||||||||||||||||||
etag |
仅限输出。资源的 ETag。 |
||||||||||||||||||||||||||||||||||||||||||
emails |
用户的电子邮件地址列表。允许的数据大小上限为 10 KB。
|
||||||||||||||||||||||||||||||||||||||||||
externalIds |
用户的外部 ID 列表,例如员工 ID 或广告联盟 ID。允许的数据大小上限为 2KB。
|
||||||||||||||||||||||||||||||||||||||||||
relations |
用户与其他用户之间关系的列表。此字段允许的数据大小上限为 2KB。有关详情,请参阅管理用户账号。
|
||||||||||||||||||||||||||||||||||||||||||
aliases[] |
仅限输出。用户的别名电子邮件地址列表。 |
||||||||||||||||||||||||||||||||||||||||||
isMailboxSetup |
仅限输出。指明用户的 Google 邮箱是否已创建。仅当用户已获得 Gmail 许可时,此属性才适用。 |
||||||||||||||||||||||||||||||||||||||||||
customerId |
仅限输出。用于检索所有账号用户的客户 ID。 |
||||||||||||||||||||||||||||||||||||||||||
addresses |
用户地址的列表。允许的数据大小上限为 10 KB。
|
||||||||||||||||||||||||||||||||||||||||||
organizations |
用户所属的单位的列表。允许的数据大小上限为 10 KB。
|
||||||||||||||||||||||||||||||||||||||||||
lastLoginTime |
仅限输出。用户最后一次登录其账号的时间。该值采用 ISO 8601 日期和时间格式。时间是完整日期加时、分、秒,格式为 |
||||||||||||||||||||||||||||||||||||||||||
phones |
用户的电话号码列表。允许的数据大小上限为 1 KB。
|
||||||||||||||||||||||||||||||||||||||||||
suspensionReason |
仅限输出。说明用户账号被管理员或 Google 在暂停时暂停的原因。仅当 |
||||||||||||||||||||||||||||||||||||||||||
thumbnailPhotoUrl |
仅限输出。用户个人资料照片的网址。该网址可能是临时网址,也可能是不公开网址。 |
||||||||||||||||||||||||||||||||||||||||||
languages |
用户语言的列表。允许的数据大小上限为 1 KB。
|
||||||||||||||||||||||||||||||||||||||||||
posixAccounts |
用户的 POSIX 账号信息列表。
|
||||||||||||||||||||||||||||||||||||||||||
creationTime |
仅限输出。创建用户账号的时间。该值采用 ISO 8601 日期和时间格式。时间是完整日期加时、分、秒,格式为 |
||||||||||||||||||||||||||||||||||||||||||
nonEditableAliases[] |
仅限输出。用户的不可修改的别名电子邮件地址列表。这些域名通常在账号的主域名或子域名之外。 |
||||||||||||||||||||||||||||||||||||||||||
sshPublicKeys |
SSH 公钥列表。
|
||||||||||||||||||||||||||||||||||||||||||
notes |
作为嵌套对象的用户备注。
|
||||||||||||||||||||||||||||||||||||||||||
websites |
用户网站的列表。
|
||||||||||||||||||||||||||||||||||||||||||
locations |
用户所在位置的列表。允许的数据大小上限为 10 KB。
|
||||||||||||||||||||||||||||||||||||||||||
includeInGlobalAddressList |
指明在为网域启用联系人共享功能后,用户的个人资料是否显示在 Google Workspace 全局地址列表中。若要详细了解如何排除用户个人资料,请参阅管理帮助中心。 |
||||||||||||||||||||||||||||||||||||||||||
keywords |
用户的关键字列表。允许的数据大小上限为 1 KB。
|
||||||||||||||||||||||||||||||||||||||||||
deletionTime |
仅限输出。用户账号被删除的时间。该值采用 ISO 8601 日期和时间格式。时间是完整日期加时、分、秒,格式为 |
||||||||||||||||||||||||||||||||||||||||||
gender |
包含用户性别的嵌套对象。此字段允许的数据大小上限为 1 KB。
|
||||||||||||||||||||||||||||||||||||||||||
thumbnailPhotoEtag |
仅限输出。用户照片的 ETag(只读) |
||||||||||||||||||||||||||||||||||||||||||
ims |
用户的 Instant Messenger (IM) 账号。一个用户账号可以有多个
|
||||||||||||||||||||||||||||||||||||||||||
customSchemas |
用户的自定义字段。键为
|
||||||||||||||||||||||||||||||||||||||||||
isEnrolledIn2Sv |
仅限输出。已注册两步验证(只读) |
||||||||||||||||||||||||||||||||||||||||||
isEnforcedIn2Sv |
仅限输出。是否强制执行两步验证(只读) |
||||||||||||||||||||||||||||||||||||||||||
archived |
指明用户是否已归档。 |
||||||||||||||||||||||||||||||||||||||||||
orgUnitPath |
与用户关联的父级组织的完整路径。如果上级组织是顶级组织,则以正斜杠 ( |
||||||||||||||||||||||||||||||||||||||||||
recoveryEmail |
用户的辅助邮箱。 |
||||||||||||||||||||||||||||||||||||||||||
recoveryPhone |
用户的辅助电话号码。电话号码必须采用 E.164 格式,以加号 (+) 开头。示例:+16506661212。 |
UserName
JSON 表示法 |
---|
{ "fullName": string, "familyName": string, "givenName": string, "displayName": string } |
字段 | |
---|---|
fullName |
将名字和姓氏值串联在一起形成的用户全名。 |
familyName |
用户的姓氏。创建用户账号时必填。 |
givenName |
用户的名字。创建用户账号时必填。 |
displayName |
用户的显示名称。限制:最多 256 个字符。 |
方法 |
|
---|---|
|
删除用户。 |
|
检索用户。 |
|
创建用户。 |
|
检索已删除用户或网域中所有用户的分页列表。 |
|
将用户设为超级用户。 |
|
使用补丁语义更新用户。 |
|
将用户退出所有网站和设备会话,并重置其登录 Cookie。 |
|
恢复已删除的用户。 |
|
更新用户。 |
|
监控用户列表的变化。 |