Agregar un dominio comprobado para un clienteAdd a verified domain for a customer

Se aplica a:Applies to:

  • Centro de partnersPartner Center
  • Centro de partners operado por 21VianetPartner Center operated by 21Vianet
  • Centro de partners para Microsoft Cloud AlemaniaPartner Center for Microsoft Cloud Germany
  • Centro de partners para Microsoft Cloud for US GovernmentPartner Center for Microsoft Cloud for US Government

Cómo agregar un dominio comprobado a la lista de dominios aprobados para un cliente existente.How to add a verified domain to the list of approved domains for an existing customer.

Requisitos previosPrerequisites

  • Debe ser un asociado que sea un registrador de dominios.You must be a Partner who is a domain registrar.

  • Credenciales tal como se describen en el artículo Autenticación del Centro de partners.Credentials as described in Partner Center authentication. Este escenario admite la autenticación con las credenciales de aplicación y aplicación independientes.This scenario supports authentication with both standalone App and App+User credentials.

  • Un id. de cliente (customer-tenant-id).A customer ID (customer-tenant-id). Si no conoces el identificador del cliente, puedes buscarlo en el panel del Centro de partners.If you don't know the customer's ID, you can look it up in the Partner Center dashboard. Selecciona CSP en el menú del Centro de partners, seguido de Clientes.Select CSP from the Partner Center menu, followed by Customers. En la lista de clientes, selecciona el cliente y, a continuación, elige Cuenta.Select the customer from the customer list, then select Account. En la página Cuenta del cliente, busca el Id. de Microsoft en la sección Información de la cuenta del cliente.On the customer’s Account page, look for the Microsoft ID in the Customer Account Info section. El identificador de Microsoft es el mismo que el de cliente (customer-tenant-id).The Microsoft ID is the same as the customer ID (customer-tenant-id).

Agregar un dominio comprobadoAdding a verified domain

Si es un asociado que es un registrador de dominios, puede usar la verifieddomain API para publicar un nuevo recurso de dominio en la lista de dominios de un cliente existente.If you are a Partner who is a domain registrar, you can use the verifieddomain API to POST a new Domain resource to the list of domains for an existing customer. Para ello, identifique al cliente mediante su CustomerTenantId.To do this, identify the customer using their CustomerTenantId. Especifique un valor para la propiedad VerifiedDomainName.Specify a value for the VerifiedDomainName property. Pase un recurso de dominio en la solicitud con las propiedades name, capability, AuthenticationType, status y VerificationMethod necesarias.Pass a Domain resource in the Request with the required Name, Capability, AuthenticationType, Status, and VerificationMethod properties included. Para especificar que el nuevo dominio es un dominio federado, establezca la propiedad AuthenticationType en el recurso de dominio en Federated e incluya un recurso DomainFederationSettings en la solicitud.To specify that the new Domain is a federated domain, set the AuthenticationType property in the Domain resource to Federated, and include a DomainFederationSettings resource in the Request. Si el método se realiza correctamente, la respuesta incluirá un recurso de dominio para el nuevo dominio comprobado.If the method is successful, the Response will include a Domain resource for the new verified domain.

Dominios comprobados personalizadosCustom verified domains

Al agregar un dominio comprobado personalizado, un dominio que no está registrado en onmicrosoft.com, debe establecer la propiedad CustomerUser. immutableId en un valor de identificador único para el cliente para el que va a agregar el dominio.When adding a custom verified domain, a domain that isn't registered on onmicrosoft.com, you must set the CustomerUser.immutableId property to a unique ID value for the customer you are adding the domain for. Este identificador único es necesario durante el proceso de validación cuando se está comprobando el dominio.This unique identifier is required during the validation process when the domain is being verified. Para obtener más información acerca de las cuentas de usuario de cliente, consulte creación de cuentas de usuario para un cliente.For more information about customer user accounts, see create user accounts for a customer.

Solicitud RESTREST request

Sintaxis de la solicitudRequest syntax

