Plugin Registration

** WARNING: This service is experimental and may change without any notice.

Plugins are OAuth2 clients that have source describing their settings. Although plugins may not necessarily need authorization, they must be registered as OAuth2 clients. OAuth2 client registration describes the registration procedure including the required parameters.

Particularly for plugins, the registration requires parameter source describing the plugin settings. After registration, plugins have to be reviewed by admins and cannot be installed until they are permitted.

To ensure security, Kustvakt only allow confidential plugins for the time being, that requires the plugins to be able to store their credentials (client id and secrets).

Example

Registering a confidential client

curl -v -H "Content-Type: application/json" -H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' -d '{"name":"My plugin","type":"CONFIDENTIAL","description":" a plugin","url":"http://example.plugin.com", "redirect_uri":"http://example.plugin.com/redirect","refresh_token_expiry" : 7776000,"source": {"name":"My plugin"}}' http://localhost:8089/api/v1.0/oauth2/client/register 

Response

{
  "client_id" : "tG6HNFmrt7dm7RHJNmGh9H",
  "client_secret" : "NHInXJ7EmYUiC-EPu18EYg"
}