Ajouter un domaine vérifié à la liste des domaines approuvés pour un client existant

  • Article

S’applique à : Espace partenaires | Espace partenaires géré par 21Vianet | Espace partenaires de Microsoft Cloud for US Government

Comment ajouter un domaine vérifié à la liste des domaines approuvés pour un client existant.

Prérequis

  • Vous devez être partenaire qui est un bureau d’enregistrement de domaines.

  • Informations d’identification, comme décrit dans Authentification auprès de l’Espace partenaires. Ce scénario prend en charge l’authentification avec les informations d’identification d’application et d’application+utilisateur autonomes.

  • ID du client (customer-tenant-id). Si vous ne connaissez pas l’ID du client, vous pouvez le rechercher dans l’Espace de partenaires en sélectionnant l’espace de travail Clients, puis le client dans la liste des clients, puis compte. Dans la page Compte du client, recherchez l’ID Microsoft dans la section Informations sur le compte client. L’ID Microsoft est le même que l’ID de client (customer-tenant-id).

Ajout d’un domaine vérifié

Si vous êtes un partenaire qui est un bureau d’enregistrement de domaines, vous pouvez utiliser l’API verifieddomain pour publier une nouvelle ressource de domaine dans la liste des domaines d’un client existant. Pour ce faire, identifiez le client à l’aide de son CustomerTenantId. Spécifiez une valeur pour la propriété VerifiedDomainName. Transmettez une ressource de domaine dans la requête avec les propriétés Name, Capability, AuthenticationType, Status et VerificationMethod requises. Pour spécifier que le nouveau domaine est un domaine fédéré, définissez la propriété AuthenticationType dans la ressource Federateddomaine sur , et incluez une ressource DomainFederation Paramètres dans la requête. Si la méthode réussit, la réponse inclut une ressource domaine pour le nouveau domaine vérifié.

Domaines vérifiés personnalisés

Lorsque vous ajoutez un domaine vérifié personnalisé, un domaine qui n’est pas inscrit sur onmicrosoft.com, vous devez définir la propriété CustomerUser.immutableId sur une valeur d’ID unique pour le client pour lequel vous ajoutez le domaine. Cet identificateur unique est requis pendant le processus de validation lorsque le domaine est vérifié. Pour plus d’informations sur les comptes d’utilisateur client, consultez créer des comptes d’utilisateur pour un client.

Demande REST

Syntaxe de la requête

Méthode URI de demande
POST {baseURL}/v1/customers/{CustomerTenantId}/verifieddomain HTTP/1.1

Paramètre d’URI

Utilisez le paramètre de requête suivant pour spécifier le client pour lequel vous ajoutez un domaine vérifié.

Nom Type Obligatoire Description
CustomerTenantId guid Y La valeur est un GUID mis en forme CustomerTenantId qui vous permet de spécifier un client.

En-têtes de requête

Pour plus d’informations, consultez En-têtes REST de l’Espace Partenaires.

Corps de la demande

Ce tableau décrit les propriétés requises dans le corps de la requête.

Nom Type Obligatoire Description
VerifiedDomainName string Oui Nom de domaine vérifié.
Domaine object Oui Contient les informations de domaine.
DomainFederation Paramètres object Oui (si AuthenticationType = Federated) Paramètres de fédération de domaine à utiliser si le domaine est un Federated domaine et non un Managed domaine.

Domain

Ce tableau décrit les propriétés de domaine obligatoires et facultatives dans le corps de la requête.

Nom Type Obligatoire Description
AuthenticationType string Oui Définit si le domaine est un Managed domaine ou un Federated domaine. Valeurs prises en charge : Managed, Federated.
Fonctionnalité string Oui Spécifie la fonctionnalité de domaine. Par exemple : Email.
IsDefault Boolean nullable Non Indique si le domaine est le domaine par défaut du locataire. Valeurs prises en charge : True, False, Null.
IsInitial Boolean nullable Non Indique si le domaine est un domaine initial. Valeurs prises en charge : True, False, Null.
Nom string Oui Nom du domaine.
RootDomain string Non Nom du domaine racine.
État string Oui État du domaine. Par exemple : Verified. Valeurs prises en charge : Unverified, Verified, PendingDeletion.
VerificationMethod string Oui Type de méthode de vérification du domaine. Valeurs prises en charge : None, DnsRecord, Email.

Paramètres de fédération de domaine

Ce tableau décrit les propriétés DomainFederation requises et facultatives Paramètres dans le corps de la requête.

Nom Type Obligatoire Description
ActiveLogOnUri string Non URI d’ouverture de session utilisé par les clients riches. Cette propriété est l’URL d’authentification STS du partenaire.
DefaultInteractiveAuthenticationMethod string Non Indique la méthode d’authentification par défaut qui doit être utilisée lorsqu’une application exige que l’utilisateur dispose d’une connexion interactive.
FederationBrandName string Non Nom de la marque de fédération.
IssuerUri string Oui Nom de l’émetteur des certificats.
LogOffUri string Oui URI de déconnexion. Cette propriété décrit l’URI de déconnexion de domaine fédéré.
MetadataExchangeUri string Non URL qui spécifie le point de terminaison d’échange de métadonnées utilisé pour l’authentification à partir d’applications clientes enrichies.
NextSigningCertificate string Non Certificat utilisé pour le futur futur par le stS ADFS V2 pour signer des revendications. Cette propriété est une représentation encodée en base64 du certificat.
OpenId Connecter DiscoveryEndpoint string Non OpenID Connecter point de terminaison de découverte du STS du fournisseur d’identité fédéré.
PassiveLogOnUri string Oui URI d’ouverture de session utilisé par les anciens clients passifs. Cette propriété est l’adresse permettant d’envoyer des demandes de connexion fédérées.
PreferredAuthenticationProtocol string Oui Format du jeton d’authentification. Par exemple : WsFed. Valeurs prises en charge : WsFed, Samlp
PromptLoginBehavior string Oui Type de comportement de connexion à l’invite. Par exemple : TranslateToFreshPasswordAuth. Valeurs prises en charge : TranslateToFreshPasswordAuth, , NativeSupportDisabled
SigningCertificate string Oui Certificat actuellement utilisé par le STS ADFS V2 pour signer des revendications. Cette propriété est une représentation encodée en base64 du certificat.
SigningCertificateUpdateStatus string Non Indique l’état de mise à jour du certificat de signature.
SigningCertificateUpdateStatus Boolean nullable Non Indique si l’IDP STS prend en charge l’authentification multifacteur. Valeurs prises en charge : True, False, Null.

Exemple de requête

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

Réponse REST

Si elle réussit, cette API retourne une ressource domaine pour le nouveau domaine vérifié.

Codes d’erreur et de réussite de la réponse

Chaque réponse est accompagnée d’un code d’état HTTP qui indique la réussite ou l’échec ainsi que des informations de débogage supplémentaires. Utilisez un outil de trace réseau pour lire ce code, le type d’erreur et des paramètres supplémentaires. Pour obtenir la liste complète, consultez Codes d’erreur REST de l’Espace partenaires.

Exemple de réponse

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