Usar conectores de API para personalizar e estender a inscrição por autoatendimento

Aplica-se a: Círculo verde com um símbolo de marca de seleção branca que indica que o conteúdo a seguir se aplica aos locatários da força de trabalho. Locatários da força de trabalho (saiba mais)

Visão geral

Como desenvolvedor ou administrador de TI, você pode usar conectores de API para integrar seus fluxos dos usuários de inscrição por autoatendimento com APIs Web para personalizar a experiência de inscrição e fazer integração com sistemas externos. Por exemplo, com conectores de API, você pode:

  • Fazer integração com fluxo de trabalho de aprovação personalizado. Conecte-se a um sistema de aprovação personalizado para gerenciar e limitar a criação da conta.
  • Executar 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.
  • Validar os dados de entrada do usuário. Verificar a existência de dados de usuário malformados ou inválidos. Por exemplo, você pode validar dados fornecidos pelo usuário em relação a dados existentes em um armazenamento de dados externo ou lista de valores permitidos. Se forem inválidos, você poderá solicitar que um usuário forneça dados válidos ou impedir que o usuário continue o fluxo de inscrição.
  • Substituir atributos de usuário. Reformate ou atribua um valor a um atributo coletado do usuário. Por exemplo, se um usuário inserir o nome com todas as letras maiúsculas ou minúsculas, você poderá formatar o nome usando somente a primeira letra maiúscula.
  • Executar a lógica de negócios personalizada. Você pode disparar 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 Microsoft Entra ID as informações necessárias para fazer uma chamada a um endpoint de API, definindo a URL do endpoint HTTP e a autenticação para a chamada à API. Depois de configurar um conector de API, você poderá 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 de API é invocado e enviado como uma solicitação HTTP POST para sua API, com informações do usuário (declarações) como pares chave-valor em um corpo JSON. A resposta à 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 insira novamente as informações ou que substitua e acrescente atributos de usuário.

Como habilitar um conector de API em um fluxo de usuário

Há dois modos de habilitar um conector de API no fluxo de usuário:

  • Após a federação 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 o cadastro do usuário, não no login.

Após a federação com um provedor de identidade durante a inscrição

Um conector de API nesta etapa no processo de inscrição é invocado imediatamente após o usuário se autenticar com um provedor de identidade (por exemplo, Google, Facebook e Microsoft Entra ID). Esta etapa precede a página de coleção de atributos, que é o formulário apresentado ao usuário para coletar atributos de usuário. Essa etapa não será invocada se um usuário estiver se registrando com uma conta local. Veja os seguintes exemplos de cenários de conector de API que você pode habilitar nessa etapa:

  • Use o email 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 de bloqueio com base na identidade social.

Antes de criar o usuário

Nesta etapa no processo de inscrição, um conector de API é invocado após a página de coleção de atributos, se incluída. Essa etapa é sempre invocada antes da criação de uma conta de usuário. Veja os seguintes exemplos de cenários que você pode habilitar neste ponto durante a inscrição:

  • Validar os dados de entrada do usuário e pedir ao usuário para reenviar os dados.
  • Bloquear uma inscrição de usuário com base nos dados inseridos pelo usuário.
  • Executar verificação de identidade.
  • Consulte sistemas externos para obter dados existentes sobre o usuário para devolvê-los no token de aplicativo ou armazená-los em Microsoft Entra ID.

Próximas etapas

  • Last updated on