The API Provisioning Plugin provisions CO Person records to a RESTful or messaging endpoint.

Operations

Registry CO Person Transaction

Crowd Action

Add

Send person object

Edit

Send person object

Enter Grace Period

Send person object

Expiration / Becomes Inactive

Send person object

Unexpire / Becomes Active

Send person object

Delete

Send person object with deleted flag

Manual Provision

Send person object


Registry CO Group Transaction

Crowd Action

Add

No actions

Edit

No actions

Delete

No actions

Manual Provision

No actions

Installation

This is a non-core plugin, see Installing and Enabling Registry Plugins for more information.

Configuration

Currently, the ApiProvisioner Plugin only supports sending a JSON message (format defined below) to a designated RESTful endpoint. Future versions may support additional formats and/or other protocols.

  1. Define a new Server in Registry.
    1. Servers > Add a New Server
    2. Server Type: HTTP
    3. On the next page, configure the Server as follows
      1. Set the Server URL to the endpoint where the message will be set. More details below.
      2. Set the Username and Password as needed.
  2. Configure a new Provisioning Target in Registry.
    1. Configuration > Provisioning Targets > Add Provisioning Target
      1. Plugin: ApiProvisioner
      2. On the next page, set the following:
        1. Select the Server created in the previous step.
        2. Select the Protocol Mode
        3. Set the Identifier Type that will be used as the person's unique identifier. This will be included in the JSON message body (described below). In addition, if Protocol Mode is set to HTTP PUT, the identifier will be appended to the URL
        4. Include Attributes must be set, not including attributes is not yet supported.

Message Format

XXX link to json schema file

See Also