MétodoMethod URI de solicitudRequest URI
POSTPOST {baseurl}/v1/customers/{CustomerTenantId}/verifieddomain http/1.1{baseURL}/v1/customers/{CustomerTenantId}/verifieddomain HTTP/1.1

Parámetro de URIURI parameter

Use el siguiente parámetro de consulta para especificar el cliente para el que va a agregar un dominio comprobado.Use the following query parameter to specify the customer you are adding a verified domain for.

NombreName TipoType ObligatorioRequired DescripciónDescription
CustomerTenantIdCustomerTenantId guidguid YY El valor es un CustomerTenantId con formato de GUID que le permite especificar un cliente.The value is a GUID formatted CustomerTenantId that allows you to specify a customer.

Encabezados de solicitudRequest headers

Para obtener más información, consulta Encabezados REST del Centro de partners.For more information, see Partner Center REST headers.

Cuerpo de la solicitudRequest body

En esta tabla se describen las propiedades necesarias en el cuerpo de la solicitud.This table describes the required properties in the request body.

NombreName TipoType ObligatorioRequired DescripciónDescription
VerifiedDomainNameVerifiedDomainName stringstring Yes El nombre de dominio comprobado.The verified domain name.
DominioDomain objectobject Yes Contiene la información de dominio.Contains the domain information.
DomainFederationSettingsDomainFederationSettings objetoobject Sí (si AuthenticationType = Federated )Yes (If AuthenticationType = Federated) La configuración de Federación de dominio que se usará si el dominio es un Federated dominio y no un Managed dominio.The domain federation settings to be used if the domain is a Federated domain and not a Managed domain.

DominioDomain

En esta tabla se describen las propiedades de dominio obligatorias y opcionales en el cuerpo de la solicitud.This table describes the required and optional Domain properties in the request body.

NombreName TipoType ObligatorioRequired DescripciónDescription
AuthenticationTypeAuthenticationType stringstring Yes Define si el dominio es un dominio Managed o un dominio Federated .Defines whether the domain is a Managed domain or a Federated domain. Valores admitidos: Managed , Federated .Supported values: Managed, Federated.
CapacidadCapability stringstring Yes Especifica la capacidad del dominio.Specifies the domain capability. Por ejemplo: Email.For example, Email.
IsDefaultIsDefault Nullable booleanonullable boolean NoNo Indica si el dominio es el dominio predeterminado para el inquilino.Indicates whether the domain is the default domain for the tenant. Valores admitidos: True , False , Null .Supported values: True, False, Null.
IsInitialIsInitial Nullable booleanonullable boolean NoNo Indica si el dominio es un dominio inicial.Indicates whether the domain is an initial domain. Valores admitidos: True , False , Null .Supported values: True, False, Null.
NombreName stringstring Yes Nombre del dominio.The domain name.
DominioraízRootDomain stringstring NoNo Nombre del dominio raíz.The name of the root domain.
EstadoStatus stringstring Yes Estado del dominio.The domain status. Por ejemplo: Verified.For example, Verified. Valores admitidos: Unverified , Verified , PendingDeletion .Supported values: Unverified, Verified, PendingDeletion.
VerificationMethodVerificationMethod stringstring Yes El tipo de método de comprobación de dominio.The domain verification method type. Valores admitidos: None , DnsRecord , Email .Supported values: None, DnsRecord, Email.

Configuración de la Federación de dominiosDomain federation settings

En esta tabla se describen las propiedades DomainFederationSettings y obligatorias en el cuerpo de la solicitud.This table describes the required and optional DomainFederationSettings properties in the request body.

