Skip to content

Commit 93f7e2f

Browse files
committed
docs: ADR issue verifiable credentials in MFE
1 parent c4f3953 commit 93f7e2f

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
Issue verifiable credentials to learners in the Learner Record MFE
2+
==================================================================
3+
4+
Status
5+
------
6+
7+
Proposed
8+
9+
10+
Context
11+
-------
12+
13+
Following the `decision <https://github.com/openedx/credentials/issues/1735>`_ to integrate `verifiable credentials`_ into the Credentials Service,
14+
this ADR describes the implementation of the user interface, so that learners can request verifiable credentials based on their achievements in the Open edX system.
15+
16+
To generate a verifiable credential, the learner needs to provide their wallet DID.
17+
In most digital credentials wallets, it can be done automatically from the mobile application by either scanning a QR code or opening a deep link.
18+
The QR code or the deep link include additional parameters, which allow the mobile app to prepare a request to the server and receive signed, verifiable credentials.
19+
20+
Learners can issue the same Open edX credentials multiple times, but every time a verifiable credential is issued,
21+
it will have a unique proof. Therefore, every issued verifiable credential is unique.
22+
23+
Decision
24+
--------
25+
26+
* It is decided to implement the user interface for issuing credentials in the `Learner Record`_ micro-frontend, as it currently contains views for a learners current status in a program and the ability to share any earned credentials publicly or with institutions.
27+
28+
* Since the verifiable credentials functionality is optional for Open edX deployers, it has been decided to introduce a flag toggle in the `Learner Record`_ MFE, called 'ENABLE_VERIFIABLE_CREDENTIALS'. If this flag is disabled, the functionality related to verifiable credentials will not be available for users.
29+
30+
* The MFE should determine the user's device type, whether it is a desktop or mobile device. If the user opens verifiable credentials interface from desktop, the QR Code generated on a server should be displayed. If the user requests its credentials from a mobile device, the option to download the credentials using a deep link is shown.
31+
32+
* The learner may choose several credentials to issue, and then add them one-by-one into the digital wallet app.
33+
34+
Consequences
35+
------------
36+
37+
Learners will have greater opportunities to share the Open edX credentials in the real world.
38+
39+
The `Learner Record`_ micro-frontend will be extended with an optional functionality for verifiable credentials.
40+
41+
Rejected Alternatives
42+
---------------------
43+
44+
* Create a new micro-frontend for verifiable credentials.
45+
46+
* Use Django templates and legacy theming to implement user interface for the verifiable credentials in the Credentials Service.
47+
48+
References
49+
----------
50+
51+
Technical design proposal for verifiable credentials: https://openedx.atlassian.net/wiki/spaces/OEPM/pages/3490840577/Verifiable+Credentials+design#Design-Proposal
52+
53+
User Interface wireframes: https://openedx.atlassian.net/wiki/spaces/OEPM/pages/3490840577/Verifiable+Credentials+design#MFE-wireframes
54+
55+
.. _`verifiable credentials`: https://www.w3.org/TR/vc-data-model/
56+
57+
.. _`Learner Record`: https://github.com/openedx/frontend-app-learner-record

0 commit comments

Comments
 (0)