REST Resource: locations.admins

Zasób: Admin

Administrator konta lub lokalizacji.

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

string

Stały. Nazwa zasobu. Jeśli administrator konta może korzystać z tego formularza: accounts/{account_id}/admins/{admin_id}

W przypadku administratorów lokalizacji wygląda to w ten sposób: locations/{locationId}/admins/{admin_id}

Jeśli to pole zostanie skonfigurowane podczas tworzenia administratora, zostanie ono zignorowane.

admin

string

Opcjonalnie: Imię i nazwisko administratora. W pierwszym zaproszeniu jest to adres e-mail zapraszanej osoby. W przypadku wywołań funkcji GET zwracany jest adres e-mail użytkownika, jeśli zaproszenie nadal oczekuje na rozpatrzenie. W przeciwnym razie zawiera on imię i nazwisko użytkownika.

To pole należy skonfigurować tylko podczas tworzenia administratora.

account

string

Stały. Nazwa zasobu konta, do którego odwołuje się ten administrator. Używana, gdy wywołujesz locations.admins.create, by zaprosić grupę lokalizacji jako administratora.

Jeśli zarówno to pole, jak i zasada 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)

Wymagane. Określa rolę, której ten administrator używa w przypadku określonego konta lub lokalizacji.

pendingInvitation

boolean

Tylko dane wyjściowe. Wskazuje, czy ten administrator ma oczekujące zaproszenie dla 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

Wyświetla listę wszystkich administratorów w określonej lokalizacji.

patch

Aktualizuje informacje na temat administratora określonej lokalizacji.