Documentation of eduGAIN database access API
Method: list_entities
Description:
Provides an entities listing according to search parameters provided.Supported formats: json, print_r, csv, internal
Arguments used:
- type (optional)
- default: 7
allowed values: 7 or "all" - all entities; 4 or "idp" - IdPs only; 2 or "sp" - SPs only; 1 or "aa" - standalone AAs only.
limits the results to a givien entity type - fed_id (optional)
- allowed values: a federation code (see list_fed_codes for a list of available codes).
Limits the results to a single federation. - entity_cat (optional)
- default: -2
allowed values: -2 - no filter; -1 - any category; any valid entitycategory identiefier (URL encoded)
limits the results to a given entity category identifier - ec (optional)
- allowed values: 0 - filter not set; 1 - filter set
only display entities which announce the given entity category - ecs (optional)
- allowed values: 0 - filter not set; 1 - filter set
only display entities which announce support for the given entity category - e_id (optional)
- allowed values: any string
input for the entity search - search_type (optional)
- allowed values: entityid - EntityID substring match; text - Whole entity multiword search; rev-text - Reverse whole entity multiword search (this will throw away rows which match the provided words
determine the type of search to be performed; while this argument is optional, in case when e_id is set search_type has to be set as well. - eccs_status (optional)
- default: 0
allowed values: 0 - no filter; 1 - status OK; 2 - status Warning; 3 - status Error
filter on eduGAIN Connectivity Check Service - clashes (optional)
- default: 0
allowed values: 0 - no info shown; 1 - show clashes info; 2 - show only entities appearing in more then one federation
display/filter on entity clashes (entities appearing in more then one federation) - warnings (optional)
- default: 0
allowed values: 0 - no filter; 2 - show only entities with validator warnings, 3 - show only entities with warnings except for those which only report missing logos
filter on validator warnings - coco (optional)
- default: 0
allowed values: 0 - no filter; 2 - any status; 3 - warnings and errors; 4 - only errors
filter on Code of Conduct monitoring status - sirtfi (optional)
- default: 0
allowed values: 0 - no filter; 1 - SIFTI asserted via the dedicated attibute value; 2 - formal SIRTFI errors
filter on REFEDS SITFI status - format (optional)
- default: json
allowed values: any supported format
Examples:
- All entities
- https://technical.edugain.org/api.php?action=list_entities&format=print_r
- All entities in CSV
- https://technical.edugain.org/api.php?action=list_entities&format=csv
- clashes - eneties in several federations
- https://technical.edugain.org/api.php?action=list_entities&format=print_r&clashes=2
- entities with ECCS errors
- https://technical.edugain.org/api.php?action=list_entities&format=print_r&eccs_status=3