Usar conectores de API para personalizar e estender a inscrição de autoatendimento
Aplica-se a:
Locatários da força de
trabalho Locatários externos (saiba mais)
Descrição geral
Como desenvolvedor ou administrador de TI, você pode usar conectores de API para integrar seus fluxos de usuário de inscrição de autoatendimento com APIs da Web para personalizar a experiência de inscrição e integrar com sistemas externos. Por exemplo, com conectores de API, você pode:
- Integre com um fluxo de trabalho de aprovação personalizado. Conecte-se a um sistema de aprovação personalizado para gerenciar e limitar a criação de contas.
- Execute a verificação de identidade. Use um serviço de verificação de identidade para adicionar um nível extra de segurança às decisões de criação de conta.
- Valide os dados de entrada do usuário. Valide contra dados de usuário malformados ou inválidos. Por exemplo, você pode validar dados fornecidos pelo usuário em relação aos dados existentes em um armazenamento de dados externo ou lista de valores permitidos. Se for inválido, você pode pedir a um usuário para fornecer dados válidos ou impedir que o usuário continue o fluxo de inscrição.
- Substitua atributos de usuário. Reformatar ou atribuir um valor a um atributo coletado do usuário. Por exemplo, se um usuário inserir o primeiro nome em todas as letras minúsculas ou maiúsculas, você poderá formatar o nome apenas com a primeira letra em maiúsculas.
- Execute uma lógica de negócios personalizada. Você pode acionar eventos downstream em seus sistemas de nuvem para enviar notificações por push, atualizar bancos de dados corporativos, gerenciar permissões, auditar bancos de dados e executar outras ações personalizadas.
Um conector de API fornece ao ID do Microsoft Entra as informações necessárias para chamar o ponto de extremidade da API, definindo a URL do ponto de extremidade HTTP e a autenticação para a chamada de API. Depois de configurar um conector de API, você pode habilitá-lo para uma etapa específica em um fluxo de usuário. Quando um usuário atinge essa etapa no fluxo de inscrição, o conector da API é invocado e se materializa como uma solicitação HTTP POST para sua API, enviando informações do usuário ("declarações") como pares chave-valor em um corpo JSON. A resposta da API pode afetar a execução do fluxo do usuário. Por exemplo, a resposta da API pode impedir que um usuário se inscreva, pedir que o usuário reinsira informações ou substituir e acrescentar atributos de usuário.
Onde você pode habilitar um conector de API em um fluxo de usuário
Há dois locais em um fluxo de usuário onde você pode habilitar um conector de API:
- Depois de federar com um provedor de identidade durante a inscrição
- Antes de criar o usuário
Importante
Em ambos os casos, os conectores de API são invocados durante a inscrição do usuário, não o login.
Depois de federar com um provedor de identidade durante a inscrição
Um conector de API nesta etapa do processo de inscrição é invocado imediatamente após o usuário se autenticar com um provedor de identidade (como Google, Facebook, & Microsoft Entra ID). Esta etapa precede a página de coleta de atributos, que é o formulário apresentado ao usuário para coletar atributos de usuário. Esta etapa não será invocada se um usuário estiver se registrando com uma conta local. A seguir estão exemplos de cenários de conector de API que você pode habilitar nesta etapa:
- Use o e-mail ou a identidade federada que o usuário forneceu para pesquisar declarações em um sistema existente. Retorne essas declarações do sistema existente, preencha previamente a página de coleta de atributos e disponibilize-as para retornar no token.
- Implemente uma lista de permissões ou bloqueios com base na identidade social.
Antes de criar o usuário
Um conector de API nesta etapa do processo de inscrição é invocado após a página de coleta de atributos, se uma estiver incluída. Esta etapa é sempre invocada antes da criação de uma conta de usuário. A seguir estão exemplos de cenários que você pode habilitar neste momento durante a inscrição:
- Valide os dados de entrada do usuário e peça a um usuário para reenviar dados.
- Bloquear uma inscrição de usuário com base nos dados inseridos pelo usuário.
- Execute a verificação de identidade.
- Consulte sistemas externos em busca de dados existentes sobre o usuário para retorná-los no token do aplicativo ou armazená-los no ID do Microsoft Entra.