Results and Deliverables 

Current Tasks

I. Draft API specifications for the most commonly used group management functions using Swagger 2.0

• Our initial assumption was that the three most basic group management calls were: 

  • Is this person a member of this group?

  • List the members of a group

  • List all the groups for which a given person is a member

• Assumption check: U of Washington Group Service Statistics, Jan, 2016

II. Draft the data schema for the group entity itself

III. Define APIs needed to support a RESTful subject source for use by Grouper

Prior Work on Group Management APIs

• Grouper:  See the REST-style versions linked from the linked page. For example, to find out if a person is a member of a given group, 

  • See hasMemberLite at https://spaces.at.internet2.edu/display/Grouper/Has+Member  

  • Example  

  • RESTful Subject Source for Grouper to Complement the LDAP and SQL Protocols Already Supported

• VOOT2 protocol from SURFnet

• • Maarten Kremers confirmed that VOOT2 is only about GETs.

  • VOOT2 protocol expressed as valid swagger2.  See VOOT2 swagger yaml used for input into editor.swagger.io (to obtain resulting swagger API documentation

• University of Washington Group Service, Jim Fox

• SCIM: See both the Protocol Specification RFC7644  and Core Schema Specification RFC7643. Marlena Erdos comment: Quite rich group operations for read (and search) and write, quite fully documented -- and quite low level. Applies to a client contacting a server (natch, but this in contrast to Grouper)

• CIFER: See the page Authorization Standard API.

• FYI, Group Mgt used in some research communities:
  • VOMS - Virtual Organization Management Service.  Used by the international Grid and Open Science Grid communities.  Uses X.509 attribute certificates.
    
    

Resources 

• https://openapis.org/ 

• http://swagger.io/
• http://raml.org/