Een geverifieerd domein toevoegen aan de lijst met goedgekeurde domeinen voor een bestaande klant

Artikel
09/26/2024

Van toepassing op: Partnercentrum | Partnercentrum beheerd door 21Vianet | Partnercentrum voor Microsoft Cloud voor de Amerikaanse overheid

Een geverifieerd domein toevoegen aan de lijst met goedgekeurde domeinen voor een bestaande klant.

Vereisten

U moet een partner zijn die een domeinregistrar is.
Referenties zoals beschreven in verificatie in partnercentrum. Dit scenario ondersteunt verificatie met zowel zelfstandige app- als app+gebruikersreferenties.
Een klant-id (customer-tenant-id). Als u de klant-id niet weet, kunt u deze opzoeken in het Partnercentrum door de werkruimte Klanten te selecteren, vervolgens de klant in de lijst met klanten en vervolgens Account. Zoek op de pagina Account van de klant naar de Microsoft-id in de sectie Klantaccountgegevens . De Microsoft-id is hetzelfde als de klant-id (customer-tenant-id).

Een geverifieerd domein toevoegen

Als u een partner bent die een domeinregistrar is, kunt u de verifieddomain API gebruiken om een nieuwe domeinresource te posten in de lijst met domeinen voor een bestaande klant. Om dit te doen, identificeert u de klant met behulp van hun CustomerTenantId. Geef een waarde op voor de eigenschap VerifiedDomainName. Geef een domeinresource door in de aanvraag met de vereiste eigenschappen Name, Capability, AuthenticationType, Status en VerificationMethod. Als u wilt opgeven dat het nieuwe domein een federatief domein is, stelt u de eigenschap AuthenticationType in de domeinresource Federatedin op en neemt u een DomainFederationSettings-resource op in de aanvraag. Als de methode is geslaagd, bevat het antwoord een domeinresource voor het nieuwe geverifieerde domein.

Aangepaste geverifieerde domeinen

Wanneer u een aangepast geverifieerd domein toevoegt, moet u de eigenschap CustomerUser.immutableId instellen onmicrosoft.com op een unieke id-waarde voor de klant waarvoor u het domein toevoegt. Deze unieke id is vereist tijdens het validatieproces wanneer het domein wordt geverifieerd. Zie Gebruikersaccounts voor een klant maken voor meer informatie over gebruikersaccounts van klanten.

REST-aanvraag

Aanvraagsyntaxis

Wijze	Aanvraag-URI
POSTEN	{baseURL}/v1/customers/{CustomerTenantId}/verifieddomain HTTP/1.1

URI-parameter

Gebruik de volgende queryparameter om de klant op te geven waarvoor u een geverifieerd domein toevoegt.

Name	Type	Vereist	Beschrijving
CustomerTenantId	guid	J	De waarde is een door de GUID opgemaakte CustomerTenantId waarmee u een klant kunt opgeven.

Aanvraagheaders

Zie Rest-headers in Partnercentrum voor meer informatie.

Aanvraagtekst

In deze tabel worden de vereiste eigenschappen in de aanvraagbody beschreven.

Name	Type	Vereist	Beschrijving
VerifiedDomainName	tekenreeks	Ja	De geverifieerde domeinnaam.
Domein	object	Ja	Bevat de domeingegevens.
DomainFederationSettings	object	Ja (If AuthenticationType = `Federated`)	De domeinfederatie-instellingen die moeten worden gebruikt als het domein een `Federated` domein is en geen `Managed` domein.

Domein

In deze tabel worden de vereiste en optionele domeineigenschappen in de aanvraagbody beschreven.

