Metadata-Version: 2.5
Name: ol-openedx-lti-utilities
Version: 0.2.0
Summary: An Open edX plugin to add utilities for LTI operations
Author: MIT Office of Digital Learning
License-Expression: BSD-3-Clause
License-File: LICENSE.txt
Requires-Python: >=3.11
Requires-Dist: django>=5.2
Requires-Dist: djangorestframework>=3.16.0
Requires-Dist: edx-django-utils>=8.0.0
Requires-Dist: edx-drf-extensions>=10.6.0
Requires-Dist: edx-opaque-keys
Description-Content-Type: text/x-rst

LTI Utilities Plugin
=============================

A django app plugin to add LTI related utilities in Open edX platform.


Version Compatibility
----------------------

For this plugin's compatibility with Open edX, see the
`Open edX Release Compatibility table <../../docs#open-edx-release-compatibility>`_.

Installation
------------

For detailed installation instructions, please refer to the `plugin installation guide <../../docs#installation-guide>`_.

Installation required in:

* LMS

How To Use
----------

**API Request**

To manually call the API, Send a POST request to ``<LMS_BASE>/lti-user-fix/`` with a JSON body containing the following field:
 - ``email``: The email address of the user whose LTI account needs to be fixed.

A sample request looks like below:

::

    POST: http://local.openedx.io:8000/api/lti-user-fix/

    Payload:
    {
        "email": "user@example.com"
    }


API Response
------------

The successful response would be an indication that an LTI user in bad state was found and fixed. The response status code would be 200.
