REST Resource: locations.admins

Recurso: administrador

Um administrador de uma conta ou local.

Representação JSON
{
  "name": string,
  "admin": string,
  "account": string,
  "role": enum (AdminRole),
  "pendingInvitation": boolean
}
Campos
name

string

Imutável. O nome do recurso. Para administradores de contas, o formato é: accounts/{account_id}/admins/{admin_id}

Para administradores de locais, o formato é: locations/{locationId}/admins/{admin_id}

Este campo será ignorado se definido durante a criação do administrador.

admin

string

Opcional. O nome do administrador. Ao fazer o convite inicial, este é o endereço de e-mail do convidado. Em chamadas GET, o endereço de e-mail do usuário será retornado se o convite ainda estiver pendente. Caso contrário, ele conterá o nome e o sobrenome do usuário.

Esse campo só precisa ser definido durante a criação do administrador.

account

string

Imutável. O nome do recurso da conta a que este administrador se refere. Usado ao chamar locations.admins.create para convidar um grupo por local como administrador.

Se este campo e admin forem definidos em solicitações CREATE, ele terá precedência e o endereço de e-mail em admin será ignorado.

Formato: accounts/{account}.

role

enum (AdminRole)

Obrigatório. Especifica a função que este administrador usa com a conta ou o local especificado.

pendingInvitation

boolean

Apenas saída. Indica se esse administrador tem um convite pendente para o recurso especificado.

Métodos

create

Convida o usuário especificado para se tornar um administrador do local especificado.

delete

Remove o administrador especificado como administrador do local especificado.

list

Lista todos os administradores do local especificado.

patch

Atualiza o administrador do local especificado.