Admin SDK: Directory API

Mit der Admin SDK Directory API können Administratoren von Unternehmensdomains die Nutzer, Gruppen, Geräte und zugehörigen Ressourcen ihrer Organisation ansehen und verwalten. Die Cloud Identity APIs bieten zusätzliche Möglichkeiten zum Verwalten einiger derselben Ressourcen.

Dienst: admin.googleapis.com

Wir empfehlen, diesen Dienst mit den von Google bereitgestellten Clientbibliotheken aufzurufen. Wenn Ihre Anwendung diesen Dienst mit Ihren eigenen Bibliotheken aufrufen muss, sollten Sie die folgenden Informationen verwenden, wenn Sie die API-Anfragen senden.

Discovery-Dokument

Ein Discovery-Dokument ist eine maschinenlesbare Spezifikation zum Beschreiben und Nutzen von REST APIs. Sie wird verwendet, um Clientbibliotheken, IDE-Plug-ins und andere Tools zu erstellen, die mit Google APIs interagieren. Ein Dienst kann mehrere Discovery-Dokumente haben. Dieser Dienst stellt folgendes Discovery-Dokument bereit:

Dienstendpunkt

Ein Dienstendpunkt ist eine Basis-URL, die die Netzwerkadresse eines API-Dienstes angibt. Ein Dienst kann mehrere Dienstendpunkte haben. Dieser Dienst hat den folgenden Dienstendpunkt und alle nachstehenden URIs beziehen sich auf ihn:

  • https://admin.googleapis.com

REST-Ressource: asps

Methoden
delete DELETE /admin/directory/v1/users/{userKey}/asps/{codeId}
Löscht ein vom Nutzer ausgestelltes ASP.
get GET /admin/directory/v1/users/{userKey}/asps/{codeId}
Ruft Informationen zu einem vom Nutzer ausgestellten ASP ab.
list GET /admin/directory/v1/users/{userKey}/asps
Führt die von einem Nutzer ausgestellten ASPs auf.

REST-Ressource: chromeosdevices

Methoden
action
(deprecated)		 POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{resourceId}/action
Verwenden Sie stattdessen BatchChangeChromeOsDeviceStatus.
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
Ruft die Eigenschaften eines ChromeOS-Geräts ab.
list GET /admin/directory/v1/customer/{customerId}/devices/chromeos
Ruft eine paginierte Liste von ChromeOS-Geräten in einem Konto ab.
moveDevicesToOu POST /admin/directory/v1/customer/{customerId}/devices/chromeos/moveDevicesToOu
Verschiebt oder fügt mehrere ChromeOS-Geräte in eine Organisationseinheit ein.
patch PATCH /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
Aktualisiert die aktualisierbaren Eigenschaften eines Geräts, z. B. annotatedUser, annotatedLocation, notes, orgUnitPath oder annotatedAssetId.
update PUT /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
Aktualisiert die aktualisierbaren Eigenschaften eines Geräts, z. B. annotatedUser, annotatedLocation, notes, orgUnitPath oder annotatedAssetId.

REST-Ressource: customer.devices.chromeos

Methoden
batchChangeStatus POST /admin/directory/v1/customer/{customerId}/devices/chromeos:batchChangeStatus
Ändert den Status einer Gruppe von ChromeOS-Geräten.
countChromeOsDevices GET /admin/directory/v1/customer/{customerId}/devices/chromeos:countChromeOsDevices
Zählt ChromeOS-Geräte, die der Anfrage entsprechen.
issueCommand POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand
Gibt einen Befehl aus, der vom Gerät ausgeführt werden soll.

REST-Ressource: customer.devices.chromeos.commands

Methoden
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}/commands/{commandId}
Ruft Befehlsdaten für einen bestimmten Befehl ab, der an das Gerät gesendet wurde.

REST-Ressource: customers

Methoden
get GET /admin/directory/v1/customers/{customerKey}
Ruft einen Kunden ab.
patch PATCH /admin/directory/v1/customers/{customerKey}
Aktualisiert einen Kunden.
update PUT /admin/directory/v1/customers/{customerKey}
Aktualisiert einen Kunden.

REST-Ressource: domainAliases

Methoden
delete DELETE /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
Löscht einen Domain-Alias des Kunden.
get GET /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
Ruft einen Domain-Alias des Kunden ab.
insert POST /admin/directory/v1/customer/{customer}/domainaliases
Fügt einen Domain-Alias des Kunden ein.
list GET /admin/directory/v1/customer/{customer}/domainaliases
Führt die Domainaliasse des Kunden auf.

REST-Ressource: domains

Methoden
delete DELETE /admin/directory/v1/customer/{customer}/domains/{domainName}
Löscht eine Domain des Kunden.
get GET /admin/directory/v1/customer/{customer}/domains/{domainName}
Ruft eine Domain des Kunden ab.
insert POST /admin/directory/v1/customer/{customer}/domains
Fügt eine Domain des Kunden ein.
list GET /admin/directory/v1/customer/{customer}/domains
Führt die Domains des Kunden auf.

REST-Ressource: groups

