sdkms.v1.apis.plugins_api module

Fortanix DSM REST API

This is a set of REST APIs for accessing the Fortanix Data Security Manager. This includes APIs for managing accounts, and for performing cryptographic and key management operations.

OpenAPI spec version: 1.0.0-20200608 Contact: support@fortanix.com Generated by: https://github.com/swagger-api/swagger-codegen.git

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class sdkms.v1.apis.plugins_api.PluginsApi(api_client=None)[source]

Bases: object

__init__(api_client=None)[source]
create_plugin(body, async_call=False, **kwargs)[source]

Create a new plugin with the specified properties.

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • body (PluginRequest) – Properties of plugin to create (required)

Return type:

Plugin

Returns:

If the method is called asynchronously, returns the request thread.

delete_plugin(plugin_id, async_call=False, **kwargs)[source]

Remove a plugin from SDKMS.

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • plugin_id (str) – Plugin Identifier (required)

Return type:

None

Returns:

If the method is called asynchronously, returns the request thread.

get_plugin(plugin_id, async_call=False, **kwargs)[source]

Look up plugin by plugin ID.

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • plugin_id (str) – Plugin Identifier (required)

Return type:

Plugin

Returns:

If the method is called asynchronously, returns the request thread.

get_plugins(group_id=None, sort=None, start=None, limit=None, offset=None, async_call=False, **kwargs)[source]

Get details of all plugins the current user has access to.

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • group_id (str) – Only retrieve plugins in the specified group.

  • sort (str) – This specifies the property (plugin_id only, for now) and order (ascending or descending) with which to sort the apps. By default, plugins are sorted by plugin_id in ascending order. The syntax is “<property>:[asc|desc]” (e.g. “plugin_id:desc”) or just “<property>” (ascending order by default).

  • start (str) – If provided, this must be a value of the property specified in sort. Returned apps will begin just above or just below this value (for asc/desc order resp.).

  • limit (int) – Maximum number of apps to return. If not provided, the limit is 100.

  • offset (int) – Number of apps past start to skip.

Return type:

list[Plugin]

Returns:

If the method is called asynchronously, returns the request thread.

invoke_plugin(plugin_id, body, async_call=False, **kwargs)[source]

Invokes a plugin execution with the provided request body as input to the plugin.

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • plugin_id (str) – Plugin Identifier (required)

  • body (PluginInvokeRequest) – Object to be passed to plugin as input (required)

Return type:

PluginInvokeResponse

Returns:

If the method is called asynchronously, returns the request thread.

sys_v1_plugins_invoke_plugin_id_get(plugin_id, async_call=False, **kwargs)[source]

Invokes a plugin with empty input.

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • plugin_id (str) – Plugin Identifier (required)

Return type:

PluginInvokeResponse

Returns:

If the method is called asynchronously, returns the request thread.

update_plugin(plugin_id, body, async_call=False, **kwargs)[source]

Change a plugin’s properties, such as name, description, code, or group membership.

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • plugin_id (str) – Plugin Identifier (required)

  • body (PluginRequest) – Properties of plugin to create (required)

Return type:

App

Returns:

If the method is called asynchronously, returns the request thread.