Deactivate A Tool

Marks a tool as inactive. The registration and its keys are kept, but launches are refused with 403 INACTIVE_TOOL until you activate it again.

Path Parameters

toolId string required
The tool's ID, as returned at registration. This is also the tool's clientId.
Example: 3wT7bVhUADSsfdG33fVV

Responses

• 200
• 401
• 403
• 404

---

Tool deactivated

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

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

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