Using the Event Notification Plug-In Service Provider Interface

This section introduces the third of the use cases—support for using the Event Notification SPI to be notified of important ActivID CMS device-related events. Use cases are comprised of subsections that briefly describe and define how some type of ActivID CMS functionality can be integrated into a custom application.

Use Case: Getting Notification of ActivID CMS Events

Use Case Goal

To notify a backend application when an important ActivID CMS event occurs, use the Event Notification Plug-in Service Provider Interface (SPI).

Context

It is important that third-party components such as the Integrated Database Management System (IDMS), the Identity Proofing and Registration System (IDPRS), or other types of backend repositories are made immediately aware of any changes to the status of a device, a credential, or a user.

Objectives

When an event occurs, an event notification plug-in can perform the following tasks:

• Log the event into a file or into a database

• Send an email message or an SNMP notification

• Notify another application/service through some protocol

• Update IDMS An Identity Management System (IDMS) is a system that manages and protects the identity information of PIV card applicants. The IDMS generally falls within the IDPRS domain./IDPRS data.

Solution

Use the Event Notification Plug-In SPI to develop event notification plug-ins that notify third-party services (for example, an email server, SNMP, or IDMS) when ActivID CMS events such as device issuance, credential revocation, user creation, or approval request occur.

The Event Notification Plug-In SPI allows code from a plug-in to be triggered when such ActivID CMS events occur as the following:

• Device Management events (such as update, bind, recycle, termination, or unlock)

• Credential Management events (such as issuance, revoke, suspend, or resume)

• Request Management events (such as submit or approve)

• User management events (such as create, delete, or terminate)

Examples

Take the case where a specific integration requires an IDMS to be alerted when a device is either issued or terminated for a specific user. For this instance, an event notification plug-in can be written that connects to the IDMS and updates its status when either of these conditions occur.

For More Information

For more information, refer to About the Event Notification Plug-in SPI.