Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

About

The Plugin Open URL Authorization API allows for the listing of all new URL endpoints introduced by all installed plugins, and returns whether authentication is required to access these URLs. This API can also be used to update these requirements.

API Spec

"], "summary": "Gets the plugin open URL configuration.", "description": "Returns plugin open URL configuration for this installation.", "operationId": "getPluginOpenUrlsConfigurationUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "An array of properties", "schema": { "type": "object", "additionalProperties": {"type": "object"} } }, "401": {"description": "Unauthorized"}, "500": {"description": "Unexpected error"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } }, "post": { "tags": ["plugin-open-urls-configuration-api"], "summary": "Sets the plugin open URL configuration.", "description": "Sets plugin open URL configuration for this installation.", "operationId": "setPluginOpenUrlsConfigurationUsingPOST", "consumes": ["application/json"], "produces": ["*/*"], "parameters": [{ "in": "body", "name": "config", "description": "config", "required": true, "schema": { "type": "object", "additionalProperties": {"type": "boolean"} } }], "responses": { "200": {"description": "OK"}, "201": {"description": "Created"}, "401": {"description": "Unauthorized"}, "500": {"description": "Unexpected error"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, } }
Open API Documentation
filterplugin-open-urls-configuration-api
supportedSubmitMethodsnone
urlhttps://www.xnat.org/api/xnat-180.json