REST Resource: locations.admins

Ресурс: Админ

Администратор учетной записи или местоположения.

JSON-представление
{
  "name": string,
  "admin": string,
  "account": string,
  "role": enum (AdminRole),
  "pendingInvitation": boolean
}
Поля
name

string

Неизменный. Имя ресурса. Для администраторов учетных записей это имеет форму: accounts/{account_id}/admins/{admin_id}

Для администраторов локаций это имеет следующий формат: locations/{locationId}/admins/{admin_id}

Это поле будет игнорироваться, если оно задано при создании администратора.

admin

string

Необязательный. Имя администратора. При первоначальном приглашении это адрес электронной почты приглашенного. При вызовах GET возвращается адрес электронной почты пользователя, если приглашение все еще находится на рассмотрении. В противном случае он содержит имя и фамилию пользователя.

Это поле необходимо задать только во время создания администратора.

account

string

Неизменный. Имя ресурса учетной записи, на который ссылается этот администратор. Используется при вызове location.admins.create, чтобы пригласить LocationGroup в качестве администратора.

Если и это поле, и admin установлены для запросов CREATE , это поле имеет приоритет, и адрес электронной почты в admin будет игнорироваться.

Формат: accounts/{account} .

role

enum ( AdminRole )

Необходимый. Указывает роль, которую этот администратор использует с указанной учетной записью или местоположением.

pendingInvitation

boolean

Только вывод. Указывает, есть ли у этого администратора ожидающее приглашение для указанного ресурса.

Методы

create

 Приглашает указанного пользователя стать администратором указанного местоположения.

delete

 Удаляет указанного администратора в качестве менеджера указанного местоположения.

list

 Список всех администраторов указанного местоположения.

patch

 Обновляет администратора для указанного местоположения.