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

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
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.
proto (optional)
default: 0
allowed values: 0 - no filter; 1 - SAML 2.0 supported; 2 - SAML 2.0 not supported
filter on the declaration of SAML 2.0 support
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
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
Remark: in json and print_r formats HTML formatted text is produced

Show full action list