Organizational Identity Sources allow for the creation of Organizational Identities linked to an external source or "system of record". These sources can include LDAP servers, REST APIs, SQL databases, flat files, and so on. Custom plugins can be written for arbitrary sources.

On this page

1. About Organizational Identity Sources

Organizational Identity Sources can only be defined on a per-CO basis. If org identities are pooled, Organizational Identity Sources are not supported. Once configured, Organizational Identities can be created from these sources in several ways:

  • Manually, via People >> Organizational Identities >> Add New Org Identity From Source or by using the Search button from the list of Organizational Identity Sources.
  • Using an Enrollment Flow, via Enrollment Sources.
  • Via the Registry Job Shell, as described below.

Organizational Identity Sources can be linked to Registry Pipelines in order to automatically create CO Person records.

(warning) When an Organizational Identity is created from a source, it is linked to that source and cannot be manually edited, not even by an administrator. However, it can be manually resynced to pull changes from the source.

(warning) If the corresponding record is removed from the Organizational Identity Source, on the next sync the Org Identity will be set to status Removed, but the Org Identity itself will remain available – it is not deleted.

(warning) If Attribute Enumerations are enabled for any attributes, permitted values for those attributes are constrained to the enumerated options. Source records containing a non-enumerated value will fail to process correctly.

Organizational Identity Sources are available in COmanage Registry v2.0.0 and later.

2. Terminology

The terminology used by Registry can be a little confusing when looking at person records related to Organizational Identity Sources.

  • View Organizational Identity: Retrieves the current Org Identity operational record used by Registry in normal operations.
  • View Organizational Identity Source: Performs a live query against the Org Identity Source backend and retrieves the current data as known to the backend. ie: This is the source's current data.
  • View Organizational Identity Source Record: Retrieves the last data retrieved from the backend and used to create or update an Org Identity. ie: This is Registry's copy of the source data.
  • Add New Org Identity From Source: Create a new Org Identity based on the Org Identity Source's data. In addition, this will create an Organizational Identity Source Record.
  • Resync Org Identity From Source: Update the Org Identity and Organizational Identity Source Record using the latest (current) data available from the Org Identity Source.
  • Configuration >> Organizational Identity Sources: Manage the plugins used to define and query one or more Org Identity Sources.

3. Sync Modes

3.1. Job Shell

Organizational Identity Sources can be configured in one of several sync modes to allow periodic automatic synchronization of records via the Registry Job Shell. Prior to Registry v4.0.0, this is handled with the syncorgsources and forcesyncorgsources tasks. As of Registry v4.0.0, this is handled via the Core Job Plugin Sync job.

  • Full: Create new Org Identities for any record in the Organizational Identity Source that does not yet have one, and update (or delete, if appropriate) existing records.
  • Query: Similar to Enrollment Sources Search mode, query the Organizational Identity Source for any records matching verified email addresses of all Org Identities, looking for new matching records to link. Also update (or delete, if appropriate) existing records.
    • (warning) Query mode should only be used for Organizational Identity Sources attached to a Registry Pipeline configured for email address-based matching. Otherwise, linking to existing CO People may not happen correctly.
    • In Query mode, if a Organizational Identity Source is queried for an email address and the Source returns a record with a different email address (eg: the person changed their email address in the other system), by default a new Org Identity (and probably CO Person) will be created. This is because Registry has not confirmed the alternate email address and cannot trust the Organizational Identity Source asserting a record linkage. This corresponds to the Email Mismatch Mode of Create New Org Identity. Alternately, Email Mismatch Mode can be set to Ignore, in which case no action is taken.
    • In Query mode, by default the Organizational Identity Source will be re-queried for all email addresses, even those already attached to an Org Identity associated with the Source. This is to allow for the checking of additional records associated with the same email address. However, this can also create a large number of extra queries, if the Source is known not to create such records (or if such records are not of interest). To disable this behavior, set (tick the box for) Do Not Query for Known Email Addresses.
  • Update: Update and delete (if appropriate) records that are already synced to Org Identities.
    • The syncorgsources task will skip any unchanged records, while the forcesyncorgsources task will process records even when they are unchanged. forcesyncorgsources is available as of Registry v3.2.0. As of Registry v4.0.0, it is accessed via the --force flag of the CoreJob Sync job.
    • (warning) When the forcesyncorgsources task is run, the getChangeList() capability supported by some plugins cannot be used. This may result in significantly longer processing times. 
  • Manual: Do not automatically sync records. Currently, manual syncing is only available on an individual record basis. (CO-1309)

