User Groups REST Endpoints

Sort by

Task Path Method

Content (IM)/User Groups

The user groups resource lets you view the list of available user groups in the knowledge management functional area. The user groups are used to grant access to a group of users to a set of knowledge articles. For example, Tier 1 Agents and Tier 2 Agents could be separate user groups, where each group is entitled to a different part of the knowledge base.

Create a user group

Method: post

Path: /km/api/v1/userGroups

Delete user group

Method: delete

Path: /km/api/v1/userGroups/{id}

Get a user group

Method: get

Path: /km/api/v1/userGroups/{id}

Get a user group by reference key

Method: get

Path: /km/api/v1/userGroups/referenceKey/{referenceKey}

Get all user groups

Method: get

Path: /km/api/v1/userGroups

Update a user group

Method: put

Path: /km/api/v1/userGroups/{id}