REST Resource: locations.admins

Ressource: Admin

Administrator eines Kontos oder Standorts

JSON-Darstellung 
{
  "name": string,
  "admin": string,
  "account": string,
  "role": enum (AdminRole),
  "pendingInvitation": boolean
}
Felder
name

string

Nicht veränderbar. Der Ressourcenname Für Kontoadministratoren hat das folgende Format: accounts/{account_id}/admins/{admin_id}

Für Standortadministratoren hat sie das folgende Format: locations/{locationId}/admins/{admin_id}

Dieses Feld wird ignoriert, wenn es beim Erstellen des Administrators festgelegt wird.
admin

string

Optional. Der Name des Administrators. Bei der ersten Einladung ist dies die E-Mail-Adresse der eingeladenen Person. Bei GET-Aufrufen wird die E-Mail-Adresse des Nutzers zurückgegeben, wenn die Einladung noch aussteht. Andernfalls enthält er den Vor- und Nachnamen des Nutzers.

Dieses Feld muss nur beim Erstellen durch den Administrator festgelegt werden.
account

string

Nicht veränderbar. Der Name der Kontoressource, auf die dieser Administrator verweist. Wird beim Aufrufen von „locations.admins.create“ verwendet, um eine Standortgruppe als Administrator einzuladen.

Wenn sowohl dieses Feld als auch admin in CREATE-Anfragen festgelegt sind, hat dieses Feld Vorrang und die E-Mail-Adresse in admin wird ignoriert.

Format: accounts/{account}
role

enum (AdminRole)

Erforderlich. Gibt die Rolle an, die dieser Administrator mit dem angegebenen Konto oder Standort verwendet.
pendingInvitation

boolean

Nur Ausgabe Gibt an, ob dieser Administrator eine ausstehende Einladung für die angegebene Ressource hat.

Methoden

create

 Lädt den angegebenen Nutzer ein, Administrator für den angegebenen Standort zu werden.

delete

 Der angegebene Administrator wird für den angegebenen Standort als Administrator entfernt.

list

 Listet alle Administratoren für den angegebenen Standort auf.

patch

 Aktualisiert den Administrator für den angegebenen Standort.