sdkms.v1.models.agree_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

http://www.apache.org/licenses/LICENSE-2.0

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.agree_key_request.AgreeKeyRequest(private_key=None, public_key=None, name=None, group_id=None, key_size=None, key_type=None, mechanism=None, enabled=None, description=None, key_ops=None, custom_metadata=None, transient=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__(private_key=None, public_key=None, name=None, group_id=None, key_size=None, key_type=None, mechanism=None, enabled=None, description=None, key_ops=None, custom_metadata=None, transient=None)[source]: AgreeKeyRequest - a model defined in Swagger

property custom_metadata

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

Type: map[str]

Setter:: Sets the custom_metadata of this AgreeKeyRequest.

property description

Gets the description of this AgreeKeyRequest. Description for the new key.

Type: str

Setter:: Sets the description of this AgreeKeyRequest.

property enabled

Gets the enabled of this AgreeKeyRequest. Whether the derived key should have cryptographic operations enabled.

Type: bool

Setter:: Sets the enabled of this AgreeKeyRequest.

property group_id

Gets the group_id of this AgreeKeyRequest. Group ID (not name) of the security group that this 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 AgreeKeyRequest.

property key_ops

Gets the key_ops of this AgreeKeyRequest. 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 AgreeKeyRequest.

property key_size

Gets the key_size of this AgreeKeyRequest. Key size of the derived key in bits (not bytes).

Type: int

Setter:: Sets the key_size of this AgreeKeyRequest.

property key_type

Gets the key_type of this AgreeKeyRequest.

Type: ObjectType

Setter:: Sets the key_type of this AgreeKeyRequest.

property mechanism

Gets the mechanism of this AgreeKeyRequest.

Type: AgreeKeyMechanism

Setter:: Sets the mechanism of this AgreeKeyRequest.

property name

Gets the name of this AgreeKeyRequest. Name of the agreed-upon key. Key names must be unique within an account. The name is ignored for transient keys and should be the empty string.

Type: str

Setter:: Sets the name of this AgreeKeyRequest.

property private_key

Gets the private_key of this AgreeKeyRequest.

Type: SobjectDescriptor

Setter:: Sets the private_key of this AgreeKeyRequest.

property public_key

Gets the public_key of this AgreeKeyRequest.

Type: SobjectDescriptor

Setter:: Sets the public_key of this AgreeKeyRequest.

property transient

Gets the transient of this AgreeKeyRequest. If this is true, DSM will derive a transient key.

Type: bool

Setter:: Sets the transient of this AgreeKeyRequest.