Skip to main content

Extensions

note

Fabulous New Accommodations

This section describes the creation and deployment of a custom HYPR Extension. Articles on prefabricated HYPR Extensions and Plugins have been permanently relocated to our Knowledge Base under Identity Providers:

An extension is a workflow integration mechanism for the Control Center (CC). It aims to facilitate integrations with external systems at key pre-determined points in the registration and authentication lifecycle.

For example, once the user is successfully registered, we might want to update the user record in an external system. We can write an extension which receives a registration callback and calls out to the external system

An extension is not an external process. It is a Java .jar which runs in process with the CC and is managed via the CC UI. This eliminates the need to manage separate processes.

Each extension is uniquely identified by anExtensionId. The CC manages extensions at a global level. Once an extension is deployed, it may be associated with one or more RPApplication via the CC web UI.

Workflow​

Structure​

An extension is a container for one or more extension points. An extension point:

  • is where we specify the logic to execute
  • contains a series of callbacks invoked by the CC
  • contains configuration callback invoked by the CC

Upon execution, an extension method can:

  • execute desired logic or calls to external systems
  • return a response indicating success or failure
  • throw an exception, which is considered an execution failure
note

Extension vs. ExtensionPoint

  • Extension is the top level container
  • ExtensionPoint contains the business logic
  • Extension contains one or many of ExtensionPoint