Sunbird Lern
AskDot
  • LEARN
    • Overview
    • Functional Capabilities
    • Technical Architecture
      • Technical Architecture Diagram
      • Tech Stack
    • Dependencies
    • Product Roadmap
  • USE
    • Overview
    • Release Notes
      • Release V 8.0.0 (Ongoing)
      • Release V 7.0.0
      • Release V 5.4.0
      • Release V 5.3.0
      • Release V 5.2.0
      • Release V 5.1.0
      • Release V 5.0.1
      • Release V 5.0.0
      • Release V 4.10.0
      • Release V 4.9.0
      • Release V 4.8.0
      • Release V 4.7.0
    • Developer Guide
      • USER & ORG SERVICE
        • Features/Core capabilities
        • Architecture
          • Code Flow
        • Developer Installation
          • System Requirements
          • Tech Stack
          • Installation Guide
          • Keycloak Local setup
          • Additional Installation Dependencies:
          • Source Code
          • Installation Configuration
        • Data Models
          • Cassandra
            • Data Dictionary
              • User
              • Organisation
              • System Settings
              • Role
              • Bulk Upload Process
              • Tenant Preference
              • Cassandra Migration Version
              • User Consent
              • Email Template
              • OTP
              • Page Management (LMS Service)
              • Location
              • User Notes
              • Deprecated
          • Elastic Search
          • Redis
        • APIs
          • User Management
            • User Deletion API
            • Ownership Transfer API
          • Organisation Management
          • Location Management
          • Consent Management
          • OTP Services
          • Tenant Configurations
          • Bulk Upload
          • System Settings
          • API Management Service
          • Data Sync
          • Notification APIs
        • Flink Jobs
          • User Cache Updater
          • User Deletion Cleanup Flink Job
          • Ownership Transfer Flink Job
        • Reports
          • Standard Exhaust
            • State Admin Geo report
            • State Admin Report
          • Other Jobs
            • User Cache Indexer Job
            • Delete Users Assets Report
          • Data Products Developer Installation
            • System Requirements
            • Tech Stack
            • Installation Dependencies
            • Local installation of data-products
            • Server setup Guide
            • Installation Configuration
            • Data-product creation guide
            • Troubleshooting a data-product
        • Logs, Telemetry Events
        • Configuration
          • Functional Configurations
          • System Settings
          • Email Configuration
          • SMS Configuration
          • OTP based SMS Configuration
        • Roles
          • System Roles
          • User Roles
          • RBAC
        • Dependencies
        • Keycloak on Sunbird
        • How to Guide
          • Create Organization
          • Create User
          • Add new user type & location
        • Single Sign-on with Sunbird
        • Caching and Denormalising User Metadata
          • ETLUserCacheUpdaterJob
          • UserCacheUpdaterFlinkJob
        • Unit Tests and Code Coverage
        • FAQs
      • LMS(BATCH) SERVICE
        • Features/Core Capabilities
        • Architecture
          • Code Flow
        • Developer Installation
          • System Requirements
          • Tech Stack
          • Installation Guide
          • Source Code
        • Data Models
          • Cassandra
            • Data Dictionary
          • ElasticSearch
          • Redis
        • APIs
        • Flink Jobs
          • Merge User Courses
          • Relation Cache Updater
          • Activity Aggregate Updater
          • Assessment Aggregator
          • Enrolment Reconciliation
          • Collection Certificate Pre-Processor
          • Collection Certificate Generator
        • Reports
          • On-Demand Exhaust
            • Response Exhaust
            • User Info Exhaust
            • Progress Exhaust
          • Other Jobs
            • Collection Summary Job
            • Course Batch Status Updater Job
            • Cassandra Migrator Job
            • Score Metric Migration Job
            • Assessment Score Correction Job
            • Collection Reconciliation Job
            • Course Enrollment Job
            • Course Consumption Job
        • Logs, Telemetry Events
        • Configuration
          • System Configuration
          • Functional Configuration
        • Dependencies
        • Certificate Registry and Credentialing using Sunbird-RC
          • Configuring PublicKey in Sunbird-RC
          • Server Setup guide for Sunbird-RC
          • API Guide For Sunbird-RC
        • Certificate Flow
          • Certificates Creation and Configuration
        • FAQs
      • GROUPS
        • Features/Core Capabilities
        • Architecture
          • Code Flow
        • Developer Installation
          • System Requirements
          • Tech Stack
          • Installation Guide
          • Source Code
          • Installation Configuration
        • Data Models
          • Cassandra
            • Data Dictionary
          • Redis
        • APIs
          • Create Group
        • Logs, Telemetry Events
          • UI Telemetry Events
          • Service Telemetry Events
        • Configuration
          • Functional Configurations
        • Design References
        • Dependencies
        • Unit Tests and Code Coverage
      • NOTIFICATION SERVICE
        • Features/Core Capabilities
        • Architecture
          • Code Flow
        • Developer Installation
          • System Requirements
          • Tech Stack
          • Installation Guide
          • Source Code
          • Installation Configuration
        • Data Models
          • Data Dictionary
        • APIs
        • Flink Jobs
        • Logs, Telemetry Events
        • Configuration
          • Functional Configurations
        • Dependencies
        • Unit Tests and Code Coverage
      • DISCUSSION FORUM
        • Features/Core capabilities
        • Architecture
          • Code Flow
        • Developer Installation
          • System Requirements
          • Tech Stack
          • Installation Guide
            • Nodebb setup
            • Discussion Middleware Setup
            • Discussion Middleware
            • Discussion forum integration with any application
            • Discussion-UI setup along with demo application.
            • Sunbird-lern portal for DF
          • Source Code
        • APIs
          • Category APIs
          • User APIs
          • Post APIs
          • Topic APIs
          • Forum APIs
        • Context Schema
        • Configurations
          • Nodebb Admin panel settings
          • Discussion MW & Nodebb System Config
        • Telemetry Events
        • Dependencies
      • ML SERVICE
        • DATA PIPELINE (Flink Jobs)
          • Program User Info
            • Component Diagram
            • Data Model
            • Folder Structure
          • Ml User Delete
            • Component Diagram
            • Data Model
            • Folder Structure
        • DATA PRODUCTS
          • Program Exhaust
            • Component Diagram
            • Folder Structure
    • Server Installation
    • Dependency Setup
    • Deprecation
      • Release-5.4.0
    • Jenkins Jobs
    • Release Calendar
    • Learn More
      • Tech References
      • Telemetry Processing
      • Data Dictionary
        • Sample Data
      • Delete User Functionality
      • Asset Ownership Transfer
    • FAQs
  • Engage
    • Discuss
    • Contribute to Sunbird Lern
    • Raise an Issue
    • Contribution Guidelines
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
  1. USE
  2. Developer Guide
  3. USER & ORG SERVICE
  4. APIs

