-
Notifications
You must be signed in to change notification settings - Fork 3
Plugin Installation
Eliza Margaretha edited this page Feb 10, 2023
·
8 revisions
If registered plugins have been reviewed by administrators and are permitted to be used within the super client, they can be installed by any users in a super client.
Available in: full version
Method: POST
Service URL: root/plugins/install
Header Parameters
| Name | Required | Description | Value |
|---|---|---|---|
| Authorization | yes | HTTP authentication with scheme: Bearer | OAuth2 access token |
| Content-Type | yes | content type of the input data | application/x-www-form-urlencoded |
Request body URL-encoded form parameters
| Name | Required | Description | Type |
|---|---|---|---|
| super_client_id | yes | A super client identifier obtained on client registration. | String |
| super_client_secret | yes | A super client secret obtained on client registration. | String |
| client_id | yes | the identifier of the client to be installed | String |
curl -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' -d 'super_client_id=fCBbQkAyYzI4NzUxMg&super_client_secret=secret&client_id=52atrL0ajex_3_5imd9Mgw' http://localhost:8089/api/v1.0/plugins/install
Successful installation
-
super_client_idindicates where the plugin has been installed.
{
"name": "Confidential plugin",
"description": "Example confidential plugin",
"url": "https://confidential.plugin.com",
"client_id": "52atrL0ajex_3_5imd9Mgw",
"super_client_id": "fCBbQkA2YzIxYmY1Ng==",
"installed_date": "2022-05-06T09:21:19.452+02:00[Europe/Berlin]"
}
Installing unpermitted plugin
- Only plugins that have been reviewed and permitted by administrators, can be installed.
{
"errors": [
[
1850,
"Plugin is not permitted",
"JpmdMRPt7796HpMpHRGHrr"
]
]
}
Redundant installation
- Plugins can only be installed once by a user within a super client.
{
"errors": [
[
1851,
"Plugin has been installed",
"52atrL0ajex_3_5imd9Mgw"
]
]
}
- Setting LDAP
- Setting initial super client
- Setting a custom environment
- Setting resources for CLARIN FCS
- Disabling query rewrites
- Named virtual corpora
- Importing Kustvakt to Eclipse
- Installing Lombok
- Setting annotation processors
- Setting a test environment
- HTTP Basic Authentication
- OAuth2 authorization scopes
- OAuth2 authorization request
- OAuth2 token request
- OAuth2 token revocation
- OAuth2 client registration
- OAuth2 client info
- OAuth2 client deregistration
- OAuth2 client secret reset
- Plugin registration
- Plugin list (marketplace)
- Plugin installation
- Plugin uninstallation
- Installed plugin list
- VC creation and update
- VC deletion
- VC list
- VC info
- VC KoralQuery
- VC statistics
- VC statistics with KoralQuery