Versions Compared

Key

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

...

  • the Self registration based on entitlement: add admins to CAT institutions NRO option needs to be set;
  • the user has to login with an eduGAIN registered IdP;
  • user's SAML data must contain the paritiespairwise-id attribute and do not contain the eduPersonTargettedAttribute (this second condition may become unnecessary in the future);
  • user's SAML data must contain the eduPersonEntitlement attribute with the appropriate value (see the note below for the explanation of "appropriate").

...

If your CSR does not follow the rules in some way then the problem may either be caught by CAT even before submission to eduPKI or an error returned by eduPKI will be displayed. To avoid this it is best to use the provided example command without making any changes.




UI-less Automated Management: the Admin API (2.

...

2)

As a NRO administrator, depending on the number of IdPs in your NRO, you may find it cumbersome to add IdPs interactively. Or maybe you already have a customer self-service management system where authorised IdP admins could self-enroll without you being in the middle.

...

API keys are distributed from the eduroam Operations Team to NRO administrators on email request. Please contact eduroam Operations for your Admin API key; API keys from version 1.x continue to be valid for version 2.02.

API Usage

The API is JSON based: you send an HTTP POST with a BODY that contains a JSON construct. The JSON always contains the desired ACTION and the APIKEY. Depending on the ACTION, there may be additional required or optional PARAMETERs.

...

The authoritative reference for the list of ACTIONs is on GitHub, https://github.com/GEANT/CAT/blob/release_2_0v2.2.1/web/lib/admin/API.php : the class constants API::ACTION_* are the available strings to put into the JSON ACTION field.

...

The authoritative reference for the list of PARAMETERs is on GitHub, https://github.com/GEANT/CAT/blob/release_2_0v2.2.1/web/lib/admin/API.php : the class constant API::ACTIONS contains two sets of parameters each, "REQ" = required parameters, "OPT" = optional parameters,

...

If the parameter is the integer representation of an EAP type, you can look up the number to use in the source (const INTEGER_...).

List of result codes

...

The authoritative reference for the list of error codes is on GitHub, https://github.com/GEANT/CAT/blob/release_2_0v2.2.1/web/lib/admin/API.php : the class constants API::ERROR_*

...