Admin SDK: Directory API

L'API Directory du SDK Admin permet aux administrateurs de domaines d'entreprise d'afficher et de gérer les utilisateurs, les groupes, les appareils et les ressources associées de leur organisation. Les API Cloud Identity offrent d'autres moyens de gérer certaines des mêmes ressources.

Service : admin.googleapis.com

Pour appeler ce service, nous vous recommandons d'utiliser les bibliothèques clientes fournies par Google. Si votre application doit utiliser vos propres bibliothèques pour appeler ce service, conformez-vous aux informations suivantes lorsque vous effectuez les requêtes API.

Document de découverte

Un document de découverte est une spécification exploitable par un ordinateur qui permet de décrire et de consommer les API REST. Ce document permet de créer des bibliothèques clientes, des plug-ins IDE et d'autres outils qui interagissent avec les API Google. Un même service peut fournir plusieurs documents de découverte. Ce service fournit le document de découverte suivant :

Point de terminaison de service

Un point de terminaison de service est une URL de base qui spécifie l'adresse réseau d'un service d'API. Un service peut posséder plusieurs points de terminaison de service. Ce service possède le point de terminaison de service suivant, et tous les URI ci-dessous sont relatifs à ce point de terminaison de service :

  • https://admin.googleapis.com

Ressource REST : asps

Méthodes
delete DELETE /admin/directory/v1/users/{userKey}/asps/{codeId}
Supprime un ASP émis par un utilisateur.
get GET /admin/directory/v1/users/{userKey}/asps/{codeId}
Récupère des informations sur un ASP émis par un utilisateur.
list GET /admin/directory/v1/users/{userKey}/asps
Liste les ASP émis par un utilisateur.

Ressource REST : chromeosdevices

Méthodes
action
(deprecated)		 POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{resourceId}/action
Utilisez BatchChangeChromeOsDeviceStatus à la place.
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
Récupère les propriétés d'un appareil ChromeOS.
list GET /admin/directory/v1/customer/{customerId}/devices/chromeos
Récupère une liste paginée des appareils ChromeOS d'un compte.
moveDevicesToOu POST /admin/directory/v1/customer/{customerId}/devices/chromeos/moveDevicesToOu
Déplace ou insère plusieurs appareils ChromeOS dans une unité organisationnelle.
patch PATCH /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
Met à jour les propriétés modifiables d'un appareil, telles que annotatedUser, annotatedLocation, notes, orgUnitPath ou annotatedAssetId.
update PUT /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
Met à jour les propriétés modifiables d'un appareil, telles que annotatedUser, annotatedLocation, notes, orgUnitPath ou annotatedAssetId.

Ressource REST : customer.devices.chromeos

Méthodes
batchChangeStatus POST /admin/directory/v1/customer/{customerId}/devices/chromeos:batchChangeStatus
Modifie l'état d'un lot d'appareils ChromeOS.
countChromeOsDevices GET /admin/directory/v1/customer/{customerId}/devices/chromeos:countChromeOsDevices
Compte les appareils ChromeOS correspondant à la requête.
issueCommand POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand
Envoie une commande à l'appareil pour qu'il l'exécute.

Ressource REST : customer.devices.chromeos.commands

Méthodes
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}/commands/{commandId}
Récupère les données de commande d'une commande spécifique envoyée à l'appareil.

Ressource REST : customers

Méthodes
get GET /admin/directory/v1/customers/{customerKey}
Récupère un client.
patch PATCH /admin/directory/v1/customers/{customerKey}
Modifie un client.
update PUT /admin/directory/v1/customers/{customerKey}
Met à jour un client.

Ressource REST : domainAliases

Méthodes
delete DELETE /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
Supprime un alias de domaine du client.
get GET /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
Récupère un alias de domaine du client.
insert POST /admin/directory/v1/customer/{customer}/domainaliases
Insère un alias de domaine du client.
list GET /admin/directory/v1/customer/{customer}/domainaliases
Liste les alias de domaine du client.

Ressource REST : domains

Méthodes
delete DELETE /admin/directory/v1/customer/{customer}/domains/{domainName}
Supprime un domaine du client.
get GET /admin/directory/v1/customer/{customer}/domains/{domainName}
Récupère un domaine du client.
insert POST /admin/directory/v1/customer/{customer}/domains
Insère un domaine du client.
list GET /admin/directory/v1/customer/{customer}/domains
Liste les domaines du client.

Ressource REST : groups

