REST Resource: accounts.admins

Zasób: Administrator

być administratorem Account lub Location.

Zapis JSON
{
  "name": string,
  "adminName": string,
  "role": enum (AdminRole),
  "pendingInvitation": boolean
}
Pola
name

string

Nazwa zasobu. W przypadku administratorów kont wygląda to tak: accounts/{accountId}/admins/{adminId}

W przypadku administratorów lokalizacji wygląda to tak: accounts/{accountId}/locations/{locationId}/admins/{adminId}

adminName

string

Imię i nazwisko administratora. Podczas wysyłania początkowego zaproszenia jest to adres e-mail zapraszanej osoby. W przypadku wywołań GET zwracany jest adres e-mail użytkownika, jeśli zaproszenie jest nadal oczekujące. W przeciwnym razie zawiera imię i nazwisko użytkownika.

role

enum (AdminRole)

Określa AdminRole, którego ten administrator używa w przypadku zasobu Account lub Location.

pendingInvitation

boolean

Tylko dane wyjściowe. Wskazuje, czy ten administrator ma oczekujące zaproszenie do określonego zasobu.

Metody

create
(deprecated)

zaprasza wskazanego użytkownika do zostania administratorem określonego konta;

delete
(deprecated)

Usuwa określonego administratora z określonego konta.

list
(deprecated)

Wyświetla listę administratorów określonego konta.

patch
(deprecated)

Aktualizuje dane administratora na wskazanym koncie.