...
The eduGAIN Connectivity Check's administrator can disable checks for entities by changing the service database. This is useful because some Identity Providers use login methods that cannot easily/reliably be checked. Therefore such IdPs should be excluded from the checks.
JSON interface
The eduGAIN Connectivity Check service provides also a JSON feed on the monitoring results in: https://technical.edugain.org/eccs/services/json_api.php
It is possible to change the page of the results by inserting the number of the page in an URL like this:
| Code Block |
|---|
|
https://technical.edugain.org/eccs/services/json_api.php?action=###ACTION-NAME###&page=###PAGE-NUMBER### |
The table below describes the JSON feed and the action that can be performed by replacing ##ACTION## in the URL:
| Code Block |
|---|
|
https://technical.edugain.org/eccs/services/json_api.php?action=##ACTION## |
| Action name (JSON) | Action description |
|---|
| entities | List all the eduGAIN Connectivity Check service results. |
| checks | List all the checks on the eduGAIN IdPs performed by eduGAIN Connectivity Check service. |
| fedstats | List all the federation statistics collected by the eduGAIN Connectivity Check service. |
The table below, instead, describes the JSON parameters that an action can use:
| Parameter name (JSON) | Parameter description |
|---|
| f_order | - All: no order
- displayName: order by DisplayName
- entityID: order by entityID
- registrationAuthority (only for "entities" action): order by registrationAuthority
- ignoreEntity: order by ignoredEntity
- lastCheck: order by last check
- currentResult: order by last result
|
| f_order_direction | - ASC: ascending order
- DESC: descending order
|
| f_entityID | - All: consider all entityIDs
- A specific IdP's entityID value: consider only a specific one
|
| f_registrationAuthority | - All: consider all registrationAuthorities
- A specific registrationAuthority value: consider only a specific one
|
| f_displayName | - All: consider all DisplayName
- A specific IdP's DisplayName value: consider only a specific one
|
| f_ignore_entity | - True: for the entities that are ignored (by the service owner).
- False: for the entities that are considered (by the service owner).
|
| f_current_result (for only "checks" action) | - All: consider all IdPs
- OK: consider only IdP that have received an "OK" from the check script.
- FORM-Invalid: consider only IdP that have received an "FORM-Invalid" from the check script
- HTTP-Error: consider only IdP that have received an "HTTP-Error" from the check script
- TCP/IP-Error: consider only IdP that have received an "TCP/IP-Error" from the check script
|
| rpp | - All: Show all entities
- 20: Show 20 entities per page. (default value: 30)
|
Example URL:
| Code Block |
|---|
|
https://technical.edugain.org/eccs/services/json_api.php?action=entities&f_registrationAuthority=https%3A%2F%2Fwww.aai.dfn.de&rpp=All |
