The Domain service , which allows G Suite domain administrators to manage users and groups, is deprecated as of May 15, 2014 , and will be turned off on November 20, 2014 . The service is replaced by the recently added Admin SDK Directory and Admin SDK Reports advanced services. This page outlines the migration path from Domain service to its new replacement, Admin SDK.
Method comparison
The table below provides an overview of the methods used in Domain service and their equivalent methods (if any) in Admin SDK.
AdminDirectory.Members.insert(resource, groupKey)
In Admin SDK, a member's role in a group can be specified via
role
. AdminDirectory.Members.list(groupKey, optionalArgs)
In Admin SDK, owner(s) can be listed using the optional
roles
parameter. AdminDirectory.Users.get(userKey)
Property:
agreedToTerms
Property:
changePasswordAtNextLogin
Property:
primaryEmail
Property:
name.familyName
Property:
name.givenName
Property:
isAdmin
Property:
suspended
AdminDirectory.Users.patch(resource, userKey)
Property:
changePasswordAtNextLogin
Property:
name.familyName
Property:
name.givenName
AdminDirectory.Users.patch(resource, userKey)
Property:
suspended
Property:
password
Property:
primaryEmail
GroupsManager.createGroup(groupId, name, description, permissionLevel)
GroupsManager.createGroup(groupId, name)
AdminDirectory.Groups.insert(resource)
Setting the permission level isn't supported in the Admin SDK.
As a workaround, get a single user's email address and extract the domain.
AdminDirectory.Users.Aliases.list(userKey, optionalArgs)
You will need to loop through the results to find the nickname.
AdminDirectory.Users.list(optionalArgs)
Either the
customer
or the domain
parameter must be provided. As an account
administrator, you can also use the my_customer
alias to
represent your account's customerId
.New features in Admin SDK
In addition to the supported methods outlined above, the Admin SDK advanced services provide the following new features:
Feature | Admin SDK class or method |
---|---|
Admin notifications | AdminDirectory.Notifications
|
Application-specific passwords | AdminDirectory.Asps
|
Device management | AdminDirectory.Chromeosdevices
AdminDirectory.Mobiledevices
|
Group aliases | AdminDirectory.Groups.Aliases
|
OAuth tokens | AdminDirectory.Tokens
|
Org units | AdminDirectory.Orgunits
|
Reporting | AdminReports
|
Search for users | AdminDirectory.Users.list(optionalArgs)
Parameter: query
|
Un-delete users | AdminDirectory.Users.undelete()
|
User data | AdminDirectory.Users.get(userKey)
|
User photo | AdminDirectory.Users.Photos.get(userKey)
|
Verification codes (2-factor) | AdminDirectory.VerificationCodes
|