Ressource: Nutzer
Mit der Directory API können Sie die Nutzer, Nutzer-Aliasse und Google-Profilbilder Ihres Kontos erstellen und verwalten. Weitere Informationen zu gängigen 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 für den Nutzer. Ein Nutzer- |
||||||||||||||||||||||||||||||||||||||||||
primaryEmail |
Die primäre E-Mail-Adresse des Nutzers. Dieses Attribut ist in einer Anfrage zum Erstellen eines Nutzerkontos erforderlich. Die |
||||||||||||||||||||||||||||||||||||||||||
password |
Hier wird das Passwort für das Nutzerkonto gespeichert. Der Passwortwert des Nutzers ist beim Erstellen eines Nutzerkontos erforderlich. Er ist optional 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 sie maximal 10.000 betragen. |
||||||||||||||||||||||||||||||||||||||||||
isAdmin |
Nur Ausgabe. Gibt einen Nutzer mit Super Admin-Berechtigungen an. Das Attribut |
||||||||||||||||||||||||||||||||||||||||||
isDelegatedAdmin |
Nur Ausgabe. Gibt an, ob der Nutzer ein delegierter Administrator ist. |
||||||||||||||||||||||||||||||||||||||||||
agreedToTerms |
Nur Ausgabe. Diese Property hat den Wert |
||||||||||||||||||||||||||||||||||||||||||
suspended |
Gibt an, ob der Nutzer gesperrt ist. |
||||||||||||||||||||||||||||||||||||||||||
changePasswordAtNextLogin |
Gibt an, ob der Nutzer bei der nächsten Anmeldung zum Ändern seines Passworts gezwungen wird. Diese Einstellung gilt nicht, wenn sich der Nutzer über einen externen Identitätsanbieter anmeldet. |
||||||||||||||||||||||||||||||||||||||||||
ipWhitelisted |
Wenn |
||||||||||||||||||||||||||||||||||||||||||
name |
Enthält den Vornamen und den 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. Das 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 die Google-Mailbox des Nutzers erstellt wurde. Diese Eigenschaft ist nur anwendbar, wenn dem Nutzer eine Gmail-Lizenz zugewiesen wurde. |
||||||||||||||||||||||||||||||||||||||||||
customerId |
Nur Ausgabe. Die Kunden-ID, mit der alle Nutzer des Kontos abgerufen werden. |
||||||||||||||||||||||||||||||||||||||||||
addresses |
Die Liste der Adressen des Nutzers. Die maximal zulässige Datengröße beträgt 10 KB.
|
||||||||||||||||||||||||||||||||||||||||||
organizations |
Die Liste der Organisationen, zu denen der Nutzer gehört. Die maximal zulässige Datengröße beträgt 10 KB.
|
||||||||||||||||||||||||||||||||||||||||||
lastLoginTime |
Nur Ausgabe. Der Zeitpunkt, zu dem sich der Nutzer zuletzt in seinem Konto angemeldet hat. Der Wert ist im Datums- und Zeitformat ISO 8601. Die Uhrzeit 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. Der Grund, warum ein Nutzerkonto entweder vom Administrator oder von Google gesperrt wurde. Die Property wird nur zurückgegeben, wenn die Property |
||||||||||||||||||||||||||||||||||||||||||
thumbnailPhotoUrl |
Nur Ausgabe. Die URL des Profilbilds des Nutzers. Die URL kann temporär oder privat sein. |
||||||||||||||||||||||||||||||||||||||||||
languages |
Die Liste der Sprachen des Nutzers. Die maximal zulässige Datengröße beträgt 1 KB.
|
||||||||||||||||||||||||||||||||||||||||||
posixAccounts |
Die Liste der POSIX für den Nutzer.
|
||||||||||||||||||||||||||||||||||||||||||
creationTime |
Nur Ausgabe. Der Zeitpunkt, zu dem das Konto des Nutzers erstellt wurde. Der Wert ist im Datums- und Zeitformat ISO 8601. Die Uhrzeit ist das vollständige Datum plus Stunden, Minuten und Sekunden im Format |
||||||||||||||||||||||||||||||||||||||||||
nonEditableAliases[] |
Nur Ausgabe. Die Liste der nicht bearbeitbaren Alias-E-Mail-Adressen des Nutzers. 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 angezeigt wird, wenn die Kontaktfreigabe für die Domain aktiviert ist. Weitere Informationen zum Ausschließen von Nutzerprofilen finden Sie in der Verwaltungshilfe. |
||||||||||||||||||||||||||||||||||||||||||
keywords |
Die Liste der Keywords des Nutzers. Die maximal zulässige Datengröße beträgt 1 KB.
|
||||||||||||||||||||||||||||||||||||||||||
deletionTime |
Nur Ausgabe. Das Datum und die Uhrzeit, zu dem das Konto des Nutzers gelöscht wurde. Der Wert ist im Datums- und Zeitformat ISO 8601. Die Uhrzeit 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 (Lesezugriff) |
||||||||||||||||||||||||||||||||||||||||||
ims |
Die Instant Messenger-Konten (IM) des Nutzers. Ein Nutzerkonto kann mehrere
|
||||||||||||||||||||||||||||||||||||||||||
customSchemas |
Benutzerdefinierte Felder des Nutzers. Der Schlüssel ist ein
|
||||||||||||||||||||||||||||||||||||||||||
isEnrolledIn2Sv |
Nur Ausgabe. Es ist für die 2-Faktor-Authentifizierung angemeldet (schreibgeschützt) |
||||||||||||||||||||||||||||||||||||||||||
isEnforcedIn2Sv |
Nur Ausgabe. Wird die Bestätigung in zwei Schritten erzwungen? (Lesezugriff) |
||||||||||||||||||||||||||||||||||||||||||
archived |
Gibt an, ob der Nutzer archiviert ist. |
||||||||||||||||||||||||||||||||||||||||||
orgUnitPath |
Der vollständige Pfad der übergeordneten Organisation, die mit dem Nutzer verknüpft ist. Wenn es sich bei der übergeordneten Organisation um die oberste Ebene handelt, wird sie durch einen Schrägstrich ( |
||||||||||||||||||||||||||||||||||||||||||
recoveryEmail |
E-Mail-Adresse für die Wiederherstellung des Nutzers. |
||||||||||||||||||||||||||||||||||||||||||
recoveryPhone |
Telefonnummer des Nutzers zur Kontowiederherstellung Die Telefonnummer muss im E.164-Format angegeben werden und mit dem Pluszeichen (+) beginnen. Beispiel: +16506661212. |
UserName
JSON-Darstellung |
---|
{ "fullName": string, "familyName": string, "givenName": string, "displayName": string } |
Felder | |
---|---|
fullName |
Der vollständige Name des Nutzers, gebildet durch die Verkettung der Werte für Vor- und Nachname. |
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. Maximal 256 Zeichen. |
Methoden |
|
---|---|
|
Löscht einen Nutzer. |
|
Ruft einen Nutzer ab. |
|
Erstellt einen Nutzer. |
|
Ruft eine paginated Liste entweder gelöschter Nutzer oder aller Nutzer in einer Domain ab. |
|
Hiermit wird ein Nutzer zum Super Admin gemacht. |
|
Aktualisiert einen Nutzer mit Patch-Semantik. |
|
Der Nutzer wird von allen Web- und Gerätesitzungen abgemeldet und seine Anmeldecookies werden zurückgesetzt. |
|
Stellt einen gelöschten Nutzer wieder her. |
|
Aktualisiert einen Nutzer. |
|
Wartet auf Änderungen in der Nutzerliste. |