Learning Tools Interoperability Core Specification 1.3

https://www.imsglobal.org/spec/lti/v1p3/
Admin
The IMS Learning Tools Interoperability (LTI) specification enables Learning Management Systems...
Tokens:40,850
Snippets:254
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### LTI 1.3 Platform Example

Source: https://www.imsglobal.org/spec/lti/v1p3/impl

Shows the LTI 1.3 tool_platform claim with guid, contact_email, description, name, url, product_family_code, and version.

```json
  {
    "https://purl.imsglobal.org/spec/lti/claim/tool_platform": {
      "guid": "cen-01/a527c23f-8684-41bb-9292-2b274c229c32",
      "contact_email": "support@platform.example.edu",
      "description": "The LMS of Example University",
      "name": "The LMS of Example University",
      "url": "https://platform.example.edu",
      "product_family_code": "ExamplePlatformVendor-Product",
      "version": "1.0"
    }
  }

```

--------------------------------

### LTI 1.3 tool_platform claim example

Source: https://www.imsglobal.org/spec/lti/v1p3

Example of the optional LTI 1.3 tool_platform claim identifying the learning institution's online learning platform. The guid is required and must be locally unique to the iss, while other properties are optional.

```json
"https://purl.imsglobal.org/spec/lti/claim/tool_platform": {
    "guid": "ex/48bbb541-ce55-456e-8b7d-ebc59a38d435",
    "product_family_code": "ExamplePlatformVendor-ZLMS",
    "name": "LMS from Example University"
}
```

--------------------------------

### LTI 1.1 Launch Presentation Example

Source: https://www.imsglobal.org/spec/lti/v1p3/impl

Shows LTI 1.1 launch_presentation parameters for display and return URL.

```python
  launch_presentation_document_target = "iframe"
  launch_presentation_width = "320"
  launch_presentation_height = "240"
  launch_presentation_return_url = "https://platform.example.edu/terms/201601/courses/7/sections/1/resources/2"

```

--------------------------------

### LTI 1.1 Course Example

Source: https://www.imsglobal.org/spec/lti/v1p3/impl

Shows LTI 1.1 context parameters for course information.

```python
  context_id = "c1d887f0-a1a3-4bca-ae25-c375edcc131a"
  context_title = "CPS 435 Learning Analytics"
  context_label = "CPS 435"
  context_type = "CourseOffering"

```

--------------------------------

### LTI 1.1 Platform Example

Source: https://www.imsglobal.org/spec/lti/v1p3/impl

Shows LTI 1.1 tool_consumer_instance parameters for platform information.

```python
  tool_consumer_instance_guid = "cen-01/a527c23f-8684-41bb-9292-2b274c229c32"
  tool_consumer_instance_contact_email = "support@platform.example.edu"
  tool_consumer_instance_description = "The LMS of Example University"
  tool_consumer_instance_name = "The LMS of Example University"
  tool_consumer_instance_url = "https://platform.example.edu"
  tool_consumer_info_version = "1.0"

```

--------------------------------

### LTI 1.3 role_scope_mentor claim example

Source: https://www.imsglobal.org/spec/lti/v1p3

Example of the optional LTI 1.3 role_scope_mentor claim containing an array of user IDs the launching user can access as a mentor. The sender must also include the Mentor role in the roles claim.

```json
{
...
  "https://purl.imsglobal.org/spec/lti/claim/role_scope_mentor": [
    "fad5fb29-a91c-770-3c110-1e687120efd9",
    "5d7373de-c76c-e2b-01214-69e487e2bd33",
    "d779cfd4-bc7b-019-9bf1a-04bf1915d4d0"
  ]
...
}
```

--------------------------------

### Resource Link Launch Request Message Example

Source: https://www.imsglobal.org/spec/lti/v1p3

A complete example of the LTI resource link launch request message JSON object, showing the structure and typical claims included in the JWT payload.

