Adicionar um domínio verificado à lista de domínios aprovados para um cliente existente

  • Artigo

Aplica-se a: Partner Center | Partner Center operado pela 21Vianet | Partner Center para o Microsoft Cloud for US Government

Como adicionar um domínio verificado à lista de domínios aprovados para um cliente existente.

Pré-requisitos

  • Você deve ser um Parceiro que seja um registrador de domínios.

  • Credenciais, conforme descrito em Autenticação do Partner Center. Esse cenário oferece suporte à autenticação com credenciais autônomas de Aplicativo e Aplicativo+Usuário.

  • Uma ID do cliente (customer-tenant-id). Se você não souber a ID do cliente, poderá procurá-la no Partner Center selecionando o espaço de trabalho Clientes, o cliente na lista de clientes e, em seguida, Conta. Na página Conta do cliente, procure a ID da Microsoft na seção Informações da Conta do Cliente. A ID da Microsoft é igual à ID do cliente (customer-tenant-id).

Adicionando um domínio verificado

Se você for um Parceiro que é um registrador de domínios, poderá usar a verifieddomain API para POSTAR um novo recurso de Domínio na lista de domínios de um cliente existente. Para fazer isso, identifique o cliente usando seu CustomerTenantId. Especifique um valor para a propriedade VerifiedDomainName. Passe um recurso Domain na Solicitação com as propriedades Name, Capability, AuthenticationType, Status e VerificationMethod necessárias incluídas. Para especificar que o novo Domínio é um domínio federado, defina a propriedade AuthenticationType no recurso Domain como Federatede inclua um recurso DomainFederationSettings na Solicitação. Se o método for bem-sucedido, a resposta incluirá um recurso de domínio para o novo domínio verificado.

Domínios verificados personalizados

Ao adicionar um domínio verificado personalizado, um domínio que não está registrado no onmicrosoft.com, você deve definir a propriedade CustomerUser.immutableId como um valor de ID exclusivo para o cliente ao qual você está adicionando o domínio. Esse identificador exclusivo é necessário durante o processo de validação quando o domínio está sendo verificado. Para obter mais informações sobre contas de usuário de cliente, consulte Criar contas de usuário para um cliente.

Solicitação REST

Sintaxe da solicitação

Método URI da solicitação
POST {baseURL}/v1/customers/{CustomerTenantId}/verifieddomain HTTP/1.1

Parâmetro do URI

Use o parâmetro de consulta a seguir para especificar o cliente ao qual você está adicionando um domínio verificado.

Nome Digitar Obrigatório Descrição
CustomerTenantId guid Y O valor é um CustomerTenantId formatado por GUID que permite especificar um cliente.

Cabeçalhos de solicitação

Para obter mais informações, confira Cabeçalhos REST do Partner Center.

Corpo da solicitação

Esta tabela descreve as propriedades necessárias no corpo da solicitação.

Nome Digitar Obrigatório Descrição
VerifiedDomainName string Sim O nome de domínio verificado.
Domínio objeto Sim Contém as informações do domínio.
DomainFederationSettings objeto Sim (Se AuthenticationType = Federated) As configurações de federação de domínio a serem usadas se o domínio for um domínio e não um FederatedManaged domínio.

Domínio

Esta tabela descreve as propriedades Domain necessárias e opcionais no corpo da solicitação.

Nome Digitar Obrigatório Descrição
AuthenticationType string Sim Define se o domínio é um domínio ou um ManagedFederated domínio. Valores com suporte: Managed e Federated.
Recurso string Sim Especifica o recurso de domínio. Por exemplo, Email.
IsDefault Booleano anulável Não Indica se o domínio é o domínio padrão para o locatário. Valores suportados: True, , NullFalse.
IsInicial Booleano anulável Não Indica se o domínio é um domínio inicial. Valores suportados: True, , NullFalse.
Nome string Sim O nome de domínio.
Domínio raiz string Não O nome do domínio raiz.
Status string Sim O status do domínio. Por exemplo, Verified. Valores suportados: Unverified, , PendingDeletionVerified.
Método de Verificação string Sim O tipo de método de verificação de domínio. Valores suportados: None, , EmailDnsRecord.

Configurações de federação de domínio

Esta tabela descreve as propriedades DomainFederationSettings necessárias e opcionais no corpo da solicitação.

Nome Digitar Obrigatório Descrição
ActiveLogOnUri string Não O URI de logon usado por clientes avançados. Esta propriedade é a URL de autenticação STS do parceiro.
Método DefaultInteractiveAuthentication string Não Indica o método de autenticação padrão que deve ser usado quando um aplicativo requer que o usuário tenha logon interativo.
FederationBrandName string Não A marca da federação.
IssuerUri string Sim O nome do emissor dos certificados.
LogOffUri string Sim O URI de logoff. Esta propriedade descreve o URI de saída do domínio federado.
MetadataExchangeUri string Não A URL que especifica o ponto de extremidade de troca de metadados usado para autenticação de aplicativos rich client.
PróximoAssinandoCertificado string Não O certificado usado para o futuro futuro pelo ADFS V2 STS para assinar declarações. Essa propriedade é uma representação codificada em base64 do certificado.
OpenIdConnectDiscoveryEndpoint string Não O OpenID Connect Discovery Endpoint do IDP STS federado.
PassiveLogOnUri string Sim O URI de logon usado por clientes passivos mais antigos. Essa propriedade é o endereço para enviar solicitações de entrada federadas.
PreferredAuthenticationProtocol string Sim O formato do token de autenticação. Por exemplo, WsFed. Valores com suporte: WsFed, Samlp
PromptLoginBehavior string Sim O tipo de comportamento de logon de prompt. Por exemplo, TranslateToFreshPasswordAuth. Valores suportados: TranslateToFreshPasswordAuth, , NativeSupport, Disabled
AssinandoCertificado string Sim O certificado atualmente usado pelo STS do ADFS V2 para assinar declarações. Essa propriedade é uma representação codificada em base64 do certificado.
SigningCertificateUpdateStatus string Não Indica o status de atualização do certificado de assinatura.
SigningCertificateUpdateStatus Booleano anulável Não Indica se o IDP STS oferece suporte a MFA. Valores suportados: True, , NullFalse.

Exemplo de solicitação

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

Resposta REST

Se for bem-sucedida, essa API retornará um recurso Domínio para o novo domínio verificado.

Códigos de êxito e de erro de resposta

Cada resposta vem com um código de status HTTP que indica êxito ou falha e informações de depuração adicionais. Use uma ferramenta de rastreamento de rede para ler esse código, o tipo de erro e os parâmetros adicionais. Para obter a lista completa, confira Códigos de erro REST do Partner Center.

Exemplo de resposta

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