Delete users and Azure AD groups from a course catalog via API

LMS365 allows to remove a user or a group from a course catalog with the help of LMS365 API endpoint.

This article describes what API to use and what steps to perform to delete a user or an Azure AD group from an LMS365 course catalog via API.

TIP   

 

To delete a user or an Azure AD group from a course catalog using API, follow the steps below:

1. Go to https://api.365.systems/ and make sure you are authorized with the relevant API key.

2. Find the CourseCatalogs section, expand it, find DEETE method /odata/v2/CourseCatalogs({id})/Users('{userLogin}') with the Remove user from course catalog description and then select Try it out in the top left corner.

 

 

3. After you select Try it out, two fields will be displayed. You will need to fill in the required parameters:

 

 

4. When ready, select on the Execute button to run the request. 

5. Go to the Responses block to check the results:

  • Number 2xx (for example, 204) under Code shows that the request worked correctly.
  • In the Response body field, you will see the results of the request. The user/group will be deleted from the course catalog and from its Users list, and will be unenrolled from all courses and training plans of this course catalog. 

IMPORTANT   

If a user is enrolled in any course or training plan of the course catalog via any other group - this user will remain in the Users list marked as not added to the course catalog 2022-07-22_12_32_26-Users.png. In this case you will need to remove the user from that group or remove that entire group to delete the user from the course catalog.

 

 

Was this article helpful?
0 out of 0 found this helpful

Comments

Article is closed for comments.