travail d’équipe : determineIfInteractionIsAllowed

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Déterminez si une interaction Microsoft Teams spécifiée est autorisée entre l’utilisateur connecté et les utilisateurs spécifiés.

Remarque : toutes les demandes adressées à cette API sont enregistrées dans les journaux d’audit Microsoft 365 des locataires où se trouvent les utilisateurs ciblés spécifiés par le paramètre utilisateurs . Pour plus d’informations, consultez Auditer les activités du journal.

Cette API est disponible dans les déploiements cloud nationaux suivants.

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) TeamworkUserInteraction.Read.All Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Non prise en charge. Non prise en charge.

Requête HTTP

POST /teamwork/determineIfInteractionIsAllowed

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON des paramètres.

Le tableau suivant répertorie les paramètres que vous pouvez utiliser avec cette action.

Paramètre Type Description
interactionType teamworkInteractionType Type d’interaction sur Microsoft Teams.
utilisateurs Collection d’identités Collection d’utilisateurs cibles avec lesquels l’appelant souhaite déterminer si l’interaction est autorisée. Les types dérivés pris en charge sont emailIdentity et teamworkUserIdentity.

Réponse

En cas de succès, cette action renvoie un code de réponse et un 200 OK booléen dans le corps de la réponse.

Exemples

Exemple 1 : déterminer si l’utilisateur connecté peut créer une conversation avec un autre utilisateur dans le même client à l’aide de son ID

L’exemple suivant montre une requête qui détermine si l’utilisateur connecté, authentifié via le contexte délégué, peut créer une conversation avec un autre utilisateur dans le même client en spécifiant l’ID de l’autre utilisateur.

Demande

L’exemple suivant illustre une demande.

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

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

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#Edm.Boolean",
  "value": true
}

Exemple 2 : déterminer si l’utilisateur connecté peut créer une conversation avec un autre utilisateur dans un autre client à l’aide de son ID et de son ID de locataire

L’exemple suivant montre une demande qui détermine si l’utilisateur connecté, authentifié via le contexte délégué, peut créer une conversation avec un autre utilisateur dans un autre client à l’aide de l’ID et de l’ID de locataire de l’autre utilisateur.

Demande

L’exemple suivant illustre une demande.

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"
}

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#Edm.Boolean",
  "value": true
}

Exemple 3 : déterminer si l’utilisateur connecté peut créer une conversation avec un autre utilisateur à l’aide de son nom d’utilisateur principal

L’exemple suivant montre une requête qui détermine si l’utilisateur connecté, authentifié via le contexte délégué, peut créer une conversation avec un autre utilisateur en spécifiant le nom d’utilisateur principal de l’autre utilisateur. Lorsque vous spécifiez le nom d’utilisateur principal d’un utilisateur dans un autre client, il n’est pas nécessaire de spécifier tenantId .

Demande

L’exemple suivant illustre une demande.

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

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

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#Edm.Boolean",
  "value": true
}

Exemple 4 : déterminer si l’utilisateur connecté peut créer une conversation avec un autre utilisateur à l’aide de son adresse e-mail

L’exemple suivant montre une requête qui détermine si l’utilisateur connecté, authentifié via le contexte délégué, peut créer une conversation avec un autre utilisateur en spécifiant l’adresse e-mail de l’autre utilisateur.

Demande

L’exemple suivant illustre une demande.

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

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

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#Edm.Boolean",
  "value": true
}

Exemple 5 : déterminer si l’utilisateur connecté peut créer une conversation avec trois autres utilisateurs

L’exemple suivant montre une demande qui détermine si l’utilisateur connecté, authentifié via le contexte délégué, peut créer une conversation avec trois autres utilisateurs. Il utilise une combinaison des types d’identité pris en charge. Dans cet exemple, l’interaction n’est pas autorisée.

Demande

L’exemple suivant illustre une demande.

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"
}

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#Edm.Boolean",
  "value": false
}