Registrar um aplicativo SaaS

  • Artigo

Este artigo explica como registrar um aplicativo SaaS usando o portal Microsoft Azure e como obter o token de acesso do editor (token de acesso do Microsoft Entra). O editor usará esse token para autenticar o aplicativo SaaS chamando as APIs de Cumprimento de SaaS. As APIs de processamento usam as credenciais do cliente OAuth 2.0 para conceder o fluxo nos pontos de extremidade do Microsoft Entra ID (v2.0) para fazer uma solicitação de token de acesso de serviço para serviço.

O Azure Marketplace não impõe restrições ao método de autenticação que seu serviço SaaS usa para usuários finais. O fluxo abaixo é obrigatório apenas para a autenticação do Serviço SaaS no Azure Marketplace.

Para obter mais informações sobre o Microsoft Entra ID (Active Directory), consulte O que é autenticação.

Registrar um aplicativo protegido por ID do Microsoft Entra

Qualquer aplicativo que queira usar os recursos da ID do Microsoft Entra deve primeiro ser registrado em um locatário do Microsoft Entra. Esse processo de registro envolve dar ao Microsoft Entra alguns detalhes sobre seu aplicativo. Para registrar um novo aplicativo usando o portal do Azure, execute as seguintes etapas:

  1. Entre no portal do Azure.

  2. Se sua conta lhe der acesso a mais de um, selecione sua conta no canto superior direito. Em seguida, defina a sessão do portal para o locatário desejado do Microsoft Entra.

  3. No painel de navegação à esquerda, selecione o serviço Microsoft Entra ID, selecione Registros de aplicativose, em seguida, selecione Novo registro de aplicativo.

    Captura de tela de uma tela de registro do aplicativo SaaS Entra.

  4. Na página Criar, insira as informações de registro do aplicativo:

    • Name: insira um nome de aplicativo significativo

    • Tipos de conta suportados:

      Selecione Contas neste diretório organizacional (apenas locatário único).

  5. Ao terminar, selecione Registrar. O Microsoft Entra ID atribui uma ID exclusiva de aplicativo ao seu novo aplicativo. Você deve registrar um aplicativo que acessa apenas a API e como locatário único.

  6. Para criar o segredo do cliente, navegue até a página Segredos e certificados e selecione +Novo segredo do cliente. Copie o valor do segredo para usá-lo em seu código.

A ID do aplicativo Microsoft Entra está associada à sua ID do editor, portanto, verifique se a mesma ID do aplicativo é usada em todas as suas ofertas.

Nota

Se o editor tiver duas ou mais contas diferentes no Partner Center, os detalhes de registro do aplicativo Microsoft Entra poderão ser usados apenas em uma conta. Não há suporte para usar o mesmo par de ID de locatário e ID do aplicativo para uma oferta em uma conta de editor diferente.

Nota

Você deve criar a entidade de serviço do aplicativo registrado no locatário que você usa para criar tokens. Confira esta documentação Como criar a entidade de serviço para um registro de aplicativo.

Como obter o token de autorização do editor

Depois de registrar seu aplicativo, você pode solicitar de forma programática o token de autorização do publicador (token de acesso do Microsoft Entra, usando o endpoint do Azure AD v2). O publicador deve usar esse token ao chamar as várias APIs de Cumprimento de SaaS. Esse token só é válido por uma hora.

Para obter mais informações sobre esses tokens, consulte Microsoft Entra Access Tokens. No fluxo abaixo, é utilizado o token do ponto de extremidade V2.

Obter o token por meio de um HTTP POST

Método HTTP

Postar

URL de solicitação

https://login.microsoftonline.com/*{tenantId}*/oauth2/v2.0/token

Parâmetro de URI
Nome do parâmetro Necessário Descrição
tenantId Verdadeiro ID do locatário do aplicativo Microsoft Entra registrado.
Cabeçalho da solicitação
Nome do cabeçalho Necessário Descrição
content-type Verdadeiro Tipo de conteúdo associado à solicitação. O valor padrão é application/x-www-form-urlencoded.
Corpo da solicitação
Nome da propriedade Necessário Descrição
grant_type Verdadeiro Tipo de concessão. Use "client_credentials".
client_id Verdadeiro Identificador de cliente/aplicativo associado ao aplicativo Microsoft Entra.
client_secret Verdadeiro Segredo associado ao aplicativo Microsoft Entra.
scope Verdadeiro Recurso de destino para o qual o token é solicitado com um escopo padrão. Use 20e940b3-4c77-4b0b-9a53-9e16a1b010a7/.default porque a API SaaS do Marketplace é sempre o recurso de destino nesse caso.
Resposta
Nome Tipo Descrição
200 OK TokenResponse Solicitação bem-sucedida.
TokenResponse

Resposta de exemplo:

{
      "token_type": "Bearer",
      "expires_in": "3600",
      "ext_expires_in": "0",
      "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6ImlCakwxUmNxemhpeTRmcHhJeGRacW9oTTJZayIsImtpZCI6ImlCakwxUmNxemhpeTRmcHhJeGRacW9oTTJZayJ9…"
  }
Elemento Descrição
access_token Esse elemento é o <access_token> que você passará como o parâmetro de autorização ao chamar todas as APIs de medição de SaaS e de processamento do Marketplace. Ao chamar uma API REST protegida, o token é inserido no campo de cabeçalho de solicitação Authorization como um token de "portador", permitindo que a API autentique o chamador.
expires_in O número de segundos em que o token de acesso continua a ser válido, antes de expirar, a partir do tempo de emissão. A data e hora de emissão pode ser encontrada na declaração iat do token.
expires_on O período de tempo em que o token de acesso expira. A data é representada como o número de segundos de "1970-01-01T0:0:0Z UTC" (corresponde à declaração exp do token).
token_type O tipo de token, que é um token de acesso do tipo "Portador", significa que o recurso pode conceder acesso ao portador desse token.

Conteúdo relacionado

Seu aplicativo protegido pelo Microsoft Entra ID agora pode usar as APIs de Assinatura de Processamento de SaaS versão 2 e as APIs de Operações de Processamento de SaaS versão 2.

tutoriais de vídeo