InAcademia uses the OpenID Connect standard to provide validation of an end-users affiliation with an academic institution. In this protocol the InAcademia service acts as an OpenID Connect provider (OP), and to validate an affiliation your service acts as a Relying party (RP).

This document is NOT a complete implementation reference for an OIDC RP for InAcademia. To ensure that the full benefits of the OpenID Connect standard and the InAcademia service are realised, it is strongly recommended that merchants use an OIDC client that has passed the OIDC certification (as listed here: https://openid.net/certification/ in the section “Certified Relying Parties”). This document assumes you are using an existing RP or RP library and provides suggestions on how to configure your client in general terms for use with InAcademia.

Examples of configuration for specific clients can be found here: https://stage.docs.inacademia.org/knowledge-base/client-rp-examples/

More best practice information can be found here: https://openid.net/specs/openid-connect-core-1_0.html

In ‘Transaction: validate affiliation’ the protocol flow and the messages exchanged in one transaction are described. All supported operations are described more in-depth in Supported operations.

Terminology and legend

In addition to the terminology defined by OpenID Connect standard, further context from the perspective of implementing OIDC for InAcademia follows.

Terminology

Formatting

Transaction: validate affiliation

To validate an end user’s affiliation with an institution your RP must be registered with the InAcademia service and have a valid client id and client secret at the InAcademia OP, see Registering Your Service.

Start of transaction: Authentication Request

A transaction is initiated when an Authentication request is received at the OP. The authentication request is sent by redirecting the end-user to:

Authorization Code Flow: /InAcademia/authorization?nonce=&state=&redirect_uri=&response_type=code&client_id=&scope=

Code with PKCE: /InAcademia/authorization?nonce=&state=&redirect_uri=&response_type=code&code_challenge=&code_challenge_method=S256&client_id=&scope=

InAcademia endpoints:

Discovery endpoint: https://op.srv.inacademia.org/.well-known/openid-configuration

Authorization Endpoint: https://op.srv.inacademia.org/InAcademia/authorization

OIDCProvider Issuer: https://op.srv.inacademia.org

All parameters are described in Authentication request. Documentation of the authentication request can be found in the section of the specs about Authentication using the Authorization Code Flow.

Note: Because of the redirect, the request is made by a client (typically a web-browser), and the response is delivered in the fragment identifier of the given redirect URI (see below).

End of transaction: Redirect URI

If the transaction succeeds, an ID Token (encoded as a JWT) will be returned. The ID Token should then be parsed running in the browser at the redirect URI.

Documentation of the response to a successful authentication can be found in the specs section on Successful authentication request.

Registration with the InAcademia service

Please see https://inacademia.org/registering-your-service/

Supported operations

OpenID Provider Configuration

To get the provider configuration of the InAcademia provider, the RP should make the following request:

GET /.well-known/openid-configuration HTTP/1.1
Host: <inacademia_base> 

The response will be a JSON document containing, for example, the authorization endpoint (where to direct the authorization request to validate the end-users affiliation).

Full documentation of the provider configuration exchange can be found in OpenID Connect Discovery.

Affiliation validation

Authentication request

The authentication should be directed to:

<inacademia_base>/authorization

The following parameters are allowed in the authentication request (any others will just be ignored):

OIDC Parameter Names

Supported Scopes

The type of affiliation to be validated for the transaction must be specified in the scope of the authentication request. There are two categories of scopes allowed:

• Affiliation: what type of affiliation should be validated?
• Identifier: what type of identifier is requested (persistent, to be able to identify returning users subsequent to the first validation, provided that the relevant attributes are supported and released by the institution, or transient, unique for each validation transaction)?

A valid scope string must fulfil the following:

• Exactly one value from the affiliation category of scopes must be specified.
• At most one value from the identifier category may be specified. If no value from the identifier category is specified, transient (see below table for description) is assumed.

Hence, the affiliation scope is required while both identifier and other scopes are optional. Any ambiguous or unsupported scope strings will be immediately rejected by the InAcademia service (refer to the Possible Errors Section below).

The table below contains all values, grouped by category, allowed in the scope string:

Scope Mapping

Additional claims

To request additional claims about the end user, the claims parameter can be specified in the authentication request, see Claims Parameter in Authentication request. 

The additional claims that can be requested can be seen in the following table:

Additional claims

Identity Provider Hinting

IdP hinting is an extension to the InAcademia service that intends to assist merchants who are keen to minimise the number of clicks a student needs to make in validating their academic affiliation, and can also be used to limit offers to users in specified countries.

An RP registered with the InAcademia service can create automatic redirects between a database of institution names hosted at the RP side and specified institutions by including a valid and correctly encoded IdP Hint in the Authorization Request to InAcademia. InAcademia will redirect the user to its Home Organization immediately instead of prompting them to select an institution from a Discovery Service UI. This has the added benefit of allowing merchants to constrain users to choose from IdPs on a country-by-country basis, and/or to target specific institutions or subsets of institutions with specific campaigns.

The list of institutions for IdP hinting is based on:

• the entityIDs of the members of the eduGAIN Interfederation, plus
• the entityIDs of institutions only available nationally where InAcademia is registered in that national federation.

Institutions might change to their entityID registered in eduGAIN or when the name of the institution changes.  On a per-institution this happens infrequently, but can happen almost daily across eduGAIN as a whole, and so implementers of InAcademia must update the IdP hint information accordingly. It is recommended to directly consume the JSON feeds provided, and to present an automatically refreshed, dynamic list of institutions from which your  users can select. If it is not possible for your service to use these feeds to automatically refresh a fully dynamic list of institutions, the JSON feeds must be consumed to refresh the list on at least a nightly basis. If the data is not monitored or consumed to support live updates to the selectable institutions, and some institutions make a change to their entityIDs, requests sent to that IdP will contain a stale hint.

In the event that an invalid or stale IdP hint is used in the Authentication Request, InAcademia will be unable to forward the user to its intended institution and will return the user to the specified redirect_uri with an error message.

The IdP Hint Assertion feature helps merchants verify that the validation returns from the institution used to initiate the validation.

RPs indicate they know the Home Organization of the end user by using the aarc_idp_hint request parameter and a valid IdP Hint.

The validation response will assert that the user has been validated as an affiliate of the specific institution that was the subject of the request (feature name ‘IdP Hint Assertion’. This feature adds a further level of validation and can mitigate against exploitation, ensuring that the user subject to the validation is not only affiliated with academia, but is affiliated with a specific institution.

For example:

<inacademia_base>/InAcademia/authorization?nonce=<nonce>&state=<state>&redirect_uri=<redirect_uri>&response_type=code&client_id=<client_id>&scope=<scope>&aarc_idp_hint=<aarc_idp_hint>

InAcademia provides and maintains a mapping between aarc_idp_hint values and Display Names of Home Organisations (available here).

Transaction success

If the transaction succeeds an ID Token and the state (if included in the initial authentication request) will be returned in the fragment identifier part of the redirect URI (see Successful authentication request). The ID Token is a JSON Web Token, containing a JSON document with all returned claims, see the table below. The id token should be inspected and validated, see ID Token Validation. A public key is required by the RP, and many OIDC frameworks fetch the public key by default, however, it’s possible to get the public key from the .well-known endpoint of the test or production platform. The .well-known endpoint contains the jwks_uri which contains the public key. 

The id_token

ID Token claims

The ID Token may also contain additional claims. The claims in the table Additional (optional) ID Token claims below will be included if:

• you are allowed to obtain them
• they were requested in the initial authentication request (see Additional Claims section above)
• the institution provides them to the InAcademia service

Additional (optional) ID token claims

Please note that in the case of Authorization Code Flow (response_type=code),  any of the claims listed in the above table can be requested as part of the userinfo response by specifying userinfo claims in the Authorzation Request.

Transaction fail

A transaction will only be started if:

1. the RP is registered with the InAcademia service and has a valid client id
2. the Redirect URI, specified in the authentication request, is among the URI’s given when registering with the InAcademia service
3. the authentication request contains the valid client id
4. the scope specified in the authentication request is valid
5. the response type is supported and valid: code 
6. the claim specified is supported
7. the entityID can be resolved

If 1. or 2. is not satisfied, no response will be sent to the RP, instead an error will be displayed to the end user. If 3. to 7. are not satisfied, an error response will be sent to the RP (see Possible errors table below for error codes). The error response will be encoded in the fragment part of the redirect URI:

<redirect_uri>#error=<error_code>&error_description=<error_description>

Where the error_description is optional according to the OIDC specification, an error_description might not be returned.

The transaction will fail if:

• the end-user wants to validate its affiliation with an unknown institution (for the InAcademia service) or an institution not part of eduGAIN
• the end-user was not authenticated at the selected institution
• the institution did not provide enough information to the InAcademia service to validate the affiliation
• the end-user did not give consent to release the necessary information

If the transaction fails an error code, and where practicable, an error description will be returned in the fragment part of the redirect URI (in the same way as described above).

Possible errors

Error Codes

See ‘InAcademia Functional Flow With Errors’ for more detailed information concerning the possible error flows and error descriptions returned. It is strongly recommended that the client is configured to gracefully handle all scenarios.