Versions Compared

Key

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

...

The purpose of the eduGAIN Connectivity Check is to identify eduGAIN Identity Providers (IdP) that are not properly configured. In particular, it checks if an IdP properly loads and consumes SAML2 metadata which contains the eduGAIN Service Providers (SP). The check results are published on the public eduGAIN Connectivity Check web page (https://technical-test.edugain.org/eccs/). The main purpose is to increase the service overall quality and user experience of the eduGAIN interfederation service by making federation and Identity Provider operators aware of configuration problems.

...

The eduGAIN Connectivity Check Service web page is available at https://technical-test.edugain.org/eccs

User interface parameters

Parameter nameParameter descriptionExample
date
Show all the service results for a specific date
date=2020-02-20
reg_auth
Show all the service results for a specific Registration Authority
reg_auth=https://reg.auth.example.org
idp
Show all the service results for a specific Identity Provider
idp=https://idp.example.org/idp/shibboleth
status
Show all the service results for a specific Status:
  • OK
  • ERROR
  • DISABLED
status=ERROR
check_result
Show all the service results for a specific result of check:
  • Invalid-Form
  • Timeout
  • Connection-Error
  • No-eduGAIN-Metadata
  • SSL-Error
  • IdP-Error
check_result=SSL-Error

Example:

API interface

The eduGAIN Connectivity Check has an API interface that provides access to the monitoring results in JSON format.

The table below describes the actions that can be performed by replacing "##ACTION##" in the URL:

https://technical-test.edugain.org/eccs/api/##ACTION##

...


The table below, instead, describes the JSON parameters that actions can use:

https://technical-test.edugain.org/eccs/api/##ACTION##?##PARAMETER##=<value>

Action Name (JSON)Parameter Name (JSON)Parameter DescriptionExample
  • eccsresults
  • fedstats
date
Returns all the service results for a specific date.
date=2020-02-20
  • eccsresults
  • fedstats
reg_auth
Returns all the service results for a specific Registration Authority.
reg_auth=https://reg.auth.example.org
  • eccsresults
idp
Returns the service results for a specific IdP by its entityID.
idp=https://idp.example.org/idp/shibboleth
  • eccsresults
status

Returns all the service results for a specific Status:

  • OK
  • ERROR
  • DISABLED
status=ERROR
  • eccsresults
check_result

Returns all the service results for a specific result of check:

  • Invalid-Form
  • Timeout
  • Connection-Error
  • No-eduGAIN-Metadata
  • SSL-Error
  • IdP-Error
check_result=SSL-Error
  • eccsresults
format
Formats the service results in a simple way
format=simple


Example URL:

GIT repository

https://gitlab.geant.org/edugain/eccs

...