Exchange Online 管理 API の AcceptedDomain エンドポイント

注:

この記事で説明されている機能は現在プレビュー段階であり、すべての組織で利用できるわけではありません。変更される可能性があります。

Exchange Online 管理 API の AcceptedDomain エンドポイントは、organization用に構成された承認済みドメインの一覧を取得します。このエンドポイントは、各ドメインのキープロパティ値を持つドメインオブジェクトのコレクションを返します。

一般的なユースケースは次のとおりです。

メールフロー構成の承認済みドメインを一覧表示します。
構成された各ドメインのプロパティ値を確認します。

Exchange Online 管理 API は、従来の Exchange Web Services (EWS) シナリオを置き換えて、特定の PowerShell コマンドレットを実行するための REST ベースの方法を提供します。詳細については、「Exchange Online 管理 API の概要」を参照してください。

エンドポイント URL

POST https://outlook.office365.com/adminapi/v2.0/<TenantID>/AcceptedDomain

ヒント

「サポートされている環境と基本 URL」の説明に従って、環境のベース URL を使用します。

要求モデル

ヘッダー

Authorization: Bearer <auth token>
Content-Type: application/json
X-AnchorMailbox: <routing hint>

X-AnchorMailbox の値については、「X-AnchorMailbox ルーティングヒント」を参照してください。

Body

{
  "CmdletInput": {
    "CmdletName": "Get-AcceptedDomain",
    "Parameters": {
      "Identity": "<domain name>",           // optional
      "ResultSize": <Integer | "Unlimited">  // optional (pagination)
    }
  }
}

改ページ

ResultSize パラメーターは改ページ位置を制御します。既定では、最大 1,000 件の結果が返されます。

より多くの結果が使用可能な場合、応答には継続 URL を持つ @odata.nextLink プロパティが含まれます。次のページをフェッチするには、同じ本文で @odata.nextLink の URL に新しい POST 要求を発行します。

プロパティの選択

このエンドポイントは、応答内の特定のプロパティのみを返すために、 $select クエリパラメーターをサポートします。以下に例を示します。

POST https://outlook.office365.com/adminapi/v2.0/<TenantID>/AcceptedDomain?$select=DomainName,Default

サポートされているコマンドレットとパラメーター

このエンドポイントでサポートされているコマンドレットは Get-AcceptedDomain です。このエンドポイントの本文内の他のコマンドレットでは、エラーが発生します。

REST エンドポイントでは、次の表で説明されているパラメーターのみを使用できます。

パラメーター	必須	型	説明
Identity	省略可能	文字列	情報を取得する承認済みドメインを指定します。有効な値は、ドメイン名 (contoso.com など) または GUID です。省略され、 ResultSize の対象となる場合、コマンドレットは受け入れられたすべてのドメインを返します。
ResultSize	省略可能	整数または文字列	返される結果の数を制限します。有効な値は、整数 (10 など) または `"Unlimited"`値です。

応答の概要

注:

プレビュー中に、エンドポイントには API 応答に Get-AcceptedDomain コマンドレットの完全な出力が含まれます。パブリックリリースへの移行中、応答は、このセクションに記載されているコアプロパティ (EWS と同等のシナリオに必要なプロパティ) に制限されます。このセクションに記載されているプロパティのみを使用することをお勧めします。使用可能なプロパティに対する変更を文書化します。

応答は、受け入れられたドメインオブジェクトの JSON 配列です。各オブジェクトには、ドメイン構成とメタデータ情報が含まれています。返されるプロパティは次のとおりです。

DomainName: 完全修飾ドメイン名 (FQDN)。たとえば contoso.com です。
AdminDisplayName: ドメインの省略可能なラベル。
DomainType: メールルーティングのドメインモード。たとえば、 Authoritative、 InternalRelay、または ExternalRelay。
名前: 承認済みドメインオブジェクトの一意の Exchange 表示名。
Id: オブジェクトのサービス識別子。
ID: Exchange で使用される正規 ID。多くの場合、 Name 値を反映します。管理操作で使用されます。
Guid: 承認済みドメインオブジェクトのグローバル一意識別子。

例

例 1: 受け入れ済みドメインをすべて表示する:

この例では、ResultSize パラメーターを使用していないため、organization用に構成された最大 1,000 個の承認済みドメインを取得します。

POST /adminapi/v2.0/<TenantID>/AcceptedDomain HTTP/1.1
Host: outlook.office365.com
Authorization: Bearer <auth token>
Content-Type: application/json
X-AnchorMailbox: <Routing Hint>

{
  "CmdletInput": {
    "CmdletName": "Get-AcceptedDomain"
  }
}

例 2: ResultSize を使用して結果を制限する:

次の使用例は、 ResultSize パラメーターを値 1 に設定して、受け入れられた 1 つのドメインに結果を制限します。

POST /adminapi/v2.0/<TenantID>/AcceptedDomain HTTP/1.1
Host: outlook.office365.com
Authorization: Bearer <auth token>
Content-Type: application/json
X-AnchorMailbox: <Routing Hint>

{
  "CmdletInput": {
    "CmdletName": "Get-AcceptedDomain",
    "Parameters": {
      "ResultSize": 1
    }
  }
}

例 3: 特定の承認済みドメインの結果を取得する:

次の使用例は、指定した contoso.com 承認済みドメインの詳細を取得します。

POST /adminapi/v2.0/<TenantID>/AcceptedDomain HTTP/1.1
Host: outlook.office365.com
Authorization: Bearer <auth token>
Content-Type: application/json
X-AnchorMailbox: <Routing Hint>

{
  "CmdletInput": {
    "CmdletName": "Get-AcceptedDomain",
    "Parameters": {
      "Identity": "contoso.com"
    }
  }
}

Last updated on 2025-11-17