チームワーク: determineIfInteractionIsAllowed

名前空間: microsoft.graph

重要

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

サインイン ユーザーと指定されたユーザーの間で指定された Microsoft Teams の対話が許可されているかどうかを確認します。

: この API へのすべての要求は、 users パラメーターで指定された対象ユーザーが存在するテナントの Microsoft 365 監査ログに記録されます。 詳細については、「 監査ログ アクティビティ」を参照してください。

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

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

アクセス許可

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

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

HTTP 要求

POST /teamwork/determineIfInteractionIsAllowed

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json. 必須です。

要求本文

要求本文で、パラメーターの JSON 表現を指定します。

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

パラメーター 説明
interactionType teamworkInteractionType Microsoft Teams での対話の種類。
users ID コレクション 呼び出し元が対話が許可されているかどうかを判断するターゲット ユーザーのコレクション。 サポートされている派生型は、 emailIdentityteamworkUserIdentity です。

応答

成功した場合、このアクションは 200 OK 応答コードと応答本文のブール値を返します。

例 1: サインインしたユーザーが自分の ID を使用して同じテナント内の別のユーザーとチャットを作成できるかどうかを判断する

次の例は、委任されたコンテキスト経由で認証されたサインイン ユーザーが、他のユーザーの ID を指定することで、同じテナント内の別のユーザーとのチャットを作成できるかどうかを判断する要求を示しています。

要求

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

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

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

応答

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

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

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

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

例 2: サインインしたユーザーが自分の ID とテナント ID を使用して、別のテナントの別のユーザーとチャットを作成できるかどうかを確認する

次の例は、委任されたコンテキスト経由で認証されたサインイン ユーザーが、他のユーザーの ID とテナント ID を使用して別のテナントの別のユーザーとのチャットを作成できるかどうかを判断する要求を示しています。

要求

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

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

応答

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

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

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

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

例 3: サインインしたユーザーが自分のユーザー プリンシパル名を使用して別のユーザーとのチャットを作成できるかどうかを確認する

次の例は、委任コンテキスト経由で認証されたサインイン ユーザーが、他のユーザーのユーザー プリンシパル名を指定することによって、別のユーザーとのチャットを作成できるかどうかを判断する要求を示しています。 別のテナントのユーザーのユーザー プリンシパル名を指定する場合、 tenantId を指定する必要はありません。

要求

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

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

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

応答

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

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

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

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

例 4: サインイン ユーザーが自分のメールを使用して別のユーザーとチャットを作成できるかどうかを確認する

次の例は、委任コンテキスト経由で認証されたサインイン ユーザーが、他のユーザーのメール アドレスを指定することで、別のユーザーとのチャットを作成できるかどうかを決定する要求を示しています。

要求

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

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

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

応答

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

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

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

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

例 5: サインイン ユーザーが他の 3 人のユーザーとチャットを作成できるかどうかを確認する

次の例は、委任コンテキスト経由で認証されたサインイン ユーザーが、他の 3 人のユーザーとのチャットを作成できるかどうかを判断する要求を示しています。 サポートされている ID の種類を混在して使用します。 この例では、この操作は許可されていません。

要求

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

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

応答

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

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

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

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