sdkms.v1.models.key_object 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.key_object.KeyObject(name=None, description=None, key_size=None, elliptic_curve=None, acct_id=None, group_id=None, creator=None, kid=None, obj_type=None, key_ops=None, custom_metadata=None, origin=None, pub_key=None, value=None, enabled=None, compliant_with_policies=None, created_at=None, lastused_at=None, transient_key=None, never_exportable=None, rsa=None, bls=None, kcv=None, state=None, history=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, key_size=None, elliptic_curve=None, acct_id=None, group_id=None, creator=None, kid=None, obj_type=None, key_ops=None, custom_metadata=None, origin=None, pub_key=None, value=None, enabled=None, compliant_with_policies=None, created_at=None, lastused_at=None, transient_key=None, never_exportable=None, rsa=None, bls=None, kcv=None, state=None, history=None)[source]

KeyObject - a model defined in Swagger

property acct_id

Gets the acct_id of this KeyObject. Account ID of the account this security object belongs to.

Type: str

Setter:

Sets the acct_id of this KeyObject.

property bls

Gets the bls of this KeyObject.

Type: BlsOptions

Setter:

Sets the bls of this KeyObject.

property compliant_with_policies

Gets the compliant_with_policies of this KeyObject. Whether this security object is compliant with cryptographic policies or not.

Type: bool

Setter:

Sets the compliant_with_policies of this KeyObject.

property created_at

Gets the created_at of this KeyObject. When this security object was created.

Type: str

Setter:

Sets the created_at of this KeyObject.

property creator

Gets the creator of this KeyObject.

Type: CreatorType

Setter:

Sets the creator of this KeyObject.

property custom_metadata

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

Type: map[str]

Setter:

Sets the custom_metadata of this KeyObject.

property description

Gets the description of this KeyObject. Description of the security object.

Type: str

Setter:

Sets the description of this KeyObject.

property elliptic_curve

Gets the elliptic_curve of this KeyObject.

Type: EllipticCurve

Setter:

Sets the elliptic_curve of this KeyObject.

property enabled

Gets the enabled of this KeyObject. Whether this security object has cryptographic operations enabled.

Type: bool

Setter:

Sets the enabled of this KeyObject.

property group_id

Gets the group_id of this KeyObject. Group ID of the security group that this security object belongs to.

Type: str

Setter:

Sets the group_id of this KeyObject.

property history

Gets the history of this KeyObject. When a Key Undo Policy is in place, a list of (non-expired) history items is returned. Each history item represents a passed key state that can be reverted to.

Type: list[HistoryItem]

Setter:

Sets the history of this KeyObject.

property kcv

Gets the kcv of this KeyObject. KCV for the Security Object

Type: str

Setter:

Sets the kcv of this KeyObject.

property key_ops

Gets the key_ops of this KeyObject. Array of key operations enabled for this security object.

Type: list[KeyOperations]

Setter:

Sets the key_ops of this KeyObject.

property key_size

Gets the key_size of this KeyObject. For objects which are not elliptic curves, this is the size in bits (not bytes) of the object. This field is not returned for elliptic curves.

Type: int

Setter:

Sets the key_size of this KeyObject.

property kid

Gets the kid of this KeyObject. Key ID uniquely identifying this security object.

Type: str

Setter:

Sets the kid of this KeyObject.

property lastused_at

Gets the lastused_at of this KeyObject. When this security object was last used.

Type: str

Setter:

Sets the lastused_at of this KeyObject.

property name

Gets the name of this KeyObject. Name of the security object.

Type: str

Setter:

Sets the name of this KeyObject.

property never_exportable

Gets the never_exportable of this KeyObject. True if this key’s operations have never contained EXPORT.

Type: bool

Setter:

Sets the never_exportable of this KeyObject.

property obj_type

Gets the obj_type of this KeyObject.

Type: ObjectType

Setter:

Sets the obj_type of this KeyObject.

property origin

Gets the origin of this KeyObject.

Type: ObjectOrigin

Setter:

Sets the origin of this KeyObject.

property pub_key

Gets the pub_key of this KeyObject. This field is returned only for asymmetric keys. It contains the public key.

Type: bytearray

Setter:

Sets the pub_key of this KeyObject.

property rsa

Gets the rsa of this KeyObject.

Type: RsaOptions

Setter:

Sets the rsa of this KeyObject.

property state

Gets the state of this KeyObject.

Type: KeyObjectState

Setter:

Sets the state of this KeyObject.

property transient_key

Gets the transient_key of this KeyObject. Transient key blob.

Type: str

Setter:

Sets the transient_key of this KeyObject.

property value

Gets the value of this KeyObject. This field is returned only for opaque and secret objects. It contains the contents of the object.

Type: bytearray

Setter:

Sets the value of this KeyObject.