User Management via APIs



This article describes the benefits of utilizing User Management APIs, which offer partners a comprehensive framework for streamlining user management workflows. By utilizing these APIs, partners can efficiently onboard and manage users in bulk while ensuring the integrity of user data and maintaining an updated list of active users on their platform for security and analytics purposes.

Audience: integration developers, business analysts, security officers, and software architects.

APIs in Scope:

1. List All Users

Retrieve a comprehensive list of all users associated with a selected platform or customer. The response will provide detailed information about each user, including their ID, creation date, accessibility, account state, and more. This enables you to gather insights and efficiently manage your user base.

For example, this endpoint can be leveraged to programmatically retrieve an up-to-date user list, which can be seamlessly integrated within the partner's user management console. As a result, providing a centralized view of user information for efficient administration and enhanced security.

2. List All Roles

Retrieve an array of platform roles, each containing details such as ID, name, and weight. You can utilize this information to manage user permissions and assign users to specific groups for streamlined access control. Group "Id" can be used to configure user permissions while inviting a user by "Invite a user".

3. List Identity Providers

The response will list identity providers configured for a platform (see. Authentication Management) and include details, such as ID, name, prefix, and enabled status. This allows partners to invite user accounts to authenticate through specific identity providers, expanding authentication options and enhancing user convenience.

4. Invite a User

The "Invite a user" endpoint allows partners to streamline the user onboarding process and efficiently invite multiple users simultaneously, offering several benefits for bulk user onboarding. 

  • Efficient User Provisioning. The "Invite a user" endpoint enables seamless integration with your existing user management systems. By programmatically sending invitations, you can automate the user provisioning process, saving time and effort without the need for manual user creation.
  • Bulk User Onboarding. By utilizing the "Invite a user" endpoint, you can invite multiple users to your platform in a single API call. The API payload includes an array called "Users," where you can include multiple user objects. This makes it incredibly convenient and time-efficient when onboarding a large number of users at once.
  • Flexible User Organization Assignment. The API payload also includes an array called "OrganizationIds," where the partner can specify multiple organization IDs for each invited user. This means that a single user can be invited and assigned to multiple organizations within the platform. This flexibility allows for streamlined user management across various organizational structures and simplifies access control.


By leveraging the benefits of the "Invite a user" endpoint, including bulk user onboarding, flexible organization assignment, and efficient provisioning, you can streamline the process of inviting users to your platform. Whether you are bringing onboard a large number of users or managing users across multiple organizations, this endpoint provides the necessary capabilities to simplify and automate the process.

Was this article helpful?

0 out of 0 found this helpful

Add comment

Please sign in to leave a comment.