Reference Materials
Somewhat Logical Chunking of Requirements
Core Scheme Data Model
Requirement ID |
Requirement Description |
---|---|
REG_0100 |
The registry shall support the storage of identity information. |
REG_0110 |
The registry shall support the storage of the partial (MM/DD) and/or full (MM/DD/YYYY) date of birth for a person. |
REG_0120 |
The registry shall have a unique identifier (non-SSN) for each person in its data store. |
REG_0130 |
The registry shall support the storage of a person's gender. |
REG_0140 |
The registry shall have the ability to storage multiple net ids for a person. |
REG_0150 |
The registry shall have an indicator as to which is the primary net id for a person. |
REG_0160 |
The registry shall store a person's first, middle (optional), last name and suffix (optional). |
REG_0170 |
The registry shall maintain a history of a person's name changes. |
REG_0180 |
The registry shall store a type associated with each person's name (for example, legal name). - Does this imply that multiple name types can be stored? (Legal / Preferred etc.) |
REG_0185 |
The registry shall have the capability to store multiple name types for a person. Examples include: legal name, preferred name |
REG_0190 |
The registry shall support the storage of multiple addresses for a person, indicated by a type (for example, employee home address). |
REG_0200 |
The registry shall store for an address, the following information: street address (multiple), city, state, postal code, country, campus location and source. |
REG_0210 |
The registry shall store for a person's name an flag to indicator whether a first name is unknown (FNU) and/or a last name is unknown (LNU). |
REG_0220 |
The registry shall support the storage of multiple telephone numbers, indicated by a type (for example employee office telephone number). |
REG_0230 |
The registry shall store for a telephone number the following information: area/country code, phone number, extension (optional) and source. |
REG_0240 |
The registry shall support the storage of a person's email address(s) and their respective type. |
REG_0250 |
The registry shall maintain a history of all of a person's address changes. |
REG_0260 |
The registry shall maintain a history of all of a person's telephone number changes. |
REG_0270 |
The registry shall maintain a history of all of a person's email address changes. |
REG_0280 |
The registry shall support the storage of information about all of the credentials a person holds (for example: kerberos principal, secure id token serial number, PKI, ...). |
REG_0320 |
The registry shall support the storage of identity card information. |
REG_0350 |
The registry shall provide a comments facility to be used for authorized personnel (Security) to record information about person's identity. |
REG_0380 |
The registry shall maintain a single namespace for person identifiers and network ids. |
REG_0390 |
The registry shall support the storage of common HR and student information, like title, status and department. |
REG_0400 |
The registry shall support the storage of international forms of user information. |
REG_0410 |
The registry shall support the storage of organization-specific attributes. |
REG_0490 |
The Registry shall support a core set of information that is maintained about each person (eg name(s), DOB, citizenship, etc). |
REG_0520 |
The Registry shall come with scheme sets that could be used with different models of Person Registry (eg thin, medium, fat). |
Search and Match
Requirement ID |
Requirement Description |
---|---|
REG_0008 |
The Identity Merge facility shall use a fuzzy logic searching capability for matching purposes. |
Merge Tools
Requirement ID |
Requirement Description |
---|---|
REG_0001 |
The Identity Merge facility shall provide the ability to link unique identity records within the registry identifying one as the primary. |
REG_0002 |
The Identity Merge facility shall maintain for historical purposes the non-primary registry entries. These entries shall not be available for further use (other than historical reporting) in subscribing systems. |
REG_0003 |
The Identity Merge facility shall provide the ability to merge identity data to a "primary" registry entry through either an automated process or a user controlled process (eg. system identifies records to merge, shows user relevant data, user decides interactively what to accept etc.) |
REG_0004 |
The Identity Merge facility shall provide notifications to subscribing systems of the merged identities |
REG_0005 |
The Identity Merge facility shall provide for the creation of business rules for the automated merging of registry data elements. (eg. defining the authoritative source by attribute when duplicates are identified) |
REG_0006 |
The Identity Merge facility shall be integrated with the Access Management Module to allow for assessing and potentially merging role and access data when duplicate identities are identified and merged. |
Provisioning
Requirement ID |
Requirement Description |
---|---|
REG_0007 |
The Identity Merge facility shall be integrated with the Provisioning Module to allow for the potential deactivation of duplicate accounts. |
Affiliations
Requirement ID |
Requirement Description |
---|---|
REG_0290 |
The registry shall support the storage of all a person's affiliations. (Should we add something here distinguishing between affiliations vs. roles per the email discussion) |
REG_0330 |
The registry shall either store an indicator or have a calculation to determine a person's primary affiliation. |
REG_0340 |
The registry shall support the mapping of its affiliations to the eduPerson attributes. |
REG_0420 |
The Registry shall support the ability to associate a START DATE with each Affiliation type. |
REG_0430 |
The Registry shall support the ability to define different life cycle processes for removing an Affiliation type (eg staff accounts are disabled immediately; faculty retain their accounts for six months but with reduced services). |
REG_0440 |
The registry shall support the ability to associate an END DATE with each Affiliation Type. |
REG_0450 |
The Registry shall support a LIFE CYCLE model. Each user is in a specific state; incoming events MAY trigger a transition to a new state; entering a new state MAY trigger sending events. Each of these transitions MAY be associated with a different Business Process. |
REG_0460 |
The Registry shall support having unique LIFE CYCLE models for each Affiliation type (eg staff accounts are closed immediately on separation; faculty permissions are trimmed on separation but accounts are closed six months after separation). |
REG_0470 |
The Registry shall support allowing a site to manage the Rules that define the transitions within a LIFE CYCLE. |
REG_0480 |
The Registry shall support optionally sending events whenever a user's attributes or Affiliation types changes. |
REG_0500 |
The Registry shall optionally support, for each Affiliation type, a scheme that defines the set of information and attributes that will be maintained for this Affiliation type for each user (eg staff have titles and office locations, students do not) |
REG_0510 |
It shall be easy for sites to modify and extend the schema associated with an Affiliation type (both the data definition step, and adding code to do specialized processing). |
Profiles
Requirement ID |
Requirement Description |
---|---|
|
|
Levels of Assurance
Requirement ID |
Requirement Description |
---|---|
REG_0300 |
The registry shall support the storage of a person's Identity Assurance Profiles. |
REG_0310 |
The registry shall store information related to an identity proofing event. |
MAN_0170 |
The registry shall provide services to add, update, and archive Identity Assurance information for a person. |
APIs & Services
Requirement ID |
Requirement Description |
---|---|
MAN_0110 |
The registry shall provide services to add, update, and archive persons. |
MAN_0120 |
The registry shall provide services to add, update, and archive address information for a person. |
MAN_0130 |
The registry shall provide services to add, update, and archive name information for a person. |
MAN_0140 |
The registry shall provide services to add, update, and archive telephone number information for a person. |
MAN_0150 |
The registry shall provide services to add, update, and archive net id information for a person. |
MAN_0160 |
The registry shall provide services to add, update, and archive credential information for a person. |
MAN_0180 |
The registry shall provide services to add, update, and archive affiliation information for a person. |
MAN_0220 |
The Registry shall provide a means of purging categories of entries (eg Applicants) or via expiration |
MAN_0190 |
The registry shall provide services that are either SOAP and/or REST-based. |
Batch/Sync Services
Requirement ID |
Requirement Description |
---|---|
ES_0140 |
The registry shall have rules for cleansing and standardizing data before its entered into the data repository. |
MAN_0210 |
The registry shall provide a flexible batch-file interface for importing and extraction of data, including support for fixed column, CSV, XML, .xls, and other formats. |
User Interfaces & Reporting
Requirement ID |
Requirement Description |
---|---|
REG_0360 |
The registry shall have complete auditing of information in its registry |
REG_0370 |
The registry shall provide a facility by which authorized personnel can obtain a read-only view of portions of its data. |
REG_0530 |
The Registry shall provide the ability to have people review and approve changes and transitions via a Workflow mechanism. |
MAN_0100 |
The registry shall provide interfaces for authorized registry authorities to manage information in its data store. |
MAN_0200 |
The registry shall provide a web-based front-end to the data contained in its registry for authorized personnel. |
MAN_0230 |
The registry shall provide a configurable means by which changes can be (optionally) reviewed and approved |
ES_0100 |
The registry shall support the notification of data changes to entities either using publish/subscribe or point to point communications. |
ES_0110 |
The registry shall support auditing of all actions for a person record. |
ES_0120 |
The registry shall support data reporting of registry data for authorized personnel. |
ES_0130 |
The registry shall notify end-users via email x days prior to the expiration of their services. |
Documentation
Requirement ID |
Requirement Description |
---|---|
|
|
Samples and Examples
Requirement ID |
Requirement Description |
---|---|
|
|