Register A Tool

Registers a third-party LTI® 1.3 tool so your LMS can launch it.

LTIAAS generates a clientId, a deploymentId and a dedicated RSA key pair for the tool, then publishes that key in your account's keyset. Hand the tool vendor the values listed in Registering a tool.

The same thing can be done from the LTIAAS Portal if you would rather not script it.

application/json

Request Body required

name string required

A human-readable name for the tool.

launchEndpoint uri required

Where resource link launches land by default.

loginEndpoint uri required

The tool's OIDC login initiation URL — where LTIAAS posts to start a launch.

deeplinkingEndpoint uri

Where deep linking launches land. Falls back to launchEndpoint.

redirectionUris uri[] required

Every URL the tool is allowed to be redirected back to. A launch whose redirect_uri is not on this list is refused.

permissions Permission[] required

Possible values: [MEMBERSHIPS_READ, LINEITEMS_READ, LINEITEMS_READ_WRITE, GRADES_READ, GRADES_WRITE, OUTCOMES_READ_WRITE, TOOL_SETTINGS_READ_WRITE]

Which LTI® services this tool may use. Requests for any other scope are refused.

personalData PersonalData required

Possible values: [NONE, EMAIL, NAME, COMPLETE]

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

Key/value pairs sent on every launch of this tool. Individual launches can add to or override these.

property name* string

active boolean

Default value: true

Whether the tool can receive launches. Defaults to true.

authConfig object required

How LTIAAS verifies messages signed by the tool.

method string required

Possible values: [JWK_SET, JWK_KEY, RSA_KEY]

JWK_SET — key is a URL to the tool's JWKS. Preferred, because the tool can rotate keys without telling you.
JWK_KEY — key is a single JWK, as a JSON string.
RSA_KEY — key is a PEM-encoded public key.

key string required

The keyset URL, JWK or PEM key, depending on method.

Responses

Tool registered

application/json

Schema

Example (from schema)

Schema

id string

clientId string

Always equal to id. This is the value you pass as clientId when launching, and the value the tool knows itself by.

deploymentId string

Identifies this deployment of the tool. Generated by LTIAAS at registration.

name string

launchEndpoint uri

loginEndpoint uri

deeplinkingEndpoint uri

Falls back to launchEndpoint when none was registered.

redirectionUris uri[]

authConfig object

How LTIAAS verifies messages signed by the tool.

method string required

Possible values: [JWK_SET, JWK_KEY, RSA_KEY]

JWK_SET — key is a URL to the tool's JWKS. Preferred, because the tool can rotate keys without telling you.
JWK_KEY — key is a single JWK, as a JSON string.
RSA_KEY — key is a PEM-encoded public key.

key string required

The keyset URL, JWK or PEM key, depending on method.

permissions Permission[]

Possible values: [MEMBERSHIPS_READ, LINEITEMS_READ, LINEITEMS_READ_WRITE, GRADES_READ, GRADES_WRITE, OUTCOMES_READ_WRITE, TOOL_SETTINGS_READ_WRITE]

personalData PersonalData

Possible values: [NONE, EMAIL, NAME, COMPLETE]

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

property name* string

active boolean

publicKey string

The public half of the key pair LTIAAS uses to sign this tool's ID Tokens. Also published in your keyset.

{
  "id": "3wT7bVhgsve6byG33fVV",
  "clientId": "3wT7bVhgsve6byG33fVV",
  "deploymentId": "EgAssgssdfgsfshshq8iw",
  "name": "Learning tool 1",
  "launchEndpoint": "https://mytool.ltiaas.com/lti/launch",
  "loginEndpoint": "https://mytool.ltiaas.com/lti/login",
  "deeplinkingEndpoint": "https://mytool.ltiaas.com/lti/launch",
  "redirectionUris": [
    "https://mytool.ltiaas.com/lti/launch"
  ],
  "authConfig": {
    "method": "JWK_SET",
    "key": "https://mytool.ltiaas.com/keys"
  },
  "permissions": [
    "MEMBERSHIPS_READ",
    "LINEITEMS_READ"
  ],
  "personalData": "COMPLETE",
  "customParameters": {},
  "active": true,
  "publicKey": "-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----\n"
}

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 account is not permitted to use this endpoint — most often because it is an LTIAAS Launch account rather than a Connect one, or because a trial quota has been reached.

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

Register A Tool​

Register A Tool