REST Resource: locations.admins

Recurso: Administrador

Un administrador de una cuenta o ubicación

Representación JSON
{
  "name": string,
  "admin": string,
  "account": string,
  "role": enum (AdminRole),
  "pendingInvitation": boolean
}
Campos
name

string

Inmutable. Es el nombre del recurso. Para los administradores de cuenta, la dirección tiene el siguiente formato: accounts/{account_id}/admins/{admin_id}

Para los administradores de ubicación, tienen el siguiente formato: locations/{locationId}/admins/{admin_id}

Este campo se ignorará si se establece durante la creación del administrador.

admin

string

Opcional. El nombre del administrador. Cuando se envía la invitación inicial, esta es la dirección de correo electrónico del invitado. En las llamadas de GET, se muestra la dirección de correo electrónico del usuario si la invitación aún está pendiente. De lo contrario, contiene el nombre y el apellido del usuario.

Este campo solo se debe configurar durante la creación del administrador.

account

string

Inmutable. Indica el nombre del recurso de la cuenta al que hace referencia este administrador. Se usa cuando se llama a locations.admins.create para invitar a un LocationGroup como administrador.

Si tanto este campo como admin se configuran en las solicitudes CREATE, este campo tiene prioridad y se ignorará la dirección de correo electrónico de admin.

Formato: accounts/{account}.

role

enum (AdminRole)

Obligatorio. Especifica el rol que usa este administrador con la cuenta o ubicación especificadas.

pendingInvitation

boolean

Solo salida. Indica si este administrador tiene una invitación pendiente para el recurso especificado.

Métodos

create

Invita al usuario especificado a convertirse en administrador de la ubicación especificada.

delete

Quita al administrador especificado como administrador de la ubicación especificada.

list

Muestra una lista de todos los administradores de la ubicación especificada.

patch

Actualiza el administrador de la ubicación especificada.