API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · lti_tools

LTI Tool Schema

Schema-ID
lti_tool
Collection
lti_tools
Permissions
  • Lesenlti_tool_view
  • Anlegenlti_tool_create
  • Ändernlti_tool_edit
  • Löschenlti_tool_delete

Felder

LTI Tool Schema

lti_tools4 Permissions

Schema for LTI 1.3 external tool registrations

namestringerforderlich

Display name of the LTI tool (e.g. "Kahoot")

1–200 Zeichen
descriptionstringoptional

Optional description of the tool

max 2000 Zeichennullable
clientIdstringerforderlich

OAuth 2.0 client_id assigned by the tool to this platform

min 1 Zeichen
clientSecretstringoptional

Optional client_secret for AGS token endpoint (if tool requires it)

nullable
deploymentIdstringerforderlich

LTI deployment identifier (unique per deployment within tenant)

min 1 Zeichen
toolUrlstringerforderlich

Tool launch URL — the target_link_uri sent in the id_token

loginInitiationUrlstringerforderlich

Tool OIDC login initiation endpoint

redirectUrisstring[]optional

Allowed redirect URIs registered with the tool

nullable
jwksUrlstringoptional

Tool's JWKS endpoint (used when tool signs messages back to platform)

nullable
deepLinkingUrlstringoptional

Tool deep linking content selection URL (optional)

nullable
customParamsobjectoptional

Default custom parameters sent with every launch from this tool

nullable
supportsGradePassbackbooleanoptional

Whether the tool sends AGS (Assignment and Grade Services) scores back to this platform

nullable
isActivebooleanoptional

Whether this tool is available for use in courses

nullable

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/lti_tools — Liste, paginiert + filterbar
  • GET /api/v1/lti_tools/<id> — Einzelne Entity
  • POST /api/v1/lti_tools — Anlegen
  • PATCH /api/v1/lti_tools/<id> — Teil-Update
  • DELETE /api/v1/lti_tools/<id> — Soft-Delete
  • GET /api/v1/lti_tools/<id>/timeline — Audit + Aktivitäten

Suche