Add a custom user group owner via API

The Learn365 API enables you to add catalog admins as owners of custom user groups. While LMS admins can manage any custom user group in their organization, catalog admins can manage the custom user groups they own. You can find the list of actions available for catalog admins at the end of this article.

In this article, we describe how to add an owner to a new or existing custom user group.

Find catalog admin user IDs

To find catalog admin user IDs, follow the steps from this article.

Add an owner to a new custom user group

Required role: LMS admin, catalog admin.

To add an owner while creating a new custom user group, follow the steps from the Create custom user groups section of this article.

Add an owner to an existing custom user group

Required role: LMS admin. Catalog admin if they are the owner of the group.

To add an owner to an existing custom user group, you'll need the group ID. Also, it's worth checking if the group already has owners. To get this information:

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

2. In the Groups section, select the GET /services/users/v2/Groups endpoint and select Try it out in the top right-hand corner.

3. If needed, use query option parameters to control the data in the response.

4. Select Execute to run the request.

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

• 200 code with a list of user groups means a successful response. 100 groups are the limit for one response. To control the data in the response, use query option parameters.
• Each user group has these parameters:
  • id: the user group ID. You'll need this ID to add an owner to the group.
  • ownerIds: a list of the user group owner IDs. If the user group doesn't have owners, the list is empty. 

To add an owner to an existing custom user group:

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

2. In the Groups section, select the PUT /services/users/v2/Groups/{groupId} endpoint and select Try it out in the top right-hand corner.

3. In the groupId field, enter the custom user group ID.

4. In the request body, enter the:

• title string parameter. If you want the user group title to stay the same, enter the current title. If you want to change it, enter a new title. The title must be unique, meaning it can’t belong to an existing custom user group or Microsoft Entra group. To see a list of existing custom user groups and Microsoft Entra groups, send the GET /services/users/v2/Groups API request.
• ownerIds array: a list of user IDs of the catalog admins that are going to be the owners of the user group. Keep in mind that the list of new group owners replaces existing user group owners, if there are any.

The request body may look like this:

{
 "title": "Sound Engineers",
 "ownerIds": [
 "3fa85f64-5717-4562-b3fc-2c963f66afa6",
 "fa35cdf2-75bd-40b0-ac0d-b5ca7bfde448" 
 ]
}

5. Select Execute to run the request.

6. Go to the Response block to check the results:

• 200 code with the group id and title in the response body indicates a successful response.
• In case of errors, the response body contains the error object with the code and message keys explaining the issue.

Actions available to user group owners

The following actions are available for catalog admins, no matter if they’re admins of custom user groups or not:

• View a list of user groups and get their IDs.
• Create a custom user group.
• Get information about a particular user group via the GET /services/users/v2/Groups/{groupId} API request.

The following actions are available for catalog admins who are custom user group owners:

• Delete a custom user group they own.
• Update a custom user group they own.
• Add user to or remove them from a custom user group the catalog admin owns.