既存の顧客の承認済みドメインの一覧に確認済みドメインを追加する

2025-06-26

適切な役割：管理者エージェント

適用対象: パートナーセンター |21Vianet が運営するパートナーセンター |Microsoft Cloud for US Government のパートナーセンター

既存の顧客の承認済みドメインの一覧に検証済みドメインを追加する方法。

[前提条件]

ドメインレジストラーパートナーである必要があります。
パートナーセンター認証で説明されている資格証明。このシナリオでは、スタンドアロンアプリとアプリ + ユーザーの両方の資格情報を使った認証がサポートされています。
顧客 ID です (customer-tenant-id)。顧客の ID がわからない場合は、パートナーセンターで [顧客] ワークスペースを選び、顧客一覧から顧客を選び、[アカウント] を選んで調べることができます。顧客の [アカウント] ページで、[顧客アカウント情報] セクションで Microsoft ID を探します。 Microsoft ID は、顧客 ID (customer-tenant-id) と同じです。

検証済みドメインを追加する

ドメインレジストラーであるパートナーの場合は、 verifieddomain API を使用して、既存の顧客のドメインの一覧に新しいドメインリソースを POST できます。これを行うには、CustomerTenantId を使用して顧客を識別します。 VerifiedDomainName プロパティの値を指定します。必要な名前、機能、AuthenticationType、Status、VerificationMethod のプロパティを含むドメインリソースを要求に渡します。新しいドメインがフェデレーションドメインであることを指定するには、ドメインリソースの AuthenticationType プロパティを Federatedに設定し、要求に DomainFederationSettings リソースを含めます。メソッドが成功した場合、応答には、新しい検証済みドメインのドメインリソースが含まれます。

カスタム検証済みドメインを追加する

カスタム検証済みドメイン ( onmicrosoft.com に登録されていないドメイン) を追加する場合は、 CustomerUser.immutableId プロパティを、ドメインを追加する顧客の一意の ID 値に設定する必要があります。この一意の識別子は、ドメインが検証される際の検証プロセス中に必要になります。顧客ユーザーアカウントの詳細については、「顧客のユーザーアカウントを作成する」を参照してください。

REST 要求を送信する

REST 要求を送信するには、次の構文を使用します。

リクエスト構文

メソッド	要求 URI
POST	{baseURL}/v1/customers/{CustomerTenantId}/verifieddomain HTTP/1.1

URI パラメーター

検証済みドメインを追加する顧客を指定するには、次のクエリパラメーターを使用します。

名前	タイプ	必須	説明
CustomerTenantId (顧客テナントID)	guid	年	値は、顧客を指定できる GUID 形式の CustomerTenantId です。

要求ヘッダー

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

要求本文

次の表では、要求本文で必要なプロパティについて説明します。

名前	タイプ	必須	説明
確認済みドメイン名	ひも	イエス	検証済みのドメイン名。
[ドメイン]	オブジェクト	イエス	ドメイン情報を格納します。
DomainFederationSettings	オブジェクト	はい (AuthenticationType = `Federated`の場合)	ドメインが`Managed` ドメインではなく、`Federated` ドメインの場合に使用されるドメインフェデレーション設定。

ドメインのプロパティについて

次の表では、要求本文の必須および省略可能な Domain プロパティについて説明します。

名前	タイプ	必須	説明
認証タイプ	ひも	イエス	ドメインが `Managed` ドメインか `Federated` ドメインかを定義します。サポートされる値: `Managed`、`Federated`。
能力	ひも	イエス	ドメイン機能を指定します。たとえば、`Email` のようにします。
IsDefault	null 許容のブール値	いいえ	ドメインがテナントの既定のドメインかどうかを示します。サポートされる値: `True`、`False`、`Null`。
IsInitial	null 許容のブール値	いいえ	ドメインが初期ドメインかどうかを示します。サポートされる値: `True`、`False`、`Null`。
名前	ひも	イエス	ドメイン名。
RootDomain	ひも	いいえ	ルートドメインの名前。
ステータス	ひも	イエス	ドメインの状態。たとえば、`Verified` のようにします。サポートされる値: `Unverified`、`Verified`、`PendingDeletion`。
検証方法	ひも	イエス	ドメイン検証方法の種類。サポートされる値: `None`、`DnsRecord`、`Email`。

ドメインフェデレーションの設定

次の表では、要求本文で必要な DomainFederationSettings プロパティと省略可能な DomainFederationSettings プロパティについて説明します。

