Use o microsoft API do Graph para trabalhar com Viva Engage (versão prévia)

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

O Microsoft API do Graph permite que os aplicativos gerenciem comunidades no Viva Engage. Viva Engage é um tecido social para o conjunto Microsoft Viva de aplicativos que conecta pessoas em toda a organização a compartilhar e aprender. É um lugar onde os funcionários podem se conectar com líderes, colegas de trabalho e comunidades, compartilhar seus conhecimentos e ideias e encontrar pertencimento no trabalho.

Importante

A API Viva Engage no Microsoft Graph só tem suporte para redes Viva Engage no modo nativo. Você não pode usar essa API para gerenciar redes de Viva Engage herdadas ou externas.

Authorization

Para chamar a API Viva Engage no Microsoft Graph, seu aplicativo precisa adquirir um token de acesso. Para obter detalhes sobre tokens de acesso, confira Obter tokens de acesso para chamar o Microsoft Graph. Seu aplicativo também precisa das permissões apropriadas. Para saber mais, confira Referência de permissões do Microsoft Graph.

Casos de uso comuns

A tabela a seguir lista casos de uso comuns para a API Viva Engage.

Caso de uso	API	Observações
Criar uma comunidade	POST /employeeExperience/communities	Se for bem-sucedido, esse método retornará um 202 Accepted código de resposta que contém um link para um objeto engagementAsyncOperation .
Sondagem para status de criação da comunidade	GET /employeeExperience/engagementAsyncOperations/{engagementAsyncOperationId}	Se for bem-sucedido, esse método retornará um 200 OK código de resposta e um objeto engagementAsyncOperation no corpo da resposta. Periodicamente marcar o status da operação fazendo uma solicitação GET para esse local; aguarde >30 segundos entre as verificações. Quando a solicitação for concluída com êxito, o status indica succeeded e o resourceLocation aponta para o recurso criado ou modificado.
Obter uma comunidade após a criação	GET /employeeExperience/communities/{communityId}	Se for bem-sucedido, esse método retornará um 200 OK código de resposta e um objeto da comunidade no corpo da resposta. O objeto da comunidade faz referência à ID do grupo do Microsoft 365 associada que você pode usar para associação da comunidade e gerenciamento de propriedade.
Adicionar membros a uma comunidade	POST /groups/{groupId}/members/$ref	Quando novos membros são adicionados a um grupo, a associação associada da comunidade é atualizada automaticamente.
Remover um membro de uma comunidade	DELETE /groups/{groupId}/members/{userId}/$ref	Quando um membro é removido de um grupo, a associação associada da comunidade é atualizada automaticamente.
Adicionar um administrador da comunidade	POST /groups/{groupId}/owners/$ref	Quando um usuário é adicionado como proprietário de grupo, ele se torna automaticamente um administrador da comunidade associada.
Remover um administrador da comunidade	DELETE /groups/{groupId}/owners/{userId}/$ref	Quando um proprietário de grupo é removido, ele deixa de ser administrador da comunidade associada. Não é possível remover o último proprietário (objeto de usuário ) de um grupo.

Comunidades e grupos

Para redes Viva Engage no modo nativo, a criação de uma nova comunidade de Viva Engage também resulta na criação de um grupo conectado do Microsoft 365, juntamente com um novo site do SharePoint, um notebook do OneNote e Planner plano. Use o grupo associado para gerenciar operações em uma comunidade, por exemplo:

• Adicionar ou remover membros do grupo
• Gerenciar a propriedade do grupo
• Excluir um grupo
• Renomear um grupo
• Atualizar a descrição do grupo

Para obter mais informações sobre a relação entre Viva Engage comunidades e grupos do Microsoft 365, consulte Viva Engage e Grupos do Microsoft 365.

Nota: Você não pode usar a API Criar grupo para provisionar uma comunidade Viva Engage.

Limites da API

Viva Engage chamadas de API estão sujeitas a limitação de taxa, permitindo 10 solicitações por usuário, por aplicativo, dentro de um período de 30 segundos. Quando você excede o limite de taxa, todas as solicitações subsequentes retornam um código de 429 Too Many Requests resposta.

Para obter diretrizes sobre como lidar com a limitação no Microsoft Graph, consulte Diretrizes de limitação do Microsoft Graph.

Próximas etapas

• Use o microsoft API do Graph para gerenciar comunidades no Viva Engage.
• Experimente a API Viva Engage no Explorer graph.