Collection
First space
First spaceSecond spaceThird Space
First space
First spaceSecond spaceThird Space
  • Page 1
  • Group 1
    • Page 2
    • Page 3
Powered by GitBook
On this page
  1. Group 1

Page 2

PreviousPage 1NextPage 3

Last updated 8 months ago

show

get
Path parameters
account_idintegerrequired
Example: 6699
idintegerrequired
Example: 9462
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/api/v1/accounts/{account_id}/lti_registrations/{id}'
200
{
  "id": 9462,
  "internal_service": false,
  "account_id": 6699,
  "root_account_id": 6699,
  "name": "Test Registration",
  "admin_nickname": null,
  "vendor": null,
  "workflow_state": "active",
  "created_at": "2024-07-11T00:03:46Z",
  "updated_at": "2024-07-11T00:03:46Z",
  "inherited": false,
  "lti_version": "1.3",
  "icon_url": null,
  "developer_key_id": null,
  "created_by": {
    "id": 14754,
    "name": "value for name",
    "created_at": "2024-07-11T00:03:46Z",
    "sortable_name": "name, value for",
    "short_name": "value for name",
    "sis_user_id": null,
    "integration_id": null,
    "sis_import_id": null
  },
  "updated_by": {
    "id": 14754,
    "name": "value for name",
    "created_at": "2024-07-11T00:03:46Z",
    "sortable_name": "name, value for",
    "short_name": "value for name",
    "sis_user_id": null,
    "integration_id": null,
    "sis_import_id": null
  },
  "configuration": {},
  "account_binding": {
    "id": 8087,
    "registration_id": 9462,
    "account_id": 6699,
    "workflow_state": "off",
    "root_account_id": 6699,
    "created_at": "2024-07-11T00:03:46Z",
    "updated_at": "2024-07-11T00:03:46Z",
    "created_by": {
      "id": 14755,
      "name": "value for name",
      "created_at": "2024-07-11T00:03:46Z",
      "sortable_name": "name, value for",
      "short_name": "value for name",
      "sis_user_id": null,
      "integration_id": null,
      "sis_import_id": null
    },
    "updated_by": {
      "id": 14755,
      "name": "value for name",
      "created_at": "2024-07-11T00:03:46Z",
      "sortable_name": "name, value for",
      "short_name": "value for name",
      "sis_user_id": null,
      "integration_id": null,
      "sis_import_id": null
    }
  }
}

TBD

list

