Ressource: Nutzer
Mit der Directory API können Sie die Nutzer, Nutzeraliasse und Google-Profilfotos der Nutzer Ihres Kontos erstellen und verwalten. Weitere Informationen zu gängigen Aufgaben finden Sie im Entwicklerhandbuch zu Nutzerkonten und im Entwicklerhandbuch zu Nutzeraliassen.
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. Der Nutzer |
||||||||||||||||||||||||||||||||||||||||||
primaryEmail |
Die primäre E-Mail-Adresse des Nutzers. Diese Property ist in einer Anfrage zum Erstellen eines Nutzerkontos erforderlich. Die |
||||||||||||||||||||||||||||||||||||||||||
password |
Speichert das Passwort für das Nutzerkonto. Der Passwortwert des Nutzers ist bei der Erstellung eines Nutzerkontos erforderlich. Er ist beim Aktualisieren eines Nutzers 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 sind, dürfen sie 10.000 oder weniger betragen. |
||||||||||||||||||||||||||||||||||||||||||
isAdmin |
Nur Ausgabe Gibt einen Nutzer mit Super Admin-Berechtigungen an. Die Eigenschaft |
||||||||||||||||||||||||||||||||||||||||||
isDelegatedAdmin |
Nur Ausgabe Gibt an, ob der Nutzer ein delegierter Administrator ist. |
||||||||||||||||||||||||||||||||||||||||||
agreedToTerms |
Nur Ausgabe Diese Property hat den Status |
||||||||||||||||||||||||||||||||||||||||||
suspended |
Gibt an, ob der Nutzer gesperrt ist. |
||||||||||||||||||||||||||||||||||||||||||
changePasswordAtNextLogin |
Gibt an, ob der Nutzer sein Passwort bei der nächsten Anmeldung ändern muss. Diese Einstellung gilt nicht, wenn sich der Nutzer über einen externen Identitätsanbieter anmeldet. |
||||||||||||||||||||||||||||||||||||||||||
ipWhitelisted |
Wenn |
||||||||||||||||||||||||||||||||||||||||||
name |
Enthält den Vor- und Nachnamen des Nutzers und den schreibgeschützten |
||||||||||||||||||||||||||||||||||||||||||
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 im Hilfeartikel 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 wird. Diese Eigenschaft ist nur anwendbar, wenn dem Nutzer eine Gmail-Lizenz zugewiesen wurde. |
||||||||||||||||||||||||||||||||||||||||||
customerId |
Nur Ausgabe Die Kundennummer zum Abrufen aller Kontonutzer. |
||||||||||||||||||||||||||||||||||||||||||
addresses |
Die Liste der Adressen des Nutzers. Die maximal zulässige Datengröße beträgt 10 KB.
|
||||||||||||||||||||||||||||||||||||||||||
organizations |
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 das letzte Mal im Konto des Nutzers angemeldet hat. Der Wert liegt im ISO 8601-Format für Datum und Uhrzeit vor. Die Uhrzeit ist das vollständige Datum mit Stunden, Minuten und Sekunden im Format |
||||||||||||||||||||||||||||||||||||||||||
phones |
Eine Liste mit den Telefonnummern des Nutzers. Die maximal zulässige Datengröße beträgt 1 KB.
|
||||||||||||||||||||||||||||||||||||||||||
suspensionReason |
Nur Ausgabe den Grund dafür, dass ein Nutzerkonto zum Zeitpunkt der Sperrung entweder vom Administrator oder von Google gesperrt wird. Das Attribut wird nur zurückgegeben, wenn das Attribut |
||||||||||||||||||||||||||||||||||||||||||
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-Kontoinformationen für den Nutzer.
|
||||||||||||||||||||||||||||||||||||||||||
creationTime |
Nur Ausgabe Der Zeitpunkt, zu dem das Nutzerkonto erstellt wurde. Der Wert liegt im ISO 8601-Format für Datum und Uhrzeit vor. Die Uhrzeit ist das vollständige Datum mit 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 der öffentlichen 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 Adressenliste von Google Workspace sichtbar ist, wenn die Kontaktfreigabefunktion für die Domain aktiviert ist. Weitere Informationen zum Ausschließen von Nutzerprofilen finden Sie in der Hilfe für Administratoren. |
||||||||||||||||||||||||||||||||||||||||||
keywords |
Die Liste mit den 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 liegt im ISO 8601-Format für Datum und Uhrzeit vor. Die Uhrzeit ist das vollständige Datum mit Stunden, Minuten und Sekunden im Format |
||||||||||||||||||||||||||||||||||||||||||
gender |
Ein verschachteltes Objekt, das das Geschlecht des Nutzers enthält. Die maximal zulässige Datengröße für dieses Feld beträgt 1 KB.
|
||||||||||||||||||||||||||||||||||||||||||
thumbnailPhotoEtag |
Nur Ausgabe ETag des Nutzerfotos (schreibgeschützt) |
||||||||||||||||||||||||||||||||||||||||||
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 Ist für die Bestätigung in zwei Schritten angemeldet (schreibgeschützt) |
||||||||||||||||||||||||||||||||||||||||||
isEnforcedIn2Sv |
Nur Ausgabe Bestätigung in zwei Schritten erzwungen (schreibgeschützt) |
||||||||||||||||||||||||||||||||||||||||||
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 durch einen Schrägstrich ( |
||||||||||||||||||||||||||||||||||||||||||
recoveryEmail |
E-Mail-Adresse zur Kontowiederherstellung des Nutzers. |
||||||||||||||||||||||||||||||||||||||||||
recoveryPhone |
Telefonnummer zur Kontowiederherstellung des Nutzers. Die Telefonnummer muss im E.164-Format angegeben werden und mit einem Pluszeichen (+) beginnen. Beispiel: +16506661212. |
UserName
JSON-Darstellung |
---|
{ "fullName": string, "familyName": string, "givenName": string, "displayName": string } |
Felder | |
---|---|
fullName |
Der vollständige Name des Nutzers wird durch Verkettung der Werte für den Vor- und Nachnamen erstellt. |
familyName |
Der Nachname des Nutzers. Erforderlich beim Erstellen eines Nutzerkontos. |
givenName |
Der Vorname des Nutzers. Erforderlich beim Erstellen eines Nutzerkontos. |
displayName |
Anzeigename des Nutzers Maximal 256 Zeichen. |
Methoden |
|
---|---|
|
Löscht einen Nutzer. |
|
Ruft einen Nutzer ab. |
|
Erstellt einen Nutzer. |
|
Ruft eine paginierte Liste entweder gelöschter Nutzer oder aller Nutzer in einer Domain ab. |
|
Nutzer werden zum Super Admin. |
|
Aktualisiert einen Nutzer mithilfe der Patch-Semantik. |
|
Nutzer werden aus allen Web- und Gerätesitzungen abgemeldet und ihre Anmeldecookies zurückgesetzt. |
|
Stellt einen gelöschten Nutzer wieder her. |
|
Aktualisiert einen Nutzer. |
|
Prüft auf Änderungen in der Nutzerliste. |