NombreName TipoType ObligatorioRequired DescripciónDescription
ActiveLogOnUriActiveLogOnUri stringstring NoNo URI de inicio de sesión utilizado por los clientes enriquecidos.The logon URI used by rich clients. Esta propiedad es la dirección URL de autenticación STS del asociado.This property is the partner's STS Auth URL.
DefaultInteractiveAuthenticationMethodDefaultInteractiveAuthenticationMethod stringstring NoNo Indica el método de autenticación predeterminado que debe usarse cuando una aplicación requiere que el usuario tenga un inicio de sesión interactivo.Indicates the default authentication method that should be used when an application requires the user to have interactive login.
FederationBrandNameFederationBrandName stringstring NoNo Nombre de la marca de Federación.The federation brand name.
IssuerUriIssuerUri stringstring Yes Nombre del emisor de los certificados.The name of the issuer of the certificates.
LogOffUriLogOffUri stringstring Yes El URI de cierre de sesión.The logoff URI. Esta propiedad describe el URI de cierre de sesión del dominio federado.This property describes the federated domain sign-out URI.
MetadataExchangeUriMetadataExchangeUri stringstring NoNo La dirección URL que especifica el extremo de intercambio de metadatos usado para la autenticación desde aplicaciones cliente enriquecidas.The URL that specifies the metadata exchange endpoint used for authentication from rich client applications.
NextSigningCertificateNextSigningCertificate stringstring NoNo El certificado usado para el futuro próximo por el STS de ADFS v2 para firmar las notificaciones.The certificate used for the coming future by the ADFS V2 STS to sign claims. Esta propiedad es una representación codificada en base64 del certificado.This property is a base64 encoded representation of the certificate.
OpenIdConnectDiscoveryEndpointOpenIdConnectDiscoveryEndpoint stringstring NoNo El punto de conexión de detección de OpenID Connect del STS de IDP federado.The OpenID Connect Discovery Endpoint of the federated IDP STS.
PassiveLogOnUriPassiveLogOnUri stringstring Yes El URI de inicio de sesión usado por los clientes pasivos más antiguos.The logon URI used by older passive Clients. Esta propiedad es la dirección para enviar solicitudes de inicio de sesión federado.This property is the address to send federated sign-in requests.
PreferredAuthenticationProtocolPreferredAuthenticationProtocol stringstring Yes El formato del token de autenticación.The format for the authentication token. Por ejemplo: WsFed.For example, WsFed. Valores admitidos: WsFed ,SamlpSupported values: WsFed, Samlp
PromptLoginBehaviorPromptLoginBehavior stringstring Yes El tipo de comportamiento solicitar inicio de sesión.The prompt login behavior type. Por ejemplo: TranslateToFreshPasswordAuth.For example, TranslateToFreshPasswordAuth. Valores admitidos: TranslateToFreshPasswordAuth , NativeSupport ,DisabledSupported values: TranslateToFreshPasswordAuth, NativeSupport, Disabled
SigningCertificateSigningCertificate stringstring Yes Certificado que el STS de ADFS V2 usa actualmente para firmar las notificaciones.The certificate currently used by the ADFS V2 STS to sign claims. Esta propiedad es una representación codificada en base64 del certificado.This property is a base64 encoded representation of the certificate.
SigningCertificateUpdateStatusSigningCertificateUpdateStatus stringstring NoNo Indica el estado de actualización del certificado de firma.Indicates the update status of the Signing certificate.
SigningCertificateUpdateStatusSigningCertificateUpdateStatus Nullable booleanonullable boolean NoNo Indica si el STS de IDP admite MFA.Indicates whether the IDP STS supports MFA. Valores admitidos: True , False , Null .Supported values: True, False, Null.

Ejemplo de solicitudRequest example

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

Respuesta RESTREST response

Si se realiza correctamente, esta API devuelve un recurso de dominio para el nuevo dominio comprobado.If successful, this API returns a Domain resource for the new verified domain.

Códigos de error y de respuesta correctosResponse success and error codes

Cada respuesta incluye un código de estado HTTP que indica si la operación se ha realizado correctamente o con errores y proporciona información de depuración adicional.Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use una herramienta de seguimiento de red para leer este código, el tipo de error y los parámetros adicionales.Use a network trace tool to read this code, error type, and additional parameters. Para obtener la lista completa, consulta Códigos de error de REST del Centro de partners.For the full list, see Partner Center REST error codes.

Ejemplo de respuestaResponse example

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