get
Path parameters
account_idintegerrequired
Example: 6699
Query parameters
dirstringoptional
Example: asc
pageintegeroptional
Example: 2
per_pageintegeroptional
Example: 5
querystringoptional
Example: searchterm
sortstringoptional
Example: installed_by
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/api/v1/accounts/{account_id}/lti_registrations'
200
{
  "total": 15,
  "data": [
    {
      "id": 9730,
      "internal_service": false,
      "account_id": 6700,
      "root_account_id": 6700,
      "name": "Site admin registration",
      "admin_nickname": null,
      "vendor": null,
      "workflow_state": "active",
      "created_at": "2024-07-11T00:04:54Z",
      "updated_at": "2024-07-11T00:04:54Z",
      "inherited": true,
      "lti_version": "1.3",
      "icon_url": null,
      "developer_key_id": null,
      "created_by": {
        "id": 15122,
        "name": "value for name",
        "created_at": "2024-07-11T00:04:54Z",
        "sortable_name": "name, value for",
        "short_name": "value for name",
        "sis_user_id": null,
        "integration_id": null,
        "sis_import_id": null
      },
      "updated_by": {
        "id": 15122,
        "name": "value for name",
        "created_at": "2024-07-11T00:04:54Z",
        "sortable_name": "name, value for",
        "short_name": "value for name",
        "sis_user_id": null,
        "integration_id": null,
        "sis_import_id": null
      },
      "account_binding": {
        "id": 8314,
        "registration_id": 9730,
        "account_id": 6699,
        "workflow_state": "on",
        "root_account_id": 6699,
        "created_at": "2024-07-11T00:04:55Z",
        "updated_at": "2024-07-11T00:04:55Z",
        "created_by": {
          "id": 15123,
          "name": "value for name",
          "created_at": "2024-07-11T00:04:55Z",
          "sortable_name": "name, value for",
          "short_name": "value for name",
          "sis_user_id": null,
          "integration_id": null,
          "sis_import_id": null
        },
        "updated_by": {
          "id": 15123,
          "name": "value for name",
          "created_at": "2024-07-11T00:04:55Z",
          "sortable_name": "name, value for",
          "short_name": "value for name",
          "sis_user_id": null,
          "integration_id": null,
          "sis_import_id": null
        }
      }
    },
    {
      "id": 9729,
      "internal_service": false,
      "account_id": 6700,
      "root_account_id": 6700,
      "name": "Site admin registration",
      "admin_nickname": null,
      "vendor": null,
      "workflow_state": "active",
      "created_at": "2024-07-11T00:04:54Z",
      "updated_at": "2024-07-11T00:04:54Z",
      "inherited": true,
      "lti_version": "1.3",
      "icon_url": null,
      "developer_key_id": null,
      "created_by": {
        "id": 15120,
        "name": "value for name",
        "created_at": "2024-07-11T00:04:54Z",
        "sortable_name": "name, value for",
        "short_name": "value for name",
        "sis_user_id": null,
        "integration_id": null,
        "sis_import_id": null
      },
      "updated_by": {
        "id": 15120,
        "name": "value for name",
        "created_at": "2024-07-11T00:04:54Z",
        "sortable_name": "name, value for",
        "short_name": "value for name",
        "sis_user_id": null,
        "integration_id": null,
        "sis_import_id": null
      },
      "account_binding": {
        "id": 8313,
        "registration_id": 9729,
        "account_id": 6699,
        "workflow_state": "on",
        "root_account_id": 6699,
        "created_at": "2024-07-11T00:04:54Z",
        "updated_at": "2024-07-11T00:04:54Z",
        "created_by": {
          "id": 15121,
          "name": "value for name",
          "created_at": "2024-07-11T00:04:54Z",
          "sortable_name": "name, value for",
          "short_name": "value for name",
          "sis_user_id": null,
          "integration_id": null,
          "sis_import_id": null
        },
        "updated_by": {
          "id": 15121,
          "name": "value for name",
          "created_at": "2024-07-11T00:04:54Z",
          "sortable_name": "name, value for",
          "short_name": "value for name",
          "sis_user_id": null,
          "integration_id": null,
          "sis_import_id": null
        }
      }
    },
    {
      "id": 9728,
      "internal_service": false,
      "account_id": 6700,
      "root_account_id": 6700,
      "name": "Site admin registration",
      "admin_nickname": null,
      "vendor": null,
      "workflow_state": "active",
      "created_at": "2024-07-11T00:04:54Z",
      "updated_at": "2024-07-11T00:04:54Z",
      "inherited": true,
      "lti_version": "1.3",
      "icon_url": null,
      "developer_key_id": null,
      "created_by": {
        "id": 15118,
        "name": "value for name",
        "created_at": "2024-07-11T00:04:54Z",
        "sortable_name": "name, value for",
        "short_name": "value for name",
        "sis_user_id": null,
        "integration_id": null,
        "sis_import_id": null
      },
      "updated_by": {
        "id": 15118,
        "name": "value for name",
        "created_at": "2024-07-11T00:04:54Z",
        "sortable_name": "name, value for",
        "short_name": "value for name",
        "sis_user_id": null,
        "integration_id": null,
        "sis_import_id": null
      },
      "account_binding": {
        "id": 8312,
        "registration_id": 9728,
        "account_id": 6699,
        "workflow_state": "on",
        "root_account_id": 6699,
        "created_at": "2024-07-11T00:04:54Z",
        "updated_at": "2024-07-11T00:04:54Z",
        "created_by": {
          "id": 15119,
          "name": "value for name",
          "created_at": "2024-07-11T00:04:54Z",
          "sortable_name": "name, value for",
          "short_name": "value for name",
          "sis_user_id": null,
          "integration_id": null,
          "sis_import_id": null
        },
        "updated_by": {
          "id": 15119,
          "name": "value for name",
          "created_at": "2024-07-11T00:04:54Z",
          "sortable_name": "name, value for",
          "short_name": "value for name",
          "sis_user_id": null,
          "integration_id": null,
          "sis_import_id": null
        }
      }
    }
  ]
}

TBD

  • GETindex
  • POSTbind
  • PUTupdate
  • GETshow
  • DELETEdestroy
  • GETlist

index

get
Path parameters
account_idintegerrequired
Example: 6699
Responses
text/html
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/accounts/{account_id}/apps'
200
text

TBD

bind

post
Path parameters
account_idintegerrequired
Example: 6699
idintegerrequired
Example: 9472
Body
workflow_statestringrequired
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/api/v1/accounts/{account_id}/lti_registrations/{id}/bind' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'workflow_state=off'
200
{
  "id": 8092,
  "registration_id": 9472,
  "account_id": 6699,
  "workflow_state": "off",
  "root_account_id": 6699,
  "created_at": "2024-07-11T00:04:12Z",
  "updated_at": "2024-07-11T00:04:12Z",
  "created_by": {
    "id": 14771,
    "name": "value for name",
    "created_at": "2024-07-11T00:04:12Z",
    "sortable_name": "name, value for",
    "short_name": "value for name",
    "sis_user_id": null,
    "integration_id": null,
    "sis_import_id": null
  },
  "updated_by": {
    "id": 14751,
    "name": "A User",
    "created_at": "2024-07-11T00:03:35Z",
    "sortable_name": "User, A",
    "short_name": "A User",
    "sis_user_id": null,
    "integration_id": null,
    "sis_import_id": null
  }
}

