LTIService#

class LTIService[source]#

Methods

get_all

List all known LTI providers for this instance.

create

Create a new LTI 1.1 or 1.3 provider.

deep_link

Create a deeplink response for the given blob.

patch_1p1_provider

Update the given LTI 1.1 provider.

get_1p3_provider

Get a LTI 1.3 provider.

patch_1p3_provider

Update the given LTI 1.3 provider.

get

Get a LTI provider.

get_all_1p3

List all known LTI 1.3 providers for this instance.

patch_provider

Update the given LTI provider.

launch_second_phase

Do the second part of an LTI launch.

get_all(*, extra_parameters=None)[source]#

List all known LTI providers for this instance.

This route is part of the public API.

Parameters:

extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.
self (LTIService[AuthenticatedClient]) –

Returns:

A list of all known LTI providers.

Return type:

Sequence[FinalizedLTI1p3Provider | NonFinalizedLTI1p3Provider | FinalizedLTI1p1Provider | NonFinalizedLTI1p1Provider]

create(json_body, *, extra_parameters=None)[source]#

Create a new LTI 1.1 or 1.3 provider.

This route is part of the public API.

Parameters:

json_body (Union[dict, list, LTI1p1ProviderData, LTI1p3ProviderData]) – The body of the request. See CreateLTIData for information about the possible fields. You can provide this data as a CreateLTIData or as a dictionary.
extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.
self (LTIService[AuthenticatedClient]) –

Returns:

The just created provider.

Return type:

FinalizedLTI1p3Provider | NonFinalizedLTI1p3Provider | FinalizedLTI1p1Provider | NonFinalizedLTI1p1Provider

deep_link(json_body, *, deep_link_blob_id, extra_parameters=None)[source]#

Create a deeplink response for the given blob.

Parameters:

json_body (Union[dict, list, DeepLinkLTIData]) – The body of the request. See DeepLinkLTIData for information about the possible fields. You can provide this data as a DeepLinkLTIData or as a dictionary.
deep_link_blob_id (str) – The id of the blob from the first phase, for which to create a deeplink.
extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

Returns:

The URL and JWT to use for the deeplink response.

Return type:

LTIDeepLinkResponse

patch_1p1_provider(json_body, *, lti_provider_id, secret=Nothing, extra_parameters=None)[source]#

Update the given LTI 1.1 provider.

This route is part of the public api.

Parameters:

json_body (Union[dict, list, Patch1P1ProviderLTIData]) – The body of the request. See Patch1P1ProviderLTIData for information about the possible fields. You can provide this data as a Patch1P1ProviderLTIData or as a dictionary.
lti_provider_id (str) – The id of the provider you want to update.
secret (Union[Just[str], _Nothing[str]]) – The secret to use to update the provider.
extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

Returns:

The updated provider.

Return type:

FinalizedLTI1p1Provider | NonFinalizedLTI1p1Provider

get_1p3_provider(*, lti_provider_id, extra_parameters=None)[source]#

Get a LTI 1.3 provider.

This route is part of the public API.

Parameters:

lti_provider_id (str) – The id of the provider you want to get.
extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

Returns:

The requested LTI 1.3 provider.

Return type:

FinalizedLTI1p3Provider | NonFinalizedLTI1p3Provider

patch_1p3_provider(json_body, *, lti_provider_id, secret=Nothing, extra_parameters=None)[source]#

Update the given LTI 1.3 provider.

This route is part of the public API.

Parameters:

json_body (Union[dict, list, Patch1P3ProviderLTIData]) – The body of the request. See Patch1P3ProviderLTIData for information about the possible fields. You can provide this data as a Patch1P3ProviderLTIData or as a dictionary.
lti_provider_id (str) – The id of the provider you want to update.
secret (Union[Just[str], _Nothing[str]]) – The secret to use to update the provider.
extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

Returns:

The updated LTI 1.3 provider.

Return type:

FinalizedLTI1p3Provider | NonFinalizedLTI1p3Provider

get(*, lti_provider_id, secret=Nothing, extra_parameters=None)[source]#

Get a LTI provider.

This route is part of the public API.

Parameters:

lti_provider_id (str) – The id of the provider you want to get.
secret (Union[Just[str], _Nothing[str]]) – The secret to use to update the provider.
extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

Returns:

The requested LTI 1.1 or 1.3 provider.

Return type:

FinalizedLTI1p3Provider | NonFinalizedLTI1p3Provider | FinalizedLTI1p1Provider | NonFinalizedLTI1p1Provider

get_all_1p3(*, extra_parameters=None)[source]#

List all known LTI 1.3 providers for this instance.

This route is part of the public API.

Parameters:

extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.
self (LTIService[AuthenticatedClient]) –

Returns:

A list of all known LTI 1.3 providers.

Return type:

Sequence[FinalizedLTI1p3Provider | NonFinalizedLTI1p3Provider]

patch_provider(json_body, *, lti_provider_id, extra_parameters=None)[source]#

Update the given LTI provider.

Parameters:

json_body (Union[dict, list, PatchProviderLTIData]) – The body of the request. See PatchProviderLTIData for information about the possible fields. You can provide this data as a PatchProviderLTIData or as a dictionary.
lti_provider_id (str) – The id of the provider you want to update.
extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.
self (LTIService[AuthenticatedClient]) –

Returns:

The updated LTI provider.

Return type:

FinalizedLTI1p3Provider | NonFinalizedLTI1p3Provider | FinalizedLTI1p1Provider | NonFinalizedLTI1p1Provider

launch_second_phase(json_body, *, extra_parameters=None)[source]#

Do the second part of an LTI launch. Used internally in our LTI Launch page only.

Parameters:

json_body (Union[dict, list, LaunchSecondPhaseLTIData]) – The body of the request. See LaunchSecondPhaseLTIData for information about the possible fields. You can provide this data as a LaunchSecondPhaseLTIData or as a dictionary.
extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

Returns:

A _LTILaunch instance.

Return type:

LTILaunchResult

`get_all`	List all known LTI providers for this instance.
`create`	Create a new LTI 1.1 or 1.3 provider.
`deep_link`	Create a deeplink response for the given blob.
`patch_1p1_provider`	Update the given LTI 1.1 provider.
`get_1p3_provider`	Get a LTI 1.3 provider.
`patch_1p3_provider`	Update the given LTI 1.3 provider.
`get`	Get a LTI provider.
`get_all_1p3`	List all known LTI 1.3 providers for this instance.
`patch_provider`	Update the given LTI provider.
`launch_second_phase`	Do the second part of an LTI launch.