sdkms.v1.models.derive_key_request_ex 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.derive_key_request_ex.DeriveKeyRequestEx(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__(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]

DeriveKeyRequestEx - a model defined in Swagger

property custom_metadata

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

Type: map[str]

Setter:

Sets the custom_metadata of this DeriveKeyRequestEx.

property description

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

Type: str

Setter:

Sets the description of this DeriveKeyRequestEx.

property enabled

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

Type: bool

Setter:

Sets the enabled of this DeriveKeyRequestEx.

property group_id

Gets the group_id of this DeriveKeyRequestEx. 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 DeriveKeyRequestEx.

property key

Gets the key of this DeriveKeyRequestEx.

Type: SobjectDescriptor

Setter:

Sets the key of this DeriveKeyRequestEx.

property key_ops

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

property key_size

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

Type: int

Setter:

Sets the key_size of this DeriveKeyRequestEx.

property key_type

Gets the key_type of this DeriveKeyRequestEx.

Type: ObjectType

Setter:

Sets the key_type of this DeriveKeyRequestEx.

property mechanism

Gets the mechanism of this DeriveKeyRequestEx.

Type: DeriveKeyMechanism

Setter:

Sets the mechanism of this DeriveKeyRequestEx.

property name

Gets the name of this DeriveKeyRequestEx. Name of the derived key. Key names must be unique within an account.

Type: str

Setter:

Sets the name of this DeriveKeyRequestEx.

property transient

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

Type: bool

Setter:

Sets the transient of this DeriveKeyRequestEx.