Agregar un dominio comprobado a la lista de dominios aprobados para un cliente existente

Artículo
09/26/2024

Se aplica a: Centro de partners | Centro de partners operado por 21Vianet | Centro de partners para Microsoft Cloud for US Government

Cómo agregar un dominio comprobado a la lista de dominios aprobados para un cliente existente.

Requisitos previos

Debe ser partner que sea registrador de dominios.
Credenciales tal como se describen en el artículo Autenticación del Centro de partners. Este escenario admite la autenticación con credenciales de aplicación independiente y app+usuario.
Un id. de cliente (customer-tenant-id). Si no conoce el identificador del cliente, puede buscarlo en el Centro de partners seleccionando el área de trabajo Clientes , luego el cliente de la lista de clientes y, a continuación , Cuenta. En la página Cuenta del cliente, busque el identificador de Microsoft en la sección Información de la cuenta de cliente. El id. de Microsoft es el mismo que el de cliente (customer-tenant-id).

Adición de un dominio comprobado

Si es partner que es registrador de dominios, puede usar la verifieddomain API para publicar un nuevo recurso de dominio en la lista de dominios de un cliente existente. Para ello, identifique al cliente mediante su CustomerTenantId. Especifique un valor para la propiedad VerifiedDomainName. Pase un recurso dominio en la solicitud con las propiedades Name, Capability, AuthenticationType, Status y VerificationMethod requeridas. Para especificar que el nuevo dominio es un dominio federado, establezca la propiedad AuthenticationType en el recurso Dominio en e incluya un recurso FederatedDomainFederationSettings en request. Si el método se ejecuta correctamente, la respuesta incluye un recurso dominio para el nuevo dominio comprobado.

Dominios comprobados personalizados

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. Este identificador único es necesario durante el proceso de validación cuando se comprueba el dominio. Para obtener más información sobre las cuentas de usuario de cliente, consulte Creación de cuentas de usuario para un cliente.

Solicitud REST

Sintaxis de la solicitud

Método	URI de solicitud
POST	{baseURL}/v1/customers/{CustomerTenantId}/verifieddomain HTTP/1.1

Parámetro de URI

Use el siguiente parámetro de consulta para especificar el cliente para el que va a agregar un dominio comprobado.

Nombre	Type	Obligatorio	Descripción
CustomerTenantId	guid	Y	El valor es un GUID con formato CustomerTenantId que permite especificar un cliente.

Encabezados de solicitud

Para obtener más información, consulta Encabezados REST del Centro de partners.

Cuerpo de la solicitud

En esta tabla se describen las propiedades necesarias en el cuerpo de la solicitud.

Nombre	Type	Obligatorio	Descripción
VerifiedDomainName	string	Sí	Nombre de dominio comprobado.
Dominio	objeto	Sí	Contiene la información del dominio.
DomainFederationSettings	objeto	Sí (If AuthenticationType = `Federated`)	Configuración de federación de dominio que se va a usar si el dominio es un `Federated` dominio y no un `Managed` dominio.

Dominio

En esta tabla se describen las propiedades de dominio necesarias y opcionales en el cuerpo de la solicitud.

Nombre	Type	Obligatorio	Descripción
AuthenticationType	string	Sí	Define si el dominio es un `Managed` dominio o un `Federated` dominio. Valores admitidos: `Managed`, `Federated`.
Funcionalidad	string	Sí	Especifica la funcionalidad de dominio. Por ejemplo, `Email`.
IsDefault	booleano que acepta valores NULL	No	Indica si el dominio es el dominio predeterminado para el inquilino. Valores admitidos: `True`, `False`, `Null`.
IsInitial	booleano que acepta valores NULL	No	Indica si el dominio es un dominio inicial. Valores admitidos: `True`, `False`, `Null`.
Nombre	string	Sí	Nombre del dominio.
RootDomain	string	No	Nombre del dominio raíz.
Estado	string	Sí	Estado del dominio. Por ejemplo, `Verified`. Valores admitidos: `Unverified`, `Verified`, `PendingDeletion`.
VerificationMethod	string	Sí	Tipo de método de verificación de dominio. Valores admitidos: `None`, `DnsRecord`, `Email`.

Configuración de federación de dominio

En esta tabla se describen las propiedades DomainFederationSettings necesarias y opcionales en el cuerpo de la solicitud.

Nombre	Type	Obligatorio	Descripción
ActiveLogOnUri	string	No	URI de inicio de sesión usado por clientes enriquecidos. Esta propiedad es la dirección URL de autenticación stS del asociado.
DefaultInteractiveAuthenticationMethod	string	No	Indica el método de autenticación predeterminado que se debe usar cuando una aplicación requiere que el usuario tenga un inicio de sesión interactivo.
FederationBrandName	string	No	Nombre de marca de federación.
IssuerUri	string	Sí	Nombre del emisor de los certificados.
LogOffUri	string	Sí	URI de cierre de sesión. Esta propiedad describe el URI de cierre de sesión de dominio federado.
MetadataExchangeUri	string	No	Dirección URL que especifica el punto de conexión de intercambio de metadatos que se usa para la autenticación de aplicaciones cliente enriquecidas.
NextSigningCertificate	string	No	El certificado usado para el futuro próximo por el STS de ADFS V2 para firmar notificaciones. Esta propiedad es una representación codificada en base64 del certificado.
OpenIdConnectDiscoveryEndpoint	string	No	El punto de conexión de detección de OpenID Connect del STS de IDP federado.
PassiveLogOnUri	string	Sí	Identificador URI de inicio de sesión usado por clientes pasivos anteriores. Esta propiedad es la dirección para enviar solicitudes de inicio de sesión federadas.
PreferredAuthenticationProtocol	string	Sí	Formato del token de autenticación. Por ejemplo, `WsFed`. Valores admitidos: `WsFed`, `Samlp`
PromptLoginBehavior	string	Sí	Tipo de comportamiento de inicio de sesión del símbolo del sistema. Por ejemplo, `TranslateToFreshPasswordAuth`. Valores admitidos: `TranslateToFreshPasswordAuth`, `NativeSupport`, `Disabled`
SigningCertificate	string	Sí	Certificado usado actualmente por el STS V2 de ADFS para firmar notificaciones. Esta propiedad es una representación codificada en base64 del certificado.
SigningCertificateUpdateStatus	string	No	Indica el estado de actualización del certificado de firma.
SigningCertificateUpdateStatus	booleano que acepta valores NULL	No	Indica si el STS de IDP admite MFA. Valores admitidos: `True`, `False`, `Null`.

Ejemplo de solicitud

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

Respuesta REST

Si se ejecuta correctamente, esta API devuelve un recurso domain para el nuevo dominio comprobado.

Códigos de error y de respuesta correctos

Cada respuesta incluye un código de estado HTTP que indica éxito o error y otra información de depuración. Use una herramienta de seguimiento de red para leer este código, tipo de error y otros parámetros. Para obtener la lista completa, consulta Códigos de error de REST del Centro de partners.

Ejemplo de respuesta

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

Compartir vía