user: translateExchangeIds

名前空間: microsoft.graph

重要

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

Outlook 関連リソースの ID の形式を変換します。

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

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

アクセス許可

次の表は、サポートされている各リソースの種類でこの API を呼び出すために必要な最小特権のアクセス許可を示しています。 ベスト プラクティスに従って、最低特権のアクセス許可を要求します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

サインインしているユーザーの Exchange ID を翻訳する権限:

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

ユーザーの Exchange ID を翻訳する権限:

POST /users/{id | userPrincipalName}/translateExchangeIds
アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) User.ReadBasic.All AgentIdUser.ReadWrite.All、AgentIdUser.ReadWrite.IdentityParentedBy、User.Read、User.Read.All、User.ReadWrite、User.ReadWrite.All
委任 (個人用 Microsoft アカウント) User.Read User.ReadWrite
アプリケーション User.Read.All AgentIdUser.ReadWrite.All、AgentIdUser.ReadWrite.IdentityParentedBy、User.ReadWrite.All

HTTP 要求

委任された (/me) アクセス許可を使用してサインインしているユーザーの Exchange ID を翻訳するには、次の手順を実行します。

POST /me/translateExchangeIds

委任されたアクセス許可またはアプリケーションのアクセス許可を使用して Exchange ID を翻訳するには、次の操作を行います。

POST /users/{id | userPrincipalName}/translateExchangeIds

要求ヘッダー

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

要求本文

パラメーター 型 説明
inputIds String collection 変換する識別子のコレクション。 コレクション内のすべての識別子は、同じソース ID の種類を持つ必要があり、同じメールボックス内のアイテム用である必要があります。 このコレクションの最大サイズは 1,000 文字列です。
sourceIdType exchangeIdFormat inputIds パラメーター内の識別子の ID タイプ。
targetIdType exchangeIdFormat 変換先に要求された ID タイプ。

exchangeIdFormat 値

メンバー 説明
entryId MAPI クライアントで使用されるバイナリ エントリ ID 形式。
ewsId Exchange Web サービス クライアントで使用される ID 形式。
immutableEntryId バイナリ MAPI 互換の変更 ID 形式。
restId Microsoft Graph で使用される既定の ID 形式。
restImmutableEntryId Microsoft Graph で使用される不変 ID 形式。

バイナリ形式 (entryId と immutableEntryId) は、URL セーフの base64 でエンコードされます。 URL の安全性は、次のようにバイナリ データの base64 エンコードを変更することによって実装されます。

  • + を - に置き換え
  • / を _ に置き換え
  • 末尾のパディング文字を削除する (=)
  • 文字列の末尾に、元の (0、 1、または 2) に含まれるパディング文字の数を示す整数を追加します

応答

成功した場合、このメソッドは応答コード 200 OK 応答本文で convertIdResult コレクションを返します。

例

次の例は、複数の識別子を通常の REST API 形式 (restId) から REST 不変形式 (restImmutableEntryId) に変換する方法を示しています。

要求

要求の例を次に示します。

POST https://graph.microsoft.com/beta/me/translateExchangeIds
Content-Type: application/json

{
  "inputIds" : [
    "{rest-formatted-id-1}",
    "{rest-formatted-id-2}"
  ],
  "sourceIdType": "restId",
  "targetIdType": "restImmutableEntryId"
}

応答

応答の例を次に示します

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

{
  "value": [
    {
      "sourceId": "{rest-formatted-id-1}",
      "targetId": "{rest-immutable-formatted-id-1}"
    },
    {
      "sourceId": "{rest-formatted-id-2}",
      "targetId": "{rest-immutable-formatted-id-2}"
    }
  ]
}