Profile attributes update
The profile attributes update extension point is triggered in case a user profile attribute is updated. It does not matter whether the attribute update is triggered through the web interface by the user or programmatically through the API. In all cases this extension point is triggered.
The profile attributes update extension point can be used to trigger any action based on a users profile attribute that is updated.
The below list is just an example of the possible use cases for this extension point:
- Synchronizing profile attribute updates with an external system (e.g. a CRM).
- Transforming attributes that were added to a user profile. In case a profile attribute from an external system was added to the user profile you can transform this and for instance break it up into several attributes. E.g. an array of groups can be transformed into separate attributes.
How to implement it
In order to use this extension point you need to implement the
UpdateProfileAttributesExtension interface provided by the Onegini IdP Extension SDK in your extension application.
When the extension point is triggered the updated profile attributes are provided alongside the existing profile of the user.
The optional response object of this extension point can provide updated attributes back to Onegini IdP. These attributes are then added to the user profile again. Only adding or updating existing profile attributes is supported. Removing attributes is currently not supported.
Warning: As a result of providing a response object with updated profile attributes this extension point will be triggered again because you are essentially updating the user profile again. To prevent an infinite loop your extension point implementation is responsible for detecting whether you need to provide a response object with updated attributes or not.