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

注:

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

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

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

メールフロー構成に使用できるドメインを一覧表示します。
構成済み各ドメインのプロパティ値を確認します。

Exchange Online 管理 API は、REST ベースで特定の PowerShell コマンドレットを実行する方法を提供し、従来の Exchange Web サービス (EWS) シナリオを置き換えます。詳細については、「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"
    }
  }
}

最終更新: 2026-09-25