Methoden
delete DELETE /admin/directory/v1/groups/{groupKey}
Löscht eine Gruppe.
get GET /admin/directory/v1/groups/{groupKey}
Ruft die Attribute einer Gruppe ab.
insert POST /admin/directory/v1/groups
Erstellt eine Gruppe.
list GET /admin/directory/v1/groups
Ruft alle Gruppen einer Domain oder eines Nutzers ab, wenn ein userKey angegeben ist (paginiert).
patch PATCH /admin/directory/v1/groups/{groupKey}
Aktualisiert die Attribute einer Gruppe.
update PUT /admin/directory/v1/groups/{groupKey}
Aktualisiert die Attribute einer Gruppe.

REST-Ressource: groups.aliases

Methoden
delete DELETE /admin/directory/v1/groups/{groupKey}/aliases/{alias}
Entfernt einen Alias.
insert POST /admin/directory/v1/groups/{groupKey}/aliases
Fügt einen Alias für die Gruppe hinzu.
list GET /admin/directory/v1/groups/{groupKey}/aliases
Listet alle Aliase für eine Gruppe auf.

REST-Ressource: members

Methoden
delete DELETE /admin/directory/v1/groups/{groupKey}/members/{memberKey}
Entfernt ein Mitglied aus einer Gruppe.
get GET /admin/directory/v1/groups/{groupKey}/members/{memberKey}
Ruft die Attribute eines Gruppenmitglieds ab.
hasMember GET /admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}
Prüft, ob der angegebene Nutzer Mitglied der Gruppe ist.
insert POST /admin/directory/v1/groups/{groupKey}/members
Fügt einen Nutzer der angegebenen Gruppe hinzu.
list GET /admin/directory/v1/groups/{groupKey}/members
Ruft eine paginierte Liste aller Mitglieder in einer Gruppe ab.
patch PATCH /admin/directory/v1/groups/{groupKey}/members/{memberKey}
Aktualisiert die Mitgliedschaftseigenschaften eines Nutzers in der angegebenen Gruppe.
update PUT /admin/directory/v1/groups/{groupKey}/members/{memberKey}
Aktualisiert die Mitgliedschaft eines Nutzers in der angegebenen Gruppe.

REST-Ressource: mobiledevices

Methoden
action POST /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}/action
Führt eine Aktion aus, die sich auf ein Mobilgerät auswirkt.
delete DELETE /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}
Entfernt ein Mobilgerät.
get GET /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}
Ruft die Attribute eines Mobilgeräts ab.
list GET /admin/directory/v1/customer/{customerId}/devices/mobile
Ruft eine paginierte Liste aller Mobilgeräte ab, die einem Konto gehören.

REST-Ressource: orgunits

Methoden
delete DELETE /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
Entfernt eine Organisationseinheit.
get GET /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
Ruft eine Organisationseinheit ab.
insert POST /admin/directory/v1/customer/{customerId}/orgunits
Fügt eine Organisationseinheit hinzu.
list GET /admin/directory/v1/customer/{customerId}/orgunits
Ruft eine Liste aller Organisationseinheiten für ein Konto ab.
patch PATCH /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
Aktualisiert eine Organisationseinheit.
update PUT /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
Aktualisiert eine Organisationseinheit.

REST-Ressource: privileges

Methoden
list GET /admin/directory/v1/customer/{customer}/roles/ALL/privileges
Ruft eine paginierte Liste aller Berechtigungen für einen Kunden ab.

REST-Ressource: resources.buildings

Methoden
delete DELETE /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Löscht ein Gebäude.
get GET /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Ruft ein Gebäude ab.
insert POST /admin/directory/v1/customer/{customer}/resources/buildings
Fügt ein Gebäude ein.
list GET /admin/directory/v1/customer/{customer}/resources/buildings
Ruft eine Liste von Gebäuden für ein Konto ab.
patch PATCH /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Patches a building.
update PUT /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Aktualisiert ein Gebäude.

REST-Ressource: resources.calendars

Methoden
delete DELETE /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Löscht eine Kalenderressource.
get GET /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Ruft eine Kalenderressource ab.
insert POST /admin/directory/v1/customer/{customer}/resources/calendars
Fügt eine Kalenderressource ein.
list GET /admin/directory/v1/customer/{customer}/resources/calendars
Ruft eine Liste der Kalenderressourcen für ein Konto ab.
patch PATCH /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Aktualisiert eine Kalenderressource.
update PUT /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Aktualisiert eine Kalenderressource.

REST-Ressource: resources.features

Methoden
delete DELETE /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Löscht ein Feature.
get GET /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Ruft ein Feature ab.
insert POST /admin/directory/v1/customer/{customer}/resources/features
Fügt ein Feature ein.
list GET /admin/directory/v1/customer/{customer}/resources/features
Ruft eine Liste der Funktionen für ein Konto ab.
patch PATCH /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Patches a feature.
rename POST /admin/directory/v1/customer/{customer}/resources/features/{oldName}/rename
Benennt ein Attribut um.
update PUT /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Aktualisiert ein Feature.

REST-Ressource: roleAssignments

