Complete Deep Linking Launch

Completes a deep linking launch, sending the user and context to the tool so it can render its content picker.

Call this from the Deep Linking URL you configured in the portal. Identical to Complete Launch except that there is no resource object — nothing has been picked yet.

application/json

Request Body required

metadata string required

The metadata claim from the verified payload JWT that LTIAAS sent to your Deep Linking URL.

user object required
The user being launched. Name and email fields are only forwarded if the tool's privacy level permits it, so it is safe to always send them.
id object required
Your identifier for the user. Should match the user value you sent on the launch.
oneOf
string
integer
---
string
Your identifier for the user. Should match the user value you sent on the launch.
integer
Your identifier for the user. Should match the user value you sent on the launch.
roles Role[] required
Possible values: [SYSTEM_ADMINISTRATOR, SYSTEM_NONE, SYSTEM_ACCOUNT_ADMIN, SYSTEM_CRETOR, SYSTEM_SYS_ADMIN, SYSTEM_SYS_SUPPORT, SYSTEM_USER, INSTITUTION_ADMINISTRATOR, INSTITUTION_FACULTY, INSTITUTION_GUEST, INSTITUTION_NONE, INSTITUTION_OTHER, INSTITUTION_STAFF, INSTITUTION_STUDENT, INSTITUTION_ALUMNI, INSTITUTION_INSTRUCTOR, INSTITUTION_LEARNER, INSTITUTION_MEMBER, INSTITUTION_MENTOR, INSTITUTION_OBSERVER, INSTITUTION_PROSPECTIVE, CONTEXT_ADMINISTRATOR, CONTEXT_CONTENT_DEVELOPER, CONTEXT_INSTRUCTOR, CONTEXT_LEARNER, CONTEXT_MENTOR, CONTEXT_MANAGER, CONTEXT_MEMBER, CONTEXT_OFFICER]
The user's roles in this context. Many tools change what they show based on whether the user is an instructor or a learner.
email string
name string
givenName string
familyName string
context object required

id object required

Your identifier for the context. Should match the context value you sent on the launch.

oneOf

string

integer

---

string

Your identifier for the context. Should match the context value you sent on the launch.

integer

Your identifier for the context. Should match the context value you sent on the launch.

label string

Short name, such as a course code.

title string

Full name.

type string[]

The kind of context this is. Most integrations send ["CourseOffering"].

Responses

• 201
• 400
• 401
• 403

---

ID Token created

application/json

Schema

Example (from schema)

---

Schema

target uri

The tool's redirect URI. Post the form here.

state string

The tool's original state value, echoed back.

idtoken string

The signed LTI® ID Token describing the user, context and resource.

{
  "target": "https://mytool.ltiaas.com/lti/launch",
  "state": "aLongString",
  "idtoken": "aVeryLongString"
}

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"
  }
}

Loading...