將已驗證的網域新增至現有客戶的已核准網域清單

文章
09/26/2024

適用於：合作夥伴中心 |由 21Vianet 營運的合作夥伴中心 |美國政府Microsoft雲端合作夥伴中心

如何將已驗證的網域新增至現有客戶的已核准網域清單。

必要條件

您必須是網域註冊機構的合作夥伴。
認證，如合作夥伴中心驗證所述。此案例支援使用獨立應用程式和 App+使用者認證進行驗證。
客戶識別碼 (customer-tenant-id)。如果您不知道客戶的標識碼，您可以在合作夥伴中心中選取 [客戶] 工作區，然後從客戶清單中查看客戶，然後從 [帳戶]。在客戶的 [帳戶] 頁面上，在 [客戶帳戶資訊] 區段中尋找Microsoft標識碼。 Microsoft 識別碼與客戶識別碼 (customer-tenant-id) 相同。

新增已驗證的網域

如果您是網域註冊機構的合作夥伴，您可以使用 verifieddomain API 將新的網域資源張貼至現有客戶的網域清單。若要這樣做，請使用其 CustomerTenantId 來識別客戶。指定 VerifiedDomainName 屬性的值。在要求中傳遞包含必要名稱、功能、AuthenticationType、Status 和 AuthenticationMethod 屬性的網域資源。若要指定新的網域是同盟網域，請將 Domain 資源中的 AuthenticationType 屬性設定為 Federated，並在 Request 中包含 DomainFederationSettings 資源。如果方法成功，回應會包含新已驗證網域的網域資源。

自訂已驗證的網域

新增自定義已驗證網域時，未在 onmicrosoft.com 註冊的網域，您必須將 CustomerUser.immutableId 屬性設定為您新增網域之客戶的唯一標識符值。當驗證網域時，驗證程序期間需要此唯一標識符。如需客戶用戶帳戶的詳細資訊，請參閱為客戶建立用戶帳戶。

REST 要求

要求語法

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

URI 參數

使用下列查詢參數來指定您要為其新增已驗證網域的客戶。

名稱	類型	必要	描述
CustomerTenantId	guid	Y	此值是 GUID 格式的 CustomerTenantId ，可讓您指定客戶。

要求標頭

如需詳細資訊，請參閱合作夥伴中心 REST 標頭。

要求本文

下表描述要求本文中的必要屬性。

名稱	類型	必要	描述
VerifiedDomainName	字串	Yes	已驗證的功能變數名稱。
網域	object	Yes	包含網域資訊。
DomainFederationSettings	object	是（如果 AuthenticationType = `Federated`）	如果網域是 `Federated` 網域而非 `Managed` 網域，則要使用的網域同盟設定。

網域

下表描述要求本文中的必要和選擇性網域屬性。

名稱	類型	必要	描述
AuthenticationType	字串	Yes	定義網域是 `Managed` 網域或 `Federated` 網域。支援的值：`Managed`、`Federated`。
功能	字串	Yes	指定網域功能。例如： `Email` 。
IsDefault	可為 null 的布爾值	No	指出網域是否為租用戶的預設網域。支援的值：`True`、、。`FalseNull`
IsInitial	可為 null 的布爾值	No	指出網域是否為初始網域。支援的值：`True`、、。`FalseNull`
名稱	字串	Yes	功能變數名稱。
RootDomain	字串	No	根域的名稱。
狀態	字串	Yes	網域狀態。例如： `Verified` 。支援的值：`Unverified`、、。`VerifiedPendingDeletion`
VerificationMethod	字串	Yes	網域驗證方法類型。支援的值：`None`、、。`DnsRecordEmail`

網域同盟設定

下表描述要求本文中的必要和選擇性 DomainFederationSettings 屬性。

名稱	類型	必要	描述
ActiveLogOnUri	字串	No	豐富型用戶端所使用的登入URI。此屬性是合作夥伴的 STS 驗證 URL。
DefaultInteractiveAuthenticationMethod	字串	No	指出當應用程式要求使用者具有互動式登入時，應該使用的預設驗證方法。
FederationBrandName	字串	No	同盟品牌名稱。
IssuerUri	字串	Yes	憑證簽發者的名稱。
LogOffUri	字串	Yes	註銷 URI。此屬性描述同盟網域註銷URI。
MetadataExchangeUri	字串	No	URL，指定用於從豐富用戶端應用程式進行驗證的元數據交換端點。
NextSigningCertificate	字串	No	ADFS V2 STS 用來簽署宣告的未來憑證。這個屬性是憑證的base64編碼表示法。
OpenIdConnectDiscoveryEndpoint	字串	No	同盟 IDP STS 的 OpenID Connect 探索端點。
PassiveLogOnUri	字串	Yes	舊版被動用戶端所使用的登入URI。這個屬性是傳送同盟登入要求的位址。
PreferredAuthenticationProtocol	字串	Yes	驗證令牌的格式。例如： `WsFed` 。支援的值：`WsFed`、`Samlp`
PromptLoginBehavior	字串	Yes	提示登入行為類型。例如： `TranslateToFreshPasswordAuth` 。支援的值：`TranslateToFreshPasswordAuth`、、 `NativeSupportDisabled`
SigningCertificate	字串	Yes	ADFS V2 STS 目前用來簽署宣告的憑證。這個屬性是憑證的base64編碼表示法。
SigningCertificateUpdateStatus	字串	No	指出簽署憑證的更新狀態。
SigningCertificateUpdateStatus	可為 null 的布爾值	No	指出IDP STS是否支援 MFA。支援的值：`True`、、。`FalseNull`

要求範例

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"
}

分享方式：