Ressource: User
Mit der Directory API können Sie Nutzer, Nutzer-Aliasse und Google-Profilbilder von Nutzern in Ihrem Konto erstellen und verwalten. Weitere Informationen zu häufigen Aufgaben finden Sie im Entwicklerleitfaden für Nutzerkonten und im Entwicklerleitfaden für Nutzeraliasse.
| JSON-Darstellung |
|---|
{ "id": string, "primaryEmail": string, "password": value, "hashFunction": string, "isAdmin": boolean, "isDelegatedAdmin": boolean, "agreedToTerms": boolean, "suspended": boolean, "changePasswordAtNextLogin": boolean, "ipWhitelisted": boolean, "name": { object ( |
| Felder | |||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
Die eindeutige ID des Nutzers. Ein Nutzer- |
||||||||||||||||||||||||||||||||||||||||||
primaryEmail |
Die primäre E-Mail-Adresse des Nutzers. Diese Eigenschaft ist in einer Anfrage zum Erstellen eines Nutzerkontos erforderlich. Der |
||||||||||||||||||||||||||||||||||||||||||
password |
Speichert das Passwort für das Nutzerkonto. Der Passwortwert des Nutzers ist erforderlich, wenn ein Nutzerkonto erstellt wird. Sie ist optional, wenn ein Nutzer aktualisiert wird, und sollte nur angegeben werden, wenn der Nutzer sein Kontopasswort aktualisiert. Der Passwortwert wird nie im Antworttext der API zurückgegeben. |
||||||||||||||||||||||||||||||||||||||||||
hashFunction |
Speichert das Hash-Format des Attributs
Wenn Runden als Teil des Präfixes angegeben werden, dürfen es maximal 10.000 sein. |
||||||||||||||||||||||||||||||||||||||||||
isAdmin |
Nur Ausgabe. Gibt einen Nutzer mit Super Admin-Berechtigungen an. Die Property |
||||||||||||||||||||||||||||||||||||||||||
isDelegatedAdmin |
Nur Ausgabe. Gibt an, ob der Nutzer ein delegierter Administrator ist. |
||||||||||||||||||||||||||||||||||||||||||
agreedToTerms |
Nur Ausgabe. Diese Eigenschaft ist |
||||||||||||||||||||||||||||||||||||||||||
suspended |
Gibt an, ob der Nutzer gesperrt ist. |
||||||||||||||||||||||||||||||||||||||||||
changePasswordAtNextLogin |
Gibt an, ob der Nutzer bei der nächsten Anmeldung zum Ändern seines Passworts aufgefordert wird. Diese Einstellung gilt nicht, wenn der Nutzer sich über einen externen Identitätsanbieter anmeldet. |
||||||||||||||||||||||||||||||||||||||||||
ipWhitelisted |
Wenn |
||||||||||||||||||||||||||||||||||||||||||
name |
Enthält den Vor- und Nachnamen des Nutzers sowie den schreibgeschützten Wert |
||||||||||||||||||||||||||||||||||||||||||
kind |
Nur Ausgabe. Der Typ der API-Ressource. Für Nutzerressourcen ist der Wert |
||||||||||||||||||||||||||||||||||||||||||
etag |
Nur Ausgabe. ETag der Ressource. |
||||||||||||||||||||||||||||||||||||||||||
emails |
Die Liste der E‑Mail-Adressen des Nutzers. Die maximal zulässige Datengröße beträgt 10 KB.
|
||||||||||||||||||||||||||||||||||||||||||
externalIds |
Die Liste der externen IDs für den Nutzer, z. B. eine Mitarbeiter- oder Netzwerk-ID. Die maximal zulässige Datengröße beträgt 2 KB.
|
||||||||||||||||||||||||||||||||||||||||||
relations |
Die Liste der Beziehungen des Nutzers zu anderen Nutzern. Die maximal zulässige Datengröße für dieses Feld beträgt 2 KB. Weitere Informationen finden Sie unter Nutzerkonten verwalten.
|
||||||||||||||||||||||||||||||||||||||||||
aliases[] |
Nur Ausgabe. Die Liste der Alias-E‑Mail-Adressen des Nutzers. |
||||||||||||||||||||||||||||||||||||||||||
isMailboxSetup |
Nur Ausgabe. Gibt an, ob das Google-Postfach des Nutzers erstellt wurde. Diese Eigenschaft gilt nur, wenn dem Nutzer eine Gmail-Lizenz zugewiesen wurde. |
||||||||||||||||||||||||||||||||||||||||||
customerId |
Nur Ausgabe. Die Kunden-ID zum Abrufen aller Kontonutzer. |
||||||||||||||||||||||||||||||||||||||||||
addresses |
Die Liste der Adressen des Nutzers. Die maximal zulässige Datengröße beträgt 10 KB.
|
||||||||||||||||||||||||||||||||||||||||||
organizations |
Die Liste der Organisationen, denen der Nutzer angehört. Die maximal zulässige Datengröße beträgt 10 KB.
|
||||||||||||||||||||||||||||||||||||||||||
lastLoginTime |
Nur Ausgabe. Der Zeitpunkt der letzten Anmeldung des Nutzers im Konto. Der Wert ist im Datums- und Zeitformat nach ISO 8601. Die Zeit ist das vollständige Datum plus Stunden, Minuten und Sekunden im Format |
||||||||||||||||||||||||||||||||||||||||||
phones |
Eine Liste der Telefonnummern des Nutzers. Die maximal zulässige Datengröße beträgt 1 KB.
|
||||||||||||||||||||||||||||||||||||||||||
suspensionReason |
Nur Ausgabe. Gibt den Grund für die Sperrung eines Nutzerkontos durch den Administrator oder durch Google zum Zeitpunkt der Sperrung an. Die Property wird nur zurückgegeben, wenn die Property |
||||||||||||||||||||||||||||||||||||||||||
thumbnailPhotoUrl |
Nur Ausgabe. Die URL des Profilbilds des Nutzers. Die URL ist möglicherweise temporär oder privat. |
||||||||||||||||||||||||||||||||||||||||||
languages |
Die Liste der Sprachen des Nutzers. Die maximal zulässige Datengröße beträgt 1 KB.
|
||||||||||||||||||||||||||||||||||||||||||
posixAccounts |
Die Liste der POSIX-Kontoinformationen für den Nutzer.
|
||||||||||||||||||||||||||||||||||||||||||
creationTime |
Nur Ausgabe. Der Zeitpunkt, zu dem das Nutzerkonto erstellt wurde. Der Wert ist im Datums- und Zeitformat nach ISO 8601. Die Zeit ist das vollständige Datum plus Stunden, Minuten und Sekunden im Format |
||||||||||||||||||||||||||||||||||||||||||
nonEditableAliases[] |
Nur Ausgabe. Die Liste der Alias-E-Mail-Adressen des Nutzers, die nicht bearbeitet werden können. Diese befinden sich in der Regel außerhalb der primären Domain oder Subdomain des Kontos. |
||||||||||||||||||||||||||||||||||||||||||
sshPublicKeys |
Eine Liste öffentlicher SSH-Schlüssel.
|
||||||||||||||||||||||||||||||||||||||||||
notes |
Hinweise für den Nutzer als verschachteltes Objekt.
|
||||||||||||||||||||||||||||||||||||||||||
websites |
Die Liste der Websites des Nutzers.
|
||||||||||||||||||||||||||||||||||||||||||
locations |
Die Liste der Standorte des Nutzers. Die maximal zulässige Datengröße beträgt 10 KB.
|
||||||||||||||||||||||||||||||||||||||||||
includeInGlobalAddressList |
Gibt an, ob das Profil des Nutzers in der globalen Adressliste von Google Workspace sichtbar ist, wenn die Funktion zur Kontaktfreigabe für die Domain aktiviert ist. Weitere Informationen zum Ausschließen von Nutzerprofilen finden Sie in der Administratorhilfe. |
||||||||||||||||||||||||||||||||||||||||||
keywords |
Die Liste der Keywords des Nutzers. Die maximal zulässige Datengröße beträgt 1 KB.
|
||||||||||||||||||||||||||||||||||||||||||
deletionTime |
Nur Ausgabe. Der Zeitpunkt, zu dem das Konto des Nutzers gelöscht wurde. Der Wert ist im Datums- und Zeitformat nach ISO 8601. Die Zeit ist das vollständige Datum plus Stunden, Minuten und Sekunden im Format |
||||||||||||||||||||||||||||||||||||||||||
gender |
Ein verschachteltes Objekt mit dem Geschlecht des Nutzers. Die maximal zulässige Datengröße für dieses Feld beträgt 1 KB.
|
||||||||||||||||||||||||||||||||||||||||||
thumbnailPhotoEtag |
Nur Ausgabe. ETag des Fotos des Nutzers (schreibgeschützt) |
||||||||||||||||||||||||||||||||||||||||||
ims |
Die Konten des Nutzers für Instant Messaging (IM). Ein Nutzerkonto kann mehrere
|
||||||||||||||||||||||||||||||||||||||||||
customSchemas |
Benutzerdefinierte Felder des Nutzers. Der Schlüssel ist ein
|
||||||||||||||||||||||||||||||||||||||||||
isEnrolledIn2Sv |
Nur Ausgabe. Hat die 2‑Faktor-Authentifizierung eingerichtet (schreibgeschützt) |
||||||||||||||||||||||||||||||||||||||||||
isEnforcedIn2Sv |
Nur Ausgabe. Wird die 2‑Faktor-Authentifizierung erzwungen? (Nur-Lesezugriff) |
||||||||||||||||||||||||||||||||||||||||||
archived |
Gibt an, ob der Nutzer archiviert ist. |
||||||||||||||||||||||||||||||||||||||||||
orgUnitPath |
Der vollständige Pfad der übergeordneten Organisation, die dem Nutzer zugeordnet ist. Wenn die übergeordnete Organisation die oberste Ebene ist, wird sie als Schrägstrich ( |
||||||||||||||||||||||||||||||||||||||||||
recoveryEmail |
Die E‑Mail-Adresse zur Kontowiederherstellung des Nutzers. |
||||||||||||||||||||||||||||||||||||||||||
recoveryPhone |
Telefonnummer zur Kontowiederherstellung des Nutzers. Die Telefonnummer muss dem Format E.164 entsprechen und mit dem Pluszeichen (+) beginnen, z. B. +16506661212. |
||||||||||||||||||||||||||||||||||||||||||
isGuestUser |
Nicht veränderbar. Gibt an, ob der Nutzer ein Gast ist. |
||||||||||||||||||||||||||||||||||||||||||
guestAccountInfo |
Nicht veränderbar. Zusätzliche Metadatenfelder für Gäste |
||||||||||||||||||||||||||||||||||||||||||
Nutzername
| JSON-Darstellung |
|---|
{ "fullName": string, "familyName": string, "givenName": string, "displayName": string } |
| Felder | |
|---|---|
fullName |
Der vollständige Name des Nutzers, der durch Verketten der Werte für Vor- und Nachname gebildet wird. |
familyName |
Der Nachname des Nutzers. Erforderlich beim Erstellen eines Nutzerkontos. |
givenName |
Der Vorname des Nutzers. Erforderlich beim Erstellen eines Nutzerkontos. |
displayName |
Der Anzeigename des Nutzers. Höchstens 256 Zeichen |
GuestAccountInfo
Kontoinformationen speziell für Gastnutzer.
| JSON-Darstellung |
|---|
{ "primaryGuestEmail": string } |
| Felder | |
|---|---|
primaryGuestEmail |
Nicht veränderbar. Die externe E‑Mail-Adresse des Gastes. |
Methoden |
|
|---|---|
|
Erstellen Sie einen Gastnutzer mit Zugriff auf eine Teilmenge der Workspace-Funktionen. |
|
Löscht einen Nutzer. |
|
Ruft einen Nutzer ab. |
|
Erstellt einen Nutzer. |
|
Ruft eine paginierte Liste der gelöschten Nutzer oder aller Nutzer in einer Domain ab. |
|
Macht einen Nutzer zum Super Admin. |
|
Aktualisiert einen Nutzer mit Patch-Semantik. |
|
Meldet einen Nutzer von allen Web- und Gerätesitzungen ab und setzt seine Anmeldecookies zurück. |
|
Löscht die Löschung eines gelöschten Nutzers. |
|
Aktualisiert einen Nutzer. |
|
Überwacht Änderungen in der Nutzerliste. |