sdkms.v1.models.sobject_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.sobject_request.SobjectRequest(name=None, description=None, key_size=None, pub_exponent=None, elliptic_curve=None, rsa=None, dsa=None, fpe=None, group_id=None, rotation_policy=None, obj_type=None, key_ops=None, custom_metadata=None, value=None, enabled=None, transient=None, deterministic_signatures=None, state=None, activation_date=None, bls=None, deactivation_date=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, pub_exponent=None, elliptic_curve=None, rsa=None, dsa=None, fpe=None, group_id=None, rotation_policy=None, obj_type=None, key_ops=None, custom_metadata=None, value=None, enabled=None, transient=None, deterministic_signatures=None, state=None, activation_date=None, bls=None, deactivation_date=None)[source]

SobjectRequest - a model defined in Swagger

property activation_date

Gets the activation_date of this SobjectRequest. When this object will be activated.

Type: str

Setter:

Sets the activation_date of this SobjectRequest.

property bls

Gets the bls of this SobjectRequest.

Type: BlsOptions

Setter:

Sets the bls of this SobjectRequest.

property custom_metadata

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

Type: map[str]

Setter:

Sets the custom_metadata of this SobjectRequest.

property deactivation_date

Gets the deactivation_date of this SobjectRequest. When this object will be deactivated.

Type: str

Setter:

Sets the deactivation_date of this SobjectRequest.

property description

Gets the description of this SobjectRequest. Description of the security object to create or import.

Type: str

Setter:

Sets the description of this SobjectRequest.

property deterministic_signatures

Gets the deterministic_signatures of this SobjectRequest.

Type: bool

Setter:

Sets the deterministic_signatures of this SobjectRequest.

property dsa

Gets the dsa of this SobjectRequest.

Type: DsaOptions

Setter:

Sets the dsa of this SobjectRequest.

property elliptic_curve

Gets the elliptic_curve of this SobjectRequest.

Type: EllipticCurve

Setter:

Sets the elliptic_curve of this SobjectRequest.

property enabled

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

Type: bool

Setter:

Sets the enabled of this SobjectRequest.

property fpe

Gets the fpe of this SobjectRequest.

Type: FpeOptions

Setter:

Sets the fpe of this SobjectRequest.

property group_id

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

property key_ops

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

property key_size

Gets the key_size of this SobjectRequest. Size in bits (not bytes) of the security object to create or import. Required for symmetric keys. For DSA keys, it represents the size of p; allowed values are 2048 or 3072. Deprecated for RSA keys, specify it in RsaOptions instead.

Type: int

Setter:

Sets the key_size of this SobjectRequest.

property name

Gets the name of this SobjectRequest. Name of the security object to create or import. Security object names must be unique within an account.

Type: str

Setter:

Sets the name of this SobjectRequest.

property obj_type

Gets the obj_type of this SobjectRequest.

Type: ObjectType

Setter:

Sets the obj_type of this SobjectRequest.

property pub_exponent

Gets the pub_exponent of this SobjectRequest. For RSA keys only. Deprecated. Specify in RsaOptions instead. Public exponent to use when generating an RSA key.

Type: int

Setter:

Sets the pub_exponent of this SobjectRequest.

property rotation_policy

Gets the rotation_policy of this SobjectRequest.

Type: RotationPolicy

Setter:

Sets the rotation_policy of this SobjectRequest.

property rsa

Gets the rsa of this SobjectRequest.

Type: RsaOptions

Setter:

Sets the rsa of this SobjectRequest.

property state

Gets the state of this SobjectRequest.

Type: KeyObjectState

Setter:

Sets the state of this SobjectRequest.

property transient

Gets the transient of this SobjectRequest. If this is true, DSM will create a transient key.

Type: bool

Setter:

Sets the transient of this SobjectRequest.

property value

Gets the value of this SobjectRequest. When importing a security object, this field contains the binary contents to import. When creating a security object, this field is unused. The value of an OPAQUE or CERTIFICATE object is always returned. For other objects, the value is returned only with /crypto/v1/keys/export API (if the object is exportable).

Type: bytearray

Setter:

Sets the value of this SobjectRequest.