sdkms.v1.apis.approval_requests_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.approval_requests_api.ApprovalRequestsApi(api_client=None)[source]

Bases: object

__init__(api_client=None)[source]
approve(request_id, body=None, async_call=False, **kwargs)[source]
Parameters:

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

  • request_id (str) – Approval Request Identifier (required)

  • body (ApproveRequest) – Approve an approval request

Return type:

None

Returns:

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

create_approval_request(body, async_call=False, **kwargs)[source]
Parameters:

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

  • body (ApprovalRequestRequest) – Request to create an approval request. (required)

Return type:

ApprovalRequest

Returns:

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

delete_approval_request(request_id, async_call=False, **kwargs)[source]
Parameters:

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

  • request_id (str) – Approval Request Identifier (required)

Return type:

None

Returns:

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

deny(request_id, async_call=False, **kwargs)[source]
Parameters:

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

  • request_id (str) – Approval Request Identifier (required)

Return type:

None

Returns:

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

get_approval_request(request_id, async_call=False, **kwargs)[source]

Get the details and status of a particular approval request.

Parameters:

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

  • request_id (str) – Approval Request Identifier (required)

Return type:

ApprovalRequest

Returns:

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

get_approval_requests(requester=None, reviewer=None, subject=None, status=None, async_call=False, **kwargs)[source]
Parameters:

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

  • requester (str) – Only retrieve approval requests with the specified requester ID

  • reviewer (str) – Only retrieve approval requests with the specified reviewer ID

  • subject (str) – Only retrieve approval requests with the specified subject ID

  • status (str) – Only retrieve approval requests with the specified approval status

Return type:

list[ApprovalRequest]

Returns:

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

get_result(request_id, async_call=False, **kwargs)[source]
Parameters:

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

  • request_id (str) – Approval Request Identifier (required)

Return type:

ApprovableResult

Returns:

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