Custom user groups are groups that you can create and manage via the Learn365 API or the Learn365 Admin Center. Unlike Microsoft Entra groups, custom user groups can include users of any type, both Learn365 and Flow365.
Create custom user groups
Required role: LMS admin, catalog admin.
To create a custom user group via API:
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 POST /services/users/v2/Groups endpoint and select Try it out in the top right-hand corner.
3. In the request body, enter the:
- title string parameter (required). 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 (optional). Enter the user IDs of the catalog admins to make them owners of the custom user group. While LMS admins can manage any custom user group in their organization, catalog admins can manage the custom user groups they own. For more information about group owners and their permissions, see this article.
The request body may look like this:
{
"title": "Sound Engineers",
"ownerIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fa35cdf2-75bd-40b0-ac0d-b5ca7bfde448"
]
}
4. Select Execute to run the request.
5. 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.
Delete custom user groups
Required role: LMS admin. Catalog admin if the catalog admin is the owner of the group.
To delete a custom group via API, you’ll need the group ID. There are two ways to find this:
- When creating a custom user group, the response contains the id parameter in its body.
- Send the GET /services/users/v2/Groups API request. You can find more information about this request in this article.
To delete a custom user group via API:
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 DELETE /services/users/v2/Groups/{groupId} endpoint and select Try it out in the top right-hand corner.
3. Enter the ID of the user group in the groupId field.
4. Select Execute to run the request.
5. 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.
Comments
Article is closed for comments.