Changes between Version 1 and Version 2 of UniformClearinghouseAPIV2
- Timestamp:
- 11/12/13 09:30:09 (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
UniformClearinghouseAPIV2
v1 v2 3 3 Marshall Brinn, GPO 4 4 5 API Version 2 *** UNDER CONSTRUCTION *** 5 API Version 2 6 *** UNDER CONSTRUCTION *** 7 6 8 Revised: November 12, 2013 7 9 … … 79 81 * VERSION: A string with the version number of the Federation API (e.g. “10.0.7”). Note: this is the version of the API not the version of the implementation. This field is mandatory for all services. 80 82 * SERVICES: The set of services the given URL supports 81 * CREDENTIAL_TYPES: A list of recognized credential types (e.g. [ ABAC, SFA]) and list of supported credential versions on protected API methods.''[Authorities only]''83 * CREDENTIAL_TYPES: A list of recognized credential types (e.g. [geni_abac, 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. ''[Authorities only]'' 82 84 * ROLES : A list of recognized roles for slice/project membership (optional for those Slice Authorities supporting membership). ''[SA only]'' 83 85 * FIELDS: A dictionary of '''''supplementary''''' object field names (i.e. in additional to the required fields) and associated attributes including: 84 * “OBJECT” provides the object to which the field belongs (if not the default authority object, i.e. SLICE for Slice Authority, MEMBER for Member Authority, S ervicefor Registry). This field is mandatory for any field listed.86 * “OBJECT” provides the object to which the field belongs (if not the default authority object, i.e. SLICE for Slice Authority, MEMBER for Member Authority, SERVICE for Registry). This field is mandatory for any field listed. 85 87 * “TYPE” may be one of “URN”, “UID”, “STRING”, “DATETIME”, “EMAIL”, “KEY”,“BOOLEAN”, “CREDENTIAL”, “CERTIFICATE”. [NB. This set of types subject to change. See Appendix for more information on these data types.] This field is mandatory for any field listed. 86 88 * “CREATE” attributes may be specified as “REQUIRED”, “ALLOWED” or “NOT ALLOWED” (default = “NOT ALLOWED”). These indicate whether the given supplementary field is required, allowed or prohibited in create calls. This attribute is optional for listed fields. … … 109 111 "OBJECTS": [ "PROJECT" ], 110 112 111 “CREDENTIAL_TYPES”: {“SFA”: [ "1" ]}, “ABAC” : ["1", "2"]},113 “CREDENTIAL_TYPES”: [{"type" : "geni_sfa", version" : 2}, {"type" : "geni_sfa", "version" : "3"}, {"type" : "geni_abac", "version" : "1"}] 112 114 113 115 “ROLES” : [“LEAD”, “ADMIN”, “MEMBER”, “AUDITOR”, “OPERATOR” ], … … 131 133 “VERSION”: “10.0.7”, 132 134 133 “CREDENTIAL_TYPES”: [“SFA”, “ABAC”],135 “CREDENTIAL_TYPES”: [{"type" : "geni_sfa", version" : 2}, {"type" : "geni_sfa", "version" : "3"}, {"type" : "geni_abac", "version" : "1"}] 134 136 135 137 "SERVICES": ["MEMBER", "KEY"],