Identity APIs

With the Identity APIs, you can create and manage user accounts, configure M2M applications, and query permission groups. You can also configure providers, link providers to applications, and manage MFA settings. On Lerian Cloud, the bearer token determines the scope of user, group, and application results. Clients should not pass tenant ownership through request payloads.

​

Available Endpoints

---

​

Groups API

Query permission groups:

• List Groups
• Retrieve Group Details - Get detailed information about a specific group, including assigned users.

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 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-jd, plugin-br-pix-indirect-btg, and plugin-br-bank-transfer.

​

Partners API

Manage partners and read the scope catalog of each product:

• List Partners - Retrieve the partners of your organization.
• Create a Partner - Register one of your customers as a partner.
• Retrieve a Partner - Get the full details of one partner.
• Update a Partner - Change the access, validity window, IP allowlist, or state of a partner.
• Delete a Partner - Remove a partner that has no applications.
• Retrieve the Partner Ceiling of a Product - Get the most that a partner can receive in one product.
• List Scope Catalogs - Retrieve the scope dimensions of each product that publishes them.
• Retrieve a Product’s Scope Catalog - Get the scope dimensions of one product.

​

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 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.
• List Own Tenants - List the tenants where your email has an active account.
• Set Own Default Tenant - Choose the tenant that your next sign-in goes to.

​

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.
• Request an MFA Disable Confirmation Code - Send a code by email that confirms an MFA disable.
• 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.