REST Resource: accounts.admins

Ressource: Admin

Administrateur d'une propriété Account ou 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 ce qui est indiqué dans le formulaire : accounts/{accountId}/admins/{adminId}

Pour les administrateurs d'établissement, voici ce qui est indiqué dans le formulaire: accounts/{accountId}/locations/{locationId}/admins/{adminId}

adminName

string

Nom de l'administrateur. Lorsque vous effectuez 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 les AdminRole que cet administrateur utilise 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 du compte spécifié.

delete
(deprecated)

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

list
(deprecated)

Liste les administrateurs du compte spécifié.

patch
(deprecated)

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