EPPN Service Information | |
---|---|
Service Name | EPPN Lookup Service |
Service Version | 2.0 |
Service Description | Lookup EPPN to CCCID mappings used by the CCC Identity Provider Proxy. SwaggerUI Docs: https://profile-eppn.ci.cccmypath.org/eppn/swagger-ui.html#/eppn-controller-v-2 |
Service Usage | This service is intended for colleges that would like to be able to retrieve the CCCIDs being associated with EPPNs that are routed through the CCC IDP Proxy. Every student that accesses a service through the IDP Proxy must have a CCCID. If the college IDP cannot provide the CCCID, then the IDP Proxy will attempt to map the colleges EPPN to the CCCID. This service provides a way for colleges to read those mappings so that they may potentially be imported back into the colleges SIS. A Java client library is available. The client allows property file configuration of endpoints and authentication. The Java client library will handle lookup up the OpenId token, setting the Authorization header, hitting the REST endpoint and converting data into Java objects. |
Release Notes | |
Valid Period | 4/15/2017 - |
Service Location | CI: https://profile-eppn.ci.cccmypath.org/eppn/* TEST: https://profile-eppn.test.cccmypath.org/eppn/* PILOT: https://profile-eppn.pilot.cccmypath.org/eppn/* PROD: https://profile-eppn.cccmypath.org/eppn/* |
Methods |
Service Operation: Get EPPN | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | /eppn/2.0/eppn-mappings/{EPPN} | ||||||||||||||||
Description | Lookup the mapping for a single EPPN | ||||||||||||||||
HTTP Method | GET | ||||||||||||||||
Preconditions | Caller must have have a valid OpenID token Caller clientId must match the domain of the requested EPPN. (ie. If the eppn is jdoe@santarosa.edu, the clientId for the caller must be "santarosa.edu") | ||||||||||||||||
Post-conditions | |||||||||||||||||
Message Exchange Pattern | Request is received EPPN mapping is looked up Mapping is returned | ||||||||||||||||
Input | |||||||||||||||||
| |||||||||||||||||
Output | |||||||||||||||||
Description | EPPN Mapping JSON | ||||||||||||||||
Data Type | { "authSource": "string", "cccId": "string", "createTime": "2017-03-24T22:47:08.089Z", "downloaded": boolean, "eppn": "string" } | ||||||||||||||||
Faults | |||||||||||||||||
|
Service Operation: Get Mappings Created Since | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | /eppn/2.0/eppn-mappings/since/{DATE} | ||||||||||||||||||||||||||||||
Description | Lookup all mappings that have an authsource matching the clientId of the caller that have been entered since DATE. | ||||||||||||||||||||||||||||||
HTTP Method | GET | ||||||||||||||||||||||||||||||
Preconditions | Caller must have have a valid OpenID token DATE Must be in YYYY-MM-DD format | ||||||||||||||||||||||||||||||
Post-conditions | |||||||||||||||||||||||||||||||
Message Exchange Pattern | Request is received EPPN mappings are looked up List of mappings is returned | ||||||||||||||||||||||||||||||
Input | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
Output | |||||||||||||||||||||||||||||||
Description | A page of EPPN mappings | ||||||||||||||||||||||||||||||
Data Type | { "data": [ { "authSource": "string", "cccId": "string", "createTime": "2017-03-24T22:58:08.904Z", "downloaded": boolean, "eppn": "string" } ], "pageNumber": integer, "pageSize": integer, "totalElements": integer } | ||||||||||||||||||||||||||||||
Faults | |||||||||||||||||||||||||||||||
|
Service Operation: Get New Mappings | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | /eppn/2.0/eppn-mappings/new-mappings | |||||||||||||||||||||
Description | Lookup all mappings that have an authsource matching the clientId of the caller that have not previously been marked as downloaded (See: Service Operation: Mark downloaded) | |||||||||||||||||||||
HTTP Method | GET | |||||||||||||||||||||
Preconditions | Caller must have have a valid OpenID token | |||||||||||||||||||||
Post-conditions | ||||||||||||||||||||||
Message Exchange Pattern | Request is received EPPN mappings are looked up List of mappings is returned | |||||||||||||||||||||
Input | ||||||||||||||||||||||
| ||||||||||||||||||||||
Output | ||||||||||||||||||||||
Description | A page of EPPN mappings | |||||||||||||||||||||
Data Type | { "data": [ { "authSource": "string", "cccId": "string", "createTime": "2017-03-24T22:58:08.904Z", "downloaded": boolean, "eppn": "string" } ], "pageNumber": integer, "pageSize": integer, "totalElements": integer } | |||||||||||||||||||||
Faults | ||||||||||||||||||||||
|
Service Operation: Mark Downloaded | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | /eppn/2.0/eppn-mappings/batch/downloaded | ||||||||||||||||
Description | Mark a set of EPPN mappings as downloaded. This operation affects the data returned from the /eppn/eppn-mappings/new-mappings request. | ||||||||||||||||
HTTP Method | POST | ||||||||||||||||
Preconditions | Caller must have have a valid OpenID token | ||||||||||||||||
Post-conditions | |||||||||||||||||
Message Exchange Pattern | Request is received EPPN mappings are looked up List of mappings is returned | ||||||||||||||||
Input | |||||||||||||||||
| |||||||||||||||||
Output | |||||||||||||||||
Description | An array of status objects. The array will consist of a single record for each EPPN listed in the request. The "status" field be set to either "Updated" or "Error" | ||||||||||||||||
Data Type | [ { "entityId": "string" // eppn value "status": "string" // will be either "Updated" or "Error" } ] | ||||||||||||||||
Faults | |||||||||||||||||
|