Documentation of eduGAIN database access API
Method: get_entity_name
Description:
Show the entity display name, this works as a name resolver of sorts. The name is shown in the specified lanuage (if the corresponfing value exists) or in English as a fallback.Supported formats: print_r, json
Arguments used:
- e_id (required)
- allowed values: eitityID string
entityID to search for - 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, also with sp, idp, aa set the output is simplified - best test it out yourself. - lang (optional)
- allowed values:
- opt (optional)
- allowed values: 1 - show request innitiator; 2 - show as an array [status, name, regauth], none or any other - just the name
Returns:
an array of names assigned to entity roles
Examples:
- show default name
- https://technical.edugain.org/api.php?action=get_entity_name&format=print_r&e_id=https://sso.umk.pl/idp/shibboleth
- show the Polish name
- https://technical.edugain.org/api.php?action=get_entity_name&format=print_r&e_id=https://sso.umk.pl/idp/shibboleth&lang=pl
- show default name with type set to idp
- https://technical.edugain.org/api.php?action=get_entity_name&format=print_r&e_id=https://sso.umk.pl/idp/shibboleth&type=idp
- show default name with type set to idp and opt set to 2
- https://technical.edugain.org/api.php?action=get_entity_name&format=print_r&e_id=https://sso.umk.pl/idp/shibboleth&type=idp&opt=2