CIFER ID Match API Draft 00
ciferproject-org-idmatch-api-v1-draft-00

Abstract

TBD

Status of This Memo

This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.

Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at http://datatracker.ietf.org/drafts/current/.

Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."

This Internet-Draft will expire on August 9, 2014.

Copyright Notice

Copyright (c) 2014 IETF Trust and the persons identified as the document authors. All rights reserved.

This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.

Table of Contents

• 1. Introduction
• 1.1. Definitions
• 2. Requirements Language
• 3. Authentication and Authorization
• 4. API
• 4.1. People
• 4.1.1. Matching SOR person and Identity Registry person
• 4.1.1.1. Response: Unique match found in Identity Registry:
• 4.1.1.2. Response: New identifier assigned
• 4.1.1.3. Other Responses TBD
• 4.1.2. Searching Identity Registry for a Match to SOR person
• 4.1.2.1. Response: No match found
• 5. Data Input/Output formats
• 6. API Versioning
• 7. HTTP Method Overloading
• 8. IANA Considerations
• 9. Security Considerations
• 10. Acknowledgements
• 11. References
• 11.1. Normative References
• 11.2. Informative References
• Authors' Addresses

1. Introduction

The [CIFER] initiative includes work to define a set of shared APIs for core functions in identity and access management. One key requirement of such systems is to match person records found in Systems of Record (SOR) with person records that may or may not already be in the core identity registry. This document defines the ID Match API that supports this essential suite of functions.

1.1. Definitions

Base URL:

The ID Match REST API invocations defined below are always relative to a Base URL. The Base URL MUST NOT contain a query string as clients may append additional path information and query parameters as part of the request. Example Base URL: https://api.example.com/idmatch/v1/

System of Record (SOR):

TBD

Identity Registry (IdReg):

TBD

2. Requirements Language

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 [RFC2119].

3. Authentication and Authorization

TBD

4. API

4.1. People

4.1.1. Matching SOR person and Identity Registry person

PUT /people/{SOR_ID}/{SOR_PERSON_ID}

{
  "referenceId": "xxxxxxx"
}

{
  "referenceId": "xxxxxxx"
}