Skip to content

Commit

Permalink
#109 - keep old example; add cookie lang. example
Browse files Browse the repository at this point in the history
  • Loading branch information
lsloan committed Jun 25, 2024
1 parent a06182e commit 8e079a1
Showing 1 changed file with 23 additions and 5 deletions.
28 changes: 23 additions & 5 deletions docs/oidc_initiation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,30 @@ to return an authentication request to the platform

.. code-block:: python
...
# ...
from lti_tool.views import OIDCLoginInitView
urlpatterns = [
path("init/<uuid:registration_uuid/", OIDCLoginInitView.as_view(), name="init"),
# ...
]
The ``registration_uuid`` parameter is a reference to the
:attr:`LtiRegistration.uuid <lti_tool.models.LtiRegistration.uuid>` property, and is
used to identify the platform registration associated with the initiation request.


Customizing language for blocked cookies
----------------------------------------

When the user's browser prevents embedded content from setting cookies within an
``iframe``, the module displays a message about it and a link to open the
content in a new tab or window. The language of the message and link may be
customized using optional message arguments to ``OIDCLoginInitView.as_view()``…

.. code-block:: python
# ...
from lti_tool.views import OIDCLoginInitView
urlpatterns = [
Expand All @@ -32,10 +54,6 @@ to return an authentication request to the platform
# ...
]
The ``registration_uuid`` parameter is a reference to the
:attr:`LtiRegistration.uuid <lti_tool.models.LtiRegistration.uuid>` property, and is
used to identify the platform registration associated with the initiation request.

The ``main_msg``, ``click_msg``, and ``loading_msg`` **optional** arguments are
passed to ``DjangoOIDCLogin.enable_check_cookies()`` to generate messages shown
in the UI. The values shown here are the default values used by
Expand Down

0 comments on commit 8e079a1

Please sign in to comment.