conversationMemberr: 追加

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

1 つの要求で チーム に複数のメンバーを追加する。 応答は、作成できたメンバーシップと作成できなかったメンバーシップの詳細を提供します。

注:

メンバーが追加された後、メンバーの追加を反映するのに時間がかかる場合があります。 ユーザーは 、変更通知 を使用して、特定のチームのメンバーシップの変更に関する通知をサブスクライブできます。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ✅ ✅ ✅

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) TeamMember.ReadWriteNonOwnerRole.All TeamMember.ReadWrite.All
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション TeamMember.ReadWriteNonOwnerRole.All TeamMember.ReadWrite.All

HTTP 要求

これは、1回の要求で conversationMember コレクションに複数の要素を追加するためのバインド アクションです。

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

要求ヘッダー

ヘッダー 値
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。

要求本文

チームに追加する必要がある conversationMember 派生物のリストの JSON 表現を要求の本文に入力します。 1 回の要求で最大 200 の conversationMember 派生物を追加できます。

次の表に、このアクションで使用できるパラメーターを示します。

パラメーター 型 説明
values conversationMember コレクション 追加する必要があるカンバセーション メンバーの一覧。

応答

成功した場合、このアクションは 200 OK応答コードと応答本体の actionResultPartの派生物のコレクションを返します。

この API は、指定されたすべてのメンバーがチームに追加されたことを示す 200 応答を返すか、指定されたメンバーの一部のみがチームに追加されたことを示す 207 応答を返します。 呼び出し側は、追加に失敗したメンバーを判断するために、応答ペイロードをチェックする必要があります。 回答の本文は、 actionResultPart 派生物のコレクションです。 この API は、要求が失敗するとエラーで応答します。 Microsoft Graph のエラーの詳細については、「 Microsoft Graph のエラーとリソースの種類」を参照してください。

例

例 1: メンバーをまとめてチームに追加する

要求

次の例では、チームに複数のメンバーを追加する要求を示します。

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

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

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.aadUserConversationMemberResult)",
    "value": [
        {
            "@odata.type": "#microsoft.graph.aadUserConversationMemberResult",
            "userId": "18a80140-b0fb-4489-b360-2f6efaf225a0",
            "error": null
        },
        {
            "@odata.type": "#microsoft.graph.aadUserConversationMemberResult",
            "userId": "86503198-b81b-43fe-81ee-ad45b8848ac9",
            "error": null
        }
    ]
}

例 2: ユーザー プリンシパル名を使用してチームにメンバーを一括追加する

次の例は、メンバーのユーザー プリンシパル名を使用して、複数のメンバーをチームに追加する方法を示しています。

注:

ユーザー プリンシパル名 (UPN) を使用して、チームにゲスト ユーザーを追加することはできません。

要求

次の例は要求を示しています。

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

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

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.aadUserConversationMemberResult)",
    "value": [
        {
            "@odata.type": "#microsoft.graph.aadUserConversationMemberResult",
            "userId": "18a80140-b0fb-4489-b360-2f6efaf225a0",
            "error": null
        },
        {
            "@odata.type": "#microsoft.graph.aadUserConversationMemberResult",
            "userId": "86503198-b81b-43fe-81ee-ad45b8848ac9",
            "error": null
        }
    ]
}