User Management

PreviousAPIsNextUser Deletion API

Last updated 1 year ago

Was this helpful?

Read User V1

get

This API is used for searching a specific user, the user search is based on the unique ID of the user

  • The endpoint for Get User by User ID is /user/v1/read/{User_ID}
  • The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
  • User can pass an optional query parameter 'fields'. The value is a comma separated list of fields whose information is required in response. e.g. fields=completeness,missingFields,topic,organisations,roles
  • 'completeness' is to return profile completeness percentage.
  • 'missingFields' is to return fields that are missing to achieve 100% profile completeness.
  • 'topic' is to return list of topics that are used for announcements.
  • 'organisations' is to return organisation and location details.
  • 'roles' is to return list of roles with name and ID details.
Path parameters
userIdstringRequired

User-Id of the user

Header parameters
tsstringOptional

Timestamp at which given API request is sent.

X-msgidstringOptional

This ID uniquely identifies a request if the same API is executed multiple times.

AuthorizationstringRequired

To make use of any User API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.

Example: {{authorization}}
x-authenticated-user-tokenstringRequired

It a unique token/key to authenticate the user each time an API is called. For corresponsing sessions, this token is exchanged, not the username/password of the user

Example: {{user_token}}
Responses
200
OK ! Successful operation."Get User by User ID" operation was successfully executed.
application/json
400
BAD REQUEST. The "Read User V1" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
application/json
500
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at info@sunbird.org.'
application/json
get
GET /api/user/v1/read/{userId} HTTP/1.1
Host: staging.open-sunbird.org
Authorization: {{authorization}}
x-authenticated-user-token: {{user_token}}
Accept: */*
{
  "id": "api.user.read",
  "ver": "v1",
  "ts": "2020-11-23 13:21:57:692+0000",
  "params": {
    "resmsgid": null,
    "msgid": "af801330-0dcb-42c6-b76b-cedaa6212118",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "response": {
      "webPages": [],
      "tcStatus": null,
      "maskedPhone": null,
      "rootOrgName": "org3",
      "subject": [],
      "channel": "channel1",
      "language": [],
      "updatedDate": null,
      "managedBy": null,
      "flagsValue": 2,
      "id": "ec8deeb2-4ded-4fa2-ac48-023ad8298d92",
      "recoveryEmail": "",
      "identifier": "ec8deeb2-4ded-4fa2-ac48-023ad8298d92",
      "thumbnail": null,
      "updatedBy": null,
      "accesscode": null,
      "locationIds": [],
      "registryId": null,
      "rootOrgId": 126796199493140480,
      "prevUsedEmail": "",
      "firstname": "first name",
      "tncAcceptedOn": null,
      "allTncAccepted": {},
      "phone": "",
      "dob": null,
      "grade": [],
      "currentLoginTime": null,
      "userType": "TEACHER",
      "userSubType": null,
      "status": 1,
      "lastname": "last name",
      "tncLatestVersion": "v8",
      "gender": null,
      "roles": [
        "PUBLIC"
      ],
      "prevUsedPhone": "",
      "stateValidated": false,
      "isDeleted": false,
      "organisations": [
        {
          "updatedBy": null,
          "organisationId": 126796199493140480,
          "orgName": "org3",
          "addedByName": null,
          "addedBy": null,
          "roles": [
            "PUBLIC"
          ],
          "approvedBy": null,
          "isSelfDeclared": true,
          "updatedDate": null,
          "userId": "ec8deeb2-4ded-4fa2-ac48-023ad8298d92",
          "approvaldate": null,
          "associationtype": 2,
          "isSystemUpload": false,
          "isDeleted": false,
          "hashTagId": 126796199493140480,
          "isSSO": false,
          "isRejected": null,
          "position": null,
          "id": 131573015167221760,
          "orgjoindate": "2020-11-23 07:02:43:194+0000",
          "isApproved": null,
          "orgLeftDate": null
        }
      ],
      "provider": null,
      "countryCode": null,
      "tncLatestVersionUrl": "https://organisation.blob.core.windows.net/termsandcond/terms-and-conditions-v8.html",
      "maskedEmail": "se*************@yopmail.com",
      "tempPassword": null,
      "email": "se*************@yopmail.com",
      "rootOrg": {
        "dateTime": null,
        "preferredLanguage": null,
        "keys": {
          "encKeys": [
            456
          ],
          "signKeys": [
            456
          ]
        },
        "channel": "channel1",
        "approvedBy": null,
        "description": "org3",
        "updatedDate": "2020-08-28 10:12:01:096+0000",
        "addressId": null,
        "orgType": null,
        "provider": null,
        "orgCode": null,
        "locationId": null,
        "theme": null,
        "id": 126796199493140480,
        "isApproved": null,
        "communityId": null,
        "slug": "channel1",
        "email": null,
        "isSSOEnabled": null,
        "thumbnail": null,
        "updatedBy": null,
        "orgName": "org3",
        "locationIds": [
          "027f81d8-0a2c-4fc6-96ac-59fe4cea3abf",
          "8250d58d-f1a2-4397-bfd3-b2e688ba7141"
        ],
        "externalId": null,
        "isRootOrg": true,
        "rootOrgId": 126796199493140480,
        "imgUrl": null,
        "approvedDate": null,
        "orgTypeId": null,
        "homeUrl": null,
        "isDefault": true,
        "createdDate": "2019-01-18 09:48:13:428+0000",
        "contactDetail": null,
        "parentOrgId": null,
        "createdBy": "system",
        "hashTagId": 126796199493140480,
        "noOfMembers": null,
        "status": 1
      },
      "profileSummary": null,
      "phoneVerified": false,
      "tcUpdatedDate": null,
      "recoveryPhone": "",
      "avatar": null,
      "userName": "username1",
      "promptTnC": true,
      "lastLoginTime": null,
      "emailVerified": true,
      "framework": {},
      "createdDate": "2020-11-23 07:02:36:155+0000",
      "createdBy": null,
      "location": null,
      "tncAcceptedVersion": null
    }
  }
}

Read User V2

get

This API is used for searching a specific user, the user search is based on the unique ID of the user

  • The endpoint for Get User by User ID v2 is /user/v2/read/{User_ID}
  • The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
  • User can pass an optional query parameter 'fields'. The value is a comma separated list of fields whose information is required in response. e.g. fields=completeness,missingFields,topic,organisations,roles
  • 'completeness' is to return profile completeness percentage.
  • 'missingFields' is to return fields that are missing to achieve 100% profile completeness.
  • 'topic' is to return list of topics that are used for announcements.
  • 'organisations' is to return organisation and location details.
  • 'roles' is to return list of roles with name and ID details.
  • Only necessary fields are returned in the response as per user profile configuration.
Path parameters
userIdstringRequired

Please append a valid User Id To the Request URI and if user need any specific values like , profile completeness ,missingFields,topic Ex: ?Fields=completeness,missingFields,topic

Header parameters
tsstringOptional

Timestamp at which given API request is sent.

X-msgidstringOptional

This ID uniquely identifies a request if the same API is executed multiple times.

AuthorizationstringRequired

Specify authorization key (format: Bearer api-key) received from administrator when performing given API request.

Example: {{authorization}}
x-authenticated-user-tokenstringRequired

Access token of registered user performing given API request.

Example: {{user_token}}
Responses
200
OK ! Successful operation."Get User by User ID v2" operation was successfully executed.
application/json
400
BAD REQUEST. The "Read User V2" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
application/json
500
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at info@sunbird.org.'
application/json
get
GET /api/user/v2/read/{userId} HTTP/1.1
Host: staging.open-sunbird.org
Authorization: {{authorization}}
x-authenticated-user-token: {{user_token}}
Accept: */*
{
  "id": "api.user.read",
  "ver": "v1",
  "ts": "2020-11-23 13:21:57:692+0000",
  "params": {
    "resmsgid": null,
    "msgid": "af801330-0dcb-42c6-b76b-cedaa6212118",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "response": {
      "webPages": [],
      "tcStatus": null,
      "maskedPhone": null,
      "rootOrgName": "org3",
      "subject": [],
      "channel": "channel1",
      "language": [],
      "updatedDate": null,
      "managedBy": null,
      "flagsValue": 2,
      "id": "ec8deeb2-4ded-4fa2-ac48-023ad8298d92",
      "recoveryEmail": "",
      "identifier": "ec8deeb2-4ded-4fa2-ac48-023ad8298d92",
      "thumbnail": null,
      "updatedBy": null,
      "accesscode": null,
      "locationIds": [],
      "registryId": null,
      "rootOrgId": 126796199493140480,
      "prevUsedEmail": "",
      "firstname": "first name",
      "tncAcceptedOn": null,
      "allTncAccepted": {},
      "phone": "",
      "dob": null,
      "grade": [],
      "currentLoginTime": null,
      "userType": "TEACHER",
      "userSubType": null,
      "status": 1,
      "lastname": "last name",
      "tncLatestVersion": "v8",
      "gender": null,
      "roles": [
        "PUBLIC"
      ],
      "prevUsedPhone": "",
      "stateValidated": false,
      "isDeleted": false,
      "organisations": [
        {
          "updatedBy": null,
          "organisationId": 126796199493140480,
          "orgName": "org3",
          "addedByName": null,
          "addedBy": null,
          "roles": [
            "PUBLIC"
          ],
          "approvedBy": null,
          "updatedDate": null,
          "isSelfDeclared": true,
          "associationtype": 2,
          "isSystemUpload": false,
          "isSSO": false,
          "userId": "ec8deeb2-4ded-4fa2-ac48-023ad8298d92",
          "approvaldate": null,
          "isDeleted": false,
          "hashTagId": 126796199493140480,
          "isRejected": null,
          "position": null,
          "id": 131573015167221760,
          "orgjoindate": "2020-11-23 07:02:43:194+0000",
          "isApproved": null,
          "orgLeftDate": null
        }
      ],
      "provider": null,
      "countryCode": null,
      "tncLatestVersionUrl": "https://organisation.blob.core.windows.net/termsandcond/terms-and-conditions-v8.html",
      "maskedEmail": "se*************@yopmail.com",
      "tempPassword": null,
      "email": "se*************@yopmail.com",
      "rootOrg": {
        "dateTime": null,
        "preferredLanguage": null,
        "keys": {
          "encKeys": [
            456
          ],
          "signKeys": [
            456
          ]
        },
        "channel": "channel1",
        "approvedBy": null,
        "description": "org3",
        "updatedDate": "2020-08-28 10:12:01:096+0000",
        "addressId": null,
        "orgType": null,
        "provider": null,
        "orgCode": null,
        "locationId": null,
        "theme": null,
        "id": 126796199493140480,
        "isApproved": null,
        "communityId": null,
        "slug": "channel1",
        "email": null,
        "isSSOEnabled": null,
        "thumbnail": null,
        "updatedBy": null,
        "orgName": "org3",
        "locationIds": [
          "027f81d8-0a2c-4fc6-96ac-59fe4cea3abf",
          "8250d58d-f1a2-4397-bfd3-b2e688ba7141"
        ],
        "externalId": null,
        "isRootOrg": true,
        "rootOrgId": 126796199493140480,
        "imgUrl": null,
        "approvedDate": null,
        "orgTypeId": null,
        "homeUrl": null,
        "isDefault": true,
        "createdDate": "2019-01-18 09:48:13:428+0000",
        "contactDetail": null,
        "parentOrgId": null,
        "createdBy": "system",
        "hashTagId": 126796199493140480,
        "noOfMembers": null,
        "status": 1
      },
      "profileSummary": null,
      "phoneVerified": false,
      "tcUpdatedDate": null,
      "recoveryPhone": "",
      "avatar": null,
      "userName": "username1",
      "promptTnC": true,
      "lastLoginTime": null,
      "emailVerified": true,
      "framework": {},
      "createdDate": "2020-11-23 07:02:36:155+0000",
      "createdBy": null,
      "location": null,
      "tncAcceptedVersion": null
    }
  }
}

