Plugins

📄️Add a plugin template to an organization

Add a template to an organization. Only one template for a plugin can be assigned to an organization at the same time. An organization-specific template will override any global templates.

📄️Get a template for a plugin

Retrieve the template with the given name for a specific plugin type and ID.

📄️Update the options of a plugin template

Update the options of a plugin template.

📄️Create a new plugin template

Create a new plugin template.

📄️Delete a plugin template

Delete a plugin template for a specific plugin. This will remove the template and its configuration.

📄️Disable a global plugin template

Disable a global plugin template for a specific plugin. This will disable the template globally, but it can still be used in organization-specific configurations.

📄️Disable an ORT plugin globally

Disable an ORT plugin globally to make it generally unavailable.

📄️Enable a global plugin template

Enable a global plugin template for a specific plugin. This will enable the template globally for all organizations, but it can still be overwritten by organization-specific templates.

📄️Enable an ORT plugin globally

Enable an ORT plugin globally to make it generally available to all organizations.

📄️Get the plugins available as global default plugins

Get the plugins that can be configured as global default plugins. These are all plugins that are not disabled, and the report definitions from the admin configuration of the default config context.

📄️Get the global default plugins

Get the plugins that are enabled by default for all categories, unless an organization configures its own defaults. If no global defaults are configured for a category, the built-in defaults are returned. The built-in defaults for project scanners are the default package scanners.

📄️Get installed ORT plugins

Get a list with detailed information about all installed ORT plugins.

📄️Get the default plugins of an organization

Get the plugins that are enabled by default for all categories for an organization. If the organization does not configure its own defaults for a category, the global defaults are returned, or the built-in defaults if no global defaults are configured. The source of the defaults is part of the response. The returned plugins are not filtered by their availability.

📄️Get all templates for a plugin

Retrieve the templates for a specific plugin type and ID.

📄️Remove a plugin template from an organization

Remove a plugin template from an organization. If any global templates are enabled for the plugin, they will now apply to the organization.

📄️Set the global default plugins of a category

Set the plugins of a category that are enabled by default, unless an organization configures its own defaults. For plugin types where the order matters, like package curation providers and package configuration providers, the plugins are used in the given order. For reporters, the names of report definitions from the admin configuration of the default config context can be used as well.

📄️Reset the global default plugins of a category

Reset the global default plugins of a category, so that the built-in defaults are used.

📄️Set the default plugins of a category for an organization

Set the plugins of a category that are enabled by default for an organization. This overrides the global defaults. Only plugins that are available for the organization can be used. For plugin types where the order matters, like package curation providers and package configuration providers, the plugins are used in the given order. For reporters, the names of report definitions from the admin configuration of the default config context can be used as well.

📄️Reset the default plugins of a category for an organization

Reset the default plugins of a category for an organization, so that the global defaults are used.

📄️Restrict an ORT plugin to organizations with a template

Restrict an ORT plugin to make it available only to organizations that have a plugin template assigned.