Totara Learn Open Discussions

Reporting API role

 
Muhammad Jamil
Reporting API role
by Muhammad Jamil - Tuesday, 11 November 2025, 3:16 AM
 

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