sdkms.v1.apis.apps_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.apps_api.AppsApi(api_client=None)[source]

Bases: object

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

Create a new application with the specified properties.

Parameters:

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

  • body (AppRequest) – Properties of application to create (required)

Return type:

App

Returns:

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

delete_app(app_id, async_call=False, **kwargs)[source]

Remove an application from SDKMS.

Parameters:

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

  • app_id (str) – Application Identifier (required)

Return type:

None

Returns:

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

get_app(app_id, async_call=False, **kwargs)[source]

Look up an application by application ID.

Parameters:

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

  • app_id (str) – Application Identifier (required)

Return type:

App

Returns:

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

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

Get details of all applications 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 applications in the specified group.

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

Returns:

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

get_credential(app_id, async_call=False, **kwargs)[source]

Retrieve the authentication credential (API key or certificate) for a particular application. Only users who are an administrator of at least one of the application’s groups can retrieve the credential.

Parameters:

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

  • app_id (str) – Application Identifier (required)

Return type:

AppCredentialResponse

Returns:

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

regenerate_api_key(app_id, body, async_call=False, **kwargs)[source]

Create a new API key for an application. An application may only have one valid API key at a time, so performing this action will invalidate all old API keys. This does not invalidate existing sessions, so any applications with an existing open session will be able to continue operating with their old session until those sessions expire.

Parameters:

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

  • app_id (str) – Application Identifier (required)

  • body (AppResetSecretRequest) – Decryption request (required)

Return type:

App

Returns:

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

update_app(app_id, body, async_call=False, **kwargs)[source]

Change an application’s properties, such as name, description, or group membership.

Parameters:

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

  • app_id (str) – Application Identifier (required)

  • body (AppRequest) – Properties of application to create (required)

Return type:

App

Returns:

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