Skip to content

Plugin List

Eliza Margaretha Illig edited this page Jun 12, 2024 · 7 revisions

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

List all plugins registered by all users (marketplace) including those that have not been reviewed by administrators and thus they cannot be installed yet. The list can be filtered by using permitted-only parameter restricting to only those that have been reviewed and can be installed.

Registration information is shown only for owned registered plugins.

Available in: full version

Method: POST

Service URL: root/plugins

Parameters

Header Parameters

Name Required Authentication scheme 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
permitted_only no Determines if only permitted plugins should be listed or not. Default: false (All registered plugins will listed) Boolean

Examples

Request

Listing all registered plugins regardless their permitted status

curl -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' -d 'super_client_id=fCBbQkAyYzI4NzUxMg&super_client_secret=secret' http://localhost:8089/api/v1.0/plugins

Listing only permitted plugins

curl -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' -d 'super_client_id=fCBbQkAyYzI4NzUxMg&super_client_secret=secret&permitted_only=true' http://localhost:8089/api/v1.0/plugins

Response

[ {
  "source" : {
    "plugin" : "source"
  },
  "permitted" : false,
  "super" : false,
  "client_id" : "N9LHnbtL6RLmNJLfNFpRpm",
  "client_name" : "Plugin",
  "client_type" : "CONFIDENTIAL",
  "client_description" : "This is a plugin test client.",
  "registration_date" : "2024-06-06T12:16:58.885+02:00[Europe/Berlin]",
  "registered_by" : "plugin-user",
  "refresh_token_expiry" : 7776000
}, {
  "source" : {
    "key" : "value"
  },
  "permitted" : true,
  "super" : false,
  "client_id" : "52atrL0ajex_3_5imd9Mgw",
  "client_name" : "confidential client 2",
  "client_type" : "CONFIDENTIAL",
  "client_description" : "Nonsuper confidential client plugin without redirect URI",
  "client_url" : "http://example.client.de"
}, {
  "source" : {
    "key" : "value"
  },
  "permitted" : true,
  "super" : false,
  "client_id" : "8bIDtZnH6NvRkW2Fq",
  "client_name" : "public client plugin with redirect uri",
  "client_type" : "PUBLIC",
  "client_description" : "Public client plugin with a registered redirect URI",
  "client_url" : "http://third.party.client.com"
} ]

Advanced Setting

Developer Setting

Search services

Metadata services

Authentication and Authorization services

Client services

Super client services

Plugin services

User services

User group services

Virtual corpus services

Virtual corpus access services

Administrative services

Description services

Clone this wiki locally