Changes between Version 17 and Version 18 of UniformClearinghouseAPI

Timestamp:

08/15/13 11:53:26 (11 years ago)

Author:

jmccolga@bbn.com

Comment:

--

UniformClearinghouseAPI

@@ -832 +832 @@
  * Identifying: Information that could identify the given member (e.g. name, email, affiliation)
 
-
-
-
+The following table contains required fields for member objects and whether they are allowed in lookup ‘match’ criteria and their protection (public, private, identifying):
+
+
+|| ''' Name ''' || ''' Type ''' || ''' Description ''' || ''' Match ''' || ''' Protection ''' || 
+|| MEMBER_URN || URN || URN of given member || Yes || Public || 
+|| MEMBER_UID ||UID || UID (unique within authority) of member || Yes || Public ||
+|| MEMBER_FIRSTNAME || DATETIME || First name of member || Yes || Identifying || 
+|| MEMBER_LASTNAME || DATETIME || Last name of member || Yes || Identifying ||
+|| MEMBER_USERNAME || BOOLEAN || Username of user || Yes || Public ||
+|| MEMBER_EMAIL || STRING || Email of user || No || Identifying ||
+
+/*
+
+Return information about version and options (filter, query, credential types) accepted by this member authority
+
+NB: This is an unprotected call, no client cert required.
+
+'''Arguments:'''
+
+None
+
+'''Return:'''
+
+get_version structure information as described above
+
+*/
+
+function '''get_version'''()
+
+/*
+Lookup public information about members matching given criteria
+
+NB: This is an unprotected call, no client cert required.
+
+'''Arguments:'''
+
+options: set of ‘filter’ and ‘match’ criteria specifying which members and which fields for each member to return
+
+'''Return:'''
+
+List of dictionaries of name/value pairs of fields specified in ‘filter’ options for members matching ‘match’ criteria
+
+*/
+
+function '''lookup_public_member_info''' (options)
+
+/*
+
+Lookup private (SSL/SSH key) information about members matching given criteria
+
+'''Arguments:'''
+
+options: set of ‘filter’ and ‘match’ criteria specifying which members and which fields for each member to return
+
+'''Return:'''
+
+List of dictionaries of name/value pairs of fields specified in ‘filter’ options for members matching ‘match’ criteria
+
+*/
+
+function '''lookup_private_member_info''' (credentials, options)
+
+/*
+
+Lookup identifying (e.g. name, email) info about matching members
+
+'''Arguments:'''
+
+options: set of ‘filter’ and ‘match’ criteria specifying which members and which fields for each member to return
+
+'''Return:'''
+
+List of dictionaries of name/value pairs of fields specified in ‘filter’ options for members matching ‘match’ criteria
+
+*/
+
+function '''lookup_identifying_member_info''' (credentials, options)
+
+/*
+
+Update information about given member public, private or identifying information
+
+'''Arguments:'''
+
+member_urn: URN of member for whom to set information
+
+options: Containing ‘update’ key with dictionary of name/value pairs to update info for given member
+
+'''Return:'''
+
+None
+
+*/
+
+function '''update_member_info''' (member_urn, credentials, options)
+
+/*
+
+Provide list of credentials (signed statements) for given member
+This is member-specific information suitable for passing as credentials in an AM API call for aggregate authorization.
+
+'''Arguments:'''
+
+member_urn: URN of member for which to retrieve credentials
+
+options: Potentially contains ‘speaking-for’ key indicating a speaks-for invocation (with certificate of the accountable member in the credentials argument)
+
+'''Return:'''
+
+List of credential in “CREDENTIAL_LIST” format, i.e. a list of credentials with type information suitable for passing to aggregates speaking AM API V3.
+
+*/
+
+function '''get_credentials'''(member_urn, credentials, options)
+
+== Appendix: CH Object Models ==
+
+As described, each CH service method takes a set of options that provide further details on the request. Many of these options reflect the fields of the underlying object models. For example, the Slice Authority manages slice objects and allows for options for querying for and by slice object fields.
+
+Different Clearinghouses will implement different subsets of the possible set of CH services. Those that do implement a given service should implement the API’s described above. The fields of the objects maintained through these API’s are flexible: some fields are required but different Clearinghouses may have their own additional data, to be returned by the get_version method.
+
+The following diagram reflects the different objects maintained within the full range of CH services, their interactions and mandatory fields.