PingDirectory

Message format

The distinguished name (DN) of a changed entry represents the default key for published messages. This value can be overridden in either of the following ways:

  • With the message-key-attribute property of the Kafka sync destination configuration object

  • With a KafkaSyncDestinationPlugin extension point

The value of the of the message is a JavaScript Object Notation (JSON) object that includes the following fields:

  • type – Type of change, such as ADD, MODIFY, DELETE, or RESYNC.

  • dn – DN of the changed entry.

  • changeID – Unique identifier for the change.

  • modifiedAttributes – List of modified attributes. This field is available only when the type is MODIFY.

  • current – Entry after the change in JSON format. This field is unavailable when the type is DELETE.

    The JSON format of a current entry is compatible with the PingDirectory Directory REST API.

  • previous – Entry before the change in JSON format. This field is unavailable if the type is RESYNC or CREATE.

    The JSON format of a previous entry is compatible with the PingDirectory Directory REST API.