REST Resource: users

Ressource: Nutzer

Mit der Directory API können Sie Nutzer, Aliasse und Gmail-Profilfotos für Ihr Konto erstellen und verwalten. Weitere Informationen zu allgemeinen Aufgaben finden Sie im Entwicklerleitfaden zu Nutzerkonten und im Entwicklerhandbuch 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 (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 für den Nutzer. Der Nutzer id kann als userKey der 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. 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 erforderlich, wenn ein Nutzerkonto erstellt wird. Sie ist bei der Aktualisierung eines Nutzers optional und sollte nur angegeben werden, wenn der Nutzer sein Kontopasswort aktualisiert. Der Passwortwert wird nie im Antworttext der API zurückgegeben. Ein Passwort kann eine beliebige Kombination aus 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 Hexadezimalwerte. SHA-1: akzeptiert einfache Hexadezimalwerte. crypt: Entspricht der C crypt library. Unterstützt die Hash-Algorithmen DES, MD5 (Hash-Präfix $1$), SHA-256 (Hash-Präfix $5$) und SHA-512 (Hash-Präfix $6$). Wenn als Teil des Präfixes Runden angegeben sind, darf die Zahl 10.000 oder weniger betragen.
isAdmin	boolean Nur Ausgabe. Gibt einen Nutzer mit Poweruser-Berechtigungen an. Die Property isAdmin kann nur im Vorgang Nutzer als Administrator festlegen ( Methode makeAdmin) bearbeitet werden. Bei einer Bearbeitung mit den Methoden insert oder update wird die Änderung 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 jedoch keine Nutzer erstellen oder wiederherstellen oder Nutzer zu Administratoren machen. 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 angemeldet hat und 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 aufgefordert wird, sein Passwort zu ändern. Diese Einstellung gilt nicht, wenn sich der Nutzer über einen externen Identitätsanbieter anmeldet.
ipWhitelisted	boolean Bei true unterliegt die IP-Adresse des Nutzers einer veralteten allowlist-Konfiguration.
name	object (UserName) Enthält die Vor- und Nachnamen des Nutzers sowie den schreibgeschützten fullName-Wert. Die maximale Anzahl der Zeichen für givenName und familyName beträgt 60. Darüber hinaus unterstützen Namenwerte Unicode-/UTF-8-Zeichen und können Leerzeichen, Buchstaben (a–z), Ziffern (0–9), Bindestriche (-), Schrägstriche (/) und Punkte (.) enthalten. Weitere Informationen zu Nutzungsregeln für 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. 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. Auch als E-Mail-ID dient. Dieser Wert kann die primäre E-Mail-Adresse des Nutzers oder ein Alias sein. emails[].customType string Wenn für die E-Mail-Adresse type der Wert custom festgelegt ist, enthält diese Property den benutzerdefinierten Wert und muss festgelegt werden. emails[].primary boolean Gibt an, ob dies die primäre E-Mail-Adresse des Nutzers ist. Nur ein Eintrag kann als primär markiert werden. emails[].type string Der Typ des E-Mail-Kontos. Wenn custom festgelegt ist, 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 den Wert custom hat, 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 custom 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, zu der der Nutzer gehört.
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 Property ist nur verfügbar, 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 den customerId Ihres Kontos darzustellen. Als Reseller-Administrator können Sie das customerId für die weiterverkauften Kundenkonten verwenden. Wenn Sie eine customerId erhalten möchten, verwenden Sie 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. Verwendet den Standard ISO 3166-1. addresses[].customType string Wenn die Adresse type custom lautet, enthält diese Eigenschaft den benutzerdefinierten Wert und muss festgelegt werden. addresses[].extendedAddress string Bei erweiterten Adressen, z. B. einer Adresse mit einer Unterregion, addresses[].formatted string Eine vollständige und unstrukturierte Postanschrift. Diese wird nicht mit den strukturierten Adressfeldern synchronisiert. Enthält die folgenden Attribute: Adresse, Postfach, Stadt, Bundesland, 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. addresses[].primary boolean Wenn dies die primäre Adresse des Nutzers ist. Die Adressenliste darf nur eine primäre Adresse enthalten. addresses[].region string Abkürzung für Provinz oder Bundesland addresses[].sourceIsStructured boolean Gibt an, ob die vom Nutzer angegebene Adresse formatiert ist. Formatierte Adressen werden derzeit nicht unterstützt. addresses[].streetAddress string Die Adresse, z. B. 1600 Amphitheatre Parkway Leerzeichen im String werden ignoriert. Zeilenumbrüche sind jedoch wichtig. addresses[].type string Der Adresstyp. Wenn custom festgelegt ist, muss auch customType festgelegt werden. Zulässige Werte: custom, home, other, work.
organizations	value (Value format) Die Liste der Organisationen, denen der Nutzer angehö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 Der Vollzeit-Äquivalent in der Organisation (100.000 = 100%). organizations[].location string Der Standort der Organisation. Dies muss keine vollständige Adresse sein. organizations[].name string Der Name der Organisation organizations[].primary boolean Gibt an, ob dies die primäre Organisation des Nutzers ist. Ein Nutzer darf nur eine primäre Organisation haben. organizations[].symbol string Textstringsymbol 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 im Konto angemeldet hat. Der Wert wird im ISO 8601-Format für Datum und Uhrzeit angegeben. Die Zeit umfasst 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 für die Telefonnummer type custom angegeben 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 primäre Telefonnummer haben. phones[].type string Der Typ der Telefonnummer. Wenn custom festgelegt ist, muss auch customType festgelegt werden. Zulässige Werte sind: assistant, callback, car, company_main, custom, grand_central, home, home_fax, isdn, main, mobile, other, other_fax, pager, radio, telex, tty_tdd, work_mobile. phones[].value string Eine lesbare Telefonnummer. Er kann ein beliebiges Telefonnummernformat haben.
suspensionReason	string Nur Ausgabe. Der Grund dafür ist, dass ein Nutzerkonto zum Zeitpunkt der Sperrung entweder vom Administrator oder von Google gesperrt wurde. Die Property wird nur zurückgegeben, wenn die Property suspended den Wert true hat.
thumbnailPhotoUrl	string Nur Ausgabe. Die URL des Profilbilds des Nutzers. Die URL kann vorübergehend 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 ihren eigenen Sprachnamen angeben, wenn es keinen entsprechenden ISO 639-Sprachcode gibt. Wenn dies festgelegt wird, kann languageCode nicht festgelegt werden. languages[].languageCode string ISO 639-Stringdarstellung einer 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 jedoch zu unerwartetem Verhalten führen. Unzulässige Werte führen zu SchemaException. Wenn dies festgelegt wird, kann customLanguage nicht festgelegt werden. languages[].preference string Optional. Gibt an, ob die angegebene languageCode die bevorzugte Sprache des Nutzers ist. Wenn customLanguage festgelegt ist, kann dies 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-Kontofeldkennung. posixAccounts[].gecos string Die GECOS-Nutzerdaten 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 Wenn dies das primäre Konto des Nutzers in der SystemId ist. posixAccounts[].shell string Der Pfad zur Log-in-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 Nutzerkonto erstellt wurde. Der Wert wird im ISO 8601-Format für Datum und Uhrzeit angegeben. Die Zeit umfasst 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 Domains befinden sich normalerweise 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 Ein öffentlicher SSH-Schlüssel.
notes	value (Value format) Hinweise für den Nutzer als verschachteltes Objekt. Fields notes.contentType string Inhaltstyp des Hinweises, entweder Text oder HTML. Standardmäßig wird Nur-Text verwendet. 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 den Wert custom hat, enthält diese Property den benutzerdefinierten Wert und muss festgelegt werden. websites[].primary boolean Wenn true, ist dies die primäre Website des Nutzers. websites[].type string Typ oder Zweck der Website. Eine Website kann beispielsweise das Label home oder blog haben. 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, 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 insbesondere zu Anzeigezwecken nützlich, um den Standort kurz zu beschreiben. Beispiel: Mountain View, CA oder Near Seattle. locations[].buildingId string Gebäude-ID. locations[].customType string Wenn der Standort type auf custom gesetzt ist, enthält diese Eigenschaft den benutzerdefinierten Wert und muss festgelegt werden. locations[].deskCode string Spezifischster Textcode eines individuellen Arbeitsplatzes. locations[].floorName string Etage/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, kann dieses Feld einen dieser Werte identifizieren. locations[].type string Der Standorttyp. Wenn custom festgelegt ist, muss auch customType festgelegt werden. Zulässige Werte: custom, default, desk.
includeInGlobalAddressList	boolean Gibt an, ob das Nutzerprofil in der globalen Google Workspace-Adressenliste 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	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 des Eintrags angibt. Ein Keyword könnte beispielsweise vom Typ occupation oder outlook sein. Zusätzlich zum Standardtyp kann ein Eintrag den Typ custom haben und ihm einen beliebigen Namen geben. Wenn custom festgelegt ist, 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 Nutzerkonto gelöscht wurde. Der Wert wird im ISO 8601-Format für Datum und Uhrzeit angegeben. Die Zeit umfasst 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, der die korrekte Art und Weise beschreibt, auf die der Profilinhaber von Menschen verweist, z. B. „er/ihn/ihn“ oder „sie/sie/sie“. gender.customGender string Name eines benutzerdefinierten Geschlechts. gender.type string Die Art 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-Konten (IM) des Nutzers. Ein Nutzerkonto kann mehrere ims-Properties haben, aber nur eine dieser ims-Properties kann der primäre IM-Kontakt sein. Fields ims[].customProtocol string Wenn der Protokollwert custom_protocol ist, enthält diese Eigenschaft den String des benutzerdefinierten Protokolls. ims[].customType string Wenn die IM-type den Wert custom hat, enthält diese Eigenschaft den benutzerdefinierten Wert und muss festgelegt werden. ims[].im string Die IM-Netzwerk-ID des Nutzers. ims[].primary boolean Wenn dies die primäre IM des Users ist. Nur ein Eintrag in der IM-Liste kann den Wert wahr aufweisen. ims[].protocol string Ein IM-Protokoll identifiziert das IM-Netzwerk. Der Wert kann ein benutzerdefiniertes oder ein Standardnetzwerk sein. Zulässige Werte: aim: AOL Instant Messenger-Protokoll custom_protocol: ein benutzerdefiniertes IM-Netzwerkprotokoll gtalk: Google Talk-Protokoll icq: ICQ-Protokoll jabber: Jabber-Protokoll msn: MSN Messenger-Protokoll net_meeting: Protokoll der Nettobesprechung qq: QQ-Protokoll skype: Skype-Protokoll yahoo: Yahoo Messenger-Protokoll ims[].type string Die Art des IM-Kontos. Wenn custom festgelegt ist, 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. Für die Bestätigung in zwei Schritten registriert (Lesezugriff)
isEnforcedIn2Sv	boolean Nur Ausgabe. Erzwingen der Bestätigung in zwei Schritten (Lesezugriff)
archived	boolean Gibt an, ob der Nutzer archiviert ist.
orgUnitPath	string Der vollständige Pfad der übergeordneten Organisation, die dem Nutzer zugeordnet ist. Wenn es sich bei der übergeordneten Organisation um die oberste Ebene handelt, wird sie als Schrägstrich (/) dargestellt.
recoveryEmail	string E-Mail-Adresse zur Kontowiederherstellung des Nutzers.
recoveryPhone	string Telefonnummer zur Kontowiederherstellung des Nutzers. Die Telefonnummer muss im Format E.164 beginnen und mit dem Pluszeichen (+) beginnen. Beispiel: [phone].

Benutzername

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

Felder
fullName	string Der vollständige Name des Nutzers, der aus der Verkettung von Vor- und Nachnamen besteht.
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 angezeigte Name 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 der gelöschten Nutzer oder aller Nutzer in einer Domain ab.
makeAdmin	Dadurch wird ein Nutzer zum Poweruser.
patch	Aktualisiert einen Nutzer mithilfe von Patch-Semantik.
signOut	Nutzer werden aus allen Web- und Gerätesitzungen abgemeldet und ihre Anmeldecookies zurückgesetzt.
undelete	Ein gelöschter Nutzer wird wiederhergestellt.
update	Aktualisiert einen Nutzer.
watch	Wartet auf Änderungen in der Nutzerliste.