Skip to content

RegistrationTool

Defined in: packages/core/src/registration.ts:56

Describes the tool being registered. The consumer supplies its own URLs.

optional claims?: string[]

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

Identity claims to request. Default: iss, sub, name, email.


clientName: string

Defined in: packages/core/src/registration.ts:58

Human-readable tool name shown in the LMS.


domain: string

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

Tool domain (host, no scheme) — the LMS scopes the registration to it.


initiateLoginUri: string

Defined in: packages/core/src/registration.ts:62

OIDC third-party login initiation URL (the LMS starts launches here).


jwksUri: string

Defined in: packages/core/src/registration.ts:60

Public JWKS URL the LMS fetches to verify our signed messages.


optional logoUri?: string

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

Optional logo shown in the LMS registration UI.


optional messages?: ToolMessage[]

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

Advertised LTI messages. Default: resource-link + deep-linking.


redirectUris: string[]

Defined in: packages/core/src/registration.ts:64

Allowed launch callback URLs (must include the one used at oidc.login).


optional scopes?: string[]

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

Scopes to request. Default: AGS (line item/score/result) + NRPS.


targetLinkUri: string

Defined in: packages/core/src/registration.ts:66

Default landing URL for a resource-link launch.