View Source

Overview

The COmanage Registry Data Model revolves around the CO Person, which conceptually represents one person associated with a CO.

In order for a person to become a CO Person, they must first have at least one Org Identity, which conceptually represents their identity as asserted by a "home" institution, such as their University or a social identity provider.
A CO Person record is created and one or more Org Identities are linked to it. The CO Person record maintains information that is unique to a person within the CO, such as names and identifiers.
A CO Person may have one or more CO Person Roles within the CO. A CO Person Role record maintains information that is unique to a role a person has within a CO, such as title and physical address.

Tables

In addition to the column definitions available for each table below, all tables have additional columns used by the framework and supporting code. These columns include

Timestamps managed by Cake (created, modified)
Columns used in support of Changelog Behavior

The statuses for each table are defined as

Stable: The table definition will not change in a backwards-incompatible manner across minor releases. Stable tables may only be removed in major releases.
Tentative: The table definition will likely become stable, but may change in a backwards-incompatible manner across minor and patch releases. Tentative tables may be refactored or removed without notice.
Experimental: No specific assertion is made about the stability of the table. It may be changed significantly or even removed without notice.
Obsolete: The table is no longer in use as of the specified version.
Not Implemented: The table definition is for planning purposes only.

Major, minor, and patch releases are as defined in semantic versioning.

