> ## 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

With the **Identity APIs**, you can create and manage user accounts, configure M2M applications, query permission groups, configure providers, link providers to applications, and manage MFA settings. In multi-tenant deployments, user, group, and application results are scoped from the bearer token; clients should not pass tenant ownership through request payloads.

## Available Endpoints

***

### Groups API

Query predefined permission groups:

* [**List Groups**](/en/reference/access-manager/list-groups) - Retrieve all available groups in the system.
* [**Retrieve Group Details**](/en/reference/access-manager/retrieve-group-details) - Get detailed information about a specific group, including assigned users.

Groups are predefined permission sets. Use the group IDs returned here when creating or updating users.

### Applications API

Manage M2M application credentials:

* [**Create an Application**](/en/reference/access-manager/create-an-application) - Register a new application for machine-to-machine authentication.
* [**List Applications**](/en/reference/access-manager/list-applications) - Retrieve all registered applications.
* [**Retrieve Application Details**](/en/reference/access-manager/retrieve-application-details) - Get detailed information about a specific application.
* [**Delete an Application**](/en/reference/access-manager/delete-application) - Remove an application and its credentials.

Current M2M application names include `midaz`, `plugin-fees`, `plugin-crm`, `reporter`, `plugin-br-pix-direct-jd`, `plugin-br-pix-indirect-btg`, and `plugin-br-bank-transfer`.

### Providers API

Manage communication providers for MFA delivery:

* [**List Providers**](/en/reference/access-manager/list-providers) - Retrieve available communication providers.
* [**Create a Provider**](/en/reference/access-manager/create-a-provider) - Create a new communication provider.
* [**Retrieve a Provider**](/en/reference/access-manager/retrieve-a-provider) - Get details for a specific provider.
* [**Update a Provider**](/en/reference/access-manager/update-a-provider) - Update provider configuration.
* [**Delete a Provider**](/en/reference/access-manager/delete-a-provider) - Remove a provider.

### Application Providers API

Manage provider links for applications:

* [**List Application Providers**](/en/reference/access-manager/list-application-providers) - Retrieve providers linked to an application.
* [**Link Provider to Application**](/en/reference/access-manager/link-provider-to-application) - Link a provider to an application.
* [**Update Application Provider Link**](/en/reference/access-manager/update-application-provider-link) - Update a provider link.
* [**Unlink Provider from Application**](/en/reference/access-manager/unlink-provider-from-application) - Remove a provider link from an application.
* [**Set Default Application Provider**](/en/reference/access-manager/set-default-application-provider) - Select the default provider for an application.

### Users API

Manage user accounts and credentials:

* [**Create a User**](/en/reference/access-manager/create-user) - Create a new user account with group assignments.
* [**List Users**](/en/reference/access-manager/list-users) - Retrieve all users in the system.
* [**Retrieve User Details**](/en/reference/access-manager/retrieve-user-details) - Get detailed information about a specific user.
* [**Update a User**](/en/reference/access-manager/update-user) - Modify user information and group memberships.
* [**Delete a User**](/en/reference/access-manager/delete-user) - Remove a user from the system.
* [**Reset a User Password**](/en/reference/access-manager/reset-user-password) - Reset a user's password (admin action).
* [**Update a User Password**](/en/reference/access-manager/update-user-password) - Change a user's password with current password verification.

### MFA API

Manage MFA setup and user MFA preferences:

* [**Initiate MFA Setup**](/en/reference/access-manager/initiate-mfa-setup) - Start MFA setup for a user.
* [**Verify MFA Passcode**](/en/reference/access-manager/verify-mfa-passcode) - Verify an MFA setup passcode.
* [**Enable MFA**](/en/reference/access-manager/enable-mfa) - Enable MFA after setup verification.
* [**Get MFA Status**](/en/reference/access-manager/get-mfa-status) - Retrieve the current MFA status for a user.
* [**Set Preferred MFA Method**](/en/reference/access-manager/set-preferred-mfa-method) - Change the user's preferred MFA method.
* [**Disable MFA**](/en/reference/access-manager/disable-mfa) - Disable MFA for a user.

## Related references

***

* [Auth APIs](/en/reference/access-manager/am-auth-apis) - Request tokens, refresh tokens, retrieve user information, and validate permissions.
* [Access Manager error list](/en/reference/access-manager/access-manager-error-list) - Review Identity error codes.
