The following is a list of Privileges and what each of them entitles, along with the APIs that require those privileges:
- Administrator Panel (Users) > Users
- Entitlement: system.user.VIEW
- This allows the tool to view a user's profile
- APIs
- GET /learn/api/public/v1/users/{userId}
- Administrator Panel (Courses) > Courses
- Entitlement: system.course.VIEW
- This allows the tool to view a course's information
- APIs
- GET /learn/api/public/v1/courses/{courseId}
- Administrator Panel (Users) > Users > Edit > View Course Enrollments
- Entitlement: system.user.course.enrollment.VIEW
- This allows the tool to view a course's enrollment
- APIs
- GET /learn/api/public/v1/courses/{courseId}/users/{userId}
- Administrator Panel (Courses) > Courses > Merge
- Entitlement: system.course.cross-list.VIEW
- This allows the tool to view a Merged course
- APIs
- GET /learn/api/public/v1/courses/{courseId}/children
- Course/Organization Control Panel (Grade Center) > Full Control
- Entitlement: course.gradebook.MODIFY
- This allows the tool to create or remove a gradebook column, and write grades into a column
- APIs
- PATCH /learn/api/public/v2/courses/{courseId}/gradebook/columns/{columnId}
- POST /learn/api/public/v2/courses/{courseId}/gradebook/columns
- DELETE /learn/api/public/v2/courses/{courseId}/gradebook/columns/{columnId}
- Course/Organization > Groups > View All Groups
- Entitlement: course.groups.VIEW
- This allows the tool to view a course's groups and the group's enrollments
- APIs
- GET /learn/api/public/v1/courses/{courseId}/groups
- GET /learn/api/public/v2/courses/{courseId}/groups/{groupId}/users/{userId}
- Administrator Panel (Users) > Users > Edit > View Organization Enrollments
- Entitlement: system.user.org.enrollment.VIEW
- This allows the tool to view an organization's enrollments
- APIs
- GET /learn/api/public/v1/courses/{courseId}/users
- Administrator Panel (Courses) > Courses > Edit > Enrollments > Add Enrollment
- Entitlement: system.enrollment.CREATE
- This allows the tool access to view the custom Course roles in a system
- APIs
- GET /learn/api/public/v1/courseRoles
Additional Privileges to be used as an alternative in case any of the previously listed Privileges were not found:
- Course/Organization Control Panel (Users and Groups) > Users > Change User's availability in Course/Organization
- Entitlement: course.course-availability.MODIFY
- This allows the tool to view a user's enrollment in case unable to find privilege 3
- Course/Organization Control Panel (Customization) > Properties
- course.configure-properties.EXECUTE
- This allows the tool access to all course properties (in case the specific course entitlements are missing)
- Course/Organization Control Panel (Packages and Utilities) > Export Course/Organization
- course.export.EXECUTE
Comments
0 comments
Please sign in to leave a comment.