REST Resource: locations.admins

Ressource: Admin

l'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, voici le formulaire: accounts/{account_id}/admins/{admin_id}

Pour les administrateurs d'établissements, voici le formulaire: 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 l'envoi 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 par l'administrateur.
account

string

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

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

Format : accounts/{account}.
role

enum (AdminRole)

Obligatoire. Spécifie le rôle que cet administrateur utilise pour le compte ou l'emplacement spécifié.
pendingInvitation

boolean

Uniquement en sortie. Indique si cet administrateur dispose d'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 que responsable de l'établissement spécifié.

list

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

patch

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