system-roles.md

System Roles

How to create system roles?

Currently there are no APIs present in UserOrg service to do role management. If any new role needs to be added it is done through DB script.

Sample Script:

insert into sunbird.role (id,name,rolegroupid,status) values ('PROGRAM_MANAGER','Program Manager',['PROGRAM_MANAGER'],1);
insert into sunbird.role_group (id,name) values ('PROGRAM_MANAGER','Program Manager');

DB details:

CREATE TABLE IF NOT EXISTS sunbird.role(id text, name text,roleGroupId List<text>,status int, PRIMARY KEY (id));
CREATE TABLE IF NOT EXISTS sunbird.role_group(id text, name text, PRIMARY KEY (id));

To fetch the roles in the system, below API can be used:

GET /v1/role/read

Role List

Roles	Description
SYSTEM_ADMINISTRATION
ADMIN
ORG_ADMIN	A org admin can : Download consent user data file in manage page. Download Geo report data. Search same org users from profile using their external ID. Assign roles to the users of same org. Create and Manage (edit, modify, delete, publish, add users) Sourcing Projects
ORG_MODERATOR
ORG_MANAGEMENT
MEMBERSHIP_MANAGEMENT
PUBLIC	Default role
BOOK_CREATOR	A book creator can create book
BOOK_REVIEWER	A book reviewer can review and publish book
COURSE_ADMIN
COURSE_MENTOR	A course mentor can: create a batch add or edit other mentors to a batch add or edit participants to a batch edit ongoing batches view status of all the batch participants Request for userinfo, progress, and question set exhaust report Download the userinfo, progress, and question set exhaust report
CONTENT_CREATOR	A content creator can create all type(Course, resource, Collection, Lessonplan, Upload content, Upload large videos, Course assessment) of contents except book
CONTENT_REVIEWER	A content reviewer can review and publish all type of contents except book
CONTENT_CURATION
REPORT_ADMIN	Can publish reports on the portal as 'Live'. Also has access to the 'Datasets' tab on the portal, where datasets are made available for Admins to be able to download. Also has all the rights of the 'REPORT_VIEWER' role - all of these for the tenant that they have the role for
REPORT_VIEWER	This role allows a registered user to have 'view' access to all reports pulbished for their tenant on the portal. These are accessed via the 'Dashboards' page on the portal
PROGRAM_MANAGER	This is a new role introduced as a part of 4.2 hotfix. The role will have access to Program dashboards and can access all CSVs for different resources mapped in a program. They will have access to the programs that they are program managers of. The role will have the following right: Will have access to the data of all the resources that are part of the program mapped to them
PROGRAM_DESIGNER	This is a new role introduced as a part of 4.2 hotfix. The role will have access to Program dashboards and can access Status CSVs for different resources mapped in a program designed by them. The role has following rights: Create a program with different published resources in it Add a description to the program Sequence different resources that are part of the program Target the program and resources to a geography Target the program and resources for different sub-roles Edit the program Access to the status data of all the resources that are part of the program created by him/her