Changes between Version 26 and Version 27 of UniformClearinghouseAPIV2


Ignore:
Timestamp:
12/10/13 10:55:01 (10 years ago)
Author:
mbrinn@bbn.com
Comment:

Incorporate Wim's comments through #5

Legend:

Unmodified
Added
Removed
Modified

  • UniformClearinghouseAPIV2

    v26 v27  
    8282 * VERSION: A string with the version number of the Federation API (e.g. “2”, the version for this document). Note: this is the version of the API not the version of the implementation. This field is mandatory for all services.
    8383 * URN : The URN of the service being contacted. This field is mandatory for SA and MA services, optional for Registry service.
    84  * IMPLEMENTATION: A string with the version number of the implementation of this service (format implementation specific). This field is optional for services.
     84 * IMPLEMENTATION: A dictionary of information of the implantation of the service: {"code_version" : code_version, "code_url" : code_url, "code_release_date" : code_release_date, "site_update_date" : site_update_date"}. Of these, code_version is of type STRING, code_url is of type URL,  code_release_date and site_update_date are of format DATETIME. The format of the code_version string is implementation specific. This field is optional for services.
    8585 * SERVICES: The list of names of services the given URL supports. This field is optional (with default being the default service for that authority, i.e. SERVICE for Federation Registry, SLICE for Slice Authority, MEMBER for MemberAuthority). 
    8686 * CREDENTIAL_TYPES: A list of recognized credential types (e.g. [geni_sfa, geni_abac]) and list of supported credential versions on protected API methods.  Format is analogous to that in the AM API: a list of {"type": cred_type, "version" : cred_version} dictionaries of all supported credential types and versions. ''[Required for Authorities only]''
    8787 * ROLES : A list of recognized roles for slice/project membership (optional for those Slice Authorities supporting membership).  ''[Required for SA only]''
     88 * SERVICE_TYPES. A list of service types provided by the Federation Registry ''[Required for Federation Registry only]''
    8889 * FIELDS: A dictionary of object field names (i.e. in additional to the required fields) and associated attributes including:
    8990     * “OBJECT” provides the object type to which the field belongs. The field is optional for fields of the default authority object (i.e. SLICE for Slice Authority, MEMBER for Member Authority, SERVICE for Federation Registry) but mandatory for all other fields.
    … …  
    124125“VERSION”: “2”,
    125126
     127"URN" : urn:publicid:IDN+example.com+authority+sa",
     128
    126129“SERVICES”: [“SLICE”, “PROJECT”, “SLICE_MEMBER”, “PROJECT_MEMBER”],
    127130
    … …  
    150153      “VERSION”: “2”,
    151154
     155       "URN" : urn:publicid:IDN+example.com+authority+ma",
     156
    152157      “CREDENTIAL_TYPES”:  [{"type" : "geni_sfa", version" : 2}, {"type" : "geni_sfa", "version" : "3"}, {"type" : "geni_abac", "version" : "1"}]
    153158
    … …  
    158163      “FIELDS”: {
    159164   
    160               “MEMBER_DISPLAYNAME”: {“TYPE”: “STRING”, “CREATE”: “ALLOWED”, “UPDATE”,
     165       “MEMBER_DISPLAYNAME”: {“TYPE”: “STRING”, “CREATE”: “ALLOWED”, “UPDATE”,
    161166
    162167TRUE, “PROTECT”: “IDENTIFYING”},
    … …  
    179184}
    180185
    181 The following is an example of a return from a get_version from a Registry, provided in JSON-like syntax:
     186The following is an example of a return from a get_version from a Federation Registry, provided in JSON-like syntax:
    182187
    183188{
    184189      “VERSION”: “2”,
     190
     191      "URN" : urn:publicid:IDN+example.com+authority+fr",
     192
     193      "SERVICE_TYPES" : ["SLICE_AUTHORITY", "MEMBER_AUTHORITY", "AGGREGATE_MANAGER"],
    185194
    186195      “FIELDS”: {
    … …  
    458467    {
    459468       …
    460        "TYPES" : ["SLICE_AUTHORITY", "MEMBER_AUTHORITY",
     469       "SERVICE_TYPES" : ["SLICE_AUTHORITY", "MEMBER_AUTHORITY",
    461470                      "AGGREGATE_MANAGER", ...]
    462471       …
    … …  
    474483|| LOGGING_SERVICE || A service to support federation-level event logging ||
    475484
    476 The following table describes the default fields for services (aggregates and authorities) provided by Registry API calls ('Required' indicates whether the field must be present for a valid service, 'match' indicates whether the field can be used in a lookup match criterion):
     485The following table describes the standard fields for services (aggregates and authorities) provided by Registry API calls. (The 'Required' column indicates whether the field must be present for a valid service, 'match' indicates whether the field can be used in a lookup match criterion):
    477486
    478487