Create Deep Linking Launch Form

Builds a self-submitting HTML form that starts a deep linking launch (LtiDeepLinkingRequest) into a registered tool.

The request body is identical to Create Deep Linking Launch Parameters; only the response differs. See the Deep linking flow guide for the full picture.

application/json

Request Body required

clientId string required

The tool whose content picker should open.

context string required

Your identifier for the context — usually a course ID.

user object required

Your identifier for the user doing the picking, normally a teacher.

oneOf

string

integer

---

string

Your identifier for the user doing the picking, normally a teacher.

integer

Your identifier for the user doing the picking, normally a teacher.

personalData object
How much personal data may be sent to the tool.
• NONE — no name and no email
• EMAIL — email only
• NAME — full, given and family name
• COMPLETE — name and email
customParameters object
Extra key/value pairs to send to the tool.
property name* string

Responses

• 201
• 400
• 401
• 403
• 404

---

Launch form created

application/json

Schema

Example (from schema)

---

Schema

form string

A self-submitting HTML form. Render it in an iframe or a new tab; it posts itself as soon as it loads.

{
  "form": "<form id=\"ltiaas_launch\" style=\"display: none;\" action=\"https://mytool.ltiaas.com/lti/login\" method=\"POST\">\n    <input type=\"hidden\" name=\"iss\" value=\"https://your.ltiaas.com\" />\n    <input type=\"hidden\" name=\"client_id\" value=\"U0gIhEYg2rdIr4ABscEJ\" />\n    <input type=\"hidden\" name=\"lti_deployment_id\" value=\"EgAssgssdfgsfshshq8iw\" />\n    <input type=\"hidden\" name=\"target_link_uri\" value=\"https://mytool.ltiaas.com/lti/launch\" />\n    <input type=\"hidden\" name=\"login_hint\" value=\"rKk4PdLgcRbqE4PdSW3iV0KhAmu2\" />\n    <input type=\"hidden\" name=\"lti_message_hint\" value=\"a.long.jwt\" />\n  </form>\n  <script>document.getElementById(\"ltiaas_launch\").submit()</script>"
}

One or more request parameters were missing or malformed.

application/json

Schema

Example (from schema)

---

Schema

status integer
error string
details object
errors object[]
One entry per field that failed validation.
Array [
field string
message string
]

{
  "status": 400,
  "error": "Bad Request",
  "details": {
    "errors": [
      {
        "field": "clientId",
        "message": "Missing 'clientId' parameter."
      }
    ]
  }
}

The Authorization header was missing, malformed, or carried the wrong key.

application/json

Schema

Example (from schema)

Example

---

Schema

status integer
error string
details object

Context for the failure. Always carries a message code; the other keys depend on what went wrong.

message string

description string

property name* any

Context for the failure. Always carries a message code; the other keys depend on what went wrong.

{
  "status": 403,
  "error": "Forbidden",
  "details": {
    "message": "INACTIVE_SERVICE",
    "description": "string"
  }
}

{
  "status": 401,
  "error": "Unauthorized",
  "details": {
    "message": "INVALID_BEARER_AUTHORIZATION_HEADER",
    "description": "Invalid API Key for account."
  }
}

The LTI® service this endpoint depends on is not enabled on your account.

application/json

Schema

Example (from schema)

Example

---

Schema

status integer
error string
details object

Context for the failure. Always carries a message code; the other keys depend on what went wrong.

message string

description string

property name* any

Context for the failure. Always carries a message code; the other keys depend on what went wrong.

{
  "status": 403,
  "error": "Forbidden",
  "details": {
    "message": "INACTIVE_SERVICE",
    "description": "string"
  }
}

{
  "status": 403,
  "error": "Forbidden",
  "details": {
    "message": "INACTIVE_SERVICE",
    "service": "Deep Linking"
  }
}

No tool with that ID is registered on this account.

application/json

Schema

Example (from schema)

Example

---

Schema

status integer
error string
details object

Context for the failure. Always carries a message code; the other keys depend on what went wrong.

message string

description string

property name* any

Context for the failure. Always carries a message code; the other keys depend on what went wrong.

{
  "status": 403,
  "error": "Forbidden",
  "details": {
    "message": "INACTIVE_SERVICE",
    "description": "string"
  }
}

{
  "status": 404,
  "error": "Not Found",
  "details": {
    "message": "UNREGISTERED_TOOL"
  }
}

Loading...