> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Identity APIs

> Crie e gerencie usuários, aplicações M2M, grupos de permissão, provedores de identidade e configurações de MFA entre tenants com as Identity APIs do Access Manager.

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. Na Lerian Cloud, 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:

* [**Listar grupos**](https://docs.lerian.studio/pt/reference/platform/access-manager/list-groups.md)
* [**Obter detalhes do grupo**](https://docs.lerian.studio/pt/reference/platform/access-manager/retrieve-group-details.md) - Obtenha informações detalhadas sobre um grupo específico, incluindo os usuários atribuídos.

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**](https://docs.lerian.studio/pt/reference/platform/access-manager/create-an-application.md) - Registre uma nova aplicação para autenticação machine-to-machine.
* [**Emitir uma credencial de serviço**](https://docs.lerian.studio/pt/reference/platform/access-manager/issue-a-service-credential.md) - Emita a aplicação com que um serviço Lerian faz login, em um deploy single-tenant.
* [**Listar aplicações**](https://docs.lerian.studio/pt/reference/platform/access-manager/list-applications.md)
* [**Obter detalhes da aplicação**](https://docs.lerian.studio/pt/reference/platform/access-manager/retrieve-application-details.md) - Obtenha informações detalhadas sobre uma aplicação específica.
* [**Excluir uma aplicação**](https://docs.lerian.studio/pt/reference/platform/access-manager/delete-application.md) - 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 parceiros

Gerencie parceiros e leia o catálogo de escopo de cada produto:

* [**Listar parceiros**](https://docs.lerian.studio/pt/reference/platform/access-manager/list-partners.md) - Obtenha os parceiros da sua organização.
* [**Criar um parceiro**](https://docs.lerian.studio/pt/reference/platform/access-manager/create-a-partner.md) - Registre um dos seus clientes como parceiro.
* [**Obter um parceiro**](https://docs.lerian.studio/pt/reference/platform/access-manager/retrieve-a-partner.md) - Obtenha todos os detalhes de um parceiro.
* [**Atualizar um parceiro**](https://docs.lerian.studio/pt/reference/platform/access-manager/update-a-partner.md) - Altere o acesso, a janela de validade, a lista de IPs permitidos ou o estado de um parceiro.
* [**Excluir um parceiro**](https://docs.lerian.studio/pt/reference/platform/access-manager/delete-a-partner.md) - Remova um parceiro que não tem aplicações.
* [**Obter o teto de parceiro de um produto**](https://docs.lerian.studio/pt/reference/platform/access-manager/retrieve-the-partner-ceiling-of-a-product.md) - Obtenha o máximo que um parceiro pode receber em um produto.
* [**Listar catálogos de escopo**](https://docs.lerian.studio/pt/reference/platform/access-manager/list-scope-catalogs.md) - Obtenha as dimensões de escopo de cada produto que as publica.
* [**Obter o catálogo de escopo de um produto**](https://docs.lerian.studio/pt/reference/platform/access-manager/retrieve-a-product-s-scope-catalog.md) - Obtenha as dimensões de escopo de um produto.

### API de provedores

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

* [**Listar provedores**](https://docs.lerian.studio/pt/reference/platform/access-manager/list-providers.md) - Recupere os provedores de comunicação disponíveis.
* [**Criar um provedor**](https://docs.lerian.studio/pt/reference/platform/access-manager/create-a-provider.md) - Crie um novo provedor de comunicação.
* [**Obter um provedor**](https://docs.lerian.studio/pt/reference/platform/access-manager/retrieve-a-provider.md) - Obtenha detalhes de um provedor específico.
* [**Atualizar um provedor**](https://docs.lerian.studio/pt/reference/platform/access-manager/update-a-provider.md) - Atualize a configuração do provedor.
* [**Excluir um provedor**](https://docs.lerian.studio/pt/reference/platform/access-manager/delete-a-provider.md) - Remova um provedor.

### API de provedores de aplicação

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

* [**Listar provedores de aplicação**](https://docs.lerian.studio/pt/reference/platform/access-manager/list-application-providers.md) - Recupere os provedores vinculados a uma aplicação.
* [**Vincular provedor à aplicação**](https://docs.lerian.studio/pt/reference/platform/access-manager/link-provider-to-application.md) - Vincule um provedor a uma aplicação.
* [**Atualizar vínculo de provedor da aplicação**](https://docs.lerian.studio/pt/reference/platform/access-manager/update-application-provider-link.md) - Atualize um vínculo de provedor.
* [**Desvincular provedor da aplicação**](https://docs.lerian.studio/pt/reference/platform/access-manager/unlink-provider-from-application.md) - Remova um vínculo de provedor de uma aplicação.
* [**Definir provedor padrão da aplicação**](https://docs.lerian.studio/pt/reference/platform/access-manager/set-default-application-provider.md) - Selecione o provedor padrão para uma aplicação.

### API de usuários

Gerencie contas de usuário e credenciais:

* [**Criar um usuário**](https://docs.lerian.studio/pt/reference/platform/access-manager/create-user.md) - Crie uma nova conta de usuário com atribuições de grupo.
* [**Listar usuários**](https://docs.lerian.studio/pt/reference/platform/access-manager/list-users.md)
* [**Obter detalhes do usuário**](https://docs.lerian.studio/pt/reference/platform/access-manager/retrieve-user-details.md) - Obtenha informações detalhadas sobre um usuário específico.
* [**Atualizar um usuário**](https://docs.lerian.studio/pt/reference/platform/access-manager/update-user.md) - Modifique as informações do usuário e as associações de grupo.
* [**Excluir um usuário**](https://docs.lerian.studio/pt/reference/platform/access-manager/delete-user.md) - Remova um usuário do sistema.
* [**Redefinir a senha de um usuário**](https://docs.lerian.studio/pt/reference/platform/access-manager/reset-user-password.md) - Redefina a senha de um usuário (ação administrativa).
* [**Atualizar a senha de um usuário**](https://docs.lerian.studio/pt/reference/platform/access-manager/update-user-password.md) - Altere a senha de um usuário com verificação da senha atual.
* [**Listar os próprios tenants**](https://docs.lerian.studio/pt/reference/platform/access-manager/list-own-tenants.md) - Liste os tenants em que o seu email tem uma conta ativa.
* [**Definir o próprio tenant padrão**](https://docs.lerian.studio/pt/reference/platform/access-manager/set-own-default-tenant.md) - Escolha o tenant para onde vai o seu próximo login.

### API de MFA

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

* [**Iniciar configuração de MFA**](https://docs.lerian.studio/pt/reference/platform/access-manager/initiate-mfa-setup.md) - Inicie a configuração de MFA para um usuário.
* [**Verificar código de MFA**](https://docs.lerian.studio/pt/reference/platform/access-manager/verify-mfa-passcode.md) - Verifique um código de configuração de MFA.
* [**Habilitar MFA**](https://docs.lerian.studio/pt/reference/platform/access-manager/enable-mfa.md) - Habilite o MFA após a verificação da configuração.
* [**Obter status do MFA**](https://docs.lerian.studio/pt/reference/platform/access-manager/get-mfa-status.md) - Recupere o status atual de MFA de um usuário.
* [**Definir método de MFA preferido**](https://docs.lerian.studio/pt/reference/platform/access-manager/set-preferred-mfa-method.md) - Altere o método de MFA preferido do usuário.
* [**Solicitar código de confirmação para desabilitar o MFA**](https://docs.lerian.studio/pt/reference/platform/access-manager/request-an-mfa-disable-confirmation-code.md) - Envie por email um código que confirma a desabilitação do MFA.
* [**Desabilitar MFA**](https://docs.lerian.studio/pt/reference/platform/access-manager/disable-mfa.md) - Desabilite o MFA para um usuário.

### API de passkey

Gerencie o login com passkey e as passkeys:

* [**Obter a política de passkey**](https://docs.lerian.studio/pt/reference/platform/access-manager/get-passkey-policy.md) - Veja se a sua organização oferece login com passkey.
* [**Atualizar a política de passkey**](https://docs.lerian.studio/pt/reference/platform/access-manager/update-passkey-policy.md) - Ative ou desative o login com passkey.
* [**Obter a passkey**](https://docs.lerian.studio/pt/reference/platform/access-manager/get-passkey.md) - Veja se a sua própria conta tem uma passkey.
* [**Começar o cadastro de passkey**](https://docs.lerian.studio/pt/reference/platform/access-manager/begin-passkey-enrollment.md) - Obtenha as opções de criação WebAuthn para a sua própria passkey.
* [**Concluir o cadastro de passkey**](https://docs.lerian.studio/pt/reference/platform/access-manager/finish-passkey-enrollment.md) - Envie a credencial criada e adicione a passkey.
* [**Excluir a passkey**](https://docs.lerian.studio/pt/reference/platform/access-manager/delete-passkey.md) - Remova a sua própria passkey.

## Referências relacionadas

***

* [Auth APIs](https://docs.lerian.studio/pt/reference/platform/access-manager/am-auth-apis.md) - Solicite tokens, renove tokens, obtenha informações do usuário e valide permissões.
* [Lista de erros do Access Manager](https://docs.lerian.studio/pt/reference/platform/access-manager/access-manager-error-list.md) - Revise os códigos de erro do Identity.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.