Méthodes
delete DELETE /admin/directory/v1/groups/{groupKey}
Supprime un groupe.
get GET /admin/directory/v1/groups/{groupKey}
Récupère les propriétés d'un groupe.
insert POST /admin/directory/v1/groups
Crée un groupe.
list GET /admin/directory/v1/groups
Récupère tous les groupes d'un domaine ou d'un utilisateur à partir d'une clé utilisateur (pagination).
patch PATCH /admin/directory/v1/groups/{groupKey}
Met à jour les propriétés d'un groupe.
update PUT /admin/directory/v1/groups/{groupKey}
Met à jour les propriétés d'un groupe.

Ressource REST : groups.aliases

Méthodes
delete DELETE /admin/directory/v1/groups/{groupKey}/aliases/{alias}
Supprime un alias.
insert POST /admin/directory/v1/groups/{groupKey}/aliases
Ajoute un alias au groupe.
list GET /admin/directory/v1/groups/{groupKey}/aliases
Liste tous les alias d'un groupe.

Ressource REST : members

Méthodes
delete DELETE /admin/directory/v1/groups/{groupKey}/members/{memberKey}
Supprime un membre d'un groupe.
get GET /admin/directory/v1/groups/{groupKey}/members/{memberKey}
Récupère les propriétés d'un membre du groupe.
hasMember GET /admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}
Vérifie si l'utilisateur donné est membre du groupe.
insert POST /admin/directory/v1/groups/{groupKey}/members
Ajoute un utilisateur au groupe spécifié.
list GET /admin/directory/v1/groups/{groupKey}/members
Récupère une liste paginée de tous les membres d'un groupe.
patch PATCH /admin/directory/v1/groups/{groupKey}/members/{memberKey}
Met à jour les propriétés d'appartenance d'un utilisateur dans le groupe spécifié.
update PUT /admin/directory/v1/groups/{groupKey}/members/{memberKey}
Met à jour l'appartenance d'un utilisateur au groupe spécifié.

Ressource REST : mobiledevices

Méthodes
action POST /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}/action
Effectue une action qui affecte un appareil mobile.
delete DELETE /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}
Supprime un appareil mobile.
get GET /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}
Récupère les propriétés d'un appareil mobile.
list GET /admin/directory/v1/customer/{customerId}/devices/mobile
Récupère une liste paginée de tous les appareils mobiles appartenant à un utilisateur pour un compte.

Ressource REST : orgunits

Méthodes
delete DELETE /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
Supprime une unité organisationnelle.
get GET /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
Récupère une unité organisationnelle.
insert POST /admin/directory/v1/customer/{customerId}/orgunits
Ajoute une unité organisationnelle.
list GET /admin/directory/v1/customer/{customerId}/orgunits
Récupère la liste de toutes les unités organisationnelles d'un compte.
patch PATCH /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
Met à jour une unité organisationnelle.
update PUT /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
Met à jour une unité organisationnelle.

Ressource REST : privileges

Méthodes
list GET /admin/directory/v1/customer/{customer}/roles/ALL/privileges
Récupère une liste paginée de tous les droits d'accès d'un client.

Ressource REST : resources.buildings

Méthodes
delete DELETE /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Supprime un bâtiment.
get GET /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Récupère un bâtiment.
insert POST /admin/directory/v1/customer/{customer}/resources/buildings
Insère un bâtiment.
list GET /admin/directory/v1/customer/{customer}/resources/buildings
Récupère la liste des bâtiments d'un compte.
patch PATCH /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Corrige un bâtiment.
update PUT /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Met à jour un bâtiment.

Ressource REST : resources.calendars

Méthodes
delete DELETE /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Supprime une ressource d'agenda.
get GET /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Récupère une ressource d'agenda.
insert POST /admin/directory/v1/customer/{customer}/resources/calendars
Insère une ressource d'agenda.
list GET /admin/directory/v1/customer/{customer}/resources/calendars
Récupère la liste des ressources d'agenda pour un compte.
patch PATCH /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Corrige une ressource d'agenda.
update PUT /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Met à jour une ressource d'agenda.

Ressource REST : resources.features

Méthodes
delete DELETE /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Supprime une caractéristique.
get GET /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Récupère une caractéristique.
insert POST /admin/directory/v1/customer/{customer}/resources/features
Insère une caractéristique.
list GET /admin/directory/v1/customer/{customer}/resources/features
Récupère la liste des fonctionnalités d'un compte.
patch PATCH /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Corrige une fonctionnalité.
rename POST /admin/directory/v1/customer/{customer}/resources/features/{oldName}/rename
Renomme une fonctionnalité.
update PUT /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Met à jour une caractéristique.

Ressource REST : roleAssignments

Méthodes
delete DELETE /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}
Supprime une attribution de rôle.
get GET /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}
Récupère une attribution de rôle.
insert POST /admin/directory/v1/customer/{customer}/roleassignments
Crée une attribution de rôle.
list GET /admin/directory/v1/customer/{customer}/roleassignments
Récupère une liste paginée de toutes les attributions de rôle.

