Totara Learn Open Discussions

Service Account for Reporting API

 
JamilMuhammad
Service Account for Reporting API
由 JamilMuhammad 发表于 2025年11月14日 Friday 01:08
 

Hi,

I hope you are doing well. I am currently working on configuring the reporting API for Totara, with the goal of extracting all reports from the system. As I was going through the documentation for adding the API, I noticed that it mentioned the need for a service account.

 We already have an API user role set up, but the permissions for this role seem to be more aligned with facilitating user provisioning from the HRIS system to Totara LMS. I wanted to inquire if there is a default service account specifically for the reporting API, and if so, could you please provide the role name?

 In the event that a default service account is not available, could you please guide me on what permissions should be assigned to the service account, specifically for reporting purposes? Additionally, if there is any documentation available regarding the creation of a reporting role, I would greatly appreciate it if you could share it with me.

 Thank you for your assistance.

 Regards,

Jamil


 
永久链接 | 回复
KurikovaNatalia
Re: Service Account for Reporting API
由 KurikovaNatalia 发表于 2025年11月24日 Monday 20:10
小组 Helpful contributor 2024小组 Learn Site Administrator小组 Most helpful contributor 2023

Hi Muhammad

I believe what is meant by "service account role" is basically a new role that you create and then assign it to an account. That account will then be used as a service account,

If you have another API user set up for HRIS system, you could create a different role for this new integration and a new account (that's usually how we manage multiple API integrations in our system). And then just go through permissions and add only relevant ones. I think when you add functions to a webservice, it should tell you which permissions are relevant (but that is not an complete list, usually others become evident when testing).

 
永久链接 | 显示父帖子 | 回复