Client SDK Version 1.8.1
Ionic Security client SDK for Python users
|
AgentKeyServicesBase class performs all key related services (create and get) for higher level objects like chunk cipher and file cryto. More...
Public Member Functions | |
def | hasactiveprofile (self) |
Determine if any device profile is active. More... | |
def | getactiveprofile (self) |
Get the current device profile of the agent. More... | |
def | createkey (self, attributesdict=None, metadatadict=None, mutableAttributesdict=None) |
Creates a single protection key with attributes This method must be overridden in a subclass Otherwise, root class version will raise an exception. More... | |
def | createkeys (self, keycount, attributesdict=None, metadatadict=None, mutableAttributesdict=None) |
Creates protection keys. More... | |
def | getkey (self, keyidstring, metadatadict=None) |
Gets a single protection key. More... | |
def | getkeys (self, keyidstringlist, metadatadict=None) |
Gets protection keys. More... | |
def | updatekey (self, keydata, metadatadict=None) |
Updates the Mutable Attributes of a single protection key. More... | |
def | updatekeys (self, keydatalist, metadatadict=None) |
Updates the Mutable Attributes of protection keys. More... | |
AgentKeyServicesBase class performs all key related services (create and get) for higher level objects like chunk cipher and file cryto.
A user may sub class this base class to create their own local key storage services, or the user could use agent.Agent, which uses the Ionic web server to store and create keys.
See also a usage example here: AgentKeyServices Implementors Overview
The interfaces createkey2 and createkeys2 are deprecated and support for them will be removed in a future version.
def ionicsdk.services.AgentKeyServicesBase.createkey | ( | self, | |
attributesdict = None , |
|||
metadatadict = None , |
|||
mutableAttributesdict = None |
|||
) |
Creates a single protection key with attributes This method must be overridden in a subclass Otherwise, root class version will raise an exception.
attributesdict | (KeyAttributesDict, optional): The protection key attributes to use for creating the protection key. |
metadatadict | (MetadataDict, optional): The metadata properties to send along with the request. |
mutableAttributesdict | (KeyAttributesDict, optional): The protection key mutable attributes to use for creating the protection key. |
Reimplemented in ionicsdk.agent.Agent.
def ionicsdk.services.AgentKeyServicesBase.createkeys | ( | self, | |
keycount, | |||
attributesdict = None , |
|||
metadatadict = None , |
|||
mutableAttributesdict = None |
|||
) |
Creates protection keys.
This method must be overridden in a subclass Otherwise, root class version will raise an exception.
keycount | (int): The number of keys to create. |
attributesdict | (KeyAttributesDict, optional): The protection key attributes to use for creating the protection keys. |
metadatadict | (MetadataDict, optional): The metadata properties to send along with the HTTP request. |
mutableAttributesdict | (KeyAttributesDict, optional): The protection key mutable attributes to use for creating the protection key. |
Reimplemented in ionicsdk.agent.Agent.
def ionicsdk.services.AgentKeyServicesBase.getactiveprofile | ( | self | ) |
Get the current device profile of the agent.
Reimplemented in ionicsdk.agent.Agent.
def ionicsdk.services.AgentKeyServicesBase.getkey | ( | self, | |
keyidstring, | |||
metadatadict = None |
|||
) |
Gets a single protection key.
This method must be overridden in a subclass. Otherwise, root class version will raise an exception.
keyidstring | (string): The protection key ID to fetch. |
metadatadict | (MetadataDict, optional): The metadata properties to send along with the HTTP request. |
Reimplemented in ionicsdk.agent.Agent.
def ionicsdk.services.AgentKeyServicesBase.getkeys | ( | self, | |
keyidstringlist, | |||
metadatadict = None |
|||
) |
Gets protection keys.
This method must be overridden in a subclass Otherwise, root class version will raise an exception.
keyidstringlist | (string): The list of protection key IDs to fetch. |
metadatadict | (MetadataDict, optional): The metadata properties to send along with the HTTP request. |
Reimplemented in ionicsdk.agent.Agent.
def ionicsdk.services.AgentKeyServicesBase.hasactiveprofile | ( | self | ) |
Determine if any device profile is active.
Reimplemented in ionicsdk.agent.Agent.
def ionicsdk.services.AgentKeyServicesBase.updatekey | ( | self, | |
keydata, | |||
metadatadict = None |
|||
) |
Updates the Mutable Attributes of a single protection key.
This method must be overridden in a subclass. Otherwise, root class version will raise an exception.
keydata | (KeyData): The protection key data with modified Mutable Attributes to update. |
metadatadict | (MetadataDict, optional): The metadata properties to send along with the HTTP request. |
Reimplemented in ionicsdk.agent.Agent.
def ionicsdk.services.AgentKeyServicesBase.updatekeys | ( | self, | |
keydatalist, | |||
metadatadict = None |
|||
) |
Updates the Mutable Attributes of protection keys.
This method must be overridden in a subclass Otherwise, root class version will raise an exception.
keydatalist | (KeyDataList): The list of protection keys with modified Mutable Attributes to update. |
metadatadict | (MetadataDict, optional): The metadata properties to send along with the HTTP request. |
Reimplemented in ionicsdk.agent.Agent.
You acknowledge your access, review and use of the documentation on this page is subject to the Ionic Security Inc. Documentation Use Rights.
© 2016-2020 Ionic Security Inc. All rights reserved.
Generated on Mon Oct 5 2020 11:07:00 for Client SDK Version 1.8.1 by
1.8.18