Přidání ověřené domény do seznamu schválených domén pro existujícího zákazníka
Platí pro: Partnerské centrum | Partnerské centrum provozované společností 21Vianet | Partnerské centrum pro Microsoft Cloud for US Government
Postup přidání ověřené domény do seznamu schválených domén pro existujícího zákazníka
Požadavky
Musíte být partner, který je doménovým registrátorem.
Přihlašovací údaje, jak je popsáno v tématu Ověřování v Partnerském centru. Tento scénář podporuje ověřování pomocí samostatných přihlašovacích údajů aplikace i aplikace a uživatele.
ID zákazníka (
customer-tenant-id
). Pokud ID zákazníka neznáte, můžete ho vyhledat v Partnerském centru tak, že vyberete pracovní prostor Zákazníci , pak zákazníka ze seznamu zákazníků a pak Účet. Na stránce Účet zákazníka vyhledejte ID Microsoft v části Informace o účtu zákazníka . ID Microsoftu je stejné jako ID zákazníka (customer-tenant-id
).
Přidání ověřené domény
Pokud jste partner, který je doménovým registrátorem, můžete pomocí verifieddomain
rozhraní API ODESLAT nový prostředek domény do seznamu domén pro stávajícího zákazníka. K tomu použijte k identifikaci zákazníka jeho ID zákazníka. Zadejte hodnotu vlastnosti VerifiedDomainName. Předejte prostředek domény v požadavku se zahrnutými požadovanými vlastnostmi Name ( Název), Capability (Schopnost), AuthenticationType (Typ ověřování), Status (Stav) a VerificationMethod (Ověřovacímethod). Pokud chcete určit, že nová doména je federovaná doména, nastavte vlastnost AuthenticationType v prostředku Domain na Federated
a do žádosti zahrňte prostředek DomainFederationSettings . Pokud je metoda úspěšná, bude odpověď obsahovat prostředek domény pro novou ověřenou doménu.
Vlastní ověřené domény
Při přidávání vlastní ověřené domény, domény, která není zaregistrovaná na onmicrosoft.com, musíte nastavit vlastnost CustomerUser.immutableId na jedinečnou hodnotu ID pro zákazníka, pro kterého doménu přidáváte. Tento jedinečný identifikátor se vyžaduje během procesu ověřování při ověřování domény. Další informace o uživatelských účtech zákazníků najdete v tématu Vytvoření uživatelských účtů pro zákazníka.
Požadavek REST
Syntaxe požadavku
Metoda | Identifikátor URI žádosti |
---|---|
POST | {baseURL}/v1/customers/{CustomerTenantId}/verifieddomain HTTP/1.1 |
Parametr identifikátoru URI
Pomocí následujícího parametru dotazu určete zákazníka, pro který přidáváte ověřenou doménu.
Název | Typ | Vyžadováno | Popis |
---|---|---|---|
CustomerTenantId | guid | Y | Hodnota je identifikátor GUID CustomerTenantId , který umožňuje zadat zákazníka. |
Hlavičky požadavku
Další informace najdete v tématu Hlavičky REST Partnerského centra.
Text požadavku
Tato tabulka popisuje požadované vlastnosti v textu požadavku.
Název | Typ | Vyžadováno | Popis |
---|---|---|---|
VerifiedDomainName | řetězec | Yes | Ověřený název domény. |
Domain (Doména) | object | Yes | Obsahuje informace o doméně. |
Nastavení DomainFederationSettings | object | Ano (pokud AuthenticationType = Federated ) |
Nastavení federace domény, které se má použít, pokud je doménou doména Federated , a ne doména Managed . |
Domain (Doména)
Tato tabulka popisuje požadované a volitelné vlastnosti domény v textu požadavku.
Název | Typ | Vyžadováno | Popis |
---|---|---|---|
Authenticationtype | řetězec | Yes | Definuje, zda je doména doména Managed nebo doména Federated . Podporované hodnoty: Managed , Federated . |
Schopnost | řetězec | Yes | Určuje schopnost domény. Například, Email . |
IsDefault | Logická hodnota s možnou hodnotou null | No | Určuje, jestli je doména výchozí doménou pro tenanta. Podporované hodnoty: True , False , . Null |
IsInitial | Logická hodnota s možnou hodnotou null | No | Určuje, jestli je doména počáteční doménou. Podporované hodnoty: True , False , . Null |
Name | řetězec | Yes | Název domény. |
Kořenová doména | řetězec | No | Název kořenové domény. |
Status | řetězec | Yes | Stav domény. Například, Verified . Podporované hodnoty: Unverified , Verified , . PendingDeletion |
Metoda ověřování | řetězec | Yes | Typ metody ověření domény Podporované hodnoty: None , DnsRecord , . Email |
Nastavení federace domény
Tato tabulka popisuje požadované a volitelné vlastnosti DomainFederationSettings v textu požadavku.
Název | Typ | Vyžadováno | Popis |
---|---|---|---|
ActiveLogOnUri | řetězec | No | Identifikátor URI přihlášení používaný klienty s rozšířenými funkcemi. Tato vlastnost je adresa URL ověřování sts partnera. |
DefaultInteractiveAuthenticationMethod | řetězec | No | Určuje výchozí metodu ověřování, která by se měla použít, když aplikace vyžaduje, aby měl uživatel interaktivní přihlášení. |
FederationBrandName | řetězec | No | Název značky federace. |
IssuerUri | řetězec | Yes | Název vystavitele certifikátů. |
Identifikátor LogOffUri | řetězec | Yes | Identifikátor URI odhlášení. Tato vlastnost popisuje identifikátor URI pro odhlášení federované domény. |
MetadataExchangeUri | řetězec | No | Adresa URL, která určuje koncový bod výměny metadat, který se používá k ověřování z komplexních klientských aplikací. |
NextSigningCertificate | řetězec | No | Certifikát používaný v nadcházející budoucnosti službou ZABEZPEČENÍ služby AD FS v2 k podepisování deklarací identity. Tato vlastnost je reprezentací certifikátu v kódování Base64. |
OpenIdConnectDiscoveryEndpoint | řetězec | No | Koncový bod zjišťování OpenID Connect federovaného ZDP STS. |
PassiveLogOnUri | řetězec | Yes | Identifikátor URI přihlášení používaný staršími pasivními klienty. Tato vlastnost je adresa pro odesílání federovaných žádostí o přihlášení. |
PreferredAuthenticationProtocol | řetězec | Yes | Formát ověřovacího tokenu. Například, WsFed . Podporované hodnoty: WsFed , Samlp |
PromptLoginBehavior | řetězec | Yes | Typ chování výzvy k přihlášení. Například, TranslateToFreshPasswordAuth . Podporované hodnoty: TranslateToFreshPasswordAuth , NativeSupport , Disabled |
Podpisovácertificate | řetězec | Yes | Certifikát, který aktuálně používá služba tokenů zabezpečení ADFS v2 k podepisování deklarací identity. Tato vlastnost je reprezentací certifikátu v kódování Base64. |
SigningCertificateUpdateStatus | řetězec | No | Označuje stav aktualizace podpisového certifikátu. |
SigningCertificateUpdateStatus | Logická hodnota s možnou hodnotou null | No | Určuje, jestli služba sts ZDP podporuje vícefaktorové ověřování. Podporované hodnoty: True , False , . Null |
Příklad požadavku
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
}
}
Odpověď REST
V případě úspěchu toto rozhraní API vrátí prostředek domény pro novou ověřenou doménu.
Úspěšné odpovědi a kódy chyb
Každá odpověď obsahuje stavový kód HTTP, který označuje úspěch nebo neúspěch, a další informace o ladění. Ke čtení tohoto kódu, typu chyby a dalších parametrů použijte nástroj pro trasování sítě. Úplný seznam najdete v tématu Kódy chyb rozhraní REST v Partnerském centru.
Příklad odpovědi
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"
}