sdkms.v1.models.persist_transient_key_request 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.models.persist_transient_key_request.PersistTransientKeyRequest(name=None, description=None, custom_metadata=None, enabled=None, key_ops=None, group_id=None, transient_key=None)[source]

Bases: object

swagger_types

The key is attribute name and the value is attribute type.

Type:

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type:

dict

__init__(name=None, description=None, custom_metadata=None, enabled=None, key_ops=None, group_id=None, transient_key=None)[source]

PersistTransientKeyRequest - a model defined in Swagger

property custom_metadata

Gets the custom_metadata of this PersistTransientKeyRequest. User-defined metadata for the persisted key. Stored as key-value pairs.

Type: map[str]

Setter:

Sets the custom_metadata of this PersistTransientKeyRequest.

property description

Gets the description of this PersistTransientKeyRequest. Description of the persisted security object.

Type: str

Setter:

Sets the description of this PersistTransientKeyRequest.

property enabled

Gets the enabled of this PersistTransientKeyRequest. Whether the new security object should be enabled. Disabled security objects may not perform cryptographic operations.

Type: bool

Setter:

Sets the enabled of this PersistTransientKeyRequest.

property group_id

Gets the group_id of this PersistTransientKeyRequest. Group ID (not name) of the security group that the persisted security object should belong to. The user or application creating this security object must be a member of this group. If no group is specified, the default group for the user or application will be used.

Type: str

Setter:

Sets the group_id of this PersistTransientKeyRequest.

property key_ops

Gets the key_ops of this PersistTransientKeyRequest. Optional array of key operations to be enabled for this security object. If this property is not provided, the DSM server will provide a default set of key operations. Note that if you provide an empty array, all key operations will be disabled.

Type: list[KeyOperations]

Setter:

Sets the key_ops of this PersistTransientKeyRequest.

property name

Gets the name of this PersistTransientKeyRequest. Name of the persisted security object. Security object names must be unique within an account.

Type: str

Setter:

Sets the name of this PersistTransientKeyRequest.

property transient_key

Gets the transient_key of this PersistTransientKeyRequest. Transient key blob.

Type: str

Setter:

Sets the transient_key of this PersistTransientKeyRequest.