LoginLinkService#

class LoginLinkService[source]#

Methods

get

Get a login link and the connected assignment.

login

Login with the given login link.
get(*, login_link_id, extra_parameters=None)[source]#

Get a login link and the connected assignment.

Parameters:

  • login_link_id (str) – The id of the login link 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 login link, which will also contain information about the connected assignment.

Return type:

AssignmentLoginLink

login(*, login_link_id, extra_parameters=None)[source]#

Login with the given login link.

This will only work when the assignment connected to this link is available, and the lock date has not expired. The received JWT token will only be valid until the 30 minutes after the lock date, and only in the course connected to this link.

The scope of the returned token will change in the future, this will not be considered a breaking change.

Parameters:

  • login_link_id (str) – The id of the login link you want to use to login.

  • 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 logged in user and an access token.

Return type:

ResultDataPostLoginLinkLogin