Machina Client SDK Version 2.1.2
Ionic Security Machina Client SDK for Python users
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
ionicsdk.keyvault.KeyVaultKeyRecord Class Reference
Inheritance diagram for ionicsdk.keyvault.KeyVaultKeyRecord:

Public Member Functions

def __init__ (self, keyid, keyBytes, attributes, mutableAttributes, obligations, issuedServerTimeUtcSeconds, expirationServerTimeUtcSeconds, state)
 Constructs key vault record from passed in arguments. More...
 

Public Attributes

 keyid
 (string) The Key ID or identifying tag
 
 keyBytes
 (bytearray) The Key data
 
 attributes
 (dict of lists) - Protection key attributes. More...
 
 mutableAttributes
 (dict of lists) - mutable protection key attributes. More...
 
 obligations
 (dict of lists) - Used to store protection key policy obligations. More...
 
 issuedServerTimeUtcSeconds
 (int) The time at which this key was issued, measured in UTC seconds according to server time.
 
 expirationServerTimeUtcSeconds
 (int) nExpirationServerTimeUtcSeconds The time at which this key expires, measured in UTC seconds according to server time.
 
 state
 (Enum) This is ONLY set on KeyVaultCustom callbacks and is otherwise unused. More...
 

Static Public Attributes

int ISKR_INVALID = 0
 (int) Key Vault Record State Enumeration - invalid
 
int ISKR_ADDED = 1
 (int) Key Vault Record State Enumeration - recently added, not yet stored
 
int ISKR_REMOVED = 2
 (int) Key Vault Record State Enumeration - recently removed, not yet remove from the store
 
int ISKR_UPDATED = 3
 (int) Key Vault Record State Enumeration - recently updated, changes not yet stored
 
int ISKR_STORED = 4
 (int) Key Vault Record State Enumeration - no changes since last stored in the vault
 

Detailed Description

Class pass key information in and out of the Key Vaults.

Constructor & Destructor Documentation

◆ __init__()

def ionicsdk.keyvault.KeyVaultKeyRecord.__init__ (   self,
  keyid,
  keyBytes,
  attributes,
  mutableAttributes,
  obligations,
  issuedServerTimeUtcSeconds,
  expirationServerTimeUtcSeconds,
  state 
)

Constructs key vault record from passed in arguments.

Parameters
keyid(string) The Key ID or identifying tag
keyBytes(bytearray) The Key data
attributes(dict of lists) - Protection key attributes.
mutableAttributes(dict of lists) - mutable protection key attributes.
obligations(dict of lists) - Used to store protection key policy obligations.
issuedServerTimeUtcSeconds(int) The time at which this key was issued, measured in UTC seconds according to server time.
expirationServerTimeUtcSeconds(int) nExpirationServerTimeUtcSeconds The time at which this key expires, measured in UTC seconds according to server time.
state(Enum) This is ONLY set on KeyVaultCustom callbacks and is otherwise unused. See KeyVaultCustom class for details.

Member Data Documentation

◆ attributes

ionicsdk.keyvault.KeyVaultKeyRecord.attributes

(dict of lists) - Protection key attributes.

For example, when creating key(s), key attributes (both immutable and mutable) can be provided for the keys being created. The attributes used (if any) when creating key(s) will also be given back when retrieving the keys.

◆ mutableAttributes

ionicsdk.keyvault.KeyVaultKeyRecord.mutableAttributes

(dict of lists) - mutable protection key attributes.

For example, when creating key(s), key attributes (both immutable and mutable) can be provided for the keys being created. The attributes used (if any) when creating key(s) will also be given back when retrieving the keys.

◆ obligations

ionicsdk.keyvault.KeyVaultKeyRecord.obligations

(dict of lists) - Used to store protection key policy obligations.

For example, when retrieving a key with GetKey(), policy obligations associated with the retrieved key will be represented here.

◆ state

ionicsdk.keyvault.KeyVaultKeyRecord.state

(Enum) This is ONLY set on KeyVaultCustom callbacks and is otherwise unused.

See KeyVaultCustom class for details.


The documentation for this class was generated from the following file: