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

注:

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

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

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

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

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

Get-OrganizationConfig コマンドレットのパラメーターは、REST エンドポイント経由で使用できません。

応答の概要

注:

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

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

  • 名前: organization 構成オブジェクトの Exchange 表示名 (organization には 1 つしかありません)。
  • ID: Exchange で使用される正規の ID (多くの場合、 Name 値をミラーします)。
  • 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"
      }
    }