Read User V3

get

This API is used for reading a specific user, the user read is based on the unique ID of the user

  • The endpoint for Get User by User ID v3 is /user/v3/read/{User_ID}
  • The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
  • User can pass an optional query parameter 'fields'. The value is a comma separated list of fields whose information is required in response. e.g. fields=completeness,missingFields,topic,organisations,roles,tokens
  • 'completeness' is to return profile completeness percentage.
  • 'missingFields' is to return fields that are missing to achieve 100% profile completeness.
  • 'topic' is to return list of topics that are used for announcements.
  • 'organisations' is to return organisation and location details.
  • 'roles' is to return list of roles with name and ID details.
  • MUA user detail can be retreived with their token details
Path parameters
userIdstringRequired

Please append a valid User Id To the Request URI and if user need any specific values like , profile completeness ,missingFields,topic Ex: ?Fields=completeness,missingFields,topic

Query parameters
withTokensbooleanOptional
  • When withTokens attribute is passed MUA user tokens will passsed in the response
Example: true
fieldsstringRequired
  • User can pass an optional query parameter 'fields'. The value is a comma separated list of fields whose information is required in response. e.g. fields=completeness,missingFields,topic,organisations,roles
Example: organisations,roles,locations,declarations
Header parameters
tsstringOptional

Timestamp at which given API request is sent.

