Centre d’aide

Personnel et permissions

Consultez l’introduction à l’API pour l’authentification, les conventions, la pagination, les limites de requêtes et les erreurs.

Les utilisateurs d’Activity Messenger sont les administrateurs et membres du personnel qui ont accès à l’interface d’administration de votre organisation. Chaque utilisateur est identifié de façon unique par son adresse email. Un utilisateur peut gérer plusieurs organisations ou y accéder. Vous pouvez inviter des utilisateurs, modifier leurs permissions et révoquer leur accès. Consultez la gestion des utilisateurs et des permissions pour en savoir plus.

Un objet utilisateur contient les attributs suivants. L’attribut confirmed vaut true lorsque la personne a confirmé son adresse courriel et terminé la configuration de son compte Activity Messenger.

{
  "id": 1234,
  "first_name": "Harry",
  "last_name": "Potter",
  "email": "harry@hogwartsrec.com",
  "mobile": "555-123-1234",
  "permission": "staff",
  "confirmed": true
}

GET /api/v1/organization/{organization}/users

Récupère tous les utilisateurs qui ont accès à l’organisation ou qui la gèrent.

GET /api/v1/organization/{organization}/users/{user}

Récupère un utilisateur à partir de son identifiant.

POST /api/v1/organization/{organization}/users

Invite un utilisateur à gérer l’organisation ou à y accéder. L’adresse email sert de clé et est obligatoire. Les attributs first_name et last_name sont également obligatoires. L’attribut mobile est facultatif; s’il est fourni, il doit respecter le format 555-123-1234. L’attribut permission détermine le niveau d’accès et accepte staff, staff_no_messaging ou guest. Consultez la gestion des utilisateurs et des permissions pour les détails.

Si la personne ne possède pas déjà de compte Activity Messenger, un compte est créé. Elle reçoit un courriel lui permettant de configurer son compte et d’accéder à votre organisation. Le point de terminaison renvoie le statut 201.

Si l’utilisateur existe déjà, il obtient l’accès à votre organisation avec la permission indiquée. S’il y avait déjà accès, sa permission est mise à jour. Les attributs de l’utilisateur ne sont pas modifiés. L’API ne permet pas d’inviter des utilisateurs avec les permissions owner ou admin, ni de modifier le niveau de permission d’un utilisateur owner ou admin. Contactez-nous si vous avez besoin de ces possibilités.

PUT /api/v1/organization/{organization}/users/{user}

Met à jour la permission d’un membre du personnel dans l’organisation. Seul l’attribut permission doit être transmis et peut être modifié. Les mêmes contraintes que pour le point de terminaison POST s’appliquent.

DELETE /api/v1/organization/{organization}/users/{user}

Révoque l’accès de l’utilisateur à l’organisation.