Migrer du service de domaine vers les services avancés de l'Admin SDK

Le service de domaine, qui permettait aux administrateurs Google Workspace de gérer les utilisateurs et les groupes, a été abandonné le 15 mai 2014 et désactivé le 20 novembre 2014. Ce service est remplacé par les services avancés Répertoire SDK Admin et Rapports SDK Admin. Cette page décrit le chemin de migration du service Domain vers l'Admin SDK.

Comparaison des méthodes

Le tableau suivant présente les méthodes utilisées dans le service Domain et leurs méthodes équivalentes (le cas échéant) dans le SDK Admin.

Méthode des services de domaine Méthode du SDK Admin
DomainGroup.addMember(memberId) AdminDirectory.Members.insert(resource, groupKey)
Dans l'Admin SDK, le rôle d'un membre dans un groupe peut être spécifié via role.
DomainGroup.addOwner(ownerId)
DomainGroup.deleteGroup() AdminDirectory.Groups.remove(groupKey)
DomainGroup.getAllMembers() AdminDirectory.Members.list(groupKey, optionalArgs)
Dans le SDK Admin, le ou les propriétaires peuvent être listés à l'aide du paramètre facultatif roles.
DomainGroup.getAllOwners()
DomainGroup.getDescription() AdminDirectory.Groups.get(groupKey)
Propriété : description
Propriété : id
Propriété : name
DomainGroup.getId()
DomainGroup.getName()
DomainGroup.getPermissionLevel() N/A
DomainGroup.removeMember(memberId) AdminDirectory.Members.remove(groupKey, memberKey)
DomainGroup.removeOwner(ownerId)
DomainGroup.setDescription(description) AdminDirectory.Groups.patch(resource, groupKey)
Propriété : description
Propriété : name
DomainGroup.setName(name)
DomainGroup.setPermissionLevel(level) N/A
DomainNickname.deleteNickname() AdminDirectory.Users.Aliases.remove(userKey, alias)
DomainNickname.getNickname() AdminDirectory.Users.Aliases.list(userKey, optionalArgs)
Propriété : aliases
Propriété : primaryEmail
DomainNickname.getUsername()
DomainUser.deleteUser() AdminDirectory.Users.remove(userKey)
DomainUser.getAgreedToTerms() AdminDirectory.Users.get(userKey)
Property: agreedToTerms
Property: changePasswordAtNextLogin
Property: primaryEmail
Property: name.familyName
Property: name.givenName
Property: isAdmin
Property: suspended
DomainUser.getChangePasswordAtNextLogin()
DomainUser.getEmail()
DomainUser.getFamilyName()
DomainUser.getGivenName()
DomainUser.getIsAdmin()
DomainUser.getIsSuspended()
DomainUser.getStorageQuota() AdminReports.UserUsageReport.get(userKey, date, optionalArgs)
Compte : total_quota_in_mb
DomainUser.setChangePasswordAtNext Login(changePassword) AdminDirectory.Users.patch(resource, userKey)
Propriété : changePasswordAtNextLogin
Propriété : name.familyName
Propriété : name.givenName
DomainUser.setFamilyName(name)
DomainUser.setGivenName(name)
DomainUser.setIsAdmin(admin) AdminDirectory.Users.makeAdmin(resource, userKey)
Propriété : isAdmin
DomainUser.setIsSuspended(suspended) AdminDirectory.Users.patch(resource, userKey)
Propriété : suspended
Propriété : password
Propriété : primaryEmail
DomainUser.setPassword(password)
DomainUser.setUsername(username)
GroupsManager.createGroup(groupId, name, description, permissionLevel) GroupsManager.createGroup(groupId, name) AdminDirectory.Groups.insert(resource)
La définition du niveau d'autorisation n'est pas prise en charge dans l'Admin SDK.
GroupsManager.getAllGroups()
GroupsManager.getAllGroups(memberId)		 AdminDirectory.Groups.list(optionalArgs)
Paramètre : userKey
GroupsManager.getDomain()
NicknameManager.getDomain()
UserManager.getDomain() 		N/A
Pour contourner ce problème, récupérez l'adresse e-mail d'un seul utilisateur et extrayez le domaine.
GroupsManager.getGroup(groupId) AdminDirectory.Groups.get(groupKey)
NicknameManager.createNickname(username, nickname) AdminDirectory.Users.Aliases.insert(resource, userKey)
NicknameManager.getAllNicknames() N/A
NicknameManager.getAllNicknames(username) AdminDirectory.Users.Aliases.list(userKey, optionalArgs)
Vous devrez parcourir les résultats en boucle pour trouver le pseudo.
NicknameManager.getNickname(nickname)
UserManager.createUser(username, givenName, familyName, password) UserManager.createUser(username, givenName, familyName, password, passwordHashFunction) AdminDirectory.Users.insert(resource)
Propriété : hashFunction
UserManager.getAllUsers() AdminDirectory.Users.list(optionalArgs)
Vous devez fournir le paramètre customer ou domain. En tant qu'administrateur de compte, vous pouvez également utiliser l'alias my_customer pour représenter le customerId de votre compte.
UserManager.getUser(user)
UserManager.getUser(username)		 AdminDirectory.Users.get(userKey)

Nouvelles fonctionnalités du SDK Admin

En plus des méthodes compatibles décrites dans la section précédente, les services avancés de l'Admin SDK proposent les nouvelles fonctionnalités suivantes :

Fonctionnalité Classe ou méthode du SDK Admin
Notifications pour les administrateurs AdminDirectory.Notifications
Mots de passe spécifiques à des applications AdminDirectory.Asps
Gestion des appareils AdminDirectory.Chromeosdevices
AdminDirectory.Mobiledevices
Alias de groupe AdminDirectory.Groups.Aliases
Jetons OAuth AdminDirectory.Tokens
Unités organisationnelles AdminDirectory.Orgunits
Rapports AdminReports
Rechercher des utilisateurs AdminDirectory.Users.list(optionalArgs)
Paramètre : query
Annuler la suppression d'utilisateurs AdminDirectory.Users.undelete()
Données utilisateur AdminDirectory.Users.get(userKey)
Photo de l'utilisateur AdminDirectory.Users.Photos.get(userKey)
Codes de validation (authentification à deux facteurs) AdminDirectory.VerificationCodes