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

注:

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

Exchange Online 管理 API の OrganizationConfig エンドポイントは、メールヒントとその他のいくつかの関連するサービス構成に関連するorganization全体の設定を取得します。

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

エンドポイント URL

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

ヒント

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

要求モデル

ヘッダー

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

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

Body

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

改ページ

改ページは使用できません。 Get-OrganizationConfig コマンドレットは、1 つのorganization構成オブジェクトを返します。

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

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

REST エンドポイントを介して Get-OrganizationConfig コマンドレットのパラメーターを使用できません。

応答の概要

注:

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

Get-OrganizationConfig 応答は、organization レベルの設定を表す 1 つの JSON オブジェクトです。次のプロパティが取得されます。

名前: organization構成オブジェクトの Exchange 表示名 (organizationには 1 つだけあります)。
ID: Exchange によって使用される正規 ID (多くの場合、名前の値を反映します)。
Id: organization構成オブジェクトのサービス識別子。
Guid: organization構成オブジェクトの安定した GUID。
MailTipsAllTipsEnabled: すべてのヒントに対してメールヒントが有効かどうかを示します。既定値は True です。
MailTipsExternalRecipientsTipsEnabled: 外部受信者のメールヒントを表示するかどうかを示します。既定値は False です。
MailTipsLargeAudienceThreshold: メールヒントの動作に影響を与える大規模な対象ユーザーのしきい値。既定値は 25 です。

例

例 1:

この例では、メールヒントの設定やコア機能フラグなど、organization全体の構成を返します。

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

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

Last updated on 2025-11-17