role.md

Role

sunbird.role [PRIMARY KEY: id]

Table used to store Roles definition.

Column Name	Data Type	Description	Sample Data
id	text	Role Identifier	CONTENT_REVIEWER
name	text	Role Name	Content Reviewer
rolegroupid	list<text>	Role Group used for API access management	['CONTENT_CURATION']
status	int	status of the role	1 - Valid

sunbird.role_group [PRIMARY KEY: id]

Table used to store role group information

Column Name	Data Type	Description	Sample Data
id	text	Role Group identifier	ORG_MANAGEMENT
name	text	Role Group Name	Org Management
url_action_ids	list<text>	URL action Identifiers (Refer to sunbird.url_action)	['createOrg', 'updateOrg', 'removeOrg', 'createUser', 'updateUser']

sunbird.url_action [PRIMARY KEY: id]

Table used to define url action to API endpoint mapping

Column Name	Data Type	Description	Sample Data
id	text	URL action Identifier	updateOrg
name	text	URL action Name	updateOrg
url	list<text>	API endpoint list	['/v1/organisation/update']

sunbird.user_roles [PRIMARY KEY (userid, role)]

Tole used to store user to role mapping

Column Name	Data Type	Description	Sample Data
userid	text	UUID of the User	5e48c2ba-cd3a-4d85-9d3b-28dc329d7dd9
role	text	Role Identifier	BOOK_REVIEWER
createdby	text	Role added By	08631a74-4b94-4cf7-a818-831135248a4a
createddate	text	Record creation timestamp	2021-08-11 08:53:49:662+0000
scope	text	Role scope - organisation to which role is defined for the user	[{"organisationId":"01334203864941363283"}]
updatedby	text	Role Updated By
updateddate	text	Last record Updated timestamp