All Tables

Table	cm_addresses
Description	Addresses

Column	Format	Description	Definition	Comments
id	integer, primary key	Row identifier	autoincrement
street	varchar(400)	Street	X.520 via RFC 4519 organizationalPerson
room	varchar(64)	Room	X.520 via RFC 4519 organizationalPerson
locality	varchar(128)	Locality (eg: city)	X.520 via RFC 4519 organizationalPerson
state	varchar(128)	State or Province	X.520 via RFC 4519 organizationalPerson
postal_code	varchar(16)	Postal Code	X.520 via RFC 4519 organizationalPerson
country	varchar(128)	Country	X.521 via RFC 4519 country
description	varchar(128)	Description		Added in Registry v3.1.0.
type	varchar(2)	Type of mail, as enumerated		When attached to a CO Person, types may be configured on a per-CO basis. See Extending the Registry Data Model.
language	varchar(16)	Language encoding of this address	RFC 5646	For supported values, see `lang.php`
co_person_role_id	integer, foreign key	CO Person Record ID	cm_co_person_roles:id	Only one of `co_person_id`, `org_identity_id`, or `co_department_id` may be specified
org_identity_id	integer, foreign key	Org Identity Record ID	cm_org_identities:id	Only one of `co_person_id`, `org_identity_id`, or `co_department_id` may be specified
co_department_id	integer, foreign key	CO Department Record ID	cm_co_departments:id	Only one of `co_person_id`, `org_identity_id`, or `co_department_id` may be specified. Added in Registry v3.1.0.
source_address_id	integer, foreign key	If Pipelines are in use, the Address ID for the Org Identity Address that created this record.	cm_addresses:id	Added in Registry v2.0.0.

Table	cm_api_users
Description	API (Programmatic) Users

Column	Format	Description	Definition	Comments
id	integer, primary key	Row identifier	autoincrement
co_id	integer, foreign key	CO ID	cm_cos:id	If `co_id` is 1 (COmanage CO), the API User is a Platform API User Added Registry v3.3.0
username	varchar(50)	User (login) name
password	varchar(40)	Hashed password	SHA1, as used by CakePHP	Will be renamed `api_key` in Registry v5.0.0
privileged	boolean	If this API User is a "superuser" within its CO	true: API User is privileged false: API User is not privileged	Added Registry v3.3.0
status	varchar(2)	API User status	A: Active S: Suspended	Added Registry v3.3.0
valid_from	datetime	API User is valid from this time	If null, valid any time through valid_through	Added Registry v3.3.0
valid_through	datetime	API User is valid through (but not past) this time	If null, valid any time from valid_from	Added Registry v3.3.0
remote_ip	varchar(80)	IP addresses this API User may connect from	Defined as regular expression, or null for any IP address	Added Registry v3.3.0

Table	cm_applications
Description	Known applications

Column	Format	Description	Definition
id	integer, primary key	Row identifier	autoincrement
name	varchar(256)	Application name
enabled	boolean	Enabled applications are available to COs	0: No 1: Yes

Table	cm_cmp_enrollment_attributes
Description	CMP enrollment attribute configuration

There is no REST interface to this table since it is intended to configure the COmanage Registry UI.

Column	Format	Description	Definition	Comments
id	integer, primary key	Row identifier	autoincrement
cmp_enrollment_configuration_id	integer, foreign key	CMP Enrollment Configuration ID	cm_cmp_enrollment_configurations:id
attribute	varchar(80)	Organizational Identity attribute name	Attributes defined in cm_org_identities or related tables (such as cm_addresses)
type	varchar(2)	If attribute definition includes a type, associate this enrollment attribute with the specified type
required	integer	If the flow requires this attribute	1: Required 0: Not required (ie: optional) -1: Not permitted
ldap_name	varchar(80)	Name of LDAP attribute used to populate this attribute		If enabled, attribute is authoritative to the originating organization. May be enabled along with saml_name.
saml_name	varchar(80)	Name of SAML attribute used to populate this attribute		If enabled, attribute is authoritative to the originating organization. May be enabled along with ldap_name.

Unable to render {include} The included page could not be found.

Table	cm_co_applications
Description	Per-CO configured applications

Column	Format	Description	Definition
id	integer, primary key	Row identifier	autoincrement
co_id	integer, foreign key	CO Record ID	cm_cos:id
name	varchar(256)	Application name
provisioned	boolean	Provisioned applications are available in the CO	0: No 1: Yes

Table	cm_co_directory_permissions
Description	Per-CO restrictions on publishing of directory information

