REST Resource: users

Ressource: Nutzer

Mit der Directory API können Sie die Nutzer, Nutzer-Aliasse und Google-Profilbilder Ihres Kontos erstellen und verwalten. Weitere Informationen zu häufigen 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 (UserName) }, "kind": string, "etag": string, "emails": value, "externalIds": value, "relations": value, "aliases": [ string ], "isMailboxSetup": boolean, "customerId": string, "addresses": value, "organizations": value, "lastLoginTime": string, "phones": value, "suspensionReason": string, "thumbnailPhotoUrl": string, "languages": value, "posixAccounts": value, "creationTime": string, "nonEditableAliases": [ string ], "sshPublicKeys": value, "notes": value, "websites": value, "locations": value, "includeInGlobalAddressList": boolean, "keywords": value, "deletionTime": string, "gender": value, "thumbnailPhotoEtag": string, "ims": value, "customSchemas": value, "isEnrolledIn2Sv": boolean, "isEnforcedIn2Sv": boolean, "archived": boolean, "orgUnitPath": string, "recoveryEmail": string, "recoveryPhone": string }

Felder
id	string Die eindeutige ID des Nutzers. Der Nutzer id kann als userKey eines Nutzeranfrage-URI verwendet werden.
primaryEmail	string Die primäre E-Mail-Adresse des Nutzers Diese Property ist in einer Anfrage zum Erstellen eines Nutzerkontos erforderlich. Die primaryEmail muss eindeutig sein und darf kein Alias eines anderen Nutzers sein.
password	value (Value format) Speichert das Passwort für das Nutzerkonto. 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 niemals im Antworttext der API zurückgegeben. Ein Passwort kann eine beliebige Kombination von ASCII-Zeichen enthalten und muss zwischen 8 und 100 Zeichen lang sein. Wir empfehlen, den Parameter password als hexadezimal codierten Hashwert zu senden und hashFunction entsprechend festzulegen. Wenn hashFunction angegeben ist, muss das Passwort ein gültiger Hash-Schlüssel sein.
hashFunction	string Speichert das Hash-Format des Attributs password. Die folgenden hashFunction-Werte sind zulässig: MD5: Akzeptiert einfache hexadezimal codierte Werte. SHA-1: Akzeptiert einfache hexadezimal codierte Werte. crypt: Entspricht der C-Crypt-Bibliothek. Die Hash-Algorithmen DES, MD5 (Hash-Präfix $1$), SHA-256 (Hash-Präfix $5$) und SHA-512 (Hash-Präfix $6$). Wenn Runden als Teil des Präfixes angegeben werden, dürfen sie maximal 10.000 betragen.
isAdmin	boolean Nur Ausgabe. Gibt einen Nutzer mit Super Admin-Berechtigungen an. Das Attribut isAdmin kann nur im Vorgang Nutzer zum Administrator machen ( Methode makeAdmin) bearbeitet werden. Wenn Sie diese in der Methode insert oder update des Nutzers bearbeiten, wird sie vom API-Dienst ignoriert.
isDelegatedAdmin	boolean Nur Ausgabe. Gibt an, ob der Nutzer ein delegierter Administrator ist. Delegierte Administratoren werden von der API unterstützt, können aber keine Nutzer erstellen oder wiederherstellen oder Nutzer zu Administratoren ernennen. Diese Anfragen werden vom API-Dienst ignoriert. Rollen und Berechtigungen für Administratoren werden über die Admin-Konsole zugewiesen.
agreedToTerms	boolean Nur Ausgabe. Diese Property ist true, wenn der Nutzer sich zum ersten Mal angemeldet und die Vereinbarung über die Nutzungsbedingungen akzeptiert hat.
suspended	boolean Gibt an, ob der Nutzer gesperrt ist.
changePasswordAtNextLogin	boolean 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	boolean Wenn true, gilt für die IP-Adresse des Nutzers eine verworfene allowlist-Konfiguration für IP-Adressen.
name	object (UserName) Enthält die Vor- und Nachnamen des Nutzers sowie den schreibgeschützten Wert fullName. Die Werte für givenName und familyName dürfen maximal 60 Zeichen enthalten. Außerdem unterstützen Namenswerte Unicode-/UTF-8-Zeichen und können Leerzeichen, Buchstaben (a-z), Zahlen (0-9), Bindestriche (-), Schrägstriche (/) und Punkte (.) enthalten. Weitere Informationen zu Regeln für die Verwendung von Zeichen finden Sie in der Hilfe für Administratoren. Die maximal zulässige Datengröße für dieses Feld beträgt 1 KB.
kind	string Nur Ausgabe. Der Typ der API-Ressource. Für Nutzerressourcen ist der Wert admin#directory#user.
etag	string Nur Ausgabe. Das ETag der Ressource.
emails	value (Value format) Die Liste der E-Mail-Adressen des Nutzers. Die maximal zulässige Datengröße beträgt 10 KB. Fields emails[].address string Die E-Mail-Adresse des Nutzers. Dient auch als E-Mail-ID. Dieser Wert kann die primäre E-Mail-Adresse des Nutzers oder ein Alias sein. emails[].customType string Wenn die E-Mail-Adresse type custom ist, enthält dieses Attribut den benutzerdefinierten Wert und muss festgelegt werden. emails[].primary boolean Gibt an, ob dies die primäre E-Mail-Adresse des Nutzers ist. Es kann nur ein Eintrag als primär markiert werden. emails[].type string Der Typ des E-Mail-Kontos. Wenn custom, muss auch customType festgelegt werden. Zulässige Werte: custom, home, other, work.
externalIds	value (Value format) 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. Fields externalIds[].customType string Wenn die externe ID type custom ist, enthält diese Eigenschaft den benutzerdefinierten Wert und muss festgelegt werden. externalIds[].type string Der Typ der externen ID. Wenn custom festgelegt ist, muss auch customType festgelegt werden. Zulässige Werte: account, custom, customer, login_id, network, organization. externalIds[].value string Der Wert der externen ID.
relations	value (Value format) 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. Fields relations[].customType string Wenn die Beziehung type auf custom gesetzt ist, enthält diese Eigenschaft den benutzerdefinierten Wert und muss festgelegt werden. relations[].type string Die Art der Beziehung. Wenn custom festgelegt ist, muss auch customType festgelegt werden. Zulässige Werte: admin_assistant assistant brother child custom domestic_partner dotted_line_manager exec_assistant father friend manager mother parent partner referred_by relative sister spouse relations[].value string Die E-Mail-Adresse der Person, mit der der Nutzer verknüpft ist.
aliases[]	string Nur Ausgabe. Die Liste der Alias-E-Mail-Adressen des Nutzers.
isMailboxSetup	boolean Nur Ausgabe. Gibt an, ob das Google-Postfach des Nutzers erstellt wurde. Diese Eigenschaft ist nur anwendbar, wenn dem Nutzer eine Gmail-Lizenz zugewiesen wurde.
customerId	string Nur Ausgabe. Die Kundennummer zum Abrufen aller Kontonutzer. Sie können den Alias my_customer verwenden, um die customerId Ihres Kontos darzustellen. Als Reseller-Administrator können Sie die customerId des Kundenkontos eines Resellers verwenden. Verwenden Sie zum Abrufen eines customerId die primäre Domain des Kontos im Parameter domain einer users.list-Anfrage.
addresses	value (Value format) Die Liste der Adressen des Nutzers. Die maximal zulässige Datengröße beträgt 10 KB. Fields addresses[].country string Land: addresses[].countryCode string Ländercode. Die Norm ISO 3166-1 wird verwendet. addresses[].customType string Wenn die Adresse type custom ist, enthält diese Eigenschaft den benutzerdefinierten Wert und muss festgelegt werden. addresses[].extendedAddress string Für erweiterte Adressen, z. B. eine Subregion. addresses[].formatted string Eine vollständige und unstrukturierte Postanschrift. Dies wird nicht mit den Feldern für strukturierte Adressen synchronisiert. Enthält die folgenden Attribute: Adresse, Postfach Feld, Stadt, Bundesland/Provinz, Postleitzahl, Land/Region. addresses[].locality string Der Ort oder die Stadt der Adresse. addresses[].poBox string Das Postfach, falls vorhanden. addresses[].postalCode string Die Postleitzahl (falls zutreffend). addresses[].primary boolean Ob dies die primäre Adresse des Nutzers ist Die Adressenliste darf nur eine primäre Adresse enthalten. addresses[].region string Die abgekürzte Provinz bzw. Provinz. addresses[].sourceIsStructured boolean Gibt an, ob die vom Nutzer angegebene Adresse formatiert wurde. Formatierte Adressen werden derzeit nicht unterstützt. addresses[].streetAddress string Die Adresse, z. B. 1600 Amphitheatre Parkway. Leerzeichen innerhalb der Zeichenfolge werden ignoriert. Allerdings sind Zeilenumbrüche wichtig. addresses[].type string Der Adresstyp. Wenn custom, muss auch customType festgelegt werden. Zulässige Werte: custom, home, other, work.
organizations	value (Value format) Die Liste der Organisationen, zu denen der Nutzer gehört. Die maximal zulässige Datengröße beträgt 10 KB. Fields organizations[].costCenter string Die Kostenstelle der Organisation des Nutzers. organizations[].customType string Wenn der Wert des Typs benutzerdefiniert ist, enthält diese Eigenschaft den benutzerdefinierten Typ. organizations[].department string Gibt die Abteilung innerhalb der Organisation an, z. B. sales oder engineering. organizations[].description string Die Beschreibung der Organisation. organizations[].domain string Die Domain, zu der die Organisation gehört. organizations[].fullTimeEquivalent integer Dem Vollzeitäquivalent in Millisekunden innerhalb der Organisation (100.000 = 100%). organizations[].location string Der physische Standort der Organisation. Dabei muss es sich nicht um eine voll qualifizierte Adresse handeln. organizations[].name string Der Name der Organisation organizations[].primary boolean Gibt an, ob dies die primäre Organisation des Nutzers ist. Ein Nutzer kann nur eine primäre Organisation haben. organizations[].symbol string Textzeichenfolgensymbol der Organisation. Das Textsymbol für Google ist beispielsweise GOOG. organizations[].title string Der Titel des Nutzers innerhalb der Organisation. Beispiel: member oder engineer. organizations[].type string Die Art der Organisation. Zulässige Werte: domain_only, school, unknown, work.
lastLoginTime	string Nur Ausgabe. Der Zeitpunkt, zu dem sich der Nutzer zuletzt in seinem Konto angemeldet hat. Der Wert wird im ISO 8601-Datums- und Zeitformat angegeben. Die Zeit ist das vollständige Datum plus Stunden, Minuten und Sekunden im Format YYYY-MM-DDThh:mm:ssTZD. Beispiel: 2010-04-05T17:30:04+01:00
phones	value (Value format) Eine Liste der Telefonnummern des Nutzers. Die maximal zulässige Datengröße beträgt 1 KB. Fields phones[].customType string Wenn die Telefonnummer type custom ist, enthält diese Eigenschaft den benutzerdefinierten Wert und muss festgelegt werden. phones[].primary boolean Wenn true, ist dies die primäre Telefonnummer des Nutzers. Ein Nutzer kann nur eine Haupttelefonnummer haben. phones[].type string Der Typ der Telefonnummer. Wenn custom festgelegt ist, muss auch customType festgelegt werden. Zulässige Werte: assistant, callback, car, company_main, custom, grand_central, home, home_fax, isdn, main, mobile, other, other_fax, pager, radio, telex, tty_tdd, work, . .work_faxwork_mobilework_pager phones[].value string Eine lesbare Telefonnummer. Sie kann ein beliebiges Telefonnummernformat haben.
suspensionReason	string Nur Ausgabe. Der Grund dafür ist, dass das Nutzerkonto zum Zeitpunkt der Sperrung entweder vom Administrator oder von Google gesperrt wurde. Das Attribut wird nur zurückgegeben, wenn das Attribut suspended den Wert true hat.
thumbnailPhotoUrl	string Nur Ausgabe. Die URL des Profilbilds des Nutzers. Die URL kann temporär oder privat sein.
languages	value (Value format) Die Liste der Sprachen des Nutzers. Die maximal zulässige Datengröße beträgt 1 KB. Fields languages[].customLanguage string Andere Sprache. Nutzer können einen eigenen Sprachnamen angeben, wenn kein entsprechender Sprachcode nach ISO 639 vorhanden ist. Ist dies festgelegt, kann languageCode nicht festgelegt werden. languages[].languageCode string ISO 639-String für eine Sprache. Eine Liste der unterstützten Codes finden Sie unter Sprachcodes. Gültige Sprachcodes außerhalb des unterstützten Satzes werden von der API akzeptiert, können aber zu unerwartetem Verhalten führen. Ungültige Werte verursachen SchemaException. Ist dies festgelegt, kann customLanguage nicht festgelegt werden. languages[].preference string Optional. Steuert, falls vorhanden, ob die angegebene languageCode die bevorzugte Sprache des Nutzers ist. Wenn customLanguage festgelegt ist, kann diese Einstellung nicht festgelegt werden. Zulässige Werte sind preferred und not_preferred.
posixAccounts	value (Value format) Die Liste der POSIX-Kontoinformationen für den Nutzer. Fields posixAccounts[].accountId string Eine POSIX-Kontofeld-ID. posixAccounts[].gecos string Die GECOS (Nutzerinformationen) für dieses Konto. posixAccounts[].gid unsigned long Die standardmäßige Gruppen-ID. posixAccounts[].homeDirectory string Der Pfad zum Basisverzeichnis für dieses Konto. posixAccounts[].operatingSystemType string Der Betriebssystemtyp für dieses Konto. Zulässige Werte: linux, unspecified, windows. posixAccounts[].primary boolean Ob dies das primäre Konto des Nutzers innerhalb der SystemId ist. posixAccounts[].shell string Der Pfad zur Anmelde-Shell für dieses Konto. posixAccounts[].systemId string Systemkennung, für die der Nutzername oder die UID des Kontos gilt. posixAccounts[].uid unsigned long Die POSIX-konforme Nutzer-ID. posixAccounts[].username string Der Nutzername des Kontos.
creationTime	string Nur Ausgabe. Der Zeitpunkt, zu dem das Konto des Nutzers erstellt wurde. Der Wert wird im ISO 8601-Datums- und Zeitformat angegeben. Die Zeit ist das vollständige Datum plus Stunden, Minuten und Sekunden im Format YYYY-MM-DDThh:mm:ssTZD. Beispiel: 2010-04-05T17:30:04+01:00
nonEditableAliases[]	string 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	value (Value format) Eine Liste der öffentlichen SSH-Schlüssel. Fields sshPublicKeys[].expirationTimeUsec long Ablaufzeit in Mikrosekunden seit der Epoche sshPublicKeys[].fingerprint string Ein SHA-256-Fingerabdruck des öffentlichen SSH-Schlüssels. (schreibgeschützt) sshPublicKeys[].key string Einen öffentlichen SSH-Schlüssel.
notes	value (Value format) Hinweise für den Nutzer als verschachteltes Objekt. Fields notes.contentType string Inhaltstyp der Notiz, entweder Nur-Text oder HTML. Der Standardwert ist Nur-Text. Zulässige Werte: text_plain, text_html. notes.value string Inhalt der Notizen.
websites	value (Value format) Die Liste der Websites des Nutzers. Fields websites[].customType string Wenn die Website type custom ist, enthält diese Eigenschaft den benutzerdefinierten Wert und muss festgelegt werden. websites[].primary boolean Wenn true, ist dies die primäre Website des Nutzers. websites[].type string Art oder Zweck der Website. Eine Website könnte beispielsweise als home oder blog gekennzeichnet werden. Alternativ kann ein Eintrag den Typ custom haben. Wenn custom festgelegt ist, muss auch customType festgelegt werden. Zulässige Werte: app_install_page, blog, custom, ftp, home, home_page, other, profile, reservations, resume und work. websites[].value string Die URL der Website.
locations	value (Value format) Die Liste der Standorte des Nutzers. Die maximal zulässige Datengröße beträgt 10 KB. Fields locations[].area string Standort in Textform. Dies ist besonders nützlich, um den Ort kurz und bündig zu beschreiben. Beispiel: Mountain View, CA oder Near Seattle. locations[].buildingId string Gebäude-ID. locations[].customType string Wenn der Standort type custom ist, enthält diese Eigenschaft den benutzerdefinierten Wert und muss festgelegt werden. locations[].deskCode string Spezifischster Textcode für den Standort eines einzelnen Büros. locations[].floorName string Name/Nummer der Etage. locations[].floorSection string Etagenabschnitt. Genauere Position innerhalb der Etage. Wenn ein Mindestbetrag beispielsweise in die Abschnitte A, B und C unterteilt ist, gibt dieses Feld einen dieser Werte an. locations[].type string Der Standorttyp. Wenn custom, muss auch customType festgelegt werden. Zulässige Werte: custom, default, desk.
includeInGlobalAddressList	boolean Gibt an, ob das Profil des Nutzers in der globalen Adressenliste von Google Workspace sichtbar ist, wenn die Kontaktfreigabe für die Domain aktiviert ist. Weitere Informationen zum Ausschließen von Nutzerprofilen finden Sie in der Hilfe für Administratoren.
keywords	value (Value format) Die Liste der Keywords des Nutzers. Die maximal zulässige Datengröße beträgt 1 KB. Fields keywords[].customType string Wenn das Keyword type den Wert custom hat, enthält diese Eigenschaft den benutzerdefinierten Wert und muss festgelegt werden. keywords[].type string Jeder Eintrag kann einen Typ haben, der den Standardtyp dieses Eintrags angibt. Beispielsweise könnte ein Keyword vom Typ „occupation“ oder „outlook“ sein. Zusätzlich zum Typ „Standard“ kann ein Eintrag den Typ custom und einen beliebigen Namen haben. Wenn custom, muss auch customType festgelegt werden. Zulässige Werte: custom, mission, occupation, outlook. keywords[].value string Keyword.
deletionTime	string Nur Ausgabe. Der Zeitpunkt, zu dem das Konto des Nutzers gelöscht wurde. Der Wert wird im ISO 8601-Datums- und Zeitformat angegeben. Die Zeit ist das vollständige Datum plus Stunden, Minuten und Sekunden im Format YYYY-MM-DDThh:mm:ssTZD. Beispiel: 2010-04-05T17:30:04+01:00.
gender	value (Value format) Ein verschachteltes Objekt, das das Geschlecht des Nutzers enthält. Die maximal zulässige Datengröße für dieses Feld beträgt 1 KB. Fields gender.addressMeAs string Ein für Menschen lesbarer String mit der richtigen Methode, um von Menschen auf den Profilinhaber zu verweisen, z. B. „er/ihm/sein“ oder „sie/sie/ihr“. gender.customGender string Name eines benutzerdefinierten Geschlechts. gender.type string Der Typ des Geschlechts. Zulässige Werte: female male other unknown
thumbnailPhotoEtag	string Nur Ausgabe. ETag des Fotos des Nutzers (schreibgeschützt)
ims	value (Value format) Die Instant Messenger (IM)-Konten des Nutzers. Ein Nutzerkonto kann mehrere ims-Eigenschaften haben, aber nur eine dieser ims-Eigenschaften kann der primäre IM-Kontakt sein. Fields ims[].customProtocol string Wenn der Protokollwert custom_protocol ist, enthält dieses Attribut den String des benutzerdefinierten Protokolls. ims[].customType string Wenn die IM-type auf custom gesetzt ist, enthält diese Eigenschaft den benutzerdefinierten Wert und muss festgelegt werden. ims[].im string Die IM-Netzwerk-ID des Nutzers. ims[].primary boolean Ob dies der primäre IM des Users ist. Nur ein Eintrag in der IM-Liste kann den Wert wahr haben. ims[].protocol string Das IM-Protokoll identifiziert das IM-Netzwerk. Der Wert kann ein benutzerdefiniertes Netzwerk oder das Standardnetzwerk sein. Zulässige Werte: aim: Protokoll von AOL Instant Messenger custom_protocol: ein benutzerdefiniertes IM-Netzwerkprotokoll gtalk: Google Talk-Protokoll icq: ICQ-Protokoll jabber: Jabber-Protokoll msn: MSN Messenger-Protokoll net_meeting: Net Meeting-Protokoll qq: QQ-Protokoll skype: Skype-Protokoll yahoo: Yahoo Messenger-Protokoll ims[].type string Der Typ des IM-Kontos. Wenn custom, muss auch customType festgelegt werden. Zulässige Werte: custom, home, other, work.
customSchemas	value (Value format) Benutzerdefinierte Felder des Nutzers. Der Schlüssel ist ein schemaName und seine Werte sind 'fieldName': 'field_value'. customSchemas.(key) ist ein verschachteltes Objekt. customSchemas.(key).(key) kann ein beliebiger Wert sein.
isEnrolledIn2Sv	boolean Nur Ausgabe. Es ist für die 2-Faktor-Authentifizierung angemeldet (schreibgeschützt)
isEnforcedIn2Sv	boolean Nur Ausgabe. 2-Faktor-Authentifizierung erzwungen (schreibgeschützt)
archived	boolean Gibt an, ob der Nutzer archiviert ist.
orgUnitPath	string 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 (/) dargestellt.
recoveryEmail	string E-Mail-Adresse zur Kontowiederherstellung des Nutzers.
recoveryPhone	string Telefonnummer zur Kontowiederherstellung des Nutzers. Die Telefonnummer muss im E.164-Format vorliegen und mit dem Pluszeichen (+) beginnen. Beispiel: [phone].

UserName

JSON-Darstellung
{ "fullName": string, "familyName": string, "givenName": string, "displayName": string }

Felder
fullName	string Der vollständige Name des Nutzers, gebildet durch die Verkettung der Werte für Vor- und Nachname.
familyName	string Der Nachname des Nutzers. Erforderlich beim Erstellen eines Nutzerkontos.
givenName	string Der Vorname des Nutzers. Erforderlich beim Erstellen eines Nutzerkontos.
displayName	string Der Anzeigename des Nutzers. Maximal 256 Zeichen.

Methoden
delete	Löscht einen Nutzer.
get	Ruft einen Nutzer ab.
insert	Erstellt einen Nutzer.
list	Ruft eine paginierte Liste mit gelöschten Nutzern oder allen Nutzern in einer Domain ab.
makeAdmin	Ein Nutzer wird zum Super Admin.
patch	Aktualisiert einen Nutzer mit Patch-Semantik.
signOut	Hiermit wird ein Nutzer aus allen Web- und Gerätesitzungen abgemeldet und seine Anmeldecookies werden zurückgesetzt.
undelete	Ein gelöschter Nutzer wird wiederhergestellt.
update	Aktualisiert einen Nutzer.
watch	Prüft auf Änderungen in der Nutzerliste.