REST Resource: locations.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.

Méthodes

create

 Invite l'utilisateur spécifié à devenir administrateur de l'établissement indiqué.

delete

 Supprime l'administrateur spécifié en tant qu'administrateur de l'établissement indiqué.

list

 Liste tous les administrateurs de l'établissement spécifié.

patch

 Met à jour l'administrateur pour l'établissement spécifié.