Create Deep Linking Launch Parameters

Builds the parameters needed to start a deep linking launch (LtiDeepLinkingRequest), which opens the tool's content picker so a teacher can choose what to embed.

Identical to Create Launch Parameters except that there is no resource field — the resource is what the teacher is about to pick. LTIAAS launches to the tool's deeplinkingEndpoint, falling back to its launchEndpoint if none was registered.

When the teacher finishes choosing, the tool posts its selection back to LTIAAS, which forwards it to your Service URL as a DEEP_LINKING_RESPONSE service request.

caution

Deep linking must be enabled on your account. If it is not, this endpoint returns 403 INACTIVE_SERVICE.

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 parameters created

application/json

Schema

Example (from schema)

---

Schema

target uri

The tool's OIDC login initiation URL. Post the form here.

iss uri

Your LTIAAS subdomain, acting as the LTI® issuer.

clientId string
ltiDeploymentId string
targetLinkUri uri

Where the tool should land after the handshake.

loginHint string

The user value you supplied.

ltiMessageHint string

A signed token representing this launch. Expires one hour after issue.

{
  "target": "https://mytool.ltiaas.com/lti/login",
  "iss": "https://your.ltiaas.com",
  "clientId": "U0gIhEYg2rdIr4ABscEJ",
  "ltiDeploymentId": "EgAssgssdfgsfshshq8iw",
  "targetLinkUri": "https://mytool.ltiaas.com/lti/launch",
  "loginHint": "rKk4PdLgcRbqE4PdSW3iV0KhAmu2",
  "ltiMessageHint": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

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...