REST Resource: locations.admins

Zasób: Administrator

administrator konta lub lokalizacji;

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

string

Niezmienne. Nazwa zasobu. Jeśli jesteś administratorem konta, ten formularz ma postać: accounts/{account_id}/admins/{admin_id}

Jeśli jesteś administratorem lokalizacji, ten format ma postać: locations/{locationId}/admins/{admin_id}

Jeśli pole zostało ustawione podczas tworzenia administratora, to pole jest ignorowane.

admin

string

Opcjonalnie. Imię i nazwisko administratora. Będzie to adres e-mail zapraszanej osoby. W przypadku połączeń z GET adres e-mail użytkownika jest zwracany, jeśli zaproszenie nadal oczekuje na rozpatrzenie. W przeciwnym razie zawiera imię i nazwisko użytkownika.

To pole trzeba skonfigurować tylko podczas tworzenia konta administratora.

account

string

Niezmienne. Nazwa zasobu konta, do którego odnosi się ten administrator. Używany podczas wywoływania locations.admins.create w celu zaproszenia grupy lokalizacji jako administratora.

Jeśli zarówno to pole, jak i pole admin są ustawione w żądaniach CREATE, to pole ma pierwszeństwo, a adres e-mail w polu admin będzie ignorowany.

Format: accounts/{account}.

role

enum (AdminRole)

To pole jest wymagane. Określa rolę, której administrator używa z określonym kontem lub lokalizacją.

pendingInvitation

boolean

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

Metody

create

Zaprasza określonego użytkownika do zostania administratorem określonej lokalizacji.

delete

Usuwa wskazanego administratora jako menedżera określonej lokalizacji.

list

Zawiera listę wszystkich administratorów określonej lokalizacji.

patch

Aktualizuje administratora określonej lokalizacji.