Instructure · Example Payload
Instructure Lti Ims Dynamicregistration Examples

EdTechEducationLMSCanvasCoursesEnrollmentsAssignmentsGradesDiscussionsGraphQLLTILearning Management
Instructure Lti Ims Dynamicregistration Examples is an example object payload from Instructure, with 2 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields

domainexamples
Example Payload

{
  "domain": "lti-ims-dynamicregistration",
  "examples": [
    {
      "type": "response",
      "operation": "GET /api/lti/registration_token",
      "summary": "registration_token",
      "status_code": "200",
      "content_type": "application/json",
      "example": {
        "uuid": "0d3f7978-8635-44dd-aec1-8a63f7520c8f",
        "oidc_configuration_url": "https://canvas.instructure.com/api/lti/security/openid-configuration",
        "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1dWlkIjoiMGQzZjc5NzgtODYzNS00NGRkLWFlYzEtOGE2M2Y3NTIwYzhmIiwiaW5pdGlhdGVkX2F0IjoiMjAyMy0xMi0zMVQwNDo1MTo1NyswMDowMCIsInVzZXJfaWQiOjE4NDksInJvb3RfYWNjb3VudF9nbG9iYWxfaWQiOjIwMDAwMDAwMDAwMzA3MywiZXhwIjoxNzA0MDAxOTE3fQ.Q_JjbjAYQZTkacPq64y2qa3PqCCrQhTEKp25RAyNy34"
      }
    },
    {
      "type": "request",
      "operation": "POST /api/lti/registrations",
      "summary": "create",
      "content_type": "application/x-www-form-urlencoded",
      "example": {
        "application_type": "web",
        "client_name": "the client name",
        "grant_types": [
          "client_credentials",
          "implicit"
        ],
        "https://purl.imsglobal.org/spec/lti-tool-configuration": {
          "claims": [
            "iss",
            "sub"
          ],
          "domain": "example.com",
          "messages": [
            {
              "type": "LtiResourceLinkRequest",
              "label": "deep link label",
              "placements": [
                "course_navigation"
              ],
              "target_link_uri": "https://example.com/launch",
              "custom_parameters": {
                "foo": "bar"
              },
              "roles": [
                "http://purl.imsglobal.org/vocab/lis/v2/membership#ContentDeveloper",
                "http://purl.imsglobal.org/vocab/lis/v2/membership#Instructor"
              ],
              "icon_uri": "https://example.com/icon.jpg"
            }
          ],
          "target_link_uri": "https://example.com/launch"
        },
        "initiate_login_uri": "https://example.com/login",
        "jwks_uri": "https://example.com/api/jwks",
        "redirect_uris": [
          "https://example.com/launch"
        ],
        "registration_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNzY4LCJpbml0aWF0ZWRfYXQiOiIyMDIzLTEyLTE1VDAyOjM5OjM3WiIsInJvb3RfYWNjb3VudF9nbG9iYWxfaWQiOjAsInV1aWQiOiIzN2ExN2E2NC03ODlhLTQ5NGYtYjFjNy1lNjllN2I3ZjRlNzIiLCJleHAiOjE3MDI2MTE2Mzd9.Q9mhBLdBY8gXf_cQxB2RYOoPk6_a47gqNLpUXjVnFcc",
        "response_types": [
          "id_token"
        ],
        "scope": "https://purl.imsglobal.org/spec/lti-nrps/scope/contextmembership.readonly https://purl.imsglobal.org/spec/lti-ags/scope/score https://purl.imsglobal.org/spec/lti/scope/noticehandlers",
        "token_endpoint_auth_method": "private_key_jwt"
      }
    },
    {
      "type": "response",
      "operation": "POST /api/lti/registrations",
      "summary": "create",
      "status_code": "200",
      "content_type": "application/json",
      "example": {
        "client_id": "941",
        "application_type": "web",
        "grant_types": [
          "client_credentials",
          "implicit"
        ],
        "initiate_login_uri": "https://example.com/login",
        "redirect_uris": [
          "https://example.com/launch"
        ],
        "response_types": [
          "id_token"
        ],
        "client_name": "the client name",
        "jwks_uri": "https://example.com/api/jwks",
        "token_endpoint_auth_method": "private_key_jwt",
        "scope": "https://purl.imsglobal.org/spec/lti-nrps/scope/contextmembership.readonly https://purl.imsglobal.org/spec/lti-ags/scope/score https://purl.imsglobal.org/spec/lti/scope/noticehandlers",
        "https://purl.imsglobal.org/spec/lti-tool-configuration": {
          "domain": "example.com",
          "messages": [
            {
              "type": "LtiResourceLinkRequest",
              "target_link_uri": "https://example.com/launch",
              "label": "deep link label",
              "icon_uri": "https://example.com/icon.jpg",
              "custom_parameters": {
                "foo": "bar"
              },
              "roles": [
                "http://purl.imsglobal.org/vocab/lis/v2/membership#ContentDeveloper",
                "http://purl.imsglobal.org/vocab/lis/v2/membership#Instructor"
              ],
              "placements": [
                "course_navigation"
              ]
            }
          ],
          "claims": [
            "iss",
            "sub"
          ],
          "target_link_uri": "https://example.com/launch"
        }
      }
    }
  ]
}