REST Resource: accounts.admins

Ressource: Admin

Administrateur d'un compte ou d'un établissement.

Représentation JSON
{
  "name": string,
  "admin": string,
  "account": string,
  "role": enum (AdminRole),
  "pendingInvitation": boolean
}
Champs
name

string

Immuable. Nom de la ressource. Pour les administrateurs de compte, le format est le suivant: accounts/{account_id}/admins/{admin_id}

Pour les administrateurs d'établissements, le format est le suivant: locations/{locationId}/admins/{admin_id}

Ce champ sera ignoré s'il est défini lors de la création de l'administrateur.

admin

string

Facultatif. Nom de l'administrateur. Lors de la création de l'invitation initiale, il s'agit de l'adresse e-mail de l'invité. Lors des appels GET, l'adresse e-mail de l'utilisateur est renvoyée si l'invitation est toujours en attente. Sinon, il contient le prénom et le nom de l'utilisateur.

Ce champ ne doit être défini que lors de la création de l'administrateur.

account

string

Immuable. Nom de la ressource "Account" à laquelle cet administrateur fait référence. Utilisé lors de l'appel de locations.admins.create pour inviter un LocationGroup en tant qu'administrateur.

Si ce champ et admin sont tous deux définis dans des requêtes CREATE, ce champ est prioritaire, et l'adresse e-mail dans admin sera ignorée.

Format : accounts/{account}.

role

enum (AdminRole)

Obligatoire. Spécifie le rôle utilisé par cet administrateur avec le compte ou l'établissement spécifiés.

pendingInvitation

boolean

Uniquement en sortie. Indique si cet administrateur a une invitation en attente pour la ressource spécifiée.

AdminRole

Indique le niveau d'accès d'un administrateur. Pour en savoir plus, consultez cet article du Centre d'aide

Enums
ADMIN_ROLE_UNSPECIFIED Non spécifié.
PRIMARY_OWNER L'administrateur dispose d'un accès de niveau propriétaire et en est le propriétaire principal. (s'affiche en tant que "Propriétaire principal" dans l'interface utilisateur).
OWNER L'administrateur dispose d'un accès de niveau propriétaire. (s'affiche avec la mention "Propriétaire" dans l'interface utilisateur).
MANAGER L'administrateur dispose d'un accès de niveau administrateur.
SITE_MANAGER L'administrateur peut gérer les pages de réseaux sociaux (Google+). ("Responsable de site" dans l'interface utilisateur) Cette API ne permet pas de créer un administrateur de compte doté du rôle SITE_MANAGER.

Méthodes

create

Invite l'utilisateur spécifié à devenir administrateur du compte spécifié.

delete

Supprime l'administrateur spécifié du compte indiqué.

list

Répertorie les administrateurs du compte spécifié.

patch

Met à jour l'administrateur de l'administrateur de compte spécifié.