Name	Type	Vereist	Beschrijving
AuthenticationType	tekenreeks	Ja	Hiermee definieert u of het domein een `Managed` domein of een `Federated` domein is. Ondersteunde waarden: `Managed`, `Federated`.
Mogelijkheid	tekenreeks	Ja	Hiermee geeft u de domeinmogelijkheid. Bijvoorbeeld: `Email`.
IsDefault	Booleaanse waarde die nullable is	Nee	Geeft aan of het domein het standaarddomein is voor de tenant. Ondersteunde waarden: `True`, `False`, `Null`.
IsInitial	Booleaanse waarde die nullable is	Nee	Geeft aan of het domein een eerste domein is. Ondersteunde waarden: `True`, `False`, `Null`.
Naam	tekenreeks	Ja	De domeinnaam.
RootDomain	tekenreeks	Nee	De naam van het hoofddomein.
Status	tekenreeks	Ja	De domeinstatus. Bijvoorbeeld: `Verified`. Ondersteunde waarden: `Unverified`, `Verified`, `PendingDeletion`.
VerificationMethod	tekenreeks	Ja	Het type domeinverificatiemethode. Ondersteunde waarden: `None`, `DnsRecord`, `Email`.

Domeinfederatie-instellingen

In deze tabel worden de vereiste en optionele domainFederationSettings-eigenschappen in de aanvraagbody beschreven.

Name	Type	Vereist	Beschrijving
ActiveLogOnUri	tekenreeks	Nee	De aanmeldings-URI die wordt gebruikt door rijke clients. Deze eigenschap is de STS-verificatie-URL van de partner.
DefaultInteractiveAuthenticationMethod	tekenreeks	Nee	Geeft de standaardverificatiemethode aan die moet worden gebruikt wanneer een toepassing vereist dat de gebruiker interactieve aanmelding heeft.
FederationBrandName	tekenreeks	Nee	De naam van het federatiemerk.
IssuerUri	tekenreeks	Ja	De naam van de uitgever van de certificaten.
LogOffUri	tekenreeks	Ja	De aanmeldings-URI. Deze eigenschap beschrijft de afmeldings-URI van het federatieve domein.
MetadataExchangeUri	tekenreeks	Nee	De URL waarmee het eindpunt voor metagegevensuitwisseling wordt opgegeven dat wordt gebruikt voor verificatie vanuit uitgebreide clienttoepassingen.
NextSigningCertificate	tekenreeks	Nee	Het certificaat dat wordt gebruikt voor de komende toekomst door de ADFS V2 STS om claims te ondertekenen. Deze eigenschap is een base64-gecodeerde weergave van het certificaat.
OpenIdConnectDiscoveryEndpoint	tekenreeks	Nee	Het OpenID Connect Discovery-eindpunt van de federatieve IDP STS.
PassiveLogOnUri	tekenreeks	Ja	De aanmeldings-URI die wordt gebruikt door oudere passieve clients. Deze eigenschap is het adres voor het verzenden van federatieve aanmeldingsaanvragen.
PreferredAuthenticationProtocol	tekenreeks	Ja	De indeling voor het verificatietoken. Bijvoorbeeld: `WsFed`. Ondersteunde waarden: `WsFed`, `Samlp`
PromptLoginBehavior	tekenreeks	Ja	Het type aanmeldingsgedrag van de prompt. Bijvoorbeeld: `TranslateToFreshPasswordAuth`. Ondersteunde waarden: `TranslateToFreshPasswordAuth`, `NativeSupportDisabled`
SigningCertificate	tekenreeks	Ja	Het certificaat dat momenteel door de ADFS V2 STS wordt gebruikt om claims te ondertekenen. Deze eigenschap is een base64-gecodeerde weergave van het certificaat.
SigningCertificateUpdateStatus	tekenreeks	Nee	Geeft de updatestatus van het handtekeningcertificaat aan.
SigningCertificateUpdateStatus	Booleaanse waarde die nullable is	Nee	Geeft aan of de IDP STS MFA ondersteunt. Ondersteunde waarden: `True`, `False`, `Null`.

Aanvraagvoorbeeld

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

Als dit lukt, retourneert deze API een domeinresource voor het nieuwe geverifieerde domein.

Geslaagde antwoorden en foutcodes

Elk antwoord wordt geleverd met een HTTP-statuscode die aangeeft dat de fout is geslaagd of mislukt en andere informatie over foutopsporing. Gebruik een hulpprogramma voor netwerktracering om deze code, het fouttype en andere parameters te lezen. Zie rest-foutcodes in Partnercentrum voor de volledige lijst.

Responsvoorbeeld

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

Delen via