顧客のカスタム ドメインを取得する

  • [アーティクル]

適用対象: パートナー センター

CustomDomain リソースを取得します。

パートナー センターで新しい カスタム アカウントが作成されると一意のドメインが割り当てられます。 このドメインは、顧客を識別するために使用できます。また、メールボックスのセットアップなどの他の目的にも使用できます。

前提条件

  • パートナー センターの認証に関するページで説明している資格情報。 このシナリオでは、アプリとユーザーの資格情報またはアプリ単独の認証がサポートされます。

  • 顧客 ID です (customer-tenant-id)。 顧客の ID がわからない場合は、パートナー センターで検索できます。 パートナー センターのホーム ページから [顧客] ワークスペースを選択します。 [顧客一覧] から顧客を選択した後、[アカウント] を選択します。 顧客の [アカウント] ページの [顧客アカウントの詳細セクション] で Microsoft ID を探します。 Microsoft ID は、顧客 ID (customer-tenant-id) と同じです。

重要

この API を呼び出すには GDAP ロールが必要です。 DAP はサポートされていません。 パートナー認証は引き続き必要です (AdminAgent/HelpDeskAgent/SalesAgent)

GDAP ロール

次の GDAP ロールのうち少なくとも 1 つが必要です。

  • ディレクトリ ライター
  • グローバル閲覧者
  • ドメイン管理者

REST 要求

要求の構文

認証方法 要求 URI
GET {baseURL}/v1/customers/{customer-tenant-id}/customDomains HTTP/1.1

URI パラメーター

特定の顧客に対して次のクエリ パラメーターを使用します。

名前 タイプ Required 説明
customer-tenant-id guid 年 この値は、GUID 形式の customer-tenant-id で、これによってリセラーは、リセラーに属する特定の顧客の結果をフィルター処理できます。

要求ヘッダー

詳細については、「パートナー センター REST ヘッダー」を参照してください。

要求本文

なし。

要求の例

GET https://api.partnercenter.microsoft.com/v1/customers/{customer-tenant-id}/customDomains HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-CorrelationId: a176c585-b5de-4d65-824c-67a6deb45cd9
MS-RequestId: 74ca1db9-df92-41c6-a362-a16433b0542b

REST 応答

成功した場合、このメソッドは応答本文でカスタム ドメイン リソースを返します。

応答の成功とエラーのコード

各応答には、成功または失敗とその他のデバッグ情報を示す HTTP 状態コードが付属しています。 ネットワーク トレース ツールを使用して、このコード、エラーの種類、およびその他のパラメーターを読み取ります。 完全な一覧については、エラー コードに関するページを参照してください。

応答の例

HTTP/1.1 200 OK
Content-Length: 1530
Content-Type: application/json; charset=utf-8
MS-CorrelationId: a176c585-b5de-4d65-824c-67a6deb45cd9
MS-RequestId: 74ca1db9-df92-41c6-a362-a16433b0542b

["contosco.onmicrosoft.com"]

関連するコンテンツ