REST Resource: locations.admins

Recurso: administrador

O administrador de uma conta ou de um 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 for definido durante a criação do administrador.

admin

string

Opcional. O nome do administrador. Ao fazer o convite inicial, esse é 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.

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

account

string

Imutável. O nome do recurso de conta a que esse administrador se refere. Usado ao chamar locations.admins.create para convidar um GroupGroup como administrador.

Se este campo e admin forem definidos em solicitações CREATE, este campo 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 especificados.

pendingInvitation

boolean

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

Métodos

create

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

delete

Remove o administrador definido como administrador do local especificado.

list

Lista todos os administradores do local especificado.

patch

Atualiza o administrador do local especificado.