Table Name	Description	Status	Introduced
cm_addresses	Addresses	Stable	v0.2
cm_api_users	API (Programmatic) Users	Tentative	v0.2
cm_applications	Known applications	Not Implemented
cm_attribute_enumerations	Attribute enumerations (per-CO or platform wide)	Tentative	v1.1.0
cm_cmp_enrollment_attributes	CMP enrollment attribute configuration	Tentative	v0.3
cm_cmp_enrollment_configurations	CMP enrollment configuration	Tentative	v0.3
cm_co_applications	Per-CO configured applications	Not Implemented
cm_co_changelog_provisioner_exports		Obsolete as of v0.8.2	v0.8
cm_co_changelog_provisioner_targets	Per-CO Changelog provisioning target configurations	Tentative	v0.8
cm_co_directory_permissions	Per-CO restrictions on publishing of directory information	Not Implemented
cm_co_enrollment_attributes	Per-CO enrollment flow attribute configurations	Stable	v0.3
cm_co_enrollment_attribute_defaults	Default values for CO enrollment flow attributes configuration	Stable	v0.8.1
cm_co_enrollment_flows	Per-CO enrollment flow configurations	Stable	v0.3
cm_co_expiration_policies	Per-CO expiration policies	Stable	v0.9.2
cm_co_extended_attributes	Per-CO extended attributes	Stable	v0.3
cm_co_extended_types	Per-CO attribute type configurations	Stable	v0.6
cm_co_fifer_servers	Per-CO FIFER services	Not Implemented
cm_co_github_provisioner_targets	Per-CO GitHub provisioning target configurations	Tentative	v0.9.1
cm_co_grouper_provisioner_groups	Per-CO per-Grouper target Grouper group map	Tentative	v0.8.3
cm_co_grouper_provisioner_targets	Per-CO Grouper provisioning target configurations	Tentative	v0.8.3
cm_co_groups	Per-CO groups	Stable	v0.2
cm_co_group_members	Per-CO group memberships	Stable	v0.2
cm_co_group_ois_mappings	Per-CO mappings from OIS records to group memberships	Tentative	v1.1.0
cm_co_homedir_provisioner_targets	Per-CO Home Directory provisioning target configurations	Experimental	v0.9
cm_co_identifier_assignments	Per-CO rules for identifier assignment	Stable	v0.6
cm_co_invites	Per-CO invitations to join	Tentative	v0.1
cm_co_job_history_records	Per-CO Job History Records	Tentative	v1.1.0
cm_co_jobs	Per-CO Job Records	Tentative	v1.1.0
cm_co_ldap_provisioner_attr_groupings	Per-CO per-LDAP target attribute grouping definitions	Stable	v0.8
cm_co_ldap_provisioner_attributes	Per-CO per-LDAP target attribute definitions	Stable	v0.8
cm_co_ldap_provisioner_dns	Per-CO per-LDAP target DN map	Stable	v0.8
cm_co_ldap_provisioner_targets	Per-CO LDAP provisioning target configurations	Stable	v0.8
cm_co_localizations	Per-CO Text Localizations	Stable	v0.8.3
cm_co_message_templates	Per-CO Message Templates	Tentative	v1.1.0
cm_co_name_identifier_assignments	Per-Identifier tracking of assigned name-based sequences	Obsolete
cm_co_navigation_links	Per-CO Navigation Links	Stable	v0.8.2
cm_co_notifications	Per-CO Notifications	Stable	v0.8.4
cm_co_nsf_demographics	Demographics for statistics	Stable	v0.3
cm_co_org_identity_links	Per-CO link to org identity	Stable	v0.3
cm_co_people	Per-CO person identity	Stable	v0.2
cm_co_person_roles	Per-CO person role identity	Stable	v0.3
cm_co_person_sources	Per-CO link from person to org person	Obsolete as of v0.3	v0.2
cm_co_petition_attributes	Per-CO enrollment petition attributes	Stable	v0.3
cm_co_petition_history_records	Per-CO enrollment petition history records	Stable	v0.3
cm_co_petitions	Per-CO enrollment petitions	Stable	v0.3
cm_co_pipelines	Per-CO pipelines	Tentative	v1.1.0
cm_co_provisioning_exports	Per-CO provisioning target export record	Stable	v0.8.2
cm_co_provisioning_queued_events	Per-CO provisioning events to process	Not Implemented	v0.8
cm_co_provisioning_targets	Per-CO provisioning targets	Stable	v0.8
cm_co_role_assignments	Per-CO person role assignments	Not Implemented
cm_co_role_groups	Per-CO group memberships implied by role	Not implemented
cm_co_roles	Per-CO role definitions	Not Implemented
cm_co_self_service_permissions	Per-CO self service permissions	Stable	v0.9
cm_co_sequential_identifier_assignments	Per-Identifier tracking of next values for sequentially assigned identifiers	Stable	v0.6
cm_co_settings	Per-CO Settings	Stable	v0.9.1
cm_co_tandc_agreements	Per-CO Person agreements to terms and conditions	Stable	v0.8.3
cm_co_terms_and_conditions	Per-CO terms and conditions	Stable	v0.8.3
cm_configuration	COordinate configuration values	Obsolete
cm_cos	Definitions of (virtual) organizations	Stable	v0.2
cm_cous	Definitions of (virtual) organization units	Stable	v0.3
cm_email_addresses	Email Addresses	Stable	v0.2
cm_history_records	Transaction history (human readable)	Stable	v0.7
cm_identifiers	Person identifiers, from organizational source	Stable	v0.2
cm_meta	Meta (platform) information	Tentative	v0.9.4
cm_names	Names	Stable	v0.2
cm_navigation_links	Navigation Links	Stable	v0.8.2
cm_net_forum_sources	netFORUM Organizational Identity Sources	Experimental	v1.1.0
cm_orcid_sources	ORCID Organizational Identity Sources	Experimental	v1.1.0
cm_org_identities	Person identity, from organizational source	Stable	v0.3
cm_org_identity_source_records	Cached records from external org identity sources	Experimental	v1.1.0
cm_org_identity_sources	External sources of organizational identities	Experimental	v1.1.0
cm_organizations	Definitions of (real) organizations	Obsolete as of v1.1.0	v0.2
cm_permissions	Permissions for COoordinate	Not Implemented
cm_ssh_keys	SSH keys	Stable	v0.9
cm_telephone_numbers	Telephone numbers	Stable	v0.2

View All Tables in a list
View data model as a high level ERD.