Admin SDK: Directory API

Mit der Admin SDK Directory API können Administratoren von Unternehmensdomains Nutzer, Gruppen, Geräte und zugehörige Ressourcen in ihrer Organisation aufrufen und verwalten. Die Cloud Identity APIs bieten zusätzliche Möglichkeiten, einige der gleichen Ressourcen zu verwalten.

Dienst: admin.googleapis.com

Um diesen Dienst aufzurufen, empfehlen wir die Verwendung der von Google bereitgestellten Clientbibliotheken. Wenn Ihre Anwendung Ihre eigenen Bibliotheken verwenden muss, um diesen Dienst aufzurufen, verwenden Sie die folgenden Informationen, wenn Sie die API-Anfragen stellen.

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. Der Dienst bietet das folgende Discovery-Dokument:

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 von einem Nutzer ausgestelltes anwendungsspezifisches Passwort.
get GET /admin/directory/v1/users/{userKey}/asps/{codeId}
Ruft Informationen zu einem von einem Nutzer ausgestellten anwendungsspezifischen Passwort ab.
list GET /admin/directory/v1/users/{userKey}/asps
Listet die von einem Nutzer ausgestellten anwendungsspezifischen Passwörter 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 Chrome OS-Geräts ab.
list GET /admin/directory/v1/customer/{customerId}/devices/chromeos
Ruft eine paginierte Liste von Chrome OS-Geräten in einem Konto ab.
moveDevicesToOu POST /admin/directory/v1/customer/{customerId}/devices/chromeos/moveDevicesToOu
Verschiebt oder fügt mehrere Chrome OS-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 Reihe von ChromeOS-Geräten.
issueCommand POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand
Gibt einen Befehl aus, der auf dem 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 eines bestimmten Befehls an das Gerät ab.

REST-Ressource: customers

Methoden
get GET /admin/directory/v1/customers/{customerKey}
Ruft einen Kunden ab.
patch PATCH /admin/directory/v1/customers/{customerKey}
Patches 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
Listet die Domain-Aliasse 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
Listet 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 mit einem userKey (paginiert) ab.
patch PATCH /admin/directory/v1/groups/{groupKey}
Aktualisiert die Eigenschaften einer Gruppe.
update PUT /admin/directory/v1/groups/{groupKey}
Aktualisiert die Eigenschaften 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 Aliasse 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 Eigenschaften eines Gruppenmitglieds ab.
hasMember GET /admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}
Überprüft, ob der angegebene Nutzer Mitglied der Gruppe ist.
insert POST /admin/directory/v1/groups/{groupKey}/members
Fügt der angegebenen Gruppe einen Nutzer hinzu.
list GET /admin/directory/v1/groups/{groupKey}/members
Ruft eine paginierte Liste aller Mitglieder 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
Wenn eine Aktion ausgeführt wird, die ein Mobilgerät betrifft
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 Eigenschaften eines Mobilgeräts ab.
list GET /admin/directory/v1/customer/{customerId}/devices/mobile
Ruft eine paginierte Liste aller Mobilgeräte des Nutzers für ein Konto ab.

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 der Gebäude für ein Konto ab
patch PATCH /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Fachtet ein Gebäude.
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 von Kalenderressourcen für ein Konto ab.
patch PATCH /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Patch 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 Element.
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 Element ein.
list GET /admin/directory/v1/customer/{customer}/resources/features
Ruft eine Liste der Features eines Kontos ab.
patch PATCH /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Patcht ein Feature.
rename POST /admin/directory/v1/customer/{customer}/resources/features/{oldName}/rename
Benennt ein Element 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 Rollenzuweisungen 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}
Patcht eine Rolle.
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}
Patcht ein 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 Zugriffstoken ab, das von einem Nutzer ausgestellt wurde.
list GET /admin/directory/v1/users/{userKey}/tokens
Gibt die Tokens zurück, die der angegebene Nutzer an Anwendungen von Drittanbietern ausgegeben hat.

REST-Ressource: twoStepVerification

Methoden
turnOff POST /admin/directory/v1/users/{userKey}/twoStepVerification/turnOff
Deaktiviert die Bestätigung in zwei Schritten 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 mit den gelöschten Nutzern oder allen Nutzern in einer Domain ab.
makeAdmin POST /admin/directory/v1/users/{userKey}/makeAdmin
Damit wird ein Nutzer zum Super Admin.
patch PATCH /admin/directory/v1/users/{userKey}
Aktualisiert einen Nutzer mit Patchsemantik.
signOut POST /admin/directory/v1/users/{userKey}/signOut
Hiermit wird ein Nutzer aus allen Web- und Gerätesitzungen abgemeldet und seine Anmeldecookies zurückgesetzt.
undelete POST /admin/directory/v1/users/{userKey}/undelete
Stellt einen gelöschten Nutzer wieder her.
update PUT /admin/directory/v1/users/{userKey}
Aktualisiert einen Nutzer.
watch POST /admin/directory/v1/users/watch
Wartet auf Änderungen an 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 Aliasse für einen Nutzer auf.
watch POST /admin/directory/v1/users/{userKey}/aliases/watch
Wartet auf Änderungen an der Nutzerliste.

REST-Ressource: users.photos

Methoden
delete DELETE /admin/directory/v1/users/{userKey}/photos/thumbnail
Entfernt das Bild 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 Back-up-Codes für den Nutzer.
invalidate POST /admin/directory/v1/users/{userKey}/verificationCodes/invalidate
Ungültig macht die aktuellen Back-up-Codes für den Nutzer.
list GET /admin/directory/v1/users/{userKey}/verificationCodes
Gibt den aktuellen Satz gültiger Back-up-Codes für den angegebenen Nutzer zurück.