Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
Este artigo orienta você pelo processo de criação de uma página de aterrissagem para um aplicativo SaaS gratuito ou de avaliação que será vendido no Microsoft Marketplace.
Importante
O Graph do Azure AD (Azure Active Directory) foi preterido em 30 de junho de 2023. Daqui para frente, não faremos mais investimentos no Azure AD Graph. Azure AD Graph APIs não têm nenhum compromisso de manutenção ou SLA para além das correções relacionadas com a segurança. Os investimentos em novos recursos e funcionalidades serão feitos apenas no Microsoft Graph.
Desativaremos o Azure AD Graph em etapas incrementais para que você tenha tempo suficiente para migrar seus aplicativos para AS APIs do Microsoft Graph. Em uma data posterior que anunciaremos, bloquearemos a criação de novos aplicativos usando o Azure AD Graph.
Para saber mais, confira Importante: Desativação do Azure AD Graph e Substituição do Módulo do PowerShell.
Visão geral
Você pode pensar na página de aterrissagem como o "lobby" para sua oferta de SaaS (software como serviço). Depois que o cliente optar por obter seu aplicativo, o Microsoft Marketplace o direcionará para a página de aterrissagem para ativar e configurar sua assinatura para seu aplicativo SaaS. Ao criar uma oferta de SaaS (software como serviço), no Partner Center, você pode escolher se deseja ou não vender por meio da Microsoft. Se você quiser listar apenas sua oferta no Microsoft Marketplace e não vender por meio da Microsoft, poderá especificar como clientes potenciais podem interagir com a oferta. Ao habilitar a opção Obter agora (Gratuita) ou Lista de avaliação gratuita , você deve especificar uma URL de página de aterrissagem para a qual o usuário pode acessar a assinatura ou avaliação gratuita.
A finalidade da página de aterrissagem é simplesmente receber o usuário para que ele possa ativar a avaliação gratuita ou a assinatura gratuita. Usando o Microsoft Entra ID e o Microsoft Graph, você habilitará o SSO (logon único) para o usuário e obterá detalhes importantes sobre o usuário que você pode usar para ativar sua avaliação gratuita ou assinatura gratuita, incluindo seu nome, endereço de email e organização.
Como as informações necessárias para ativar a assinatura são limitadas e fornecidas pela ID do Microsoft Entra e pelo Microsoft Graph, não deve haver necessidade de solicitar informações que exijam consentimento mais do que básico. Se você precisar de detalhes do usuário que exijam mais consentimento para seu aplicativo, solicite essas informações após a conclusão da ativação da assinatura. Isso permite a ativação de assinatura sem atritos para o usuário e diminui o risco de abandono.
A página de aterrissagem normalmente inclui as seguintes informações e opções de listagem:
- Apresente o nome e os detalhes da avaliação gratuita ou da assinatura gratuita. Por exemplo, especifique os limites de uso ou a duração de uma avaliação.
- Apresente os detalhes da conta do usuário, incluindo nome e sobrenome, organização e email.
- Solicite ao usuário que confirme ou substitua diferentes detalhes da conta.
- Orientar o usuário sobre as próximas etapas após a ativação. Por exemplo, receba um email de boas-vindas, gerencie a assinatura, obtenha suporte ou leia a documentação.
As seções a seguir neste artigo orientam você pelo processo de criação de uma página de aterrissagem:
- Crie um registro de aplicativo do Microsoft Entra para a página de aterrissagem.
- Use um exemplo de código como ponto de partida para seu aplicativo.
- Leia informações de declarações codificadas no token de ID, recebidas da ID do Microsoft Entra após a entrada, que foram enviadas com a solicitação.
- Use a API do Microsoft Graph para coletar informações adicionais, conforme necessário.
Criar um registro de aplicativo do Microsoft Entra
O Microsoft Marketplace é totalmente integrado à ID do Microsoft Entra. Os usuários chegam ao Marketplace autenticados com uma conta do Microsoft Entra ou uma conta da Microsoft (MSA). Depois de adquirir uma assinatura de avaliação gratuita ou gratuita por meio de sua oferta somente de lista, o usuário vai do Marketplace para a URL da página de aterrissagem para ativar e gerenciar sua assinatura para seu aplicativo SaaS. Você deve permitir que o usuário entre em seu aplicativo com o SSO do Microsoft Entra. (A URL da página de aterrissagem é especificada na página de configuração técnica da oferta.)
Dica
Não inclua o caractere de sinal de libra (#) na URL da página de aterrissagem. Caso contrário, os clientes não poderão acessar sua página de aterrissagem.
A primeira etapa para usar a identidade é garantir que sua página de aterrissagem esteja registrada como um aplicativo do Microsoft Entra. O registro do aplicativo permite que você use a ID do Microsoft Entra para autenticar usuários e solicitar acesso aos recursos do usuário. Ele pode ser considerado a definição do aplicativo, que permite que o serviço saiba como emitir tokens para o aplicativo com base nas configurações do aplicativo.
Registrar um novo aplicativo usando o portal do Azure
Para começar, siga as instruções para registrar um novo aplicativo. Para permitir que usuários de outras empresas visitem o aplicativo, você deve escolher Contas em qualquer diretório organizacional (qualquer diretório do Microsoft Entra — multilocatário) e contas pessoais da Microsoft (como Skype ou Xbox) quando perguntado quem pode usar o aplicativo.
Se você pretende consultar a API do Microsoft Graph, configure seu novo aplicativo para acessar APIs Web. Quando você seleciona as permissões de API para este aplicativo, o padrão user.read é suficiente para coletar informações básicas sobre o usuário para tornar o processo de integração suave e automático. Não solicite permissões de API rotuladas que precisem de consentimento do administrador, pois isso impedirá que todos os usuários não administradores acessem sua página de aterrissagem.
Se você precisar de permissões elevadas como parte do seu processo de integração ou provisionamento, considere usar a funcionalidade de consentimento incremental da ID do Microsoft Entra para que todos os usuários enviados do Marketplace possam interagir inicialmente com a página de aterrissagem.
Usar um exemplo de código como ponto de partida
A Microsoft forneceu vários aplicativos de exemplo que implementam um site simples com o logon do Microsoft Entra habilitado. Depois que seu aplicativo é registrado na ID do Microsoft Entra, a folha Início Rápido oferece uma lista de tipos de aplicativos comuns e pilhas de desenvolvimento (Figura 1). Escolha aquele que corresponda ao seu ambiente e siga as instruções para download e configuração.
Figura 1: folha início rápido no portal do Azure
Depois de baixar o código e configurar seu ambiente de desenvolvimento, altere as configurações no aplicativo para refletir a ID do aplicativo, a ID do locatário e o segredo do cliente que você registrou no procedimento anterior. As etapas exatas diferem dependendo de qual exemplo você está usando.
Ler informações de declarações codificadas no token de ID
Como parte do fluxo do OpenID Connect , a ID do Microsoft Entra adiciona um token de ID à solicitação quando o usuário é enviado para a página de aterrissagem. Esse token contém várias informações básicas que podem ser úteis no processo de ativação, incluindo as informações vistas nesta tabela.
| Value | Description |
|---|---|
| Aud | Público-alvo pretendido para esse token. Nesse caso, ele deve corresponder à ID do aplicativo e ser validado. |
| nome_de_usuário_preferido | Nome de usuário primário do usuário visitante. Pode ser um endereço de email, um número de telefone ou outro identificador. |
| Endereço de email do usuário. Esse campo pode estar vazio. | |
| nome | Valor legível por humanos que identifica o assunto do token. Nesse caso, é o nome do usuário. |
| Sem contexto adicional, mantém-se como "oid". | Identificador no sistema de identidade da Microsoft que identifica exclusivamente o usuário entre aplicativos. O Microsoft Graph retornará esse valor como a propriedade ID de uma determinada conta de usuário. |
| Tid | Identificador que representa o locatário do Microsoft Entra do qual o usuário é. No caso de uma identidade MSA, isso sempre será 9188040d-6c67-4c5b-b112-36a304b66dad. Para obter mais informações, consulte a observação na próxima seção: Use a API do Microsoft Graph. |
| Substituto | Identificador que identifica exclusivamente o usuário neste aplicativo específico. |
Usar a API do Microsoft Graph
O token de ID contém informações básicas para identificar o usuário, mas seu processo de ativação pode exigir mais detalhes, como a empresa do usuário, para concluir o processo de integração. Use a API do Microsoft Graph para solicitar essas informações para evitar forçar o usuário a inserir esses detalhes novamente. As permissões padrão user.read incluem as seguintes informações, por padrão:
| Value | Description |
|---|---|
| nome de exibição | Nome exibido no catálogo de endereços do usuário. |
| nome dado | Nome do usuário. |
| título do cargo | Cargo do usuário. |
| Endereço SMTP para o usuário. | |
| mobilePhone | Número de telefone celular primário para o usuário. |
| preferredLanguage | Código ISO 639-1 para o idioma preferencial do usuário. |
| surname | Sobrenome do usuário. |
Mais propriedades, como o nome da empresa do usuário ou a localização do usuário (país/região), podem ser selecionadas para inclusão na solicitação. Para obter mais informações, consulte Propriedades para o tipo de recurso do usuário.
A maioria dos aplicativos registrados com a ID do Microsoft Entra concede permissões delegadas para ler as informações do usuário do locatário do Microsoft Entra de sua empresa. Qualquer solicitação ao Microsoft Graph para essas informações deve ser acompanhada por um token de acesso como autenticação. Etapas específicas para gerar o token de acesso dependerão da pilha de tecnologia que você está usando, mas o código de exemplo conterá um exemplo. Para obter mais informações, consulte Obter acesso em nome de um usuário.
Observação
As contas do locatário do MSA (com ID 9188040d-6c67-4c5b-b112-36a304b66dadde locatário) não retornarão mais informações do que já foram coletadas com o token de ID. Portanto, você pode ignorar essa chamada para a API do Graph para essas contas.