Add users to a course catalog via the API

Users can be invited to a course catalog via the Learn365 Admin Center or the LMS365 (Learn365) API.

In this article, we describe how to add a user to a course catalog via the LMS365 (Learn365) API.

 

To add a user to a course catalog via the LMS365 (Learn365) API, follow these steps:

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

2. Find the CourseCatalogs section, expand it, find POST /odata/v2/CourseCatalogs({id})/Users with the Add user to the Course Catalog description, and then select Try it out in the top right-hand corner.

 

2022-07-22_11_44_25-LMS365_API.png

 

3. After you select Try it out, you'll need to complete the parameters:

{
"LoginName": "string", (replace string with the User principal name from Azure AD).
"DirectoryObjectId": "string", (replace string with Object ID). This parameter is required if there can be users with the same login names in the organization's Azure AD, for example the user was deleted and created again or there are users with the same first and last names.
}

 

Other parameters are optional. 


EXAMPLE

{
"LoginName": "ChrisEvance@lms365preview.onmicrosoft.com",
"DirectoryObjectId": "e46480dd-39ec-4da4-ad23-153fb0430d2c"
}

2023-02-22_16_14_44-LMS365_API.png

 

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

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

  • Number 2xx (for example, 202) under Code shows that the request worked correctly.
  • In the Response body field, you'll see the result of the request - the user will be added to the target catalog, and they'll be displayed in its Users list with the data taken from the organization's Azure AD (if provided for the user).

The user will be given access to view all course and training plan home pages of the catalog, preventing them from encountering an access denied message from SharePoint when they navigate around the catalog. 

 

2023-02-22_16_15_37-LMS365_API.png

 

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

Comments

Article is closed for comments.