Identity APIs

Com as Identity APIs, você pode criar e gerenciar contas de usuário, configurar aplicações M2M e consultar grupos de permissão. Você também pode configurar provedores, vincular provedores a aplicações e gerenciar configurações de MFA. Em deploys multi-tenant, o bearer token determina o escopo dos resultados de usuário, grupo e aplicação. Recomenda-se que os clientes não repassem a posse do tenant pelos payloads da requisição.

​

Endpoints disponíveis

---

​

API de grupos

Consulte grupos de permissão predefinidos:

• Listar grupos - Recupere todos os grupos disponíveis no sistema.
• Obter detalhes do grupo - Obtenha informações detalhadas sobre um grupo específico, incluindo os usuários atribuídos.

Cada grupo mantém um conjunto predefinido de permissões. Use os IDs de grupo retornados aqui ao criar ou atualizar usuários.

​

API de aplicações

Gerencie credenciais de aplicações M2M:

• Criar uma aplicação - Registre uma nova aplicação para autenticação machine-to-machine.
• Listar aplicações - Recupere todas as aplicações registradas.
• Obter detalhes da aplicação - Obtenha informações detalhadas sobre uma aplicação específica.
• Excluir uma aplicação - Remova uma aplicação e suas credenciais.

Os nomes de aplicações M2M atuais incluem midaz, plugin-fees, plugin-crm, reporter, plugin-br-pix-jd, plugin-br-pix-indirect-btg e plugin-br-bank-transfer.

​

API de provedores

Gerencie provedores de comunicação para entrega de MFA:

• Listar provedores - Recupere os provedores de comunicação disponíveis.
• Criar um provedor - Crie um novo provedor de comunicação.
• Obter um provedor - Obtenha detalhes de um provedor específico.
• Atualizar um provedor - Atualize a configuração do provedor.
• Excluir um provedor - Remova um provedor.

​

API de provedores de aplicação

Gerencie vínculos de provedor para aplicações:

• Listar provedores de aplicação - Recupere os provedores vinculados a uma aplicação.
• Vincular provedor à aplicação - Vincule um provedor a uma aplicação.
• Atualizar vínculo de provedor da aplicação - Atualize um vínculo de provedor.
• Desvincular provedor da aplicação - Remova um vínculo de provedor de uma aplicação.
• Definir provedor padrão da aplicação - Selecione o provedor padrão para uma aplicação.

​

API de usuários

Gerencie contas de usuário e credenciais:

• Criar um usuário - Crie uma nova conta de usuário com atribuições de grupo.
• Listar usuários - Recupere todos os usuários no sistema.
• Obter detalhes do usuário - Obtenha informações detalhadas sobre um usuário específico.
• Atualizar um usuário - Modifique as informações do usuário e as associações de grupo.
• Excluir um usuário - Remova um usuário do sistema.
• Redefinir a senha de um usuário - Redefina a senha de um usuário (ação administrativa).
• Atualizar a senha de um usuário - Altere a senha de um usuário com verificação da senha atual.

​

API de MFA

Gerencie a configuração de MFA e as preferências de MFA do usuário:

• Iniciar configuração de MFA - Inicie a configuração de MFA para um usuário.
• Verificar código de MFA - Verifique um código de configuração de MFA.
• Habilitar MFA - Habilite o MFA após a verificação da configuração.
• Obter status do MFA - Recupere o status atual de MFA de um usuário.
• Definir método de MFA preferido - Altere o método de MFA preferido do usuário.
• Desabilitar MFA - Desabilite o MFA para um usuário.

​

Referências relacionadas

---

• Auth APIs - Solicite tokens, renove tokens, obtenha informações do usuário e valide permissões.
• Lista de erros do Access Manager - Revise os códigos de erro do Identity.