API Source is an External Identity Source Plugin designed to integrate with upstream sources via a REST API.

The data format used by this Plugin is based on the TAP Attribute Dictionary. As such, while the COmanage-specific term External Identity Source is generally used in this documentation, the TAP term System of Record is used when referencing elements directly related to the TAP definitions. Practically speaking, these terms can be used interchangeably.

Configuration

  1. API Source is part of the ApiConnector Registry Plugin, which must be activated.
  2. When adding a new External Identity Source, the Plugin is ApiConnector.ApiSources.

Modes

API Source supports three modes of operation:

  • Push Mode: The External Identity Source sends records to API Source via a standard API
  • Pull Mode: API Source queries the External Identity Source via the EIS's API (not yet implemented)
  • Poll Mode: API Source polls an endpoint (typically a message bus) for records to process (not yet implemented)

Push Mode

Push Mode is implemented via the API Source Endpoint API Plugin, which describes the necessary additional configuration and endpoint information.

See Also

Changes From Earlier Versions

As of Registry v5.2.0

As of Registry v5.0.0

  • Message Meiosis is no longer supported, as the native data structures now permit multiple Roles.
  • Time specifications no longer use the Z notation. Strictly speaking this is not compliant with the TAP API, and is subject to change in a future release (CFM-352).
  • No labels