List assignedRoles

Namespace: microsoft.graph

Obtenha uma lista de todas as funções atribuídas a um usuário no Viva Engage.

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) EngagementRole.Read EngagementRole.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application EngagementRole.Read.All EngagementRole.ReadWrite.All

Observação

Chamar o ponto de extremidade /me exige um usuário conectado e, portanto, uma permissão delegada. Não há suporte para permissões de aplicativo ao usar o /me ponto de extremidade.

Solicitação HTTP

GET /users/{userId}/employeeExperience/assignedRoles
GET /me/employeeExperience/assignedRoles

Observação: Representa {userId} a ID de usuário do Office.

Parâmetros de consulta opcionais

Esse método dá suporte aos $filter parâmetros de consulta (eq), $select, e $count OData. Para obter informações gerais, acesse Parâmetros de consulta OData. Somente as propriedades displayName e id dão suporte ao $filter parâmetro.

A tabela a seguir mostra como você pode usar parâmetros de consulta OData com essa API.

Descrição Solicitação HTTP
Filtrar funções atribuídas por nome de exibição GET /users/{userId}/employeeExperience/assignedRoles?$filter=displayName eq 'Corporate Communicator'
Obter apenas a propriedade id para uma lista de funções atribuídas GET /users/{userId}/employeeExperience/assignedRoles?$select=id
Incluir a contagem total de funções atribuídas GET /users/{userId}/employeeExperience/assignedRoles?$count=true

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Se for bem-sucedido, esse método retornará um 200 OK código de resposta e uma coleção de objetos engagementRole no corpo da resposta.

Exemplos

Exemplo 1: obter uma lista de todas as funções atribuídas a um usuário conectado no Viva Engage

O exemplo a seguir mostra como obter uma lista de todas as funções atribuídas a um usuário conectado no Viva Engage.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/v1.0/me/employeeExperience/assignedRoles

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#me/employeeExperience/assignedRoles",
  "value": [
    {
        "id": "ec791927-d09f-4f91-bd76-d3b05e1c1a31",
        "displayName": "Network Admin"
    },
    {
        "id": "b0de8e6d-4457-4722-bdc5-5a32a09bf064",
        "displayName": "Verified Admin"
    },
    {
        "id": "77aa7d76-bdf6-4cc0-80e2-fd1ac5a28471",
        "displayName": "Corporate Communicator"
    }
  ]
}

Exemplo 2: Obter uma lista de todas as funções atribuídas a um usuário no Viva Engage

O exemplo a seguir mostra como obter uma lista de todas as funções atribuídas a um usuário no Viva Engage.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/v1.0/users/e8d9f6a2-1c34-4b7a-9f11-2a4d8b7c9e01/employeeExperience/assignedRoles

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users/e8d9f6a2-1c34-4b7a-9f11-2a4d8b7c9e01/employeeExperience/assignedRoles",
  "value": [
    {
        "id": "ec791927-d09f-4f91-bd76-d3b05e1c1a31",
        "displayName": "Network Admin"
    },
    {
        "id": "b0de8e6d-4457-4722-bdc5-5a32a09bf064",
        "displayName": "Verified Admin"
    },
    {
        "id": "77aa7d76-bdf6-4cc0-80e2-fd1ac5a28471",
        "displayName": "Corporate Communicator"
    }
  ]
}