Methoden
delete DELETE /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}
Löscht eine Rollenzuweisung.
get GET /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}
Ruft eine Rollenzuweisung ab.
insert POST /admin/directory/v1/customer/{customer}/roleassignments
Erstellt eine Rollenzuweisung.
list GET /admin/directory/v1/customer/{customer}/roleassignments
Ruft eine paginierte Liste aller roleAssignments ab.

REST-Ressource: roles

Methoden
delete DELETE /admin/directory/v1/customer/{customer}/roles/{roleId}
Löscht eine Rolle.
get GET /admin/directory/v1/customer/{customer}/roles/{roleId}
Ruft eine Rolle ab.
insert POST /admin/directory/v1/customer/{customer}/roles
Erstellt eine Rolle.
list GET /admin/directory/v1/customer/{customer}/roles
Ruft eine paginierte Liste aller Rollen in einer Domain ab.
patch PATCH /admin/directory/v1/customer/{customer}/roles/{roleId}
Patches a role.
update PUT /admin/directory/v1/customer/{customer}/roles/{roleId}
Aktualisiert eine Rolle.

REST-Ressource: schemas

Methoden
delete DELETE /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
Löscht ein Schema.
get GET /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
Ruft ein Schema ab.
insert POST /admin/directory/v1/customer/{customerId}/schemas
Erstellt ein Schema.
list GET /admin/directory/v1/customer/{customerId}/schemas
Ruft alle Schemas für einen Kunden ab.
patch PATCH /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
Patches a schema.
update PUT /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
Aktualisiert ein Schema.

REST-Ressource: tokens

Methoden
delete DELETE /admin/directory/v1/users/{userKey}/tokens/{clientId}
Löscht alle Zugriffstokens, die von einem Nutzer für eine Anwendung ausgestellt wurden.
get GET /admin/directory/v1/users/{userKey}/tokens/{clientId}
Ruft Informationen zu einem von einem Nutzer ausgestellten Zugriffstoken ab.
list GET /admin/directory/v1/users/{userKey}/tokens
Gibt die Gruppe von Tokens zurück, die der angegebene Nutzer für Drittanbieteranwendungen ausgestellt hat.

REST-Ressource: twoStepVerification

Methoden
turnOff POST /admin/directory/v1/users/{userKey}/twoStepVerification/turnOff
Deaktiviert die 2‑Faktor-Authentifizierung für den Nutzer.

REST-Ressource: users

Methoden
delete DELETE /admin/directory/v1/users/{userKey}
Löscht einen Nutzer.
get GET /admin/directory/v1/users/{userKey}
Ruft einen Nutzer ab.
insert POST /admin/directory/v1/users
Erstellt einen Nutzer.
list GET /admin/directory/v1/users
Ruft eine paginierte Liste der gelöschten Nutzer oder aller Nutzer in einer Domain ab.
makeAdmin POST /admin/directory/v1/users/{userKey}/makeAdmin
Macht einen Nutzer zum Super Admin.
patch PATCH /admin/directory/v1/users/{userKey}
Aktualisiert einen Nutzer mithilfe der Patch-Semantik.
signOut POST /admin/directory/v1/users/{userKey}/signOut
Meldet einen Nutzer von allen Web- und Gerätesitzungen ab und setzt seine Anmeldecookies zurück.
undelete POST /admin/directory/v1/users/{userKey}/undelete
Macht das Löschen eines gelöschten Nutzers rückgängig.
update PUT /admin/directory/v1/users/{userKey}
Aktualisiert einen Nutzer.
watch POST /admin/directory/v1/users/watch
Prüft auf Änderungen in der Nutzerliste.

REST-Ressource: users.aliases

Methoden
delete DELETE /admin/directory/v1/users/{userKey}/aliases/{alias}
Entfernt einen Alias.
insert POST /admin/directory/v1/users/{userKey}/aliases
Fügt einen Alias hinzu.
list GET /admin/directory/v1/users/{userKey}/aliases
Listet alle Aliase für einen Nutzer auf.
watch POST /admin/directory/v1/users/{userKey}/aliases/watch
Prüft auf Änderungen in der Nutzerliste.

REST-Ressource: users.photos

Methoden
delete DELETE /admin/directory/v1/users/{userKey}/photos/thumbnail
Entfernt das Foto des Nutzers.
get GET /admin/directory/v1/users/{userKey}/photos/thumbnail
Ruft das Foto des Nutzers ab.
patch PATCH /admin/directory/v1/users/{userKey}/photos/thumbnail
Fügt ein Foto für den Nutzer hinzu.
update PUT /admin/directory/v1/users/{userKey}/photos/thumbnail
Fügt ein Foto für den Nutzer hinzu.

REST-Ressource: verificationCodes

Methoden
generate POST /admin/directory/v1/users/{userKey}/verificationCodes/generate
Generiert neue Backup-Codes für den Nutzer.
invalidate POST /admin/directory/v1/users/{userKey}/verificationCodes/invalidate
Die aktuellen Back-up-Codes für den Nutzer werden ungültig.
list GET /admin/directory/v1/users/{userKey}/verificationCodes
Gibt die aktuelle Gruppe gültiger Back-up-Bestätigungscodes für den angegebenen Nutzer zurück.