Column	Format	Description	Definition	Comments
id	integer, primary key	Row identifier	autoincrement
cm_org_person_id	integer, foreign key	Org Person Record ID	cm_org_identities:id
attribute	varchar(256)	Schema attribute name	Correlate to cm_co_person_roles columns	Use attribute '*' to apply to entire record
release	boolean	Released attributes are public	0: No 1: Yes

Table	cm_co_extended_attributes
Description	Per-CO extended attribute definitions

Column	Format	Description	Definition	Comments
id	integer, primary key	Row identifier	autoincrement
co_id	integer, foreign key	CO Record ID	cm_cos:id
name	varchar(64)	Database column name for attribute
display_name	varchar(64)	Display name for attribute
type	varchar(32)	Database type for attribute	INTEGER TIMESTAMP VARCHAR(32)	Once set, type cannot be changed
index	boolean	Create database index for attribute	true: Index false: Do not index

Unable to render {include} The included page could not be found.

Table	cm_co_groups
Description	Per-CO group definitions

Column	Format	Description	Definition	Comments
id	integer, primary key	Row identifier	autoincrement
co_id	integer, foreign key	CO Record ID	cm_cos:id
cou_id	integer, foreign key	COU Record ID	cm_cous:id	Added v2.0.0. Initially intended for special groups, may be used for manual groups in the future.
name	varchar(128)	Group name
description	varchar(256)	Description
open	boolean	An open group allows anyone to self-subscribe	true: Open false: Closed
status	varchar(2)	Group's status within CO	A: Active S: Suspended
group_type	varchar(2)	Group Type	A: Admins M: All Members MA: Active Members S: Standard	Added v2.0.0.
auto	boolean	Automatic Group	true: Group is automatically managed false: Group is manually managed	Added v2.0.0.
nesting_mode_all	boolean	Nested Group Memberships calculation mode	true: Member must be a member of ALL nested groups false: Member may be a member of ANY nested group	Added v4.0.0.

Table	cm_co_group_members
Description	Per-CO group memberships

Column	Format	Description	Definition	Comments
id	integer, primary key	Row identifier	autoincrement
co_group_id	integer, foreign key	CO Group Record ID	cm_co_groups:id
co_person_id	integer, foreign key	CO Person Record ID	cm_co_people:id
member	boolean	Person is a member of the group	true: Member false: Not a member
owner	boolean	Person is an owner of the group	true: Owner false: Not an owner
valid_from	datetime	CO Group Membership is considered valid from this time	If null, valid any time through valid_through	Added in v3.2.0
valid_through	datetime	CO Group Membership is considered valid through (but not past) this time	If null, valid any time from valid_from	Added in v3.2.0
source_org_identity_id	integer, foreign key	If Pipelines are in use, the Org Identity ID of record that created this Group Membership	cm_org_identities:id
co_group_nesting_id	integer, foreign key	If set, this membership was created via a Nested Group and cannot be manually edited	cm_co_group_nestings:id	Added in v3.3.0

Table	cm_co_invites
Description	Per-CO invitations to join

Column	Format	Description	Definition	Comments
id	integer, primary key	Row identifier	autoincrement
co_person_id	integer, foreign key	CO Person Record ID	cm_co_people:id
mail	varchar(256)	Email address invited	cm_email_addresses:mail	Copied rather than linked since the linked reference could change
skip_invite	boolean	Whether to skip the invitation step due to an already verified email address being present		Added in Registry v4.0.0 as a workaround for `SkipIfVerified` mode
email_address_id	integer, foreign key	Email Address ID to confirm	cm_email_addresses:id	If set, the invite is intended to verify the linked email address
invitation	varchar(16)	Randomly generated activation key
expires	datetime	Time at which invitation is no longer valid

Table	cm_co_org_identity_links
Description	Link from CO person role to Org identity

Column	Format	Description	Definition
id	integer, primary key	Row identifier	autoincrement
co_person_id	integer, foreign key	CO Person Record ID	cm_co_people:id
org_identity_id	integer, foreign key	Organization Person Record ID	cm_org_identities:id

Table	cm_co_people
Description	Per-CO People

Column	Format	Description	Definition	Comments
id	integer, primary key	Row identifier	autoincrement
co_id	integer, foreign key	CO ID	cm_cos:id
timezone	varchar(80)	Person's preferred timezone	IANA Timezone Database
date_of_birth	date	Person's date of birth		Added in Registry v3.3.0
status	varchar(2)	Person's status within CO	A: Active C: Confirmed D: Deleted D2: Duplicate GP: Grace Period I: Invited L: Locked N: Denied P: Pending PA: Pending Approval PC: Pending Confirmation PV: Pending Vetting S: Suspended X: Declined XP: Expired Y: Approved

Table	cm_co_person_roles
Description	Per-CO person roles

Column	Format	Description	Definition	Comments
id	integer, primary key	Row identifier	autoincrement
co_person_id	integer, foreign key	CO Person ID	cm_co_people:id
manager_co_person_id	integer, foreign key	CO Person ID of Manager	cm_co_people:id	Added in Registry v4.1.0
sponsor_co_person_id	integer, foreign key	CO Person ID of Sponsor for continued membership	cm_co_people:id	not necessarily the same as the enrollment sponsor in cm_co_petitions
cou_id	integer, foreign key	COU ID	cm_cous:id
affiliation	varchar(8)	Broad affiliation to CO	eduPerson person	Extended Type
title	varchar(128)	Title at CO	X.520 via RFC 4519 person
o	varchar(128)	CO	X.520 via RFC 4519 person
ou	varchar(128)	Departmental affiliation at CO	X.520 via RFC 4519 person
valid_from	datetime	Person Role is valid member of CO from this time	If null, valid any time through valid_through
valid_through	datetime	Person Role is valid member of CO through (but not past) this time	If null, valid any time from valid_from
ordr	integer	Order/Rank/Priority of this Person Role		Added in Registry v3.2.0
status	varchar(2)	Person's Role status within CO	A: Active C: Confirmed D: Deleted D2: Duplicate GP: Grace Period I: Invited N: Denied P: Pending PA: Pending Approval PC: Pending Confirmation PV: Pending Vetting S: Suspended X: Declined XP: Expired Y: Approved
source_org_identity_id	integer, foreign key	If Pipelines are in use, the Org Identity ID of record that created this Person Role	cm_org_identities:id

Table	cm_co_person_sources
Description	Link from CO person role to Org identity *This table is obsolete*

Column	Format	Description	Definition
id	integer, primary key	Row identifier	autoincrement
co_id	integer, foreign key	CO ID	cm_cos:id
co_person_id	integer, foreign key	CO Person Record ID	cm_co_person_roles:id
cou_id	integer, foreign key	COU ID	cm_cous:id
org_person_id	integer, foreign key	Organization Person Record ID	cm_org_identities:id

Table	cm_co_role_assignments
Description	Per-CO person role assignments

Column	Format	Description	Definition
id	integer, primary key	Row identifier	autoincrement
co_role_id	integer, foreign key	CO Role Record ID	cm_co_roles:id
co_person_id	integer, foreign key	CO Person Record ID	cm_co_person_roles:id
percent_time	integer	Percent time Person is allocated to Role	0 (none) to 100 (full)

Table	cm_co_role_groups
Description	Per-CO group memberships implied by role

Column	Format	Description	Definition
id	integer, primary key	Row identifier	autoincrement
co_role_id	integer, foreign key	CO Role Record ID	cm_co_roles:id
co_group_id	integer, foreign key	CO Group Record ID	cm_co_groups:id

Table	cm_co_roles
Description	Per-CO role definitions

Column	Format	Description	Definition
id	integer, primary key	Row identifier	autoincrement
co_id	integer, foreign key	CO Record ID	cm_cos:id
description	varchar(256)	Description
status	varchar(2)	Role's status within CO	A: Active D: Deleted

Table	cm_configuration
Description	COordinate configuration values This table was not implemented and is obsolete

Column	Format	Description	Definition
id	integer, primary key	Row identifier	autoincrement
attribute	varchar(256)	Configuration item
value	varchar(256)	Configuration value

Table	cm_cos
Description	Definitions of (virtual) organizations

CO Admins are defined by membership within the "admin" group within their CO
Special CO with name "COmanage" is where COmanage Admins are listed

Column	Format	Description	Definition	Comments
id	integer, primary key	Row identifier	autoincrement
name	varchar(128)	CO Name
description	varchar(256)	Description
status	varchar(2)	CO's status	A: Active S: Suspended T: Template	Template added Registry v3.2.0

Table	cm_cous
Description	Per-CO unit definitions

Column	Format	Description	Definition	Comments
id	integer, primary key	Row identifier	autoincrement
co_id	integer, foreign key	CO Record ID	cm_cos:id
parent_cou_id	integer, foreign key	pointer to parent cou	cm_cous:id
lft	integer	Tree left value	required by CakePHP for tree functions	Automatically managed
rght	integer	Tree right value	required by CakePHP for tree functions	Automatically managed
name	varchar(128)	COU name
description	varchar(256)	Description

Note: The CakePHP implementation of the model that represents this table includes code that enables the model to support a tree structure and leverage class MPTT behavior. The result is extra structure not easily seen in the table definition above. Refer to the implementation for details.

Table	cm_email_addresses
Description	Email Addresses

Column	Format	Description	Definition	Comments
id	integer, primary key	Row identifier	autoincrement
mail	varchar(256)	Internet mail address	RFC 4524 inetOrgPerson
description	varchar(128)	Description		Added in Registry v3.1.0.
type	varchar(32)	Type of mail, as enumerated		When attached to a CO Person, types may be configured on a per-CO basis. See Extending the Registry Data Model. See also Recommendations For Email Addresses.
verified	boolean	Was this address verified?	true: Verified false: Not verified	Verification is via a URL sent to the address
co_person_id	integer, foreign key	CO Person Record ID	cm_co_people:id	Only one of `co_person_id`, `org_identity_id`, or `co_department_id` may be specified
org_identity_id	integer, foreign key	Org Identity Record ID	cm_org_identities:id	Only one of `co_person_id`, `org_identity_id`, or `co_department_id` may be specified
co_department_id	integer, foreign key	CO Department Record ID	cm_co_departments:id	Only one of `co_person_id`, `org_identity_id`, or `co_department_id` may be specified. Added in Registry v3.1.0.
source_email_address_id	integer, foreign key	If Pipelines are in use, the Email Address ID for the Org Identity Email Address that created this Name	cm_email_addresses:id	Added in Registry v2.0.0.

Unable to render {include} The included page could not be found.

Table	cm_identifiers
Description	Person identifiers

Column	Format	Description	Definition	Comments
id	integer, primary key	Row identifier	autoincrement
identifier	varchar(256)	Identifier	As per type definition
type	varchar(32)	Type of identifier	Arbitrary values may be configured via cm_co_extended_types (for identifiers attached to COs, only) or default values available are eppn: eduPersonPrincipalName eptid: eduPersonTargetedID mail: RFC 4524 inetOrgPerson openid: OpenID uid: RFC 4519 uidObject (previously userid)	mail is intended for CO generated mail aliases/addresses to be stored, regardless of whether or not they are in use. Email addresses intended to be reflected into directories or other downstream locations should be stored in the email_addresses table.
login	boolean	Registry login flag	true: This identifier can be used to login to Registry false: This identifier cannot be used to login to Registry	Only applies to identifiers attached to Org Identities.
status	varchar(2)	Identifier's status	A: Active S: Suspended	An identifier marked deleted is no longer considered in use by COmanage, but it cannot be reassigned. Prior to v2.0.0, the status D/Deleted was used instead of S/Suspended.
co_person_id	integer, foreign key	CO Person Record ID	cm_co_people:id	Only one of `co_person_id`, `org_identity_id`, `co_group_id`, or `co_department_id` may be specified
org_identity_id	integer, foreign key	Org Identity Record ID	cm_org_identities:id	Only one of `co_person_id`, `org_identity_id`, `co_group_id`, or `co_department_id` may be specified
co_department_id	integer, foreign key	CO Department Record ID	cm_co_departments:id	Only one of `co_person_id`, `org_identity_id`, `co_group_id`, or `co_department_id` may be specified. Added in Registry v3.1.0.
co_group_id	integer, foreign key	CO Group Record ID	cm_co_groups:id	Only one of `co_person_id`, `org_identity_id`, `co_group_id`, or `co_department_id` may be specified. Added in Registry v3.3.0.
source_identifier_id	integer, foreign key	If Pipelines are in use, the Identifier ID for the Org Identity Identifier that created this record.	cm_identifiers:id	Added in Registry v2.0.0.
co_provisioning_target_id	integer, foreign key	CO Provisioning Target ID	cm_co_provisioning_targets:id	ie: The Provisioning Target that assigned (and is responsible for managing) this Identifier. Added in Registry v3.1.0.

Table	cm_names
Description	Person names

Column	Format	Description	Definition	Comments
id	integer, primary key	Row identifier	autoincrement
honorific	varchar(32)	Dr, Mr, Ms, etc
given	varchar(128)	First/Given name(s)
middle	varchar(128)	Middle name(s)
family	varchar(128)	Last/Family name(s)
suffix	varchar(32)	Jr, III, PhD, etc
language	varchar(16)	Language encoding of this name	RFC 5646	For supported values, see `lang.php`
type	varchar(2)			When attached to a CO Person, types may be configured on a per-CO basis. See Extending the Registry Data Model.
primary_name	boolean	true: This name is the primary name for the CO Person or Org Identity false: This name is not the primary name		Exactly one name per CO Person and one per Org Identity should have primary_name true at all times
co_person_id	integer, foreign key	CO Person Record ID	cm_co_people:id	Only one of `co_person_id` or `org_identity_id` may be specified
org_identity_id	integer, foreign key	Org Identity Record ID	cm_org_identities:id	Only one of `co_person_id` or `org_identity_id` may be specified
source_name_id	integer, foreign key	If Pipelines are in use, the Name ID for the Org Identity Name that created this Name	cm_names:id

Table	cm_org_identities
Description	Person identity, from institutional source

Column	Format	Description	Definition	Comments
id	integer, primary key	Row identifier	autoincrement
status	varchar(2)	Org Identity status	RM: Removed SY: Synced	Added in v2.0.0. Currently intended primarily for org identities synced from an org identity source.
date_of_birth	date	Person's date of birth		Added in Registry v3.3.0
affiliation	varchar(8)	Broad affiliation to source organization	eduPerson person
title	varchar(128)	Title at source organization	X.520 via RFC 4519 person
o	varchar(128)	Source organization	X.520 via RFC 4519 person
ou	varchar(128)	Departmental affiliation at source organization	X.520 via RFC 4519 person
valid_from	datetime	Org Identity is considered valid from this time	If null, valid any time through valid_through	Added in v2.0.0
valid_through	datetime	Org Identity is considered valid through (but not past) this time	If null, valid any time from valid_from	Added in v2.0.0
manager_identifier	varchar(512)	Identifier for this Org Identity's manager	cm_identifiers:identifier	Added in v4.1.0
sponsor_identifier	varchar(512)	Identifier for this Org Identity's sponsor	cm_identifiers:identifier	Added in v4.1.0
~~organization_id~~	~~integer, foreign key~~	~~Source organization via known organizations~~	~~cm_organizations (obsolete):id~~	Unused column removed in v2.0.0
co_id	integer, foreign key	If `pool_org_identities` is false in the CMP Enrollment Configuration, the CO in which this Org Identity is available	cm_cos:id

Table	cm_organizations
Description	Definitions of (external) organizations

Column	Format	Description	Definition	Comments
id	integer, primary key	Row identifier	autoincrement
co_id	integer, foreign key	CO Record ID	cm_cos:id
name	varchar(128)	Name
description	varchar(128)	Description
type	varchar(32)	Organization type		May be configured on a per-CO basis. See Extending the Registry Data Model.

Table	cm_permissions
Description	Permissions for COoordinate

Special CO with id "1" and name "COmanage" (linked via cm_co_person_roles:co_id) is where COordinate Admins are listed

Column	Format	Description	Definition
id	integer, primary key	Row identifier	autoincrement
co_person_id	integer, foreign key	CO Person Record ID	cm_co_person_roles:id
permission	varchar(2)	Permission	A: Admin for CO

Table	cm_telephone_numbers
Description	Telephone Numbers

Column	Format	Description	Definition	Comments
id	integer, primary key	Row identifier	autoincrement
country_code	varchar(3)	Telephone Country Code	ITU E.164
area_code	varchar(8)	Telephone Area (National Destination) Code	ITU E.164
number	varchar(64)	Telephone Subscriber Number	ITU E.164
extension	varchar(16)	Telephone Extension	Location specific
description	varchar(128)	Description		Added in Registry v3.1.0.
type	varchar(2)	Type of telephone		When attached to a CO Person Role, types may be configured on a per-CO basis. See Extending the Registry Data Model.
co_person_role_id	integer, foreign key	CO Person Role Record ID	cm_co_person_roles:id	Only one of `co_person_id`, `org_identity_id`, or `co_department_id` may be specified
org_identity_id	integer, foreign key	Org Identity Record ID	cm_org_identities:id	Only one of `co_person_id`, `org_identity_id`, or `co_department_id` may be specified
co_department_id	integer, foreign key	CO Department Record ID	cm_co_departments:id	Only one of `co_person_id`, `org_identity_id`, or `co_department_id` may be specified. Added in Registry v3.1.0.
source_telephone_number_id	integer, foreign key	If Pipelines are in use, the Telephone Number ID for the Org Identity Telephone Number that created this record.	cm_telephone_numbers:id	Added in Registry v2.0.0.

Space shortcuts

Page tree