conversationMember: remove
名前空間: microsoft.graph
1 つの要求で チーム から複数のメンバーを削除します。 応答は、削除できるメンバーシップと削除できなかったメンバーシップの詳細を提供します。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
|---|---|---|---|
| ✅ | ✅ | ✅ | ✅ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
|---|---|---|
| 委任 (職場または学校のアカウント) | TeamMember.ReadWrite.All | 注意事項なし。 |
| 委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
| アプリケーション | TeamMember.ReadWrite.All | 注意事項なし。 |
HTTP 要求
この API は、1 つの要求で conversationMember コレクションから複数の要素を削除するためのバインドされたアクションです。
POST /teams/{team-id}/members/remove
要求ヘッダー
| ヘッダー | 値 |
|---|---|
| Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
| Content-Type | application/json. 必須です。 |
要求本文
要求本文で、チームから削除する conversationMember 派生物の一覧の JSON 表現を指定します。 1 回の要求で最大 20 個の conversationMember 派生物を削除できます。
次の表に、このメソッドで使用できるパラメーターを示します。
| パラメーター | 型 | 説明 |
|---|---|---|
| values | conversationMember コレクション | 削除する会話メンバーの一覧。 |
応答
成功した場合、このメソッドは、指定されたすべてのメンバーがチームから正常に削除された場合は 204 No Content 応答、一部のメンバーのみが削除された場合は 207 Multi-Status 応答を返します。 呼び出し元は、応答ペイロードを検査して、失敗したメンバーの削除を特定する必要があります。 応答本文には、 actionResultPart リソースの派生物のコレクションが含まれています。 要求が失敗した場合、API はエラーを返します。 Microsoft Graph エラーの詳細については、「Microsoft Graph エラー応答およびリソースの種類」を参照してください。
例
例 1: チームからメンバーを一括で削除する
次の例は、1 つの要求でチームから複数のメンバーを削除する方法を示しています。
要求
次の例は要求を示しています。
POST https://graph.microsoft.com/v1.0/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/v1.0/users('18a80140-b0fb-4489-b360-2f6efaf225a0')"
},
{
"@odata.type": "microsoft.graph.aadUserConversationMember",
"user@odata.bind": "https://graph.microsoft.com/v1.0/users('86503198-b81b-43fe-81ee-ad45b8848ac9')"
}
]
}
応答
次の例は応答を示しています。
HTTP/1.1 204 No Content
例 2: ユーザー プリンシパル名を使用してチームからメンバーを一括で削除する
次の例は、ユーザー プリンシパル名を使用して、1 つの要求でチームから複数のメンバーを削除する方法を示しています。
要求
次の例は要求を示しています。
POST https://graph.microsoft.com/v1.0/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/v1.0/users('jacob@contoso.com')"
},
{
"@odata.type": "microsoft.graph.aadUserConversationMember",
"user@odata.bind": "https://graph.microsoft.com/v1.0/users('alex@contoso.com')"
}
]
}
応答
次の例は応答を示しています。
HTTP/1.1 204 No Content
例 3: 削除に失敗したチームからメンバーを一括で削除する
次の例は、メンバーの削除が失敗したときにチームから複数のメンバーを削除する方法を示しています。
要求
次の例は要求を示しています。
POST https://graph.microsoft.com/v1.0/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/v1.0/users('c04f28bf-ab68-40a2-974b-e6af31fa78fb')"
},
{
"@odata.type": "microsoft.graph.aadUserConversationMember",
"user@odata.bind": "https://graph.microsoft.com/v1.0/users('86503198-b81b-43fe-81ee-ad45b8848ac9')"
}
]
}
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 207 Multi-Status
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$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
}
]
}