Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page describes the functional flow and is provided to assist the design of merchant workflows in implementing the InAcademia academic validation service.

...

ANNOUNCEMENT 30.11.2020: 

Release 2.5.0 deploys enhancements to the error flow, and is released to the production environment today as previously announced between 22:00 and 23:59 UTC. No service outage is required. Clients planning to take advantage of the idp_hint assertion feature in production who haven’t already expressed this preference, please email a request to info@inacademia.org.. Please refer to errors 9, 10 and 11 in the diagrams below. For the purposes of comparison, documentation is provided for the error flow as built in version 2.4.0 as well as the enhancements built in version 2.5.0, and to follow in version 2.6.0. It is strongly recommended that workflows are updated to respond to these errors.

Release 2.6.0 will be deployed to the customer integration platform this week, and will address errors 8 and 13. As no new feature is planned to be deployed in v2.6.0 (only very minor enhancements to the two error flows as described below), it is planned for deploy to production w/c 14th December.

  • Release 4.6.3 (see SVS 4.6.3) introducing support for SATOSA 8.5.1 and pysaml2 7.5.2, deployed to production 17th March 2025

Table of Contents

High Level Functional flow

...

Detailed functional flow

In the following diagram, light blue represents the merchant web shop, grey blue is InAcademia functionality. Institutional Identity Provider is represented in Green. 

The figure presents the 'happy' flow, ending in a successful validation, as displayed in green, as well the possible error scenarios represented in red or orange. The error situation where a institutional IdP, or the merchant redirect URL component cannot be reached because of network issues or similar is not take into account as that is out are out of scope and control for InAcademia and will always yield an some error in the users browser. The InAcademia service is part of a continuing development programme and additional features planned for the future are also captured below. Gliffy DiagramnameInAcademia

Entry Flow

...

with Errors v4.6.3

Gliffy Diagram
macroId58e99b56-11a5-4bc2-b5ba-d55540ae6e12
displayNameInAcademia Entry Flow 3.3.0

...

Response Flow for all versions up to and including 2.4.0 (provided to assist the migration of merchant workflows interacting with 2.4.0 to 2.5.0):

Gliffy Diagram
displayNameInAcademia Response Flow (V3) - PUBLIC
nameInAcademia Response Flow (V3) CopyEntry Flow 3.3.0 - PUBLIC
pagePin73

Response Flow

...

v4.6.

...

3

Gliffy Diagram
macroIda217b297fdf63335-83d9-46d34b65-4bec-9e13-0ec82b63c1819c71-493e1e1cdedd
displayNameInAcademia Response Flow 4.4.0 - PUBLIC
nameInAcademia Response Flow 24.60.0 - PUBLIC
pagePin13