Skip to main content

User Management API

  • Updated

Use cases

The User Management API enables you to sync user data between your platform, such as an HRIS or CRM and your BlueVolt University.

With this API, you can seamlessly add, update, or remove users, ensuring that data reflects any changes made in the primary system in near real-time. It also supports the enrollment and un-enrollment of Learners in specific courses and Training Tracks, helping streamline user access management and authorization processes across platforms.

Users

  • Add Users

The "Add Users" endpoint enables the creation of new user records within the platform. It accepts user-specific data such as name, email, role, group and other attributes, registering them into the system. This endpoint is ideal for bulk importing users or onboarding new individuals, streamlining user data from external systems.

When passing over group roles ( GroupRoleList ), users can be assigned to:

  • 0 = Group Admin

  • 1 = Group member = Student

  • 2 = Report Admin

"GroupRoleList": [
                {
                    "Role": [
                        1
                    ],

Note: Admin roles are strictly limited to group roles. Roles such as Training Track, Course editor, and other university wide admin roles can only be assigned from within the LMS.

Additionally, the GroupRolesType parameter defines how the sync is done.

  • 0 = No data of groups is being synced. All data coming in GroupRoleList will be ignored.

  • 1 = All data coming in GroupRoleList will be ignored. System assign the user as student in the parent group CompanyName ( not recommended )

  • 2 = Groups data included in the payload as the GroupRoleList on every user. Manually created Groups that are empty will be deleted.

  • 3 = Will add groups that doesn't exist in the platform and enroll the users into those groups found in the GroupRoleList parameter, but will not delete Manually created Groups that are empty

"GroupRolesType": 2,

To avoid deletion of Manually created groups that are empty is to keep this configuration in “AddOnly2:

This should be done by a CSM.

image-20241204-182058.png

  • Update Users

The endpoint facilitates modifications to existing user records. It allows you to change user attributes such as email addresses, roles, groups or other details to keep records accurate and current. This is particularly useful for syncing user data from external systems or handling role and permission changes.

  • Remove Users

The endpoint allows for the deletion of user accounts from the system. This is often used to deactivate accounts or clean up unused or duplicate records. Soft deletions is supported by disabling access without full data removal.

Enrolling Learners

Both “Add Users” and “Update Users” endpoints has the ability to enroll users into Courses and/or Training Tracks.

To allow enrollment data to be processed via API request, the university SSO must be configured in the following way:

image-20240830-035544.png

This step should be done by CSM.

Additionally, the following values displayed in the json body of the request must been set to 2 to let the API know that courses and training tracks are being synced:

"EnrollmentSyncType": 2,
"GroupRolesType": 2,
"TrainingTrackSyncType": 2

  • 0: there are no enrollments for courses/training tracks

  • 1: The enrollments are being synced, meaning that IDs not found in the list will be unrolled. This settings will unenroll courses and should be used in limited situation.

  • 2: The courses and training tracks will be added if the user is not enrolled.

Courses

Use this structure to add courses to the user; note that EnrollmentDate and EnrollmentDateSpecified must be null and false, respectively. Add to the EnrollmentList parameter the following structure.

[
    {
      "CourseCode": "390449", // the course instace ID
      "EnrollmentDate": \/Date(123123123),
      "EnrollmentDateSpecified": false
    }
]

Training Tracks

Use the following structure to add training tracks to the user; note that TrackCode is not the same as trainingTrackID; it’s a code defined by the university's admin and can be any random number. Add the following structure to the TrainingTrackList parameter. 

 [
  {
      "TrackCode": "443212",
      "EnrollmentDate": null,
      "EnrollmentDateSpecified": false
  }
]

Limits

There is a limit of 20 requests/minute.

Go back to BlueVolt Developer Portal.

Related articles