名前	タイプ	必須	説明
ActiveLogOnUri	ひも	いいえ	リッチクライアントで使用されるサインイン URI。このプロパティは、パートナーの STS 認証 URL です。
デフォルトのインタラクティブ認証方法	ひも	いいえ	アプリケーションでユーザーに対話型サインインが必要な場合に使用する既定の認証方法を示します。
FederationBrandName	ひも	いいえ	フェデレーションブランド名。
IssuerUri	ひも	イエス	証明書の発行者の名前。
LogOffUri	ひも	イエス	ログオフ URI。このプロパティは、フェデレーションドメインのサインアウト URI を表します。
メタデータ交換URI	ひも	いいえ	リッチクライアントアプリケーションからの認証に使用されるメタデータ交換エンドポイントを指定する URL。
NextSigningCertificate	ひも	いいえ	要求に署名するために ADFS V2 STS によって今後使用される証明書。このプロパティは、証明書の base64 でエンコードされた表現です。
OpenIdConnectDiscoveryEndpoint	ひも	いいえ	フェデレーション IDP STS の OpenID Connect 検出エンドポイント。
PassiveLogOnUri	ひも	イエス	以前のパッシブクライアントで使用されるログオン URI。このプロパティは、フェデレーションサインイン要求を送信するアドレスです。
優先認証プロトコル	ひも	イエス	認証トークンの形式。たとえば、`WsFed` のようにします。サポートされる値: `WsFed`、`Samlp`
プロンプトログイン動作	ひも	イエス	プロンプトログイン動作の種類。たとえば、`TranslateToFreshPasswordAuth` のようにします。サポートされる値: `TranslateToFreshPasswordAuth`、`NativeSupport`、`Disabled`
署名証明書	ひも	イエス	要求に署名するために ADFS V2 STS によって現在使用されている証明書。このプロパティは、証明書の base64 でエンコードされた表現です。
署名証明書更新ステータス	ひも	いいえ	署名証明書の更新状態を示します。
SigningCertificateUpdateStatus（署名証明書更新ステータス）	null 許容のブール値	いいえ	IDP STS が MFA をサポートしているかどうかを示します。サポートされる値: `True`、`False`、`Null`。

要求の例

POST https://api.partnercenter.microsoft.com/v1/customers/{CustomerTenantId}/verifieddomain HTTP/1.1
Authorization: Bearer <token>
Accept: application/json, text/plain, */*
MS-RequestId: 312b044d-dc41-4b37-c2d5-7d27322d9654
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
Content-Type: application/json;charset=utf-8
X-Locale: "en-US"

{
    "VerifiedDomainName": "Example.com",
    "Domain": {
        "AuthenticationType": "Federated",
        "Capability": "Email",
        "IsDefault": Null,
        "IsInitial": Null,
        "Name": "Example.com",
        "RootDomain": null,
        "Status": "Verified",
        "VerificationMethod": "None"
    },
    "DomainFederationSettings": {
        "ActiveLogOnUri": "https://sts.microsoftonline.com/FederationPassive/",
        "DefaultInteractiveAuthenticationMethod": "http://schemas.microsoft.com/ws/2008/06/identity/authenticationmethod/password",
        "FederationBrandName": "FederationBrandName",
        "IssuerUri": "Example.com",
        "LogOffUri": "https://sts.microsoftonline.com/FederationPassive/",
        "MetadataExchangeUri": null,
        "NextSigningCertificate": null,
        "OpenIdConnectDiscoveryEndpoint": "https://sts.contoso.com/adfs/.well-known/openid-configuration",
        "PassiveLogOnUri": "https://sts.microsoftonline.com/Trust/2005/UsernameMixed",
        "PreferredAuthenticationProtocol": "WsFed",
        "PromptLoginBehavior": "TranslateToFreshPasswordAuth",
        "SigningCertificate": <Certificate Signature goes here>,
        "SigningCertificateUpdateStatus": null,
        "SupportsMfa": true
    }
}

REST 応答を確認する

成功した場合、この API は新しい検証済みドメインのドメインリソースを返します。

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

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

応答の例

HTTP/1.1 201 Created
Content-Length: 206
Content-Type: application/json; charset=utf-8
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 312b044d-dc41-4b37-c2d5-7d27322d9654
Date: Tue, 14 Feb 2017 20:06:02 GMT

{
    "authenticationType": "federated",
    "capability": "email",
    "isDefault": false,
    "isInitial": null,
    "name": "Example.com",
    "status": "verified",
    "verificationMethod": "dns_record"
}

パートナーセンター REST API とは