```APIDOC
## Resource Link Launch Request Message

### Description
This is a complete example of the LTI resource link launch request message JSON object. It is encoded as a JWT and sent via a form post using the `id_token` parameter.

### Method
POST

### Endpoint
https://example.tool.com/videos/f7701643-d79a-468a-ba8e-998f98b71638

### Parameters
#### Form Parameters
- **id_token** (string) - Required - The JWT containing the LTI launch request claims.

### Request Example
```json
{
  "iss": "https://platform.example.edu",
  "sub": "a6d5c443-1f51-4783-ba1a-7686ffe3b54a",
  "aud": ["962fa4d8-bcbf-49a0-94b2-2de05ad274af"],
  "exp": 1510185728,
  "iat": 1510185228,
  "azp": "962fa4d8-bcbf-49a0-94b2-2de05ad274af",
  "nonce": "fc5fdc6d-5dd6-47f4-b2c9-5d1216e9b771",
  "name": "Ms Jane Marie Doe",
  "given_name": "Jane",
  "family_name": "Doe",
  "middle_name": "Marie",
  "picture": "https://platform.example.edu/jane.jpg",
  "email": "jane@platform.example.edu",
  "locale": "en-US",
  "https://purl.imsglobal.org/spec/lti/claim/deployment_id": "07940580-b309-415e-a37c-914d387c1150",
  "https://purl.imsglobal.org/spec/lti/claim/message_type": "LtiResourceLinkRequest",
  "https://purl.imsglobal.org/spec/lti/claim/version": "1.3.0",
  "https://purl.imsglobal.org/spec/lti/claim/roles": [
    "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Student",
    "http://purl.imsglobal.org/vocab/lis/v2/membership#Learner",
    "http://purl.imsglobal.org/vocab/lis/v2/membership#Mentor"
  ],
  "https://purl.imsglobal.org/spec/lti/claim/role_scope_mentor": [
    "fad5fb29-a91c-770-3c110-1e687120efd9",
    "5d7373de-c76c-e2b-01214-69e487e2bd33",
    "d779cfd4-bc7b-019-9bf1a-04bf1915d4d0"
  ],
  "https://purl.imsglobal.org/spec/lti/claim/context": {
    "id": "c1d887f0-a1a3-4bca-ae25-c375edcc131a",
    "label": "ECON 1010",
    "title": "Economics as a Social Science",
    "type": ["http://purl.imsglobal.org/vocab/lis/v2/course#CourseOffering"]
  },
  "https://purl.imsglobal.org/spec/lti/claim/resource_link": {
    "id": "200d101f-2c14-434a-a0f3-57c2a42369fd",
    "description": "Assignment to introduce who you are",
    "title": "Introduction Assignment"
  },
  "https://purl.imsglobal.org/spec/lti/claim/tool_platform": {
    "guid": "ex/48bbb541-ce55-456e-8b7d-ebc59a38d435",
    "contact_email": "support@platform.example.edu",
    "description": "An Example Tool Platform",
    "name": "Example Tool Platform",
    "url": "https://platform.example.edu",
    "product_family_code": "ExamplePlatformVendor-Product",
    "version": "1.0"
  },
  "https://purl.imsglobal.org/spec/lti/claim/target_link_uri": "https://tool.example.com/lti/48320/ruix8782rs",
  "https://purl.imsglobal.org/spec/lti/claim/launch_presentation": {
    "document_target": "iframe",
    "height": 320,
    "width": 240,
    "return_url": "https://platform.example.edu/terms/201601/courses/7/sections/1/resources/2"
  },
  "https://purl.imsglobal.org/spec/lti/claim/custom": {
    "xstart": "2017-04-21T01:00:00Z",
    "request_url": "https://tool.com/link/123"
  },
  "https://purl.imsglobal.org/spec/lti/claim/lis": {
    "person_sourcedid": "example.edu:71ee7e42-f6d2-414a-80db-b69ac2defd4",
    "course_offering_sourcedid": "example.edu:SI182-F16",
    "course_section_sourcedid": "example.edu:SI182-001-F16"
  },
  "http://www.ExamplePlatformVendor.com/session": {
    "id": "89023sj890dju080"
  }
}
```

### Notes
- The JSON object is encoded as a JWT and sent as a form post using the `id_token` parameter.
- Most properties are optional and may not appear in most resource link launch request messages.
```

--------------------------------

### LTI 1.1 Resource Link Example

Source: https://www.imsglobal.org/spec/lti/v1p3/impl

Shows LTI 1.1 resource_link parameters.

```python
  resource_link_id = "A200d101f2c14"
  resource_link_description = "Assignment to introduce who you are"
  resource_link_title = "Introduction Assignment"

```

--------------------------------

### LTI 1.3 context claim example

Source: https://www.imsglobal.org/spec/lti/v1p3

Example of the optional LTI 1.3 context claim used when the resource link launch occurs in the context of a course. The id is required and must be locally unique to the deployment_id, while type, label, and title are optional.

```json
{
...
"https://purl.imsglobal.org/spec/lti/claim/context": {
"id": "c1d887f0-a1a3-4bca-ae25-c375edcc131a",
"label": "CPS 435",
"title":  "CPS 435 Learning Analytics",
"type": ["http://purl.imsglobal.org/vocab/lis/v2/course#CourseOffering"]
}
...
}
```

--------------------------------

### LTI 1.3 Course Example

Source: https://www.imsglobal.org/spec/lti/v1p3/impl

Shows the LTI 1.3 context claim with id, title, label, and type.

```json
  {
    "https://purl.imsglobal.org/spec/lti/claim/context": {
      "id": "c1d887f0-a1a3-4bca-ae25-c375edcc131a",
      "title":  "CPS 435 Learning Analytics",
      "label": "CPS 435",
      "type": ["http://purl.imsglobal.org/vocab/lis/v2/course#CourseOffering"]
    }
  }

```

--------------------------------

### LTI 1.3 Resource Link Example

Source: https://www.imsglobal.org/spec/lti/v1p3/impl

Shows the LTI 1.3 resource_link claim with id, description, and title.

```json
  {
    "https://purl.imsglobal.org/spec/lti/claim/resource_link": {
      "id": "200d101f-2c14-434a-a0f3-57c2a42369fd",
      "description": "Assignment to introduce who you are",
      "title": "Introduction Assignment"
    }
  }

```

--------------------------------

### LTI 1.3 Launch Presentation Example

Source: https://www.imsglobal.org/spec/lti/v1p3/impl

Shows the LTI 1.3 launch_presentation claim with document_target, height, width, and return_url.

```json
  {
    "https://purl.imsglobal.org/spec/lti/claim/launch_presentation": {
      "document_target": "iframe",
      "height": 320,
      "width": 240,
      "return_url": "https://platform.example.edu/terms/201601/courses/7/sections/1/resources/2"
    }
  }

```

--------------------------------

### LTI 1.1 LIS Information Example

Source: https://www.imsglobal.org/spec/lti/v1p3/impl

Shows the lis_person_sourcedid parameter in LTI 1.1.

```python
  lis_person_sourcedid = "example.edu:71ee7e42-f6d2-414a-80db-b69ac2defd4"

```
Tokens:
Raw