Difference between revisions of "Federation API"

From MgmtWiki
Jump to: navigation, search
m (References)
Line 44: Line 44:
*[https://www.incommon.org/federation/ InCommon Federation] has been running for several years now with [[SAML 2.0]].
*[https://www.incommon.org/federation/ InCommon Federation] has been running for several years now with [[SAML 2.0]].
[[Category: Glossary]]
[[Category: Standard]]
[[Category: Identifier]]

Revision as of 11:50, 3 July 2022

Full Title or Meme

A Federation API is designed to allow communicating parties to determine if the other party is a member of a particular federation and which options of the federation are supported.


Each federation publishes a Framework Profile which describes the conditions for membership in the federation. THe term profile is used in the context because the base assumption is that trust federations are single rooted into a common trust framework in which all are bound by a set of baseline functional requirements (the BFR).

The existing SAML 2.0 Federation API is purely technical. It is designed to allow one Entity to get configuration data from another Entity where a single Framework Profile is assumed to apply to all entities. As Web Sites discover a need to belong to adhere to more than one Framework Profile because of a diverse set of Users, and the Users are sufficiently savvy to pick and choose from Framework Profiles based on their own needs, a more complex set of conditions need to be accommodated. In particular it is expected that Users will be able to query one or more Federation APIs to get a list of Web Sites that meet their queiry.


The Federation API need to solve the following set of User expectations.

  1. The user is not familiar with the specific syntax of any federation by wishes to learn more about the members by creating a query in their own language.
  2. Framework Profiles will each create a different list of required and optional elements.
  3. Each Federation Office will have their own update cycle with respect not only to their own elements but also the implemented version of the API.
  4. Users will likely be getting and saving API information from a variety of federations in a single search for relevant Web Sites.


In order to satisfy Users in a heterogeneous environment each response needs be interpretable on its own irrespective of the federation or API version used. In the sample from the link below it can be seen that the version a federation office are the first mandatory items and that multiple results are possibly displayed (including no results at all). We expect that conversion to jwt is optional and might only occur when one specific endpoint is requested.


 "version": "OID FED 0.04",
 "iss": "TrustRegistry.us",
 "iat": "201811031839",
 "frameworkOffice": "tid:idef",
 "members": [
  "sub": "www.authen2cate.com",
  "serviceName": "Authen2cate",
  "serviceDesc": "Authen2cate is a full-service secured cloud based identity management solution that provides single sign-on (SSO), multi- factor authentication and identity management services for cloud, web, VPN and mobile resources.",
  "providerName": "Authen2cate, LLC.",
  "dateListed": "October 31 2017 2:47pm",
  "services": [5 items],
  "roles": [rp iap ua],
  "counts": {3 items},
  "scores": {9 items}