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.
- Define a new Server in Registry.
- Servers > Add a New Server
- Server Type: HTTP
- On the next page, configure the Server as follows
- Set the Server URL to the endpoint where the message will be set. More details below.
- Set the Username and Password as needed.
- Configure a new Provisioning Target in Registry.
- Configuration > Provisioning Targets > Add Provisioning Target
- Plugin: ApiProvisioner
- On the next page, set the following:
- Select the Server created in the previous step.
- Select the Protocol Mode
- 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
- Include Attributes must be set, not including attributes is not yet supported.
- Configuration > Provisioning Targets > Add Provisioning Target
Message Format
XXX link to json schema file
See Also
- cm_co_api_provisioner_targets