TBD

update

put
Path parameters
account_idintegerrequired
Example: 6699
idintegerrequired
Example: 9463
Body
admin_nicknamestringrequired
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request PUT \
  --url '/api/v1/accounts/{account_id}/lti_registrations/{id}' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'admin_nickname=New Name'
200
{
  "admin_nickname": "New Name",
  "workflow_state": "active",
  "root_account_id": 6699,
  "id": 9463,
  "internal_service": false,
  "account_id": 6699,
  "name": "Test Registration",
  "vendor": null,
  "created_at": "2024-07-11T00:03:59Z",
  "updated_at": "2024-07-11T00:04:05Z",
  "inherited": false,
  "lti_version": "1.3",
  "icon_url": "https://example.com/api/apps/1/icon.svg",
  "dynamic_registration": true,
  "developer_key_id": null,
  "created_by": {
    "id": 14757,
    "name": "User",
    "created_at": "2024-07-11T00:03:58Z",
    "sortable_name": "User",
    "short_name": "User",
    "sis_user_id": null,
    "integration_id": null,
    "sis_import_id": null
  },
  "updated_by": {
    "id": 14751,
    "name": "A User",
    "created_at": "2024-07-11T00:03:35Z",
    "sortable_name": "User, A",
    "short_name": "A User",
    "sis_user_id": null,
    "integration_id": null,
    "sis_import_id": null
  }
}

TBD

destroy

delete
Path parameters
account_idintegerrequired
Example: 6699
idintegerrequired
Example: 9461
Body
objectoptional
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url '/api/v1/accounts/{account_id}/lti_registrations/{id}' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data ''
200
{
  "workflow_state": "deleted",
  "root_account_id": 6699,
  "id": 9461,
  "internal_service": false,
  "account_id": 6699,
  "name": "Test Registration",
  "admin_nickname": null,
  "vendor": null,
  "created_at": "2024-07-11T00:03:36Z",
  "updated_at": "2024-07-11T00:03:41Z",
  "inherited": false,
  "lti_version": "1.3",
  "icon_url": "https://example.com/api/apps/1/icon.svg",
  "dynamic_registration": true,
  "developer_key_id": null,
  "created_by": {
    "id": 14752,
    "name": "value for name",
    "created_at": "2024-07-11T00:03:36Z",
    "sortable_name": "name, value for",
    "short_name": "value for name",
    "sis_user_id": null,
    "integration_id": null,
    "sis_import_id": null
  },
  "updated_by": {
    "id": 14752,
    "name": "value for name",
    "created_at": "2024-07-11T00:03:36Z",
    "sortable_name": "name, value for",
    "short_name": "value for name",
    "sis_user_id": null,
    "integration_id": null,
    "sis_import_id": null
  },
  "configuration": {
    "name": "Test Dynamic Registration",
    "description": null,
    "domain": "example.com",
    "custom_fields": {},
    "target_link_uri": "https://example.com/api/registrations/3/launch",
    "privacy_level": "public",
    "icon_url": "https://example.com/api/apps/1/icon.svg",
    "oidc_initiation_url": "https://example.com/api/registrations/3/login",
    "redirect_uris": [
      "https://example.com/api/registrations/3/launch"
    ],
    "public_jwk_url": "https://example.com/api/registrations/3/jwks",
    "scopes": [
      "https://purl.imsglobal.org/spec/lti-ags/scope/lineitem",
      "https://purl.imsglobal.org/spec/lti-ags/scope/lineitem.readonly",
      "https://purl.imsglobal.org/spec/lti-ags/scope/result.readonly",
      "https://purl.imsglobal.org/spec/lti-ags/scope/score",
      "https://purl.imsglobal.org/spec/lti-nrps/scope/contextmembership.readonly",
      "https://canvas.instructure.com/lti/public_jwk/scope/update",
      "https://canvas.instructure.com/lti/account_lookup/scope/show",
      "https://canvas.instructure.com/lti-ags/progress/scope/show"
    ],
    "placements": [
      {
        "placement": "global_navigation",
        "enabled": true,
        "message_type": "LtiResourceLinkRequest",
        "target_link_uri": "https://example.com/api/registrations/3/launch?placement=global_navigation",
        "text": "Test Dynamic Registration (Global Navigation)",
        "icon_url": "https://example.com/api/apps/1/icon.svg",
        "custom_fields": {
          "foo": "bar",
          "context_id": "$Context.id"
        }
      }
    ],
    "tool_id": null
  }
}

TBD