The API Provisioning Plugin provisions CO Person records to a RESTful or messaging endpoint. |
Registry CO Person Transaction | Message 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 |
*See URL Construction and Message Format below for additional information
Registry CO Group Transaction | Message Action |
---|---|
Add | None |
Edit | None |
Delete | None |
Manual Provision | None |
This is a non-core plugin, see Installing and Enabling Registry Plugins for more information.
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.
The Username and Password are sent to the server using Basic Auth. As such, the use of HTTPS is strongly recommended.
The URL is constructed as the Server URL with an appended trailing slash (/
).
POST https://myserver.nil/rest/upload/ |
The URL is constructed as the Server URL with an appended trailing slash (/
) and the Identifier of the configured type.
On a delete action, the HTTP method will be DELETE
instead of PUT
.
|
The message is sent to the URL endpoint with a Content-Type
of application/json
.
The message body is described using JSON Schema:
When the Protocol Mode is HTTP PUT and the action being handled is Delete CO Person, no message body is sent.
The HTTP Response Code is examined for successful processing of the message. Any 200 series response is considered successful receipt of the message.
The ApiProvisioner Plugin does not currently expect any message body in the response from the endpoint.