You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 126 Next »

TIER-Data Structures and APIs Working Group Home

Future Calls: Chose the one (Wed. or Fri.) that works best for your schedule and time zone):

Agenda and Collaborative scribing notes are here : http://j.mp/1PWMCp5

Attendees are encouraged to participate in live-scribing the meetings on the above Google doc.

Email List: tier-api@internet2.edu 

  – To subscribe, browse to  https://lists.internet2.edu/sympa/subscribe/tier-api  

Working Group Chair: Keith Hazelton, University of Wisconsin

Charter for Data Structures and APIs Working Group 

Overview of the APIs and Data Structures and the Entity Registry Working Groups

TIER VIsion

  • Help education and research organizations solve the Identity and Access Management (IAM) challenges they encounter 

    • By providing open source implementations of key IAM capabilities and assuring their long-term sustainability

    • By standardizing 

      • How applications (whether local, federated or SaaS)  integrate with IAM infrastructure 

      • How existing institutional IAM infrastructure can interoperate with TIER components to provide a full IAM service suite

    • The TIER Entity Registry Working Group and the TIER Data Structures and APIs Working Group share the following key goals

      • To define integration and interoperability strategies and models

      • To help charter development projects that address specific gaps in existing open source IAM packages

TIER Entity Registry WG and Data Structures and APIs WG Tasks

  • Develop a comprehensive functional model of IAM
  • Develop specifications for the resource schema and interfaces needed to deliver identity and access management (IAM) services
    • Between the various TIER IAM components
    • Between TIER components and the rest of the institutional IT landscape, both on premise and in the cloud
  • Provide guidance on building IAM infrastructure and processes that accord with the TIER model

Standards, Tools and Guidelines set out in TIER Release1

  • Expose IAM capabilities at RESTful endpoints
    • ...Where it makes sense:  LDAP, SAML, etc. still have their well-earned place, TIER will take full advantage of such common protocols and interfaces. OAuth 2, OpenID Connect and UMA are also coming into play.
    • REST ness in the TIER context means:  HTTP verbs operate on Resources (groups, users,....); RPCish idioms should only be used when nothing else will do what needs to be done.
    • The model for interoperating with existing institutional IAM services is to provide the TIER components with connectors that know how to interact with both back end legacy systems as well as the growing number of contracted-out SaaS and PaaS services 
  • Adopt the many useful conventions specified in the new IETF standard, SCIM 2.0 ,
    • around the design choices that would otherwise tend to provoke endless Working Group debates on matters such as pagination, metadata schema, data formats, etc.
    • the choice to leverage SCIM, as much as anything else, made the decision to support JSON easier.  Support for XML can be provided if and where it's needed.

API Specifications: 

  • The canonical specification language for HTTP-oriented APIs in TIER is Swagger 2.0
  • Why Swagger and not RAML? After all, RAML is pretty cool
  • In the move from version 1 to version 2, Swagger incorporated a lot of the RAML coolness (around reusable definitions, etc)
  • Swagger 2 has been adopted as the basis for further development by the industry-launched Open API Initiative (http://openapis.org)


Key Deliverables for TIER R1

Narrative Form

By April 2016

  • Publish and promote the adoption of a first-round set of conventions for API and data structure design. The goal is to inform and hopefully influence API development for Release 1.0 Grouper and COmanage components.
  • Pair the basic group and membership management APIs with an event-driven messaging approach to the same functionality. Clarify the circumstances that favor one approach over the other.
  • Assess possible models for APIs and data structures around consent.
  • Document the first round requirements for administering and monitoring IAM infrastructure and specify the kinds of instrumentation needed in each component to support administration and monitoring. 

Other resources



See Also:

  • No labels