trabalho em equipe: determineIfInteractionIsAllowed

Namespace: microsoft.graph

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.

Determine se uma interação especificada do Microsoft Teams é permitida entre o usuário conectado e os usuários especificados.

Observação: todas as solicitações para essa API são registradas nos logs de auditoria do Microsoft 365 dos locatários onde existem os usuários de destino especificados pelo parâmetro users . Para obter mais informações, consulte Atividades de log de auditoria.

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) Trabalho em equipeUserInteraction.Read.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Aplicativo Sem suporte. Sem suporte.

Solicitação HTTP

POST /teamwork/determineIfInteractionIsAllowed

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON dos parâmetros.

A tabela a seguir mostra os parâmetros que você pode usar com essa ação.

Parâmetro Tipo Descrição
interactionType teamworkInteractionType O tipo de interação no Microsoft Teams.
usuários Coleção de identidades A coleção de usuários de destino com os quais o chamador deseja determinar se a interação é permitida. Os tipos derivados com suporte são emailIdentity e teamworkUserIdentity.

Resposta

Se for bem-sucedida, essa ação retornará um código de 200 OK resposta e um booliano no corpo da resposta.

Exemplos

Exemplo 1: determinar se o usuário conectado pode criar um chat com outro usuário no mesmo locatário usando sua ID

O exemplo a seguir mostra uma solicitação que determina se o usuário conectado, autenticado por meio de contexto delegado, pode criar um chat com outro usuário no mesmo locatário especificando a ID do outro usuário.

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/beta/teamwork/determineIfInteractionIsAllowed

{
  "users":
  [
    {
      "@odata.type": "microsoft.graph.teamworkUserIdentity",
      "id": "59b5bc69-ca73-4ffd-a2e0-88a79115d13b"
    }
  ],
  "interactionType": "createChat"
}

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/beta/$metadata#Edm.Boolean",
  "value": true
}

Exemplo 2: determinar se o usuário conectado pode criar um chat com outro usuário em um locatário diferente usando sua ID e ID de locatário

O exemplo a seguir mostra uma solicitação que determina se o usuário conectado, autenticado por meio de contexto delegado, pode criar um chat com outro usuário em um locatário diferente usando a ID e a ID do locatário do outro usuário.

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/beta/teamwork/determineIfInteractionIsAllowed

{
  "users":
  [
    {
      "@odata.type": "microsoft.graph.teamworkUserIdentity",
      "id": "59b5bc69-ca73-4ffd-a2e0-88a79115d13b",
      "tenantId": "b11186db-6149-4b3d-95ad-23c9e1bf6853"
    }
  ],
  "interactionType": "createChat"
}

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/beta/$metadata#Edm.Boolean",
  "value": true
}

Exemplo 3: determinar se o usuário conectado pode criar um chat com outro usuário usando seu nome UPN

O exemplo a seguir mostra uma solicitação que determina se o usuário conectado, autenticado por meio de contexto delegado, pode criar um chat com outro usuário especificando o nome principal do usuário do outro usuário. Quando você especifica o nome UPN de um usuário em outro locatário, tenantId não precisa ser especificado.

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/beta/teamwork/determineIfInteractionIsAllowed

{
  "users":
  [
    {
      "@odata.type": "microsoft.graph.teamworkUserIdentity",
      "userPrincipalName": "maia@contoso.com"
    }
  ],
  "interactionType": "createChat"
}

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/beta/$metadata#Edm.Boolean",
  "value": true
}

Exemplo 4: determinar se o usuário conectado pode criar um chat com outro usuário usando seu email

O exemplo a seguir mostra uma solicitação que determina se o usuário conectado, autenticado por meio de contexto delegado, pode criar um chat com outro usuário especificando o email do outro usuário.

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/beta/teamwork/determineIfInteractionIsAllowed

{
  "users":
  [
    {
      "@odata.type": "microsoft.graph.emailIdentity",
      "email": "LauraW@contoso.com"
    }
  ],
  "interactionType": "createChat"
}

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/beta/$metadata#Edm.Boolean",
  "value": true
}

Exemplo 5: determinar se o usuário conectado pode criar um chat com três outros usuários

O exemplo a seguir mostra uma solicitação que determina se o usuário conectado, autenticado por meio de contexto delegado, pode criar um chat com três outros usuários. Ele usa uma combinação dos tipos de identidade com suporte. Neste exemplo, a interação não é permitida.

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/beta/teamwork/determineIfInteractionIsAllowed

{
  "users":
  [
    {
      "@odata.type": "microsoft.graph.emailIdentity",
      "email": "LauraW@foo.com"
    },
    {
      "@odata.type": "microsoft.graph.teamworkUserIdentity",
      "userPrincipalName": "MaiaR@foobar.com"
    },
    {
      "@odata.type": "microsoft.graph.teamworkUserIdentity",
      "id": "bd6a223f-59b5-46dd-90bc-0ddebaf3da5a"
    }
  ],
  "interactionType": "createChat"
}

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/beta/$metadata#Edm.Boolean",
  "value": false
}