从网域服务迁移到 Admin SDK 高级服务

可让 G Suite 网域管理员管理用户和群组的网域服务自 2014 年 5 月 15 日起弃用,并将于 2014 年 11 月 20 日停用。该服务已被最近添加的 Admin SDK DirectoryAdmin SDK 报告高级服务所取代。本页面概述了从网域服务到新的替代产品 Admin SDK 的迁移路径。

方法比较

下表简要介绍了网域服务中使用的方法,以及 Admin SDK 中的等效方法(如有)。

域名服务方法 Admin SDK 方法
DomainGroup.addMember(memberId) AdminDirectory.Members.insert(resource, groupKey)
在 Admin SDK 中,可以通过 role 指定成员在群组中的角色。
DomainGroup.addOwner(ownerId)
DomainGroup.deleteGroup() AdminDirectory.Groups.remove(groupKey)
DomainGroup.getAllMembers() AdminDirectory.Members.list(groupKey, optionalArgs)
在 Admin SDK 中,可以使用可选的 roles 参数列出所有者。
DomainGroup.getAllOwners()
DomainGroup.getDescription() AdminDirectory.Groups.get(groupKey)
属性: description
属性: id
属性: name
DomainGroup.getId()
DomainGroup.getName()
DomainGroup.getPermissionLevel() 不适用
DomainGroup.removeMember(memberId) AdminDirectory.Members.remove(groupKey, memberKey)
DomainGroup.removeOwner(ownerId)
DomainGroup.setDescription(description) AdminDirectory.Groups.patch(resource, groupKey)
媒体资源: description
媒体资源: name
DomainGroup.setName(name)
DomainGroup.setPermissionLevel(level) 不适用
DomainNickname.deleteNickname() AdminDirectory.Users.Aliases.remove(userKey, alias)
DomainNickname.getNickname() AdminDirectory.Users.Aliases.list(userKey, optionalArgs)
媒体资源: aliases
媒体资源:primaryEmail
DomainNickname.getUsername()
DomainUser.deleteUser() AdminDirectory.Users.remove(userKey)
DomainUser.getAgreedToTerms() AdminDirectory.Users.get(userKey)
属性: agreedToTerms
属性: changePasswordAtNextLogin
属性: primaryEmail
属性: name.familyName
属性: name.givenName
属性: isAdmin
属性: suspended
DomainUser.getChangePasswordAtNextLogin()
DomainUser.getEmail()
DomainUser.getFamilyName()
DomainUser.getGivenName()
DomainUser.getIsAdmin()
DomainUser.getIsSuspended()
DomainUser.getStorageQuota() AdminReports.UserUsageReport.get(userKey, date, optionalArgs)
帐号: total_quota_in_mb
DomainUser.setChangePasswordAtNext Login(changePassword) AdminDirectory.Users.patch(resource, userKey)
属性: changePasswordAtNextLogin
属性: name.familyName
属性: name.givenName
DomainUser.setFamilyName(name)
DomainUser.setGivenName(name)
DomainUser.setIsAdmin(admin) AdminDirectory.Users.makeAdmin(resource, userKey)
属性: isAdmin
DomainUser.setIsSuspended(suspended) AdminDirectory.Users.patch(resource, userKey)
属性: suspended
属性: password
属性: primaryEmail
DomainUser.setPassword(password)
DomainUser.setUsername(username)
GroupsManager.createGroup(groupId, name, description, permissionLevel) GroupsManager.createGroup(groupId, name) AdminDirectory.Groups.insert(resource)
Admin SDK 不支持设置权限级别。
GroupsManager.getAllGroups()
GroupsManager.getAllGroups(memberId)
AdminDirectory.Groups.list(optionalArgs)
参数:userKey
GroupsManager.getDomain()
NicknameManager.getDomain()
UserManager.getDomain()
不适用
如需解决此问题,请获取单个用户的电子邮件地址并提取网域。
GroupsManager.getGroup(groupId) AdminDirectory.Groups.get(groupKey)
NicknameManager.createNickname(username, nickname) AdminDirectory.Users.Aliases.insert(resource, userKey)
NicknameManager.getAllNicknames() 不适用
NicknameManager.getAllNicknames(username) AdminDirectory.Users.Aliases.list(userKey, optionalArgs)
您需要遍历查询结果以查找别名。
NicknameManager.getNickname(nickname)
UserManager.createUser(username, givenName, familyName, password) UserManager.createUser(username, givenName, familyName, password, passwordHashFunction) AdminDirectory.Users.insert(resource)
属性: hashFunction
UserManager.getAllUsers() AdminDirectory.Users.list(optionalArgs)
必须提供 customer domain 参数。作为帐号管理员,您还可以使用 my_customer 别名来表示帐号的 customerId
UserManager.getUser(user)
UserManager.getUser(username)
AdminDirectory.Users.get(userKey)

Admin SDK 中的新功能

除了上述受支持的方法之外,Admin SDK 高级服务还提供以下新功能:

功能 Admin SDK 类或方法
管理员通知 AdminDirectory.Notifications
应用程序专用密码 AdminDirectory.Asps
设备管理 AdminDirectory.Chromeosdevices
AdminDirectory.Mobiledevices
群组别名 AdminDirectory.Groups.Aliases
OAuth 令牌 AdminDirectory.Tokens
组织部门 AdminDirectory.Orgunits
报告 AdminReports
搜索用户 AdminDirectory.Users.list(optionalArgs)
参数: query
恢复删除的用户 AdminDirectory.Users.undelete()
用户数据 AdminDirectory.Users.get(userKey)
用户照片 AdminDirectory.Users.Photos.get(userKey)
验证码(双重验证) AdminDirectory.VerificationCodes