X-msgidstringOptional

This ID uniquely identifies a request if the same API is executed multiple times.

AuthorizationstringRequired

Specify authorization key (format: Bearer api-key) received from administrator when performing given API request.

Example: {{authorization}}
x-authenticated-user-tokenstringRequired

Access token of registered user performing given API request.

Example: {{user_token}}
Responses
200
OK ! Successful operation."Get User by User ID v3" operation was successfully executed.
application/json
400
BAD REQUEST. The "Read User V3" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.
application/json
500
'INTERNAL SERVER ERROR. We track these errors automatically and try to set it right at the earliest. Try refreshing the page. If the problem persists contact us at info@sunbird.org.'
application/json
get
GET /api/user/v3/read/{userId} HTTP/1.1
Host: staging.open-sunbird.org
Authorization: {{authorization}}
x-authenticated-user-token: {{user_token}}
Accept: */*
{
  "id": "api.user.read",
  "ver": "v3",
  "ts": "2020-11-24 09:13:00:959+0000",
  "params": {
    "resmsgid": null,
    "msgid": "26012a3e-59f1-40af-b96e-5bc808f5f2ab",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "response": {
      "webPages": [],
      "tcStatus": null,
      "maskedPhone": null,
      "rootOrgName": "org3",
      "subject": [],
      "channel": "channel1",
      "language": [],
      "updatedDate": "2020-11-23 17:47:49:640+0000",
      "managedBy": null,
      "flagsValue": 2,
      "id": "ec8deeb2-4ded-4fa2-ac48-023ad8298d92",
      "recoveryEmail": "",
      "identifier": "ec8deeb2-4ded-4fa2-ac48-023ad8298d92",
      "thumbnail": null,
      "updatedBy": "ec8deeb2-4ded-4fa2-ac48-023ad8298d92",
      "accesscode": null,
      "registryId": null,
      "roleList": [
        {
          "name": "Content Curation",
          "id": "CONTENT_CURATION"
        },
        {
          "name": "Content Creator",
          "id": "CONTENT_CREATOR"
        },
        {
          "name": "Official TextBook Badge Issuer",
          "id": "OFFICIAL_TEXTBOOK_BADGE_ISSUER"
        },
        {
          "name": "Admin",
          "id": "ADMIN"
        },
        {
          "name": "Course Mentor",
          "id": "COURSE_MENTOR"
        },
        {
          "name": "Org Admin",
          "id": "ORG_ADMIN"
        },
        {
          "name": "Content Review",
          "id": "CONTENT_REVIEW"
        },
        {
          "name": "Flag Reviewer",
          "id": "FLAG_REVIEWER"
        },
        {
          "name": "Announcement Sender",
          "id": "ANNOUNCEMENT_SENDER"
        },
        {
          "name": "System Administration",
          "id": "SYSTEM_ADMINISTRATION"
        },
        {
          "name": "Book Creator",
          "id": "BOOK_CREATOR"
        },
        {
          "name": "Course Creator",
          "id": "COURSE_CREATOR"
        },
        {
          "name": "Report Viewer",
          "id": "REPORT_VIEWER"
        },
        {
          "name": "Flag Reviewer",
          "id": "FLAG_REVIEWER "
        },
        {
          "name": "Membership Management",
          "id": "MEMBERSHIP_MANAGEMENT"
        },
        {
          "name": "Content Creation",
          "id": "CONTENT_CREATION"
        },
        {
          "name": "Book Reviewer",
          "id": "BOOK_REVIEWER"
        },
        {
          "name": "Teacher Badge Issuer",
          "id": "TEACHER_BADGE_ISSUER"
        },
        {
          "name": "Org Management",
          "id": "ORG_MANAGEMENT"
        },
        {
          "name": "Course Admin",
          "id": "COURSE_ADMIN"
        },
        {
          "name": "Org Moderator",
          "id": "ORG_MODERATOR"
        },
        {
          "name": "Public",
          "id": "PUBLIC"
        },
        {
          "name": "Content Reviewer",
          "id": "CONTENT_REVIEWER"
        },
        {
          "name": "Report Admin",
          "id": "REPORT_ADMIN"
        },
        {
          "name": "Content Curation",
          "id": "CONTENT_CURATION"
        },
        {
          "name": "Content Creator",
          "id": "CONTENT_CREATOR"
        },
        {
          "name": "Official TextBook Badge Issuer",
          "id": "OFFICIAL_TEXTBOOK_BADGE_ISSUER"
        },
        {
          "name": "Admin",
          "id": "ADMIN"
        },
        {
          "name": "Course Mentor",
          "id": "COURSE_MENTOR"
        },
        {
          "name": "Org Admin",
          "id": "ORG_ADMIN"
        },
        {
          "name": "Content Review",
          "id": "CONTENT_REVIEW"
        },
        {
          "name": "Flag Reviewer",
          "id": "FLAG_REVIEWER"
        },
        {
          "name": "Announcement Sender",
          "id": "ANNOUNCEMENT_SENDER"
        },
        {
          "name": "System Administration",
          "id": "SYSTEM_ADMINISTRATION"
        },
        {
          "name": "Book Creator",
          "id": "BOOK_CREATOR"
        },
        {
          "name": "Course Creator",
          "id": "COURSE_CREATOR"
        },
        {
          "name": "Report Viewer",
          "id": "REPORT_VIEWER"
        },
        {
          "name": "Flag Reviewer",
          "id": "FLAG_REVIEWER "
        },
        {
          "name": "Membership Management",
          "id": "MEMBERSHIP_MANAGEMENT"
        },
        {
          "name": "Content Creation",
          "id": "CONTENT_CREATION"
        },
        {
          "name": "Book Reviewer",
          "id": "BOOK_REVIEWER"
        },
        {
          "name": "Teacher Badge Issuer",
          "id": "TEACHER_BADGE_ISSUER"
        },
        {
          "name": "Org Management",
          "id": "ORG_MANAGEMENT"
        },
        {
          "name": "Course Admin",
          "id": "COURSE_ADMIN"
        },
        {
          "name": "Org Moderator",
          "id": "ORG_MODERATOR"
        },
        {
          "name": "Public",
          "id": "PUBLIC"
        },
        {
          "name": "Content Reviewer",
          "id": "CONTENT_REVIEWER"
        },
        {
          "name": "Report Admin",
          "id": "REPORT_ADMIN"
        },
        {
          "name": "Content Curation",
          "id": "CONTENT_CURATION"
        },
        {
          "name": "Content Creator",
          "id": "CONTENT_CREATOR"
        },
        {
          "name": "Official TextBook Badge Issuer",
          "id": "OFFICIAL_TEXTBOOK_BADGE_ISSUER"
        },
        {
          "name": "Admin",
          "id": "ADMIN"
        },
        {
          "name": "Course Mentor",
          "id": "COURSE_MENTOR"
        },
        {
          "name": "Org Admin",
          "id": "ORG_ADMIN"
        },
        {
          "name": "Content Review",
          "id": "CONTENT_REVIEW"
        },
        {
          "name": "Flag Reviewer",
          "id": "FLAG_REVIEWER"
        },
        {
          "name": "Announcement Sender",
          "id": "ANNOUNCEMENT_SENDER"
        },
        {
          "name": "System Administration",
          "id": "SYSTEM_ADMINISTRATION"
        },
        {
          "name": "Book Creator",
          "id": "BOOK_CREATOR"
        },
        {
          "name": "Course Creator",
          "id": "COURSE_CREATOR"
        },
        {
          "name": "Report Viewer",
          "id": "REPORT_VIEWER"
        },
        {
          "name": "Flag Reviewer",
          "id": "FLAG_REVIEWER "
        },
        {
          "name": "Membership Management",
          "id": "MEMBERSHIP_MANAGEMENT"
        },
        {
          "name": "Content Creation",
          "id": "CONTENT_CREATION"
        },
        {
          "name": "Book Reviewer",
          "id": "BOOK_REVIEWER"
        },
        {
          "name": "Teacher Badge Issuer",
          "id": "TEACHER_BADGE_ISSUER"
        },
        {
          "name": "Org Management",
          "id": "ORG_MANAGEMENT"
        },
        {
          "name": "Course Admin",
          "id": "COURSE_ADMIN"
        },
        {
          "name": "Org Moderator",
          "id": "ORG_MODERATOR"
        },
        {
          "name": "Public",
          "id": "PUBLIC"
        },
        {
          "name": "Content Reviewer",
          "id": "CONTENT_REVIEWER"
        },
        {
          "name": "Report Admin",
          "id": "REPORT_ADMIN"
        },
        {
          "name": "Content Curation",
          "id": "CONTENT_CURATION"
        },
        {
          "name": "Content Creator",
          "id": "CONTENT_CREATOR"
        },
        {
          "name": "Official TextBook Badge Issuer",
          "id": "OFFICIAL_TEXTBOOK_BADGE_ISSUER"
        },
        {
          "name": "Admin",
          "id": "ADMIN"
        },
        {
          "name": "Course Mentor",
          "id": "COURSE_MENTOR"
        },
        {
          "name": "Org Admin",
          "id": "ORG_ADMIN"
        },
        {
          "name": "Content Review",
          "id": "CONTENT_REVIEW"
        },
        {
          "name": "Flag Reviewer",
          "id": "FLAG_REVIEWER"
        },
        {
          "name": "Announcement Sender",
          "id": "ANNOUNCEMENT_SENDER"
        },
        {
          "name": "System Administration",
          "id": "SYSTEM_ADMINISTRATION"
        },
        {
          "name": "Book Creator",
          "id": "BOOK_CREATOR"
        },
        {
          "name": "Course Creator",
          "id": "COURSE_CREATOR"
        },
        {
          "name": "Report Viewer",
          "id": "REPORT_VIEWER"
        },
        {
          "name": "Flag Reviewer",
          "id": "FLAG_REVIEWER "
        },
        {
          "name": "Membership Management",
          "id": "MEMBERSHIP_MANAGEMENT"
        },
        {
          "name": "Content Creation",
          "id": "CONTENT_CREATION"
        },
        {
          "name": "Book Reviewer",
          "id": "BOOK_REVIEWER"
        },
        {
          "name": "Teacher Badge Issuer",
          "id": "TEACHER_BADGE_ISSUER"
        },
        {
          "name": "Org Management",
          "id": "ORG_MANAGEMENT"
        },
        {
          "name": "Course Admin",
          "id": "COURSE_ADMIN"
        },
        {
          "name": "Org Moderator",
          "id": "ORG_MODERATOR"
        },
        {
          "name": "Public",
          "id": "PUBLIC"
        },
        {
          "name": "Content Reviewer",
          "id": "CONTENT_REVIEWER"
        },
        {
          "name": "Report Admin",
          "id": "REPORT_ADMIN"
        },
        {
          "name": "Content Curation",
          "id": "CONTENT_CURATION"
        },
        {
          "name": "Content Creator",
          "id": "CONTENT_CREATOR"
        },
        {
          "name": "Official TextBook Badge Issuer",
          "id": "OFFICIAL_TEXTBOOK_BADGE_ISSUER"
        },
        {
          "name": "Admin",
          "id": "ADMIN"
        },
        {
          "name": "Course Mentor",
          "id": "COURSE_MENTOR"
        },
        {
          "name": "Org Admin",
          "id": "ORG_ADMIN"
        },
        {
          "name": "Content Review",
          "id": "CONTENT_REVIEW"
        },
        {
          "name": "Flag Reviewer",
          "id": "FLAG_REVIEWER"
        },
        {
          "name": "Announcement Sender",
          "id": "ANNOUNCEMENT_SENDER"
        },
        {
          "name": "System Administration",
          "id": "SYSTEM_ADMINISTRATION"
        },
        {
          "name": "Book Creator",
          "id": "BOOK_CREATOR"
        },
        {
          "name": "Course Creator",
          "id": "COURSE_CREATOR"
        },
        {
          "name": "Report Viewer",
          "id": "REPORT_VIEWER"
        },
        {
          "name": "Flag Reviewer",
          "id": "FLAG_REVIEWER "
        },
        {
          "name": "Membership Management",
          "id": "MEMBERSHIP_MANAGEMENT"
        },
        {
          "name": "Content Creation",
          "id": "CONTENT_CREATION"
        },
        {
          "name": "Book Reviewer",
          "id": "BOOK_REVIEWER"
        },
        {
          "name": "Teacher Badge Issuer",
          "id": "TEACHER_BADGE_ISSUER"
        },
        {
          "name": "Org Management",
          "id": "ORG_MANAGEMENT"
        },
        {
          "name": "Course Admin",
          "id": "COURSE_ADMIN"
        },
        {
          "name": "Org Moderator",
          "id": "ORG_MODERATOR"
        },
        {
          "name": "Public",
          "id": "PUBLIC"
        },
        {
          "name": "Content Reviewer",
          "id": "CONTENT_REVIEWER"
        },
        {
          "name": "Report Admin",
          "id": "REPORT_ADMIN"
        },
        {
          "name": "Content Curation",
          "id": "CONTENT_CURATION"
        },
        {
          "name": "Content Creator",
          "id": "CONTENT_CREATOR"
        },
        {
          "name": "Official TextBook Badge Issuer",
          "id": "OFFICIAL_TEXTBOOK_BADGE_ISSUER"
        },
        {
          "name": "Admin",
          "id": "ADMIN"
        },
        {
          "name": "Course Mentor",
          "id": "COURSE_MENTOR"
        },
        {
          "name": "Org Admin",
          "id": "ORG_ADMIN"
        },
        {
          "name": "Content Review",
          "id": "CONTENT_REVIEW"
        },
        {
          "name": "Flag Reviewer",
          "id": "FLAG_REVIEWER"
        },
        {
          "name": "Announcement Sender",
          "id": "ANNOUNCEMENT_SENDER"
        },
        {
          "name": "System Administration",
          "id": "SYSTEM_ADMINISTRATION"
        },
        {
          "name": "Book Creator",
          "id": "BOOK_CREATOR"
        },
        {
          "name": "Course Creator",
          "id": "COURSE_CREATOR"
        },
        {
          "name": "Report Viewer",
          "id": "REPORT_VIEWER"
        },
        {
          "name": "Flag Reviewer",
          "id": "FLAG_REVIEWER "
        },
        {
          "name": "Membership Management",
          "id": "MEMBERSHIP_MANAGEMENT"
        },
        {
          "name": "Content Creation",
          "id": "CONTENT_CREATION"
        },
        {
          "name": "Book Reviewer",
          "id": "BOOK_REVIEWER"
        },
        {
          "name": "Teacher Badge Issuer",
          "id": "TEACHER_BADGE_ISSUER"
        },
        {
          "name": "Org Management",
          "id": "ORG_MANAGEMENT"
        },
        {
          "name": "Course Admin",
          "id": "COURSE_ADMIN"
        },
        {
          "name": "Org Moderator",
          "id": "ORG_MODERATOR"
        },
        {
          "name": "Public",
          "id": "PUBLIC"
        },
        {
          "name": "Content Reviewer",
          "id": "CONTENT_REVIEWER"
        },
        {
          "name": "Report Admin",
          "id": "REPORT_ADMIN"
        },
        {
          "name": "Content Curation",
          "id": "CONTENT_CURATION"
        },
        {
          "name": "Content Creator",
          "id": "CONTENT_CREATOR"
        },
        {
          "name": "Official TextBook Badge Issuer",
          "id": "OFFICIAL_TEXTBOOK_BADGE_ISSUER"
        },
        {
          "name": "Admin",
          "id": "ADMIN"
        },
        {
          "name": "Course Mentor",
          "id": "COURSE_MENTOR"
        },
        {
          "name": "Org Admin",
          "id": "ORG_ADMIN"
        },
        {
          "name": "Content Review",
          "id": "CONTENT_REVIEW"
        },
        {
          "name": "Flag Reviewer",
          "id": "FLAG_REVIEWER"
        },
        {
          "name": "Announcement Sender",
          "id": "ANNOUNCEMENT_SENDER"
        },
        {
          "name": "System Administration",
          "id": "SYSTEM_ADMINISTRATION"
        },
        {
          "name": "Book Creator",
          "id": "BOOK_CREATOR"
        },
        {
          "name": "Course Creator",
          "id": "COURSE_CREATOR"
        },
        {
          "name": "Report Viewer",
          "id": "REPORT_VIEWER"
        },
        {
          "name": "Flag Reviewer",
          "id": "FLAG_REVIEWER "
        },
        {
          "name": "Membership Management",
          "id": "MEMBERSHIP_MANAGEMENT"
        },
        {
          "name": "Content Creation",
          "id": "CONTENT_CREATION"
        },
        {
          "name": "Book Reviewer",
          "id": "BOOK_REVIEWER"
        },
        {
          "name": "Teacher Badge Issuer",
          "id": "TEACHER_BADGE_ISSUER"
        },
        {
          "name": "Org Management",
          "id": "ORG_MANAGEMENT"
        },
        {
          "name": "Course Admin",
          "id": "COURSE_ADMIN"
        },
        {
          "name": "Org Moderator",
          "id": "ORG_MODERATOR"
        },
        {
          "name": "Public",
          "id": "PUBLIC"
        },
        {
          "name": "Content Reviewer",
          "id": "CONTENT_REVIEWER"
        },
        {
          "name": "Report Admin",
          "id": "REPORT_ADMIN"
        },
        {
          "name": "Content Curation",
          "id": "CONTENT_CURATION"
        },
        {
          "name": "Content Creator",
          "id": "CONTENT_CREATOR"
        },
        {
          "name": "Official TextBook Badge Issuer",
          "id": "OFFICIAL_TEXTBOOK_BADGE_ISSUER"
        },
        {
          "name": "Admin",
          "id": "ADMIN"
        },
        {
          "name": "Course Mentor",
          "id": "COURSE_MENTOR"
        },
        {
          "name": "Org Admin",
          "id": "ORG_ADMIN"
        },
        {
          "name": "Content Review",
          "id": "CONTENT_REVIEW"
        },
        {
          "name": "Flag Reviewer",
          "id": "FLAG_REVIEWER"
        },
        {
          "name": "Announcement Sender",
          "id": "ANNOUNCEMENT_SENDER"
        },
        {
          "name": "System Administration",
          "id": "SYSTEM_ADMINISTRATION"
        },
        {
          "name": "Book Creator",
          "id": "BOOK_CREATOR"
        },
        {
          "name": "Course Creator",
          "id": "COURSE_CREATOR"
        },
        {
          "name": "Report Viewer",
          "id": "REPORT_VIEWER"
        },
        {
          "name": "Flag Reviewer",
          "id": "FLAG_REVIEWER "
        },
        {
          "name": "Membership Management",
          "id": "MEMBERSHIP_MANAGEMENT"
        },
        {
          "name": "Content Creation",
          "id": "CONTENT_CREATION"
        },
        {
          "name": "Book Reviewer",
          "id": "BOOK_REVIEWER"
        },
        {
          "name": "Teacher Badge Issuer",
          "id": "TEACHER_BADGE_ISSUER"
        },
        {
          "name": "Org Management",
          "id": "ORG_MANAGEMENT"
        },
        {
          "name": "Course Admin",
          "id": "COURSE_ADMIN"
        },
        {
          "name": "Org Moderator",
          "id": "ORG_MODERATOR"
        },
        {
          "name": "Public",
          "id": "PUBLIC"
        },
        {
          "name": "Content Reviewer",
          "id": "CONTENT_REVIEWER"
        },
        {
          "name": "Report Admin",
          "id": "REPORT_ADMIN"
        },
        {
          "name": "Content Curation",
          "id": "CONTENT_CURATION"
        },
        {
          "name": "Content Creator",
          "id": "CONTENT_CREATOR"
        },
        {
          "name": "Official TextBook Badge Issuer",
          "id": "OFFICIAL_TEXTBOOK_BADGE_ISSUER"
        },
        {
          "name": "Admin",
          "id": "ADMIN"
        },
        {
          "name": "Course Mentor",
          "id": "COURSE_MENTOR"
        },
        {
          "name": "Org Admin",
          "id": "ORG_ADMIN"
        },
        {
          "name": "Content Review",
          "id": "CONTENT_REVIEW"
        },
        {
          "name": "Flag Reviewer",
          "id": "FLAG_REVIEWER"
        },
        {
          "name": "Announcement Sender",
          "id": "ANNOUNCEMENT_SENDER"
        },
        {
          "name": "System Administration",
          "id": "SYSTEM_ADMINISTRATION"
        },
        {
          "name": "Book Creator",
          "id": "BOOK_CREATOR"
        },
        {
          "name": "Course Creator",
          "id": "COURSE_CREATOR"
        },
        {
          "name": "Report Viewer",
          "id": "REPORT_VIEWER"
        },
        {
          "name": "Flag Reviewer",
          "id": "FLAG_REVIEWER "
        },
        {
          "name": "Membership Management",
          "id": "MEMBERSHIP_MANAGEMENT"
        },
        {
          "name": "Content Creation",
          "id": "CONTENT_CREATION"
        },
        {
          "name": "Book Reviewer",
          "id": "BOOK_REVIEWER"
        },
        {
          "name": "Teacher Badge Issuer",
          "id": "TEACHER_BADGE_ISSUER"
        },