REST Resource: accounts.locations.admins

Recurso: administrador

Um administrador de uma Account ou uma Location.

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

string

O nome do recurso. Para administradores de conta, o formato é: accounts/{accountId}/admins/{adminId}

Para administradores de locais, o formato é: accounts/{accountId}/locations/{locationId}/admins/{adminId}

adminName

string

O nome do administrador. Ao fazer o convite inicial, esse é o endereço de e-mail da pessoa. 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.

role

enum (AdminRole)

Especifica o AdminRole que este administrador usa com o recurso Account ou Location especificado.

pendingInvitation

boolean

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

Métodos

create
(deprecated)

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

delete
(deprecated)

Remove o administrador especificado como administrador do local especificado.

list
(deprecated)

Lista todos os administradores do local especificado.

patch
(deprecated)

Atualiza o administrador do local especificado.