conversationMember : remove

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 .

Supprimer plusieurs membres d’une équipe en une seule demande. La réponse fournit des détails sur les appartenances qui peuvent et ne peuvent pas être supprimées.

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) TeamMember.ReadWrite.All Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application TeamMember.ReadWrite.All Non disponible.

Requête HTTP

Il s’agit d’une action liée pour supprimer plusieurs éléments d’une collection conversationMember en une seule requête.

POST /teams/{team-id}/members/remove

En-têtes de demande

En-tête Valeur
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 la représentation JSON de la liste des dérivés de conversationMember à supprimer d’une équipe. Un maximum de 20 dérivés de conversationMember peut être supprimé en une seule requête.

Le tableau suivant indique le paramètre que vous pouvez utiliser avec cette méthode.

Paramètre Type Description
values Collection conversationMember Liste des membres de la conversation qui doivent être supprimés.

Réponse

En cas de réussite, cette méthode renvoie soit une 204 No Content réponse si tous les membres spécifiés ont été supprimés de l’équipe, soit une 207 Multi-Status réponse si seuls certains membres ont été supprimés. L’appelant doit inspecter la charge utile de réponse pour identifier les suppressions de membres qui ont échoué. Le corps de la réponse contient une collection de dérivés de la ressource actionResultPart . Si la demande échoue, l’API renvoie une erreur. Pour plus d’informations sur les erreurs de Microsoft Graph, consultez l’article Types de ressources et réponses d’erreur Microsoft Graph.

Exemples

Exemple 1 : supprimer des membres en bloc d’une équipe

L’exemple suivant montre comment supprimer plusieurs membres d’une équipe en une seule requête.

Demande

L’exemple suivant illustre une demande.

POST https://graph.microsoft.com/beta/teams/e4183b04-c9a2-417c-bde4-70e3ee46a6dc/members/remove
Content-Type: application/json

{
    "values": [
        {
            "@odata.type": "microsoft.graph.aadUserConversationMember",
            "user@odata.bind": "https://graph.microsoft.com/beta/users('18a80140-b0fb-4489-b360-2f6efaf225a0')"
        },
        {
            "@odata.type": "microsoft.graph.aadUserConversationMember",
            "user@odata.bind": "https://graph.microsoft.com/beta/users('86503198-b81b-43fe-81ee-ad45b8848ac9')"
        }
    ]
}

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content

Exemple 2 : supprimer des membres en bloc d’une équipe à l’aide du nom d’utilisateur principal

L’exemple suivant montre comment supprimer plusieurs membres d’une équipe en une seule demande en utilisant leur nom d’utilisateur principal.

Demande

L’exemple suivant illustre une demande.

POST https://graph.microsoft.com/beta/teams/e4183b04-c9a2-417c-bde4-70e3ee46a6dc/members/remove
Content-Type: application/json

{
    "values": [
        {
            "@odata.type": "microsoft.graph.aadUserConversationMember",
            "user@odata.bind": "https://graph.microsoft.com/beta/users('jacob@contoso.com')"
        },
        {
            "@odata.type": "microsoft.graph.aadUserConversationMember",
            "user@odata.bind": "https://graph.microsoft.com/beta/users('alex@contoso.com')"
        }
    ]
}

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content

Exemple 3 : Supprimer des membres en bloc d’une équipe avec des suppressions ayant échoué

L’exemple suivant montre comment supprimer plusieurs membres d’une équipe lorsque la suppression d’un membre échoue.

Demande

L’exemple suivant illustre une demande.

POST https://graph.microsoft.com/beta/teams/e4183b04-c9a2-417c-bde4-70e3ee46a6dc/members/remove
Content-Type: application/json

{
    "values": [
        {
            "@odata.type": "microsoft.graph.aadUserConversationMember",
            "user@odata.bind": "https://graph.microsoft.com/beta/users('c04f28bf-ab68-40a2-974b-e6af31fa78fb')"
        },
        {
            "@odata.type": "microsoft.graph.aadUserConversationMember",
            "user@odata.bind": "https://graph.microsoft.com/beta/users('86503198-b81b-43fe-81ee-ad45b8848ac9')"
        }
    ]
}

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 207 Multi-Status
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.aadUserConversationMemberResult)",
    "value": [
        {
            "@odata.type": "#microsoft.graph.aadUserConversationMemberResult",
            "userId": "c04f28bf-ab68-40a2-974b-e6af31fa78fb",
            "error": {
                "code": "NotFound",
                "message": "Could not find resource"
            }
        },
        {
            "@odata.type": "#microsoft.graph.aadUserConversationMemberResult",
            "userId": "86503198-b81b-43fe-81ee-ad45b8848ac9",
            "error": null
        }
    ]
}

Supprimer un membre de l’équipe