Page tree
Skip to end of metadata
Go to start of metadata

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

Compare with Current View Page History

Version 1 Next »

Principles

TIER API specifications follow SCIM conventions on syntax and semantics

Some TIER APIs may be defined as profiles of SCIM-defined APIs

TIER Resource Type specifications follow SCIM conventions on schema definition and extension processes, syntax and semantics

Some TIER resource types may be defined as profiles of SCIM resource types

Pros:

  1. Full SCIM compliance: Can be accomplished in conformance with SCIM RFCs using SCIM-defined procedures for defining new Resource Types and their core schema.
  2. Freedom to define our own resource types and schema and/or use existing SCIM resource types and schema
  3. Existing SCIM clients can access SCIM-profiled TIER resources and attributes without modification
  4. SCIM SDKs and libraries may be partially reusable in implementing TIER APIs

Cons and other issues:

  1. To support SCIM User and Group objects, TIER would need to provide bi-directional, automated mapping between the TierUser and TierGroup schema and the corresponding SCIM schema. 
    1. Q: Does that mean we still do prefixing in naming these objects?
    2. A: No, I'd say when converting objects to SCIM, we'd ditch all the TIER ResourceType attributes that don't have a direct counterpart in SCIM. That way SCIM endpoints would see pure SCIM.
    3. Q: Can we fix issues with SCIM e.g. that we want to offer a better way to page through large resultsets?
    4. A: Since we declare TIER a superset of SCIM, we could define points on which TIER APIs diverge from SCIM APIs, but I think we should set a pretty high bar for deciding it's necessary to do that. If there's something wrong with SCIM, we should first really try to get it fixed in the next release of SCIM.  In general, better lines of communication with the SCIM community is a good thing.
    5. Q: Does this mean we can't add things to the Meta object?  We are back to having a Meta and a TierMeta for Tier resource types?
    6. A: If we just make sure all the SCIM meta attributes have a direct counterpart in the meta element we define for each TIER Resource Type, then we just need one meta object. Mapping from a TIER Resource Type to a SCIM Resource Type is then a straight mapping of corresponding attributes, plus filtering out all the TIER-specific meta elements.
    7. Comment: We don't need to do the mapping. We can if we think there is value in doing so.
  2. This solves the problem of TIER wanted to pepper the object model with new attributes, but what about when institutions want to add new attributes, they will have to either define institution specific resource types which is a lot of work or follow the scim extension model which is clunky.
    1. Response: Worth discussing. I'm inclined to say that for TIER-defined Resource Types we should allow local implementations to supplement the TIER schema at will with locally-defined attributes but insist that they prefix those attributes in a way that minimizes the chance of clashing definitions. That can be accomplished by requiring the 2nd-level component of the local domain name (the part just to the left of .edu) as a prefix. This isn't guaranteed to work for non-edu sites, so there are corner cases to keep an eye on. Then mapping from a local resource representation down to 'Pure TIER' or 'Pure SCIM' can be accomplished with a well-defined and simple filtering rule.
    2. Local implementations can do what they want, but adding attributes would break SCIM compliance.  The new attributes would not be in the resource schema specification.  One of the advantages of adopting a standard, in addition to having little documentation to do ourselves, is that we can take advantage of already written applications and libraries that work with the standard.  A quick search found several libraries for SCIM and Python.  One of which defines a "EnterpriseUser" resource.  So we are not the first to propose this. Whether or not undocumented attributes would break anything is unknown.
    3. Since it is we who control the schema, allowing institutions to propose formal additions should not be out of the question.
    4. Comment: What exactly is "clunky" about the extension mechanism in this use case? For TIER API as a whole it is problematic because we need to "redefine" a bunch of attributes, but for campus extensions this shouldn't happen. (Or else the campus should do the same thing and create a CampusPerson or whatever.) So is it just that the attribute label is lengthy? Perhaps we need a convention for extending complex attributes?
  3. Some call this a con, some say pro, but you would have /TierUser and /User, /TierGroup, and /Group
    1. There is duplication here, might be more to implement, might have drift between the object models
    2. My contention is that we do not have /TierUser and /User, /TierGroup, and /Group.  In fact, in our API we have only EduPeople and EduGroups, and EduMembers (to use the new names).  Our API does not have Users or Groups.  It may be a service would add support for those SCIM core resources, but it wouldn't have to.  The two are separate APIs.  We might try to keep our resources as supersets of the scim core ones, to help sites that want to support both, but we wouldn't have to.
      1. Response: +1, The 'Edu' prefix has the advantage of giving TIER complete control over its resource schema. The 'superset of SCIM' idea minimizes the effort needed to map Tier resource representations to SCIM and vice versa.
  • No labels