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 - Retrieve all available groups in the system.
• 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 - Register a new application for machine-to-machine authentication.
• List Applications - Retrieve all registered applications.
• Retrieve Application Details - Get detailed information about a specific application.
• Delete an 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 - Retrieve available communication providers.
• Create a Provider - Create a new communication provider.
• Retrieve a Provider - Get details for a specific provider.
• Update a Provider - Update provider configuration.
• Delete a Provider - Remove a provider.

Application Providers API

Manage provider links for applications:

• List Application Providers - Retrieve providers linked to an application.
• Link Provider to Application - Link a provider to an application.
• Update Application Provider Link - Update a provider link.
• Unlink Provider from Application - Remove a provider link from an application.
• Set Default Application Provider - Select the default provider for an application.

Users API

Manage user accounts and credentials:

• Create a User - Create a new user account with group assignments.
• List Users - Retrieve all users in the system.
• Retrieve User Details - Get detailed information about a specific user.
• Update a User - Modify user information and group memberships.
• Delete a User - Remove a user from the system.
• Reset a User Password - Reset a user’s password (admin action).
• Update a User Password - Change a user’s password with current password verification.

MFA API

Manage MFA setup and user MFA preferences:

• Initiate MFA Setup - Start MFA setup for a user.
• Verify MFA Passcode - Verify an MFA setup passcode.
• Enable MFA - Enable MFA after setup verification.
• Get MFA Status - Retrieve the current MFA status for a user.
• Set Preferred MFA Method - Change the user’s preferred MFA method.
• Disable MFA - Disable MFA for a user.

Related references

---

• Auth APIs - Request tokens, refresh tokens, retrieve user information, and validate permissions.
• Access Manager error list - Review Identity error codes.