Attendance LTI for Blackboard Learn: Required API Privileges

The following is a list of Privileges and what each of them entitles, along with the APIs that require those privileges:

  1. Administrator Panel (Users) > Users
    1. Entitlement: system.user.VIEW
    2. This allows us to view a user's profile
    3. APIs
      1. GET /learn/api/public/v1/users/{userId}
  2. Administrator Panel (Courses) > Courses
    1. Entitlement: system.course.VIEW
    2. This allows us to view a course's information
    3. APIs
      1. GET /learn/api/public/v1/courses/{courseId}
  3. Administrator Panel (Users) > Users > Edit > View Course Enrollments
    1. Entitlement: system.user.course.enrollment.VIEW
    2. This allows us to view a course's enrollment
    3. APIs
      1. GET /learn/api/public/v1/courses/{courseId}/users/{userId}
  4. Administrator Panel (Courses) > Courses > Merge
    1. Entitlement: system.course.cross-list.VIEW
    2. This allows us to view a Merged course
    3. APIs
      1. GET /learn/api/public/v1/courses/{courseId}/children
  5. Course/Organization Control Panel (Grade Center) > Full Control
    1. Entitlement: course.gradebook.MODIFY
    2. This allows us to create or remove a gradebook column, and write grades into a column
    3. APIs
      1. PATCH /learn/api/public/v2/courses/{courseId}/gradebook/columns/{columnId}
      2. POST /learn/api/public/v2/courses/{courseId}/gradebook/columns
      3. DELETE /learn/api/public/v2/courses/{courseId}/gradebook/columns/{columnId}
  6. Course/Organization > Groups > View All Groups
    1. Entitlement: course.groups.VIEW
    2. This allows us to view a course's groups and the group's enrollments
    3. APIs
      1. GET /learn/api/public/v1/courses/{courseId}/groups
      2. GET /learn/api/public/v2/courses/{courseId}/groups/{groupId}/users/{userId}
  7. Administrator Panel (Users) > Users > Edit > View Organization Enrollments
    1. Entitlement: system.user.org.enrollment.VIEW
    2. This allows us to view an organization's enrollments
    3. APIs
      1. GET /learn/api/public/v1/courses/{courseId}/users
  8. Administrator Panel (Courses) > Courses > Edit > Enrollments > Add Enrollment
    1. Entitlement: system.enrollment.CREATE
    2. This allows us access to view the custom Course roles in a system
    3. APIs
      1. 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: 

  1. Course/Organization Control Panel (Users and Groups) > Users > Change User's availability in Course/Organization
    1. Entitlement: course.course-availability.MODIFY
    2. This allows us to view a user's enrollment in case unable to find privilege 3
  2. Course/Organization Control Panel (Customization) > Properties
    1. course.configure-properties.EXECUTE
    2. This allows us access to all course properties (in case the specific course entitlements are missing)
  3. Course/Organization Control Panel (Packages and Utilities) > Export Course/Organization
    1. course.export.EXECUTE
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk