The Identifier Collector is an Enrollment Flow Plugin that records the authenticated Identifier of the Enrollee and attaches it to the Person record.

Configuration

  1. When adding a new Enrollment Flow Step, the Plugin is CoreEnroller.IdentifierCollectors.
  2. The Actor Type should be Enrollee.
  3. The Type will be assigned to the Identifier collected by this Plugin.

(info) The Identifier Collector is designed to be used only once per Enrollment Flow. A Petition can not have multiple Identifier Collector steps.

Usage

When the Enrollment Flow transitions to the Identifier Collector step, authentication will be triggered if it has not already happened. (It may be desirable to advise the Enrollee that they will be required to authenticate to continue.) After authentication, the value of $REMOTE_USER will be stored in the Petition.

(info) It is not possible to change the name of the variable, for more sophisticated use cases, use EnvSource instead.

When the Petition is finalized, the collected Identifier will be attached to the Person record as a login Identifier.

See Also

Changes From Earlier Versions

As of Registry v5.1.0

  • The Identifier type can be configured. Previously, collected Identifiers were always assigned ePPN.

Invitation Accepter was not available in Registry v5.0.x.

  • No labels