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.
APPLIES TO: Desenvolvedor | Básico v2 | Padrão | Standard v2 | Premium | Premium v2
A ID Externa do Microsoft Entra é uma solução de gerenciamento de identidade de nuvem que permite que identidades externas acessem com segurança seus aplicativos e recursos. Você pode usá-lo para gerenciar o acesso ao portal do desenvolvedor do Gerenciamento de API por identidades externas.
Neste artigo, você aprenderá a configuração do provedor de identidade do Microsoft Entra ID para os seguintes cenários compatíveis com o portal do desenvolvedor do Gerenciamento de API:
- Integração com ID externa do Microsoft Entra no seu locatário da força de trabalho. Por exemplo, se o tenant da sua força de trabalho for da organização Contoso, você pode querer configurar o Google ou o Facebook como um provedor de identidade externo para que esses usuários externos também possam entrar usando suas contas.
- Integração com ID externa do Microsoft Entra em um locatário externo separado. Essa configuração só permite que usuários externos desse locatário entrem no portal do desenvolvedor.
Observação
Atualmente, você não pode configurar mais de um provedor de identidade do Microsoft Entra ID para o portal do desenvolvedor.
Para obter uma visão geral das opções para proteger o acesso ao portal do desenvolvedor, consulte Acesso seguro ao portal do desenvolvedor do Gerenciamento de API.
Observação
O Gerenciamento de API fornece suporte herdado para o Azure Active Directory B2C como um provedor de identidade externo. No entanto, recomendamos que você use o Microsoft Entra External ID como um provedor de identidade ao invés do Azure Active Directory B2C para novas implantações do portal do desenvolvedor do Gerenciamento de APIs.
Importante
A partir de 1º de maio de 2025, o Azure AD B2C não estará mais disponível para compra para novos clientes. Saiba mais em nossas perguntas frequentes.
Pré-requisitos
- Um locatário do Microsoft Entra ID (locatário da força de trabalho) no qual habilitar o acesso externo ou um locatário externo separado
- Permissões para criar um aplicativo e configurar fluxos dos usuários no locatário da força de trabalho.
- Uma instância de Gerenciamento de API. Se você ainda não tiver uma, crie uma instância de Gerenciamento de API do Azure.
- Se você criou sua instância em uma camada v2, habilite o portal do desenvolvedor. Para obter mais informações, consulte Tutorial: Acessar e personalizar o portal do desenvolvedor.
Adicionar um provedor de identidade externo ao seu locatário
Se você estiver usando um locatário da força de trabalho, um provedor de identidade externo deverá estar habilitado nesse locatário. A configuração do provedor de identidade externo está fora do escopo deste artigo. Para mais informações, confira Provedores de identidade para External ID no locatário da força de trabalho.
Criar registro de aplicativo do Microsoft Entra
Criar um registro de aplicativo no seu locatário do Microsoft Entra ID. O registro de aplicativo representa o aplicativo do portal do desenvolvedor no Microsoft Entra e permite que usuários façam login no portal usando o Microsoft Entra ID.
- No portal do Azure, acesse Microsoft Entra ID.
- No menu da barra lateral, em Gerenciar, selecione Registros de aplicativo>+ Novo registro.
- Na página Registrar um aplicativo , insira as informações de registro do aplicativo.
- Na seção Nome , insira um nome de aplicativo de sua escolha.
- Na seção Tipos de conta com suporte , selecione Somente Contas neste diretório organizacional.
- No URI de Redirecionamento, selecione SPA (aplicativo de página única) e insira a seguinte URL:
https://{your-api-management-service-name}.developer.azure-api.net/signin, onde{your-api-management-service-name}está o nome da instância de Gerenciamento de API. - Selecione Registrar para criar o aplicativo. 1.Na página Visão geral do aplicativo, localize a ID do aplicativo (cliente) e a ID do diretório (locatário) e copie esses valores para um local seguro. Você precisa deles mais tarde.
- No menu da barra lateral, em Gerenciar, selecione Certificados &segredos.
- Na página Certificados & segredos , na guia Segredos do Cliente , selecione + Novo segredo do cliente.
- Insira uma Descrição.
- Selecione qualquer opção para Expira.
- Escolha Adicionar.
- Copie o valor do segredo do cliente para um local seguro antes de sair da página. Isso será necessário mais tarde.
- No menu da barra lateral, em Gerenciar, selecione Configuração de token> opcional.
- Em Tipo de token, selecione ID.
- Selecione (verifique) as seguintes declarações: email, family_name, given_name.
- Selecione Adicionar. Se solicitado, selecione Ativar o email do Microsoft Graph, permissão de perfil.
Habilitar o registro automático para seu cliente
Para que usuários externos se inscrevam para acessar o portal do desenvolvedor, você deve concluir estas etapas:
- Habilitar autoatendimento de inscrição para seu locatário.
- Adicione seu aplicativo ao fluxo de usuário de cadastro de autoatendimento.
Para obter mais informações e etapas detalhadas, consulte os seguintes artigos, dependendo de você estar usando uma força de trabalho ou um locatário externo:
- Locatário da força de trabalho: adicionar fluxos dos usuários de autoatendimento para colaboração B2B
- Locatário externo: criar um fluxo de usuário de inscrição e entrada para um aplicativo de locatário externo e adicionar um aplicativo ao fluxo do usuário
Configurar a ID do Microsoft Entra como um provedor de identidade para o portal do desenvolvedor
Em sua instância de Gerenciamento de API, configure o provedor de identidade do Microsoft Entra ID. Você precisa dos valores copiados do registro do seu aplicativo em uma seção anterior.
Na guia portal do Azure, navegue até a instância de Gerenciamento de API.
No menu da barra lateral, no portal do Desenvolvedor, selecione Identidades>+ Adicionar.
Na página Adicionar provedor de identidade , selecione a ID do Microsoft Entra. Depois de selecionado, você poderá inserir outras informações necessárias.
- Na ID do cliente, insira a ID do aplicativo (cliente) do registro do aplicativo.
- No segredo do cliente, insira o valor secreto do registro do aplicativo.
- Em Locatário de entrada, inserir o ID do diretório (locatário) do registro do seu aplicativo.
- Na lista suspensa Biblioteca do cliente, selecione MSAL.
Selecione Adicionar.
Republice o portal do desenvolvedor para que a configuração do Microsoft Entra entre em vigor. No menu da barra lateral, no portal do Desenvolvedor, selecionePublicar> do Portal.
Importante
Você precisa republicar o portal do desenvolvedor ao criar ou atualizar as configurações do provedor de identidade para que as alterações entrem em vigor.
Iniciar sessão no portal do desenvolvedor com ID externa do Microsoft Entra
No portal do desenvolvedor, é possível entrar com a ID Externa do Microsoft Entra utilizando o botão de entrada do widget OAuth. O widget já está incluído na página de entrada do conteúdo do portal do desenvolvedor padrão.
Para entrar usando a ID Externa do Microsoft Entra, abra uma nova janela do navegador e acesse o portal do desenvolvedor. Selecione Entrar.
Na página Entrar , selecione Azure Active Directory.
Na janela de entrada do locatário do Microsoft Entra, selecione opções de entrada. Selecione o provedor de identidade configurado em seu locatário do Microsoft Entra para entrar. Por exemplo, se você configurou o Google como um provedor de identidade, selecione Entrar com o Google.
Para continuar o login, responda às solicitações. Depois que a entrada for concluída, você será redirecionado de volta para o portal do desenvolvedor.
Agora você está conectado ao portal do desenvolvedor para sua instância de serviço de Gerenciamento de API. Você foi adicionado como uma nova identidade de usuário do Gerenciamento de API em Usuários e como um novo usuário de locatário externo no Microsoft Entra ID.