Aller au contenu principal

Scopes

Les scopes définissent les permissions de votre clé API.

Scopes disponibles​

  • READ_APPOINTMENTS - Consulter les rendez-vous
  • WRITE_APPOINTMENTS - Créer et modifier des rendez-vous
  • CANCEL_APPOINTMENTS - Annuler des rendez-vous
  • READ_DEPARTMENTS - Consulter les départements
  • READ_AVAILABILITY - Vérifier les disponibilités
  • READ_USERS - Consulter les utilisateurs (limité)
  • READ_ORGANIZATIONS - Consulter les informations de l'organisation

Il n'existe pas de scope "administrateur complet" : une clé API doit toujours se voir attribuer explicitement chacun des scopes dont elle a besoin (principe du moindre privilège appliqué par défaut).

Choisir les bons scopes​

Suivez le principe du moindre privilège : ne demandez que les scopes dont vous avez réellement besoin.

Exemples​

Application de réservation simple :

  • READ_DEPARTMENTS
  • WRITE_APPOINTMENTS
  • READ_APPOINTMENTS

Dashboard administrateur :

  • Tous les scopes individuels nécessaires (READ_APPOINTMENTS, WRITE_APPOINTMENTS, CANCEL_APPOINTMENTS, READ_DEPARTMENTS, READ_AVAILABILITY, READ_USERS, READ_ORGANIZATIONS)