REST Resource: users

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 (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,
  "isGuestUser": boolean,
  "guestAccountInfo": {
    object (GuestAccountInfo)
  }
}
Felder
id

string

Die eindeutige ID des Nutzers. Ein Nutzer-id kann als userKey eines Nutzeranfrage-URI verwendet werden.

primaryEmail

string

Die primäre E-Mail-Adresse des Nutzers. Diese Eigenschaft ist in einer Anfrage zum Erstellen eines Nutzerkontos erforderlich. Der 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 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.

 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 Hash-Wert 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. Folgende hashFunction-Werte sind zulässig:

  • MD5: Akzeptiert einfache hexadezimal codierte Werte.
  • SHA-1: Akzeptiert einfache hexadezimal codierte Werte.
  • crypt – Entspricht der C-Kryptografiebibliothek. 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 Runden als Teil des Präfixes angegeben werden, dürfen es maximal 10.000 sein.

isAdmin

boolean

Nur Ausgabe. Gibt einen Nutzer mit Super Admin-Berechtigungen an. Die Property isAdmin kann nur im Vorgang Einen Nutzer zum Administrator machen ( Methode makeAdmin) bearbeitet werden. Wenn sie in den Methoden insert oder update des Nutzers bearbeitet werden, wird die Bearbeitung 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 und Nutzer nicht 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 Eigenschaft ist true, wenn der Nutzer eine Erstanmeldung abgeschlossen 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 zum Ändern seines Passworts aufgefordert wird. Diese Einstellung gilt nicht, wenn der Nutzer sich über einen externen Identitätsanbieter anmeldet.

ipWhitelisted

boolean

Wenn true, unterliegt die IP-Adresse des Nutzers einer veralteten IP-Adresskonfiguration allowlist.

name

object (UserName)

Enthält den Vor- und Nachnamen des Nutzers sowie den schreibgeschützten Wert fullName. Die maximale Anzahl an Zeichen in den Werten givenName und familyName beträgt 60. Außerdem werden für Namenswerte Unicode-/UTF-8-Zeichen unterstützt. Sie können Leerzeichen, Buchstaben (a–z), Zahlen (0–9), Bindestriche (-), Schrägstriche (/) und Punkte (.) enthalten. Weitere Informationen zu den Regeln für die Verwendung von Zeichen finden Sie in der Verwaltungshilfe. 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. 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 diese Property den benutzerdefinierten Wert und muss festgelegt werden.

emails[].primary

boolean

Gibt an, ob es sich um die primäre E-Mail-Adresse des Nutzers handelt. 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 gleich custom ist, enthält diese Property 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 Property den benutzerdefinierten Wert und muss festgelegt werden.

relations[].type

string

Der Beziehungstyp. 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 verwandt 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 gilt nur, wenn dem Nutzer eine Gmail-Lizenz zugewiesen wurde.

customerId

string

Nur Ausgabe. Die Kunden-ID 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 weiterverkauften Kundenkontos verwenden. Um eine customerId zu erhalten, 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 ISO 3166-1-Standard.

addresses[].customType

string

Wenn die Adresse type custom ist, enthält diese Property den benutzerdefinierten Wert und muss festgelegt werden.

addresses[].extendedAddress

string

Für erweiterte Adressen, z. B. eine Adresse, die eine Unterregion enthält.

addresses[].formatted

string

Eine vollständige und unstrukturierte Postanschrift. Diese werden nicht mit den strukturierten Adressfeldern synchronisiert. Enthält die folgenden Attribute: Straße, Postfach, Stadt, Bundesland, Postleitzahl, Land/Region.

addresses[].locality

string

Der Ort der Adresse.

addresses[].poBox

string

Das Postfach, falls vorhanden.

addresses[].postalCode

string

Die Postleitzahl, falls zutreffend.

addresses[].primary

boolean

Gibt an, 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 oder das abgekürzte Bundesland.

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 im String werden ignoriert, Zeilenumbrüche jedoch nicht.

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 Typ „custom“ 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 Milli-Prozentwert des Vollzeitäquivalents innerhalb der Organisation (100.000 = 100%).

organizations[].location

string

Der physische Standort der Organisation. Dabei muss es sich nicht um eine vollständig 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

Symbol für den Textstring der Organisation. Das Textsymbol für Google ist beispielsweise GOOG.

organizations[].title

string

Der Titel des Nutzers in der Organisation. Beispiel: member oder engineer.

organizations[].type

string

Der Organisationstyp.

Zulässige Werte: domain_only, school, unknown, work.

lastLoginTime

string

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 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 dieses Attribut 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 der Wert auf 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_fax, work_mobile, work_pager.

phones[].value

string

Eine lesbare Telefonnummer. Sie kann in einem beliebigen Telefonnummernformat angegeben werden.

suspensionReason

string

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 suspended den Wert true hat.

thumbnailPhotoUrl

string

Nur Ausgabe. Die URL des Profilbilds des Nutzers. Die URL ist möglicherweise temporär oder privat.

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 es keinen entsprechenden ISO 639-Sprachcode gibt. Wenn dieser Parameter festgelegt ist, 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, die nicht in der unterstützten Gruppe enthalten sind, werden von der API akzeptiert, können aber zu unerwartetem Verhalten führen. Ungültige Werte führen zu SchemaException. Wenn dieser Parameter festgelegt ist, kann customLanguage nicht festgelegt werden.

languages[].preference

string

