diff --git a/docs/use-cases/college.md b/docs/use-cases/college.md new file mode 100644 index 0000000000..c665643222 --- /dev/null +++ b/docs/use-cases/college.md @@ -0,0 +1,34 @@ +# College Discount + +We have another potential transit discount use case, which is for students/faculty/staff from the Monterey-Salinas Transit (MST) area. We will be taking [the existing program](https://mst.org/fares/overview/) where students from certain schools ride free, expanding it to faculty and staff in some cases, and allowing those riders to enroll their contactless bank (credit/debit) cards for half-price (50%) discounts during fall and winter breaks. + +## Prototype + +Here's a clickable prototype showing the planned flow, having users enroll via their college's single sign-on (SSO) system: + + + +## Process + +Here's what will happen behind the scenes in a success flow: + +```mermaid +sequenceDiagram + actor rider + participant Benefits as Benefits app + participant IdG as Identity Gateway + participant SSO + participant Littlepay + + rider->>Benefits: visits site + Benefits-->>IdG: redirected to sign in + IdG-->>SSO: redirected to sign in + rider->>SSO: enters credentials + SSO-->>IdG: user attributes + IdG-->>Benefits: user attributes + Benefits-->>Littlepay: enrollment start + rider->>Littlepay: enters payment card details + Littlepay-->>Benefits: enrollment complete +``` + +The plan is to determine whether the rider is eligible via SAML attributes and/or membership in a group on the college side. diff --git a/docs/use-cases/students.md b/docs/use-cases/students.md deleted file mode 100644 index 40560e6c44..0000000000 --- a/docs/use-cases/students.md +++ /dev/null @@ -1,32 +0,0 @@ -# Students - -We have another potential transit discount use case, which is for college students from the Monterey-Salinas Transit (MST) area. We will be taking [the existing program](https://mst.org/fares/overview/) where students from certain schools ride free, and allowing those students to enroll their contactless bank (credit/debit) cards. - -## Prototype - -Here's a clickable prototype showing what the flow might look like, having students enroll via their college's Learning Management System (LMS): - - - -## Process - -Here's what might happen behind the scenes in a success flow: - -```mermaid -sequenceDiagram - actor student - participant LMS - participant Benefits as Benefits app - participant Littlepay - - student->>LMS: visits their LMS - LMS-->>Benefits: opens in an iframe - Benefits-->>LMS: initiates authentication - LMS-->>Benefits: provides user role - student->>Benefits: sent to enrollment page - Benefits-->>Littlepay: enrollment start - student->>Littlepay: enters payment card details - Littlepay-->>Benefits: enrollment complete -``` - -The current plan is for Benefits application to be integrated with each school's LMS as an [LTI 1.3](http://www.imsglobal.org/spec/lti/v1p3/) tool. Authentication would happen through [OpenID Connect](https://openid.net/specs/openid-connect-core-1_0.html#Overview) via an [anonymous launch](http://www.imsglobal.org/spec/lti/v1p3/#anonymous-launch-case). The hope is that we can infer the rider is an eligible student via their [role in the LMS](http://www.imsglobal.org/spec/lti/v1p3/#role-vocabularies). diff --git a/mkdocs.yml b/mkdocs.yml index c296885605..2697220ff0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -35,10 +35,11 @@ plugins: - awesome-pages - redirects: redirect_maps: - "students.md": "use-cases/students.md" "deployment/azure.md": "deployment/infrastructure.md" "getting-started/development.md": "development/README.md" "getting-started/docker-dynamic-ports.md": "development/docker-dynamic-ports.md" + "students.md": "use-cases/college.md" + "use-cases/students.md": "use-cases/college.md" extra_css: - https://use.fontawesome.com/releases/v5.13.0/css/all.css