REST Resource: accounts.locations.admins

Ressource: Admin

Administrateur d'un Account ou d'un Location.

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

string

Nom de la ressource Pour les administrateurs de compte, voici le formulaire: accounts/{accountId}/admins/{adminId}

Pour les administrateurs d'établissements, voici le formulaire: accounts/{accountId}/locations/{locationId}/admins/{adminId}

adminName

string

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.

role

enum (AdminRole)

Spécifie le AdminRole utilisé par cet administrateur avec la ressource Account ou Location spécifiée.

pendingInvitation

boolean

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

Méthodes

create
(deprecated)

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

delete
(deprecated)

Supprime l'administrateur spécifié en tant que responsable de l'établissement spécifié.

list
(deprecated)

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

patch
(deprecated)

Met à jour l'administrateur pour l'administrateur d'établissements spécifié.