Mevcut bir müşterinin onaylı etki alanları listesine doğrulanmış etki alanı ekleme

Makale
09/26/2024

Şunlar için geçerlidir: İş Ortağı Merkezi | 21Vianet tarafından işletilen İş Ortağı Merkezi | ABD Kamu için Microsoft Bulut İş Ortağı Merkezi

Mevcut bir müşterinin onaylı etki alanları listesine doğrulanmış etki alanı ekleme.

Önkoşullar

Etki alanı kayıt şirketi olan bir İş Ortağı olmanız gerekir.
İş Ortağı Merkezi kimlik doğrulamasında açıklandığı gibi kimlik bilgileri. Bu senaryo hem tek başına Uygulama hem de Uygulama+Kullanıcı kimlik bilgileriyle kimlik doğrulamayı destekler.
Müşteri kimliği (customer-tenant-id). Müşterinin kimliğini bilmiyorsanız, İş Ortağı Merkezi'nde Müşteriler çalışma alanını, ardından müşteri listesinden müşteriyi ve ardından Hesap'ı seçerek bunu arayabilirsiniz. Müşterinin Hesap sayfasında, Müşteri Hesabı Bilgileri bölümünde Microsoft Kimliği'ni arayın. Microsoft Kimliği, müşteri kimliğiyle (customer-tenant-id) aynıdır.

Doğrulanmış etki alanı ekleme

Etki alanı kayıt şirketi olan bir İş Ortağıysanız API'yi kullanarak verifieddomain var olan bir müşterinin etki alanları listesine yeni bir Etki Alanı kaynağı GÖNDERebilirsiniz. Bunu yapmak için CustomerTenantId değerini kullanarak müşteriyi tanımlayın. VerifiedDomainName özelliği için bir değer belirtin. İstekte gerekli Ad, Yetenek, AuthenticationType, Durum ve VerificationMethod özelliklerini içeren bir Etki Alanı kaynağı geçirin. Yeni Etki Alanının federasyon etki alanı olduğunu belirtmek için, Etki alanı kaynağındaki AuthenticationType özelliğini olarak ayarlayın ve İstek'e Federatedbir DomainFederationSettings kaynağı ekleyin. 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ı

onmicrosoft.com kaydedilmemiş bir etki alanı olan özel bir doğrulanmış etki alanı eklerken CustomerUser.immutableId özelliğini etki alanını eklediğiniz müşteri için benzersiz bir kimlik değerine ayarlamanız gerekir. Bu benzersiz tanımlayıcı, etki alanı doğrulanırken 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

Metot	İstek URI'si
POST	{baseURL}/v1/customers/{CustomerTenantId}/verifieddomain HTTP/1.1

URI parametresi

Doğrulanmış etki alanı eklediğiniz müşteriyi belirtmek için aşağıdaki sorgu parametresini kullanın.

Adı	Tür	Zorunlu	Açıklama
CustomerTenantId	guid	Y	Değer, müşteri belirtmenize olanak tanıyan GUID biçimli customerTenantId değeridir.

İstek üst bilgileri

Daha fazla bilgi için bkz . İş Ortağı Merkezi REST üst bilgileri.

Request body

Bu tablo, istek gövdesindeki gerekli özellikleri açıklar.

Adı	Tür	Zorunlu	Açıklama
VerifiedDomainName	string	Yes	Doğrulanmış etki alanı adı.
Alan	nesne	Yes	Etki alanı bilgilerini içerir.
DomainFederationSettings	nesne	Evet (AuthenticationType = `Federated`ise )	Etki alanı etki alanı değil`Managed`, etki `Federated` alanıysa kullanılacak etki alanı federasyon ayarları.

Domain

Bu tabloda, istek gövdesindeki gerekli ve isteğe bağlı Etki alanı özellikleri açıklanmaktadır.

Adı	Tür	Zorunlu	Açıklama
AuthenticationType	string	Yes	Etki alanının etki `Managed` alanı mı yoksa `Federated` etki alanı mı olduğunu tanımlar. Desteklenen değerler: `Managed`, `Federated`.
Özellik	string	Yes	Etki alanı özelliğini belirtir. Örneğin, `Email`.
IsDefault	null atanabilir boole değeri	Hayır	Etki alanının kiracı için varsayılan etki alanı olup olmadığını gösterir. Desteklenen değerler: `True`, `False`, `Null`.
IsInitial	null atanabilir boole değeri	Hayır	Etki alanının ilk etki alanı olup olmadığını gösterir. Desteklenen değerler: `True`, `False`, `Null`.
Ad	string	Yes	Etki alanı adı.
RootDomain	Dize	Hayır	Kök etki alanının adı.
Durum	string	Yes	Etki alanı durumu. Örneğin, `Verified`. Desteklenen değerler: `Unverified`, `Verified`, `PendingDeletion`.
VerificationMethod	string	Yes	Etki alanı doğrulama yöntemi türü. Desteklenen değerler: `None`, `DnsRecord`, `Email`.

Etki alanı federasyon ayarları

Bu tabloda, istek gövdesindeki gerekli ve isteğe bağlı DomainFederationSettings özellikleri açıklanmaktadır.

Adı	Tür	Zorunlu	Açıklama
ActiveLogOnUri	Dize	Hayır	Zengin istemciler tarafından kullanılan oturum açma URI'si. Bu özellik, İş Ortağının STS Kimlik Doğrulama URL'sidir.
DefaultInteractiveAuthenticationMethod	Dize	Hayır	Bir uygulama kullanıcının etkileşimli oturum açma bilgilerini gerektirdiğinde kullanılması gereken varsayılan kimlik doğrulama yöntemini gösterir.
FederationBrandName	Dize	Hayır	Federasyon marka adı.
VerenUri	string	Yes	Sertifikaları verenin adı.
LogOffUri	string	Yes	Oturum kapatma URI'si. Bu özellik, federasyon etki alanı oturum kapatma URI'sini açıklar.
MetadataExchangeUri	Dize	Hayır	Zengin istemci uygulamalarından kimlik doğrulaması için kullanılan meta veri değişim uç noktasını belirten URL.
NextSigningCertificate	Dize	Hayır	ADFS V2 STS tarafından talepleri imzalamak için gelecek için kullanılan sertifika. Bu özellik, sertifikanın base64 kodlanmış bir gösterimidir.
OpenIdConnectDiscoveryEndpoint	Dize	Hayır	Federasyon IDP STS'sinin OpenID Connect Bulma Uç Noktası.
PassiveLogOnUri	string	Yes	Eski pasif İstemciler tarafından kullanılan oturum açma URI'si. Bu özellik, federasyon oturum açma isteklerini gönderme adresidir.
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	ADFS V2 STS tarafından talepleri imzalamak için şu anda kullanılan sertifika. Bu özellik, sertifikanın base64 kodlanmış bir gösterimidir.
SigningCertificateUpdateStatus	Dize	Hayır	İmzalama sertifikasının güncelleştirme durumunu gösterir.
SigningCertificateUpdateStatus	null atanabilir boole değeri	Hayır	IDP STS'nin MFA'yi 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: 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 yanıtı

Başarılı olursa, bu API doğrulanmış yeni 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ılı veya başarısız olduğunu ve diğer hata ayıklama bilgilerini gösteren bir HTTP durum koduyla birlikte gelir. Bu kodu, hata türünü ve diğer parametreleri okumak için bir ağ izleme aracı kullanın. Tam liste için bkz . İş 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: 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"
}

Aracılığıyla paylaş