Does Pega KM Rest API be able to get articles by roles?


For KM, we will call REST APIs to get KM articles, and then put the content into node level data page. But when I look at the URL/parameters of the KM REST APIs, I don’t see any parameter regarding access role. So how can we associate access role to the REST API so that different articles are returned based on different access roles?

Please see the attachment for detail.




Keep up to date on this post and subscribe to comments

December 3, 2019 - 6:18pm

Please check below Pega Knowledge product overview:

Check "Content security" section:

Specify Pega access roles to restrict content visibility to certain user groups (organizations, managers, etc.).  Roles are defined by category level with child categories honoring inherited roles from parent levels. Authors have a configuration option to enable content security on specific Pega Knowledge help sites. Only end users with the required Access Roles will have visibility to articles at or below the category where the Access Role(s) was defined.


December 3, 2019 - 6:23pm

In the above Pega Knowledge product overview, Page 18, "REST APIs", under "Knowledge articles", there is  "List articles by category", it returns list of all published articles belonging to categories passed as parameter.

Please check this. 

December 5, 2019 - 3:15pm
Response to SusanLiu

Hi Susan:

    Thanks a lot for your reply! But if KM has contents for both application A with role A and application B with role B, now after calling the search REST web service, all the articles which contain the search key word will be returned regardless whether it is from application A or from application B, right?

   In the search REST web service I don't see any parameter related to role. If I want to only search contents related to application A how to do that?