Ressource REST : roles

Méthodes
delete DELETE /admin/directory/v1/customer/{customer}/roles/{roleId}
Supprime un rôle.
get GET /admin/directory/v1/customer/{customer}/roles/{roleId}
Récupère un rôle.
insert POST /admin/directory/v1/customer/{customer}/roles
Crée un rôle.
list GET /admin/directory/v1/customer/{customer}/roles
Récupère une liste paginée de tous les rôles d'un domaine.
patch PATCH /admin/directory/v1/customer/{customer}/roles/{roleId}
Corrige un rôle.
update PUT /admin/directory/v1/customer/{customer}/roles/{roleId}
Met à jour un rôle.

Ressource REST : schemas

Méthodes
delete DELETE /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
Supprime un schéma.
get GET /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
Récupère un schéma.
insert POST /admin/directory/v1/customer/{customerId}/schemas
Crée un schéma.
list GET /admin/directory/v1/customer/{customerId}/schemas
Récupère tous les schémas d'un client.
patch PATCH /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
Corrige un schéma.
update PUT /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
Met à jour un schéma.

Ressource REST : tokens

Méthodes
delete DELETE /admin/directory/v1/users/{userKey}/tokens/{clientId}
Supprime tous les jetons d'accès émis par un utilisateur pour une application.
get GET /admin/directory/v1/users/{userKey}/tokens/{clientId}
Obtient des informations sur un jeton d'accès émis par un utilisateur.
list GET /admin/directory/v1/users/{userKey}/tokens
Renvoie l'ensemble des jetons émis par l'utilisateur spécifié pour les applications tierces.

Ressource REST : twoStepVerification

Méthodes
turnOff POST /admin/directory/v1/users/{userKey}/twoStepVerification/turnOff
Désactive la validation en deux étapes pour l'utilisateur.

Ressource REST : users

Méthodes
delete DELETE /admin/directory/v1/users/{userKey}
Supprime un utilisateur.
get GET /admin/directory/v1/users/{userKey}
Récupère un utilisateur.
insert POST /admin/directory/v1/users
Crée un utilisateur.
list GET /admin/directory/v1/users
Récupère une liste paginée des utilisateurs supprimés ou de tous les utilisateurs d'un domaine.
makeAdmin POST /admin/directory/v1/users/{userKey}/makeAdmin
Définit un utilisateur comme super-administrateur.
patch PATCH /admin/directory/v1/users/{userKey}
Met à jour un utilisateur à l'aide de la sémantique de correctif.
signOut POST /admin/directory/v1/users/{userKey}/signOut
Déconnecte un utilisateur de toutes les sessions Web et sur les appareils, et réinitialise ses cookies de connexion.
undelete POST /admin/directory/v1/users/{userKey}/undelete
Restaure un utilisateur supprimé.
update PUT /admin/directory/v1/users/{userKey}
Met à jour un utilisateur.
watch POST /admin/directory/v1/users/watch
Surveille les modifications apportées à la liste des utilisateurs.

Ressource REST : users.aliases

Méthodes
delete DELETE /admin/directory/v1/users/{userKey}/aliases/{alias}
Supprime un alias.
insert POST /admin/directory/v1/users/{userKey}/aliases
Ajoute un alias.
list GET /admin/directory/v1/users/{userKey}/aliases
Liste tous les alias d'un utilisateur.
watch POST /admin/directory/v1/users/{userKey}/aliases/watch
Surveille les modifications apportées à la liste des utilisateurs.

Ressource REST : users.photos

Méthodes
delete DELETE /admin/directory/v1/users/{userKey}/photos/thumbnail
Supprime la photo de l'utilisateur.
get GET /admin/directory/v1/users/{userKey}/photos/thumbnail
Récupère la photo de l'utilisateur.
patch PATCH /admin/directory/v1/users/{userKey}/photos/thumbnail
Ajoute une photo pour l'utilisateur.
update PUT /admin/directory/v1/users/{userKey}/photos/thumbnail
Ajoute une photo pour l'utilisateur.

Ressource REST : verificationCodes

Méthodes
generate POST /admin/directory/v1/users/{userKey}/verificationCodes/generate
Génère de nouveaux codes de validation de secours pour l'utilisateur.
invalidate POST /admin/directory/v1/users/{userKey}/verificationCodes/invalidate
Invalide les codes de validation de secours actuels de l'utilisateur.
list GET /admin/directory/v1/users/{userKey}/verificationCodes
Renvoie l'ensemble actuel des codes de validation de secours valides pour l'utilisateur spécifié.