Mevcut bir müşteri için onaylanmış etki alanları listesine doğrulanmış bir etki alanı ekleme
Uygulama:İş Ortağı Merkezi | İş Ortağı Merkezi 21Vianet | İş Ortağı Merkezi Microsoft Bulut Almanya için | İş Ortağı Merkezi için Microsoft Cloud for US Government
Mevcut bir müşteri için onaylı etki alanları listesine doğrulanmış etki alanı ekleme.
Önkoşullar
Etki alanı kayıt şirketi olan bir İş Ortağınız olmalıdır.
kimlik doğrulamasında açıklandığı gibi İş Ortağı Merkezi bilgileri. Bu senaryo hem tek başına Uygulama hem de Uygulama+Kullanıcı kimlik bilgileriyle kimlik doğrulamasını destekler.
Müşteri kimliği (
customer-tenant-id). Müşterinin kimliğini bilmiyorsanız bu kimliği panoda İş Ortağı Merkezi. İş Ortağı Merkezi'den CSP'yi ve ardından Müşteriler'i seçin. Müşteri listesinden müşteriyi ve ardından Hesap'ı seçin. Müşterinin Hesap sayfasında Müşteri Hesabı Bilgileri bölümünde MicrosoftKimliği'ne bakın. Microsoft Kimliği, müşteri kimliği () ilecustomer-tenant-idaynıdır.
Doğrulanmış etki alanı ekleme
Etki alanı kayıt şirketi olan bir İş Ortağınız varsa API'yi kullanarak mevcut bir müşterinin etki alanları listesine yeni bir Etki alanı verifieddomain kaynağı ekleyebilirsiniz. verifieddomain Bunu yapmak için CustomerTenantId'sini kullanarak müşteriyi tanıyın. VerifiedDomainName özelliği için bir değer belirtin. İstekte gerekli Name, Capability, AuthenticationType, Status ve VerificationMethod özelliklerine sahip bir Etki alanı kaynağı girin. Yeni Etki Alanının federasyon etki alanı olduğunu belirtmek için, Etki alanı kaynağında AuthenticationType özelliğini olarak ayarlayın ve İstek'e bir DomainFederationSettings kaynağı dahil ederek. Yöntem başarılı olursa Yanıt, yeni doğrulanmış etki alanı için bir Etki alanı kaynağı içerir.
Özel doğrulanmış etki alanları
Özel bir doğrulanmış etki alanı eklerken, onmicrosoft.comüzerinde kayıtlı olmayan bir etki alanı, CustomerUser.immutableId özelliğini etki alanını eklemekte olan müşteri için benzersiz bir kimlik değerine ayarlamış olur. Bu benzersiz tanımlayıcı, etki alanı doğrulandığında doğrulama işlemi sırasında gereklidir. Müşteri kullanıcı hesapları hakkında daha fazla bilgi için bkz. Müşteri için kullanıcı hesapları oluşturma.
REST isteği
İstek söz dizimi
| Yöntem | İstek URI'si |
|---|---|
| POST | {baseURL}/v1/customers/{CustomerTenantId}/verifieddomain HTTP/1.1 |
URI parametresi
Doğrulanmış bir etki alanı eklemekte olduğunu müşteriyi belirtmek için aşağıdaki sorgu parametresini kullanın.
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| CustomerTenantId | guid | Y | Değer, müşteri belirtmenize olanak sağlayan GUID biçiminde bir CustomerTenantId değeridir. |
İstek üst bilgileri
Daha fazla bilgi için bkz. İş Ortağı Merkezi REST üst bilgileri.
İstek gövdesi
Bu tablo, istek gövdesinde gerekli özellikleri açıklar.
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| VerifiedDomainName | string | Yes | Doğrulanmış etki alanı adı. |
| Etki alanı | object | Yes | Etki alanı bilgilerini içerir. |
| DomainFederationSettings | object | Evet (AuthenticationType = Federated ise) |
Etki alanı bir etki alanı değil etki alanı ise Federated kullanılacak etki alanı federasyon Managed ayarları. |
Etki alanı
Bu tablo, istek gövdesinde gerekli ve isteğe bağlı Etki alanı özelliklerini açıklar.
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| Authenticationtype | string | Yes | Etki alanının bir etki alanı mı Managed yoksa etki alanı mı olduğunu Federated tanımlar. Desteklenen değerler: Managed , Federated . |
| Özellik | string | Yes | Etki alanı özelliğini belirtir. Örneğin, Email. |
| Isdefault | null değere sahip boole değeri | No | Etki alanının kiracı için varsayılan etki alanı olup olmadığını gösterir. Desteklenen değerler: True , False , Null . |
| IsInitial | null değere sahip boole değeri | No | Etki alanının bir ilk etki alanı olup olmadığını gösterir. Desteklenen değerler: True , False , Null . |
| Name | string | Yes | Etki alanı adı. |
| RootDomain | dize | No | Kök etki alanının adı. |
| Durum | string | Yes | Etki alanı durumu. Örneğin, Verified. Desteklenen değerler: Unverified , Verified , PendingDeletion . |
| Doğrulamaları Icationmethod | string | Yes | Etki alanı doğrulama yöntemi türü. Desteklenen değerler: None , DnsRecord , Email . |
Etki alanı Federasyon ayarları
Bu tabloda, istek gövdesinde gerekli ve isteğe bağlı Domainfederationsettings özellikleri açıklanmaktadır.
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| ActiveLogOnUri | dize | No | Zengin istemciler tarafından kullanılan oturum açma URI 'SI. Bu özellik, ortağın STS kimlik doğrulama URL 'sidir. |
| Defaultınteractiveauthenticationmethod | dize | No | Bir uygulama kullanıcının etkileşimli oturum açmasını gerektirdiğinde kullanılması gereken varsayılan kimlik doğrulama yöntemini gösterir. |
| FederationBrandName | dize | No | Federasyon markası adı. |
| Issueruri | string | Yes | Sertifika verenin adı. |
| LogOffUri | string | Yes | Oturum kapatma URI 'SI. Bu özellik, Federasyon etki alanı oturum açma URI 'sini açıklar. |
| MetadataExchangeUri | dize | No | Zengin istemci uygulamalarından kimlik doğrulaması için kullanılan meta veri değişim uç noktasını belirten URL. |
| NextSigningCertificate | dize | No | Daha sonra gelen ve ADFS v2 STS tarafından talepleri imzalamak için kullanılan sertifika. Bu özellik, sertifikanın Base64 olarak kodlanmış bir gösterimidir. |
| Openıdconnectdiscoveryendpoint | dize | No | federal ıdp STS 'nin openıd Bağlan bulma uç noktası. |
| PassiveLogOnUri | string | Yes | Eski pasif Istemciler tarafından kullanılan oturum açma URI 'SI. Bu özellik, Federasyon oturum açma isteklerini göndermek için olan adrestir. |
| PreferredAuthenticationProtocol | string | Yes | Kimlik doğrulama belirtecinin biçimi. Örneğin, WsFed. Desteklenen değerler: WsFed , Samlp |
| PromptLoginBehavior | string | Yes | İstem oturum açma davranışı türü. Örneğin, TranslateToFreshPasswordAuth. Desteklenen değerler: TranslateToFreshPasswordAuth , NativeSupport , Disabled |
| SigningCertificate | string | Yes | Şu anda ADFS v2 STS tarafından talepleri imzalamak için kullanılan sertifika. Bu özellik, sertifikanın Base64 olarak kodlanmış bir gösterimidir. |
| SigningCertificateUpdateStatus | dize | No | Imzalama sertifikasının güncelleştirme durumunu gösterir. |
| SigningCertificateUpdateStatus | null yapılabilir Boole | No | IDP STS 'nin MFA 'yı destekleyip desteklemediğini gösterir. Desteklenen değerler: True , False , Null . |
İstek örneği
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 yanıtı
Başarılı olursa, bu API yeni doğrulanmış etki alanı için bir etki alanı kaynağı döndürür.
Yanıt başarısı ve hata kodları
Her yanıt başarı veya başarısızlık ve ek hata ayıklama bilgilerini gösteren bir HTTP durum kodu ile gelir. Bu kodu, hata türünü ve ek parametreleri okumak için bir ağ izleme aracı kullanın. Tam liste için bkz. Iş ortağı MERKEZI Rest hata kodları.
Yanıt örneği
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"
}