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

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

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

前提条件

• ドメイン レジストラーであるパートナーである必要があります。

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

• 顧客 ID です (customer-tenant-id)。 顧客の ID がわからない場合は、パートナー センターで [顧客] ワークスペースを選び、顧客一覧から顧客を選び、[アカウント] を選んで調べることができます。 顧客の [アカウント] ページの [顧客のアカウント情報] セクションで Microsoft ID を探します。 Microsoft ID は、顧客 ID (customer-tenant-id) と同じです。

検証済みドメインの追加

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

カスタムの検証済みドメイン

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

REST 要求

要求の構文

認証方法	要求 URI
POST	{baseURL}/v1/customers/{CustomerTenantId}/verifieddomain HTTP/1.1

URI パラメーター

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

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

要求ヘッダー

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

要求本文

次の表は、要求本文の必須プロパティの説明です。

名前	タイプ	必須	説明
VerifiedDomainName	string	はい	検証済みドメインの名前。
[ドメイン]	object	はい	ドメイン情報を格納します。
DomainFederationSettings	object	はい (AuthenticationType = Federated の場合)	このドメインが Managed ドメインではなく Federated ドメインである場合に使われるドメイン フェデレーション設定。

Domain

この表は、要求本文の必須と省略可能な Domain プロパティの説明です。

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

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

この表は、要求本文の必須と省略可能な DomainFederationSettings プロパティの説明です。

名前	タイプ	必須	説明
ActiveLogOnUri	string	いいえ	リッチ クライアントで使われるログオン URI。 このプロパティは、パートナーの STS 認証 URL です。
DefaultInteractiveAuthenticationMethod	string	いいえ	アプリケーションがユーザーに対話型ログインを求める場合に使う必要がある既定の認証方法を示します。
FederationBrandName	string	いいえ	フェデレーション ブランド名。
IssuerUri	string	はい	証明書の発行者の名前。
LogOffUri	string	はい	ログオフ URI。 このプロパティは、フェデレーション ドメインのサインアウト URI を表します。
MetadataExchangeUri	string	いいえ	リッチ クライアント アプリケーションからの認証に使われるメタデータ交換エンドポイントを指定する URL。
NextSigningCertificate	string	いいえ	今後、ADFS V2 STS が要求に署名する際に使う証明書。 このプロパティは、証明書の base64 エンコード表現です。
OpenIdConnectDiscoveryEndpoint	string	いいえ	フェデレーション IDP STS の OpenID Connect 検出エンドポイント。
PassiveLogOnUri	string	はい	以前のパッシブ クライアントで使われるログオン URI。 このプロパティは、フェデレーション サインイン要求を送信するアドレスです。
PreferredAuthenticationProtocol	string	はい	認証トークンの形式。 たとえば、WsFed のようにします。 サポートされる値: WsFed、Samlp
PromptLoginBehavior	string	はい	プロンプト ログイン動作の種類。 たとえば、TranslateToFreshPasswordAuth のようにします。 サポートされる値: TranslateToFreshPasswordAuth、NativeSupport、Disabled
SigningCertificate	string	はい	ADFS V2 STS が要求に署名するために現在使っている証明書。 このプロパティは、証明書の base64 エンコード表現です。
SigningCertificateUpdateStatus	string	いいえ	署名証明書の更新状態を示します。
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: 7cb67bb7-4750-403d-cc2e-6bc44c52d52c
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 は新しい検証済みドメインの Domain リソースを返します。

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

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

応答の例

HTTP/1.1 201 Created
Content-Length: 206
Content-Type: application/json; charset=utf-8
MS-CorrelationId: 7cb67bb7-4750-403d-cc2e-6bc44c52d52c
MS-RequestId: 312b044d-dc41-4b37-c2d5-7d27322d9654
Date: Tue, 14 Feb 2017 20:06:02 GMT

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