Updates docs for LTI variable expansions

- Changes Canvas.user.globalId and Canvas.root_account.global_id variable docs
- Removed mention of duplicates

Closes INTEROP-5279
flag=none

test plan
- Run rake doc:api
- Review documentation for Canvas.user.globalId and Canvas.root_account.global_id variables

Change-Id: I2d33258be879d5b8ba4a5651150ed4ca25df8d98
Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/347686
Reviewed-by: Xander Moffatt <xmoffatt@instructure.com>
QA-Review: Xander Moffatt <xmoffatt@instructure.com>
Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com>
Product-Review: Alexis Nast <alexis.nast@instructure.com>
This commit is contained in:
Siddharth Bawankule 2024-05-17 14:26:54 -07:00
parent f3cf98c439
commit a43ab94532
2 changed files with 2 additions and 4 deletions

View File

@ -603,7 +603,7 @@ returns the shard id for the current context.
```
1234
```
## Canvas.root_account.global_id [duplicates Canvas.user.globalId]
## Canvas.root_account.global_id
returns the root account's global id for the current context.
**Availability**: *always*
@ -1047,7 +1047,7 @@ Same as "Canvas.xuser.allRoles", but uses roles formatted for LTI Advantage.
"http://purl.imsglobal.org/vocab/lis/v2/membership#Instructor",
"http://purl.imsglobal.org/vocab/lis/v2/system/person#User"
```
## Canvas.user.globalId [duplicates Canvas.root_account.global_id]
## Canvas.user.globalId
Returns the Canvas global user_id of the launching user.
**Availability**: *when launched by a logged in user*

View File

@ -808,7 +808,6 @@ module Lti
-> { Shard.current.id }
# returns the root account's global id for the current context.
# @duplicates Canvas.user.globalId
# @example
# ```
# 123400000000123
@ -1365,7 +1364,6 @@ module Lti
-> { lti_helper.all_roles("lti1_3") }
# Returns the Canvas global user_id of the launching user.
# @duplicates Canvas.root_account.global_id
# @example
# ```
# 420000000000042