Skip to content
LTIkit LTIkit

LtiClaims

Defined in: packages/core/src/types.ts:67

Verified LTI launch claims. Known keys are typed; unknown/custom claims are preserved via the index signature (LMSs add vendor-specific claims).

Indexable

Section titled “Indexable”

[claim: string]: unknown

Properties

Section titled “Properties”

aud

Section titled “aud”

aud: string | string[]

Defined in: packages/core/src/types.ts:70

azp?

Section titled “azp?”

optional azp?: string

Defined in: packages/core/src/types.ts:74

email?

Section titled “email?”

optional email?: string

Defined in: packages/core/src/types.ts:75

exp

Section titled “exp”

exp: number

Defined in: packages/core/src/types.ts:73

family_name?

Section titled “family_name?”

optional family_name?: string

Defined in: packages/core/src/types.ts:78

given_name?

Section titled “given_name?”

optional given_name?: string

Defined in: packages/core/src/types.ts:77

https://purl.imsglobal.org/spec/lti-ags/claim/endpoint?

Section titled “https://purl.imsglobal.org/spec/lti-ags/claim/endpoint?”

optional https://purl.imsglobal.org/spec/lti-ags/claim/endpoint?: AgsEndpointClaim

Defined in: packages/core/src/types.ts:89

https://purl.imsglobal.org/spec/lti-dl/claim/deep\_linking\_settings?

Section titled “https://purl.imsglobal.org/spec/lti-dl/claim/deep\_linking\_settings?”

optional https://purl.imsglobal.org/spec/lti-dl/claim/deep\_linking\_settings?: DeepLinkingSettingsClaim

Defined in: packages/core/src/types.ts:88

https://purl.imsglobal.org/spec/lti-nrps/claim/namesroleservice?

Section titled “https://purl.imsglobal.org/spec/lti-nrps/claim/namesroleservice?”

optional https://purl.imsglobal.org/spec/lti-nrps/claim/namesroleservice?: NrpsClaim

Defined in: packages/core/src/types.ts:90

https://purl.imsglobal.org/spec/lti/claim/context?

Section titled “https://purl.imsglobal.org/spec/lti/claim/context?”

optional https://purl.imsglobal.org/spec/lti/claim/context?: ContextClaim

Defined in: packages/core/src/types.ts:86

https://purl.imsglobal.org/spec/lti/claim/custom?

Section titled “https://purl.imsglobal.org/spec/lti/claim/custom?”

optional https://purl.imsglobal.org/spec/lti/claim/custom?: Record<string, string>

Defined in: packages/core/src/types.ts:87

https://purl.imsglobal.org/spec/lti/claim/deployment\_id

Section titled “https://purl.imsglobal.org/spec/lti/claim/deployment\_id”

https://purl.imsglobal.org/spec/lti/claim/deployment\_id: string

Defined in: packages/core/src/types.ts:82

https://purl.imsglobal.org/spec/lti/claim/message\_type

Section titled “https://purl.imsglobal.org/spec/lti/claim/message\_type”

https://purl.imsglobal.org/spec/lti/claim/message\_type: string

Defined in: packages/core/src/types.ts:80

Section titled “https://purl.imsglobal.org/spec/lti/claim/resource\_link?”

optional https://purl.imsglobal.org/spec/lti/claim/resource\_link?: ResourceLinkClaim

Defined in: packages/core/src/types.ts:85

https://purl.imsglobal.org/spec/lti/claim/roles?

Section titled “https://purl.imsglobal.org/spec/lti/claim/roles?”

optional https://purl.imsglobal.org/spec/lti/claim/roles?: string[]

Defined in: packages/core/src/types.ts:84

Section titled “https://purl.imsglobal.org/spec/lti/claim/target\_link\_uri?”

optional https://purl.imsglobal.org/spec/lti/claim/target\_link\_uri?: string

Defined in: packages/core/src/types.ts:83

https://purl.imsglobal.org/spec/lti/claim/version

Section titled “https://purl.imsglobal.org/spec/lti/claim/version”

https://purl.imsglobal.org/spec/lti/claim/version: string

Defined in: packages/core/src/types.ts:81

iat

Section titled “iat”

iat: number

Defined in: packages/core/src/types.ts:72

iss

Section titled “iss”

iss: string

Defined in: packages/core/src/types.ts:68

name?

Section titled “name?”

optional name?: string

Defined in: packages/core/src/types.ts:76

nonce

Section titled “nonce”

nonce: string

Defined in: packages/core/src/types.ts:71

sub

Section titled “sub”

sub: string

Defined in: packages/core/src/types.ts:69