Utiliser le API Graph Microsoft pour utiliser Viva Engage
Microsoft API Graph permet aux applications de gérer les communautés dans Viva Engage. Viva Engage est un tissu social pour la suite Microsoft Viva d’applications qui connecte des personnes dans l’organization à partager et à apprendre. Il s’agit d’un endroit où les employés peuvent entrer en contact avec des dirigeants, des collègues et des communautés, partager leurs connaissances et leurs idées, et trouver leur appartenance au travail.
Importante
L’API Viva Engage dans Microsoft Graph est uniquement prise en charge pour les réseaux Viva Engage en mode natif. Vous ne pouvez pas utiliser cette API pour gérer des réseaux Viva Engage hérités ou externes.
Autorisation
Pour appeler l’API Viva Engage dans Microsoft Graph, votre application doit acquérir un jeton d’accès. Pour plus d’informations sur les jetons d’accès, reportez-vous à l’article Obtenir des jetons d’accès pour appeler Microsoft Graph. Votre application a également besoin des autorisations appropriées. Pour plus d’informations, reportez-vous à l’article relatif aux Autorisations Microsoft Graph.
Cas d’utilisation courants
Le tableau suivant répertorie les cas d’usage courants pour l’API Viva Engage.
| Cas d’utilisation | API | Commentaires |
|---|---|---|
| Créer une communauté | POST /employeeExperience/communities | Si elle réussit, cette méthode renvoie un 202 Accepted code de réponse qui contient un lien vers un objet engagementAsyncOperation . |
| Interroger les status de création de communauté | GET /employeeExperience/engagementAsyncOperations/{engagementAsyncOperationId} | Si elle réussit, cette méthode renvoie un 200 OK code de réponse et un objet engagementAsyncOperation dans le corps de la réponse. Régulièrement case activée le status de l’opération en effectuant une requête GET à cet emplacement ; attendez >30 secondes entre les vérifications. Une fois la demande terminée, le status indique succeeded et la ressourceLocation pointe vers la ressource créée ou modifiée. |
| Obtenir une communauté après la création | GET /employeeExperience/communities/{communityId} | Si elle réussit, cette méthode renvoie un 200 OK code de réponse et un objet de communauté dans le corps de la réponse. L’objet communauté fait référence à l’ID de groupe Microsoft 365 associé que vous pouvez utiliser pour la gestion de l’appartenance à la communauté et de la propriété. |
| Obtenir la liste des communautés | GET /employeeExperience/communities | Si elle réussit, cette méthode renvoie un 200 OK code de réponse et une collection d’objets Viva Engage communauté dans le corps de la réponse. |
| Mettre à jour une communauté | PATCH /employeeExperience/communities/{communityId} | Si elle réussit, cette méthode met à jour une communauté Viva Engage existante et retourne un 204 No Content code de réponse. |
| Supprimer une communauté | DELETE /employeeExperience/communities/{communityId} | Si elle réussit, cette méthode supprime une communauté Viva Engage ainsi que tout le contenu Microsoft 365 associé, y compris le groupe Microsoft 365 connecté, le bloc-notes OneNote et les plans Planificateur. Pour plus d’informations, consultez Que se passe-t-il si je supprime une communauté Viva Engage connectée à des groupes Microsoft 365. |
| Ajouter des membres à une communauté | POST /groups/{groupId}/members/$ref | Lorsque de nouveaux membres sont ajoutés à un groupe, l’appartenance associée à la communauté est automatiquement mise à jour. |
| Supprimer un membre d’une communauté | DELETE /groups/{groupId}/members/{userId}/$ref | Lorsqu’un membre est supprimé d’un groupe, l’appartenance associée à la communauté est automatiquement mise à jour. |
| Ajouter un administrateur de communauté | POST /groups/{groupId}/owners/$ref | Lorsqu’un utilisateur est ajouté en tant que propriétaire de groupe, il devient automatiquement administrateur de la communauté associée. |
| Supprimer un administrateur de communauté | DELETE /groups/{groupId}/owners/{userId}/$ref | Lorsqu’un propriétaire de groupe est supprimé, il cesse d’être administrateur de la communauté associée. Vous ne pouvez pas supprimer le dernier propriétaire (objet utilisateur ) d’un groupe. |
Communautés et groupes
Pour Viva Engage réseaux en mode natif, la création d’une communauté Viva Engage entraîne également la création d’un groupe Microsoft 365 connecté, ainsi qu’un nouveau site SharePoint, un bloc-notes OneNote et un plan Planificateur. Utilisez le groupe associé pour gérer les opérations sur une communauté, par exemple :
- Ajouter des membres à un groupe ou en supprimer
- Gérer la propriété du groupe
- Supprimer un groupe
- Renommer un groupe
- Mettre à jour la description du groupe
Pour plus d’informations sur la relation entre les communautés Viva Engage et les groupes Microsoft 365, consultez Viva Engage et Groupes Microsoft 365.
Note: Vous ne pouvez pas utiliser l’API Créer un groupe pour approvisionner une communauté Viva Engage.
Limites de l’API
Viva Engage appels d’API sont soumis à une limitation du débit, ce qui autorise 10 demandes par utilisateur, par application, sur une période de 30 secondes. Lorsque vous dépassez la limite de débit, toutes les requêtes suivantes retournent un 429 Too Many Requests code de réponse.
Pour obtenir des conseils sur la gestion de la limitation dans Microsoft Graph, consultez Guide de limitation de Microsoft Graph.
Étapes suivantes
- Utilisez microsoft API Graph pour gérer les communautés dans Viva Engage.
- Essayez l’API Viva Engage dans le Explorer Graph.