ExternalTool

class canvasapi.external_tool.ExternalTool(requester, attributes)

Parameters:

• requester (canvasapi.requester.Requester) – The requester to pass HTTP requests through.

• attributes (dict) – The JSON object to build this object with.

delete(**kwargs)

Remove the specified external tool.

Calls:

DELETE /api/v1/courses/:course_id/external_tools/:external_tool_id or DELETE /api/v1/accounts/:account_id/external_tools/:external_tool_id

Return type:

canvasapi.external_tool.ExternalTool

edit(**kwargs)

Update the specified external tool.

Calls:

PUT /api/v1/courses/:course_id/external_tools/:external_tool_id or PUT /api/v1/accounts/:account_id/external_tools/:external_tool_id

Return type:

canvasapi.external_tool.ExternalTool

get_parent(**kwargs)

Return the object that spawned this tool.

Return type:

canvasapi.account.Account or canvasapi.account.Course

get_sessionless_launch_url(**kwargs)

Return a sessionless launch url for an external tool.

Calls:

GET /api/v1/courses/:course_id/external_tools/sessionless_launch or GET /api/v1/accounts/:account_id/external_tools/sessionless_launch

Return type:

str

property parent_id

Return the id of the course or account that spawned this tool.

Return type:

int

property parent_type

Return whether the tool was spawned from a course or account.

Return type:

str