Dela via


Lägga till en verifierad domän i listan över godkända domäner för en befintlig kund

Gäller för: Partnercenter | Partnercenter som drivs av 21Vianet | Partnercenter för Microsoft Cloud for US Government

Så här lägger du till en verifierad domän i listan över godkända domäner för en befintlig kund.

Förutsättningar

  • Du måste vara en partner som är domänregistrator.

  • Autentiseringsuppgifter enligt beskrivningen i Partnercenter-autentisering. Det här scenariot stöder autentisering med både fristående app- och App+User-autentiseringsuppgifter.

  • Ett kund-ID (customer-tenant-id). Om du inte känner till kundens ID kan du söka efter det i Partnercenter genom att välja arbetsytan Kunder , sedan kunden från kundlistan och sedan Konto. På kundens kontosida letar du efter Microsoft-ID :t i avsnittet Kundkontoinformation . Microsoft-ID:t är samma som kund-ID :t (customer-tenant-id).

Lägga till en verifierad domän

Om du är en partner som är domänregistrator kan du använda API:et verifieddomain för att PUBLICERA en ny domänresurs i listan över domäner för en befintlig kund. Det gör du genom att identifiera kunden med hjälp av deras CustomerTenantId. Ange ett värde för egenskapen VerifiedDomainName. Skicka en domänresurs i begäran med de nödvändiga egenskaperna Namn, Kapacitet, AuthenticationType, Status och VerificationMethod. Om du vill ange att den nya domänen är en federerad domän anger du egenskapen AuthenticationType i domänresursen till Federatedoch inkluderar en DomainFederationSettings-resurs i begäran. Om metoden lyckas innehåller svaret en domänresurs för den nya verifierade domänen.

Anpassade verifierade domäner

När du lägger till en anpassad verifierad domän, en domän som inte är registrerad på onmicrosoft.com, måste du ange egenskapen CustomerUser.immutableId till ett unikt ID-värde för den kund som du lägger till domänen för. Den här unika identifieraren krävs under valideringsprocessen när domänen verifieras. Mer information om kundanvändarkonton finns i Skapa användarkonton för en kund.

REST-begäran

Syntax för begäran

Metod URI för förfrågan
POST {baseURL}/v1/customers/{CustomerTenantId}/verifieddomain HTTP/1.1

URI-parameter

Använd följande frågeparameter för att ange den kund som du lägger till en verifierad domän för.

Namn Typ Obligatoriskt Beskrivning
CustomerTenantId guid Y Värdet är ett GUID-formaterat CustomerTenantId som gör att du kan ange en kund.

Begärandehuvuden

Mer information finns i REST-huvuden för Partnercenter.

Begärandetext

I den här tabellen beskrivs de nödvändiga egenskaperna i begärandetexten.

Namn Typ Obligatoriskt Beskrivning
VerifiedDomainName sträng Ja Det verifierade domännamnet.
Domän objekt Ja Innehåller domäninformationen.
DomainFederationSettings objekt Ja (om AuthenticationType = Federated) De domänfederationsinställningar som ska användas om domänen är en Federated domän och inte en Managed domän.

Domän

I den här tabellen beskrivs de obligatoriska och valfria domänegenskaperna i begärandetexten.

Namn Typ Obligatoriskt Beskrivning
AuthenticationType sträng Ja Definierar om domänen är en Managed domän eller en Federated domän. Värden som stöds: Managed, Federated.
Kapacitet sträng Ja Anger domänfunktionen. Exempel: Email
IsDefault nullbart booleskt värde Nej Anger om domänen är standarddomänen för klientorganisationen. Värden som stöds: True, False, Null.
IsInitial nullbart booleskt värde Nej Anger om domänen är en första domän. Värden som stöds: True, False, Null.
Name sträng Ja Domännamnet.
RootDomain sträng Nej Namnet på rotdomänen.
Status sträng Ja Domänstatus. Exempel: Verified Värden som stöds: Unverified, Verified, PendingDeletion.
VerificationMethod sträng Ja Typ av domänverifieringsmetod. Värden som stöds: None, DnsRecord, Email.

Inställningar för domänfederation

I den här tabellen beskrivs de obligatoriska och valfria egenskaperna DomainFederationSettings i begärandetexten.

Namn Typ Obligatoriskt Beskrivning
ActiveLogOnUri sträng Nej Inloggnings-URI:n som används av rich-klienter. Den här egenskapen är partnerns STS-autentiserings-URL.
DefaultInteractiveAuthenticationMethod sträng Nej Anger den standardautentiseringsmetod som ska användas när ett program kräver att användaren har interaktiv inloggning.
FederationBrandName sträng Nej Federationens varumärke.
IssuerUri sträng Ja Namnet på utfärdaren av certifikaten.
LogOffUri sträng Ja Utloggnings-URI:n. Den här egenskapen beskriver URI:n för federerad domänutloggning.
MetadataExchangeUri sträng Nej URL:en som anger den metadatautbytesslutpunkt som används för autentisering från omfattande klientprogram.
NextSigningCertificate sträng Nej Certifikatet som används för den kommande framtiden av ADFS V2 STS för att signera anspråk. Den här egenskapen är en base64-kodad representation av certifikatet.
OpenIdConnectDiscoveryEndpoint sträng Nej OpenID Connect Discovery-slutpunkten för federerad IDP STS.
PassiveLogOnUri sträng Ja Inloggnings-URI:n som används av äldre passiva klienter. Den här egenskapen är adressen för att skicka federerade inloggningsbegäranden.
PreferredAuthenticationProtocol sträng Ja Formatet för autentiseringstoken. Exempel: WsFed Värden som stöds: WsFed, Samlp
PromptLoginBehavior sträng Ja Beteendetypen för promptinloggning. Exempel: TranslateToFreshPasswordAuth Värden som stöds: TranslateToFreshPasswordAuth, NativeSupport, Disabled
SigningCertificate sträng Ja Certifikatet som för närvarande används av ADFS V2 STS för att signera anspråk. Den här egenskapen är en base64-kodad representation av certifikatet.
SigningCertificateUpdateStatus sträng Nej Anger uppdateringsstatus för signeringscertifikatet.
SigningCertificateUpdateStatus nullbart booleskt värde Nej Anger om IDP STS stöder MFA. Värden som stöds: True, False, Null.

Exempel på begäran

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-svar

Om det lyckas returnerar det här API:et en domänresurs för den nya verifierade domänen.

Svarsframgång och felkoder

Varje svar levereras med en HTTP-statuskod som anger lyckad eller misslyckad och annan felsökningsinformation. Använd ett verktyg för nätverksspårning för att läsa den här koden, feltypen och andra parametrar. Den fullständiga listan finns i Rest-felkoder för Partnercenter.

Svarsexempel

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