ylqjgm
/
canvas-lms
mirror of https://github.com/instructure/canvas-lms.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update ext_roles documentation 

fixes PLAT-3154

test plan:
the updated documentation should make it clear how the
ext_roles and Canvas.xuser.allRoles variable expansion work.

Change-Id: I6482bf6c6b4e19cd61f36db0b9d34cf2ea94b978
Reviewed-on: https://gerrit.instructure.com/141781
Tested-by: Jenkins
Reviewed-by: Marc Alan Phillips <mphillips@instructure.com>
QA-Review: August Thornton <august@instructure.com>
Product-Review: Karl Lloyd <karl@instructure.com>
This commit is contained in:
Nathan Mills 2018-02-23 21:19:34 -07:00
parent 65ce4d512f
commit bde75c653d
2 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/api/tools_variable_substitutions.md
View File

@ -681,8 +681,13 @@ http://purl.imsglobal.org/vocab/lis/v2/institution/person#Administrator
```
## Canvas.xuser.allRoles [duplicates ext_roles which is sent by default]
Returns list of [LIS role full URNs](https://www.imsglobal.org/specs/ltiv1p0/implementation-guide#toc-16).
Note that this will include all roles the user has across the entire root account. Roles will not
be scoped to the context of the LTI launch.
Note that this will include all roles the user has.
There are 3 different levels of roles defined: Context, Institution, System.
Context role urns start with "urn:lti:ims" and include roles for the context where the launch occurred.
Institution role urns start with "urn:lti:instrole" and include roles the user has in the institution. This
will include roles they have in other courses or at the account level. Note that there is not a TA role at the
Institution level. Instead Users with a TA enrollment will have an institution role of Instructor.
System role urns start with "urn:lti:sysrole" and include roles for the entire system.
**Availability**: *always*

9
lib/lti/variable_expander.rb
View File

@ -746,8 +746,13 @@ module Lti
default_name: 'roles'
# Returns list of [LIS role full URNs](https://www.imsglobal.org/specs/ltiv1p0/implementation-guide#toc-16).
# Note that this will include all roles the user has across the entire root account. Roles will not
# be scoped to the context of the LTI launch.
# Note that this will include all roles the user has.
# There are 3 different levels of roles defined: Context, Institution, System.
# Context role urns start with "urn:lti:ims" and include roles for the context where the launch occurred.
# Institution role urns start with "urn:lti:instrole" and include roles the user has in the institution. This
# will include roles they have in other courses or at the account level. Note that there is not a TA role at the
# Institution level. Instead Users with a TA enrollment will have an institution role of Instructor.
# System role urns start with "urn:lti:sysrole" and include roles for the entire system.
# @duplicates ext_roles which is sent by default
# @example
# ```