Optional. Wenn vorhanden, wird damit festgelegt, ob die angegebene languageCode die bevorzugte Sprache des Nutzers ist. Wenn customLanguage festgelegt ist, kann dieser Parameter 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 Kennung für das Feld „POSIX-Konto“.

posixAccounts[].gecos

string

Die GECOS-Informationen (Nutzerinformationen) für dieses Konto.

posixAccounts[].gid

unsigned long

Die Standard-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

Gibt an, ob dies das primäre Konto des Nutzers innerhalb der SystemId ist.

posixAccounts[].shell

string

Der Pfad zur Login-Shell für dieses Konto.

posixAccounts[].systemId

string

System-ID, für die der Nutzername oder die Nutzer-ID 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 ist im Datums- und Zeitformat nach ISO 8601. 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 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

value (Value format)

Eine Liste öffentlicher 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

Inhalte von Kontextanmerkungen.

websites

value (Value format)

Die Liste der Websites des Nutzers.

Fields

websites[].customType

string

Wenn die Website type custom ist, 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

Der Typ oder Zweck der Website. Eine Website könnte beispielsweise als home oder blog gekennzeichnet sein. 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. Der Standort in Textform wird angezeigt und sollte eine prägnante Ortsangabe oder -beschreibung sein, 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 Property den benutzerdefinierten Wert und muss festgelegt werden.

locations[].deskCode

string

Spezifischster Textcode für den Standort des einzelnen Schreibtischs.

locations[].floorName

string

Etage

locations[].floorSection

string

Etagenabschnitt. Einen genauer spezifizierten Standort auf der Etage Wenn ein Stockwerk beispielsweise in die Abschnitte A, B und C unterteilt ist, wird in diesem Feld einer dieser Werte angegeben.

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 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

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 gleich custom ist, enthält diese Property den benutzerdefinierten Wert und muss festgelegt werden.

keywords[].type

string

Jeder Eintrag kann einen Typ haben, der den Standardtyp des Eintrags angibt.

 Das Keyword kann beispielsweise vom Typ occupation oder outlook sein. Zusätzlich zum Standardtyp kann ein Eintrag den Typ custom haben und einen beliebigen Namen erhalten. 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 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 YYYY-MM-DDThh:mm:ssTZD. Beispiel: 2010-04-05T17:30:04+01:00.

gender

value (Value format)

Ein verschachteltes Objekt mit dem Geschlecht des Nutzers. 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 richtige Art der Anrede des Profilinhabers enthält, z. B. „er/ihm/sein“ oder „sie/ihnen/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 Konten des Nutzers für Instant Messaging (IM). Ein Nutzerkonto kann mehrere ims-Properties haben, aber nur eine davon kann der primäre IM-Kontakt sein.ims

Fields

ims[].customProtocol

string

Wenn der Protokollwert custom_protocol ist, enthält diese Eigenschaft den String des benutzerdefinierten Protokolls.

ims[].customType

string

Wenn der IM type custom ist, enthält diese Property den benutzerdefinierten Wert und muss festgelegt werden.

ims[].im

string

Die IM-Netzwerk-ID des Nutzers.

ims[].primary

boolean

Gibt an, ob dies die primäre IM des Nutzers ist. Nur ein Eintrag in der Liste der Zwischenhändler kann den Wert „true“ haben.

ims[].protocol

string

Ein IM-Protokoll identifiziert das IM-Netzwerk. Der Wert kann ein benutzerdefiniertes Netzwerk oder das 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: Net Meeting-Protokoll
  • 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. Hat die 2‑Faktor-Authentifizierung eingerichtet (schreibgeschützt)

isEnforcedIn2Sv

boolean

Nur Ausgabe. Wird die 2‑Faktor-Authentifizierung erzwungen? (Nur-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 die übergeordnete Organisation die oberste Ebene ist, wird sie als Schrägstrich (/) dargestellt.

recoveryEmail

string

Die E‑Mail-Adresse zur Kontowiederherstellung des Nutzers.

recoveryPhone

string

Telefonnummer zur Kontowiederherstellung des Nutzers. Die Telefonnummer muss dem Format E.164 entsprechen und mit dem Pluszeichen (+) beginnen, z. B. +16506661212.

isGuestUser

boolean

Nicht veränderbar. Gibt an, ob der Nutzer ein Gast ist.

guestAccountInfo

object (GuestAccountInfo)

Nicht veränderbar. Zusätzliche Metadatenfelder für Gäste

Nutzername

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

string

Der vollständige Name des Nutzers, der durch Verketten der Werte für Vor- und Nachname gebildet wird.

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. Höchstens 256 Zeichen

GuestAccountInfo

Kontoinformationen speziell für Gastnutzer.

JSON-Darstellung
{
  "primaryGuestEmail": string
}
Felder
primaryGuestEmail

string

Nicht veränderbar. Die externe E‑Mail-Adresse des Gastes.

Methoden

createGuest

Erstellen Sie einen Gastnutzer mit Zugriff auf eine Teilmenge der Workspace-Funktionen.

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

Macht einen Nutzer zum Super Admin.

patch

Aktualisiert einen Nutzer mit Patch-Semantik.

signOut

Meldet einen Nutzer von allen Web- und Gerätesitzungen ab und setzt seine Anmeldecookies zurück.

undelete

Löscht die Löschung eines gelöschten Nutzers.

update

Aktualisiert einen Nutzer.

watch

Überwacht Änderungen in der Nutzerliste.