LtiIdentity
Defined in: packages/core/src/identity.ts:17
Normalized, app-facing view of who launched and from where.
Properties
Section titled “Properties”contextId?
Section titled “contextId?”
optionalcontextId?:string
Defined in: packages/core/src/identity.ts:30
contextTitle?
Section titled “contextTitle?”
optionalcontextTitle?:string
Defined in: packages/core/src/identity.ts:31
email?
Section titled “email?”
optionalemail?:string
Defined in: packages/core/src/identity.ts:23
May be absent (Canvas Test Student, privacy) — fall back to sub.
familyName?
Section titled “familyName?”
optionalfamilyName?:string
Defined in: packages/core/src/identity.ts:26
givenName?
Section titled “givenName?”
optionalgivenName?:string
Defined in: packages/core/src/identity.ts:25
isInstructor
Section titled “isInstructor”isInstructor:
boolean
Defined in: packages/core/src/identity.ts:28
isLearner
Section titled “isLearner”isLearner:
boolean
Defined in: packages/core/src/identity.ts:29
issuer
Section titled “issuer”issuer:
string
Defined in: packages/core/src/identity.ts:21
Platform issuer. Together with sub, uniquely identifies the user.
optionalname?:string
Defined in: packages/core/src/identity.ts:24
resourceLinkId?
Section titled “resourceLinkId?”
optionalresourceLinkId?:string
Defined in: packages/core/src/identity.ts:32
roles:
string[]
Defined in: packages/core/src/identity.ts:27
sub:
string
Defined in: packages/core/src/identity.ts:19
Stable per-user id within the issuer — the identity key (NOT email).