(warning) Not all Organizational Identity Source plugins support all sync modes. Check the documentation for any limitations.

Syncing via Job Shell can be disabled on a per-CO basis via CO Settings >> Disable Org Identity Source Sync.

3.2. Login

As of Registry v3.1.0, Org Identities associated with an Organizational Identity Source can be resynced on user login to Registry. This is enabled on a per-Organizational Identity Source basis, by enabling the Sync on Login setting.

Because user login crosses COs, when a user logs in the identifier they used to login will be searched against all Organizational Identities (regardless of CO) for matching CO Person records. Then, any Org Identity associated with those CO Person records will be checked for an associated Organizational Identity Source for the Sync on Login setting. In other words, a login event will resync any suitably configured record, not just the one associated with the identifier used to login.

If external databases are configured as Organizational Identity Sources to sync during login, users may experience login delays related to querying those databases.

Sync on login is not supported when Organizational Identities are pooled. Unexpected results may occur.

4. Linking a Record to a CO Person

By default, creating an Org Identity (via Add New Org Identity From Source or any other mechanism) will not create a CO Person.

If the Org Identity Source is attached to a Pipeline, then that Pipeline will likely create a CO Person for the new Org Identity. If a Pipeline Match Strategy is configured, then the Pipeline may attach the new Org Identity to an existing CO Person if the match conditions are satisfied.

To manually link an Org Identity to an existing CO Person, there are two options:

  1. If no Pipeline is attached to the Org Identity Source, simply link the record manually.
  2. Define an Enrollment Flow. A typical configuration would be
    1. Authorization: CO Admin (or COU Admin)
    2. Identity Matching: Select
    3. Attach an appropriate Enrollment Source, in Select mode
    4. Do not define any Enrollment Attributes

5. Creating ePPNs

When syncing records from an Org Identity Source, Registry can automatically create an identifier of type ePPN to be injected into the Org Identity created from the Source. This can be useful for (eg) automatically calculating the ePPN of an IdP associated with the Source. There are two settings:

  • EPPN Identifier Type: The Identifier of this type as found in the Org Identity created from the Source will be used as the left-hand side of the newly created ePPN.
  • EPPN Suffix: The specified string will be used as the right-hand side of the newly created ePPN. Do not include the @.

An ePPN will not be generated if one is found in the Org Identity record created from the Source.

6. CO Group Mappings

Organizational Identity Sources can generate CO Group Memberships via Group Mappings, when the relevant OIS Plugin implements the appropriate interfaces. However, since group memberships attach to a CO Person and not an Organizational Identity, for this to be useful the OIS must typically be attached to a Pipeline, which will then create CO Group Memberships attached to the relevant CO Person record. For OIS Plugins that support this feature, the steps to enable it are:

  1. Make sure the group(s) you want to add memberships to already exists. Automatic groups (such as members groups) cannot be used here.
  2. View the OIS configuration (ie: use the Edit button, not the Configure button), and click Configure Group Mapping.
    1. (info) In Registry versions prior to v3.1.0, the Configure Group Mapping button is available on the index page of Organizational Identity Sources.
    2. The OIS must be connected to a Pipeline for CO Group Memberships to be assigned.
  3. Add one or more mappings.
    1. Attribute: The attribute found in the Organizational Identity Source.
    2. Target Group: The group for which a membership will be created, when the Org Identity has an Attribute matching the specified Comparison and Pattern.
  4. At this point, if you search the Organizational Identity Source, any records matching the defined mappings will also show what CO Group memberships would be assigned if a CO Person record were created from or attached to this source record. However, an action triggering the Pipeline (as described above) must take place. (warning) This means group memberships for existing records will not be assigned until there is a manual sync or a change in the source record.

If a CO Person already has a CO Group Membership (either manually created or from another Organizational Identity Source), a new membership will not be created.

Manually rerunning a Pipeline will not correctly recalculate group memberships, as the original source record is not available for processing. Completely resyncing the Org Identity from Source (which will in turn rerun the Pipeline) will work correctly.

7. Storing Cached Source Records

When a record has been synced to Registry from the Organizational Identity Source, a cached copy is stored in the Organizational Identity Source Record so that Registry may detect when the source record has been updated. By default, this is a full copy of the record as returned to Registry from the backend (in whatever format is returned from the source, eg JSON, XML, etc). This is also useful for tracing problems, as it is possible for an administrator to look at a cached copy of the data.

However, there may be privacy or data retention concerns that make storing a full copy less desirable for a given deployment. As an alternative, Registry can create a hash of the data to be stored instead. This can be enabled via the Hash Source Records configuration option.

When this configuration is changed, existing records are not affected. Furthermore, since the cached copy will no longer match the current source record, all records from the Source will be considered out of date the next time a sync is performed. It is best to determine the appropriate value for this setting prior to significant production usage.

An additional consideration when enabling Hash Source Records for privacy or data retention reasons is that older copies of the source records are maintained by Changelog Behavior. It is insufficient to enable this setting and perform a full sync to remove all old records from the database, rather manual intervention is required. The following SQL is for general guidance and should not be used directly without first testing against a test server:

SQL> update cm_org_identity_source_records set source_record=md5(source_record) where org_identity_source_id=? and (deleted=true or org_identity_source_record_id is not null);

8. Filtering Inbound Records

As of Registry v4.1.0, Organizational Identity Sources support Data Filters. Data Filters apply to the structured Org Identity record created by the plugin, and not the cached source record. The cached source record will have the original values obtained from the source, unless Hash Source Records is enabled.

9. Extending with Plugins

The type and nature of provisioners used with the Registry can be extended through Plugins

9.1. Org Identity Source Plugin Library

There are several plugins that are already available for your use:

  • Page:
    API Source — The API Organizational Identity Source Plugin is designed to integrate using RESTful APIs and message buses.
  • Page:
    Env Source — The Env Organizational Identity Source Plugin is designed to pull attributes from environment variables, generally populated by web server authentication modules.
  • Page:
    File Source — The File Organizational Identity Source Plugin is designed to integrate using CSV files.
  • Page:
    LDAP Source — The LDAP Organizational Identity Source Plugin is designed to integrate with an LDAP server.
  • Page:
    netFORUM Source — The netFORUM Organizational Identity Source Plugin is designed to integrate with the Abila netFORUM Association Management System via the XML API (xWeb).
  • Page:
    Novi Source — The Novi Organizational Identity Source Plugin is designed to integrate with the Novi Association Management Software platform using the Novi AMS API.
  • Page:
    ORCID Source — The ORCID Organizational Identity Source Plugin is designed to integrate with the ORCID API in order to create Organizational Identities and to securely link an ORCID iD to an existing CO Person Record. In Registry v4.4.0 and later, this plugin supports the use of the ORCID Member API for collecting ORCID access and refresh tokens in addition to ORCID iDs.
  • Page:
    Salesforce Source — The Salesforce Organizational Identity Source Plugin is designed to integrate with Salesforce via the REST API.
  • Page:
    SQL Source — The SQL Organizational Identity Source Plugin is designed to integrate inbound data via a SQL database. SqlSource is available as of Registry v4.1.0.

9.2. Creating your own plugins

You can build your own authenticator plugin to extend Registry functionality. Please see the following documentation to get started:

10. See Also

10.1. Org Identity Source data model

The following database tables are associated with Org Identity Sources:

  • No labels