Machina Client SDK Version 2.1.2
Ionic Security Machina Client SDK for Python users
Classes | Public Member Functions | Public Attributes | List of all members
ionicsdk.agent.CreateKeysRequest Class Reference

Class used to request multiple keys with varying attributes. More...

Inheritance diagram for ionicsdk.agent.CreateKeysRequest:

Classes

class  KeyRequest
 Inner class for CreateKeyRequest to hold groups of counts and attributes. More...
 

Public Member Functions

def __init__ (self, metadata=None, simulate=False)
 Constructor for CreateKeyRequest. More...
 
def addkeyrequest (self, ref, count, attributes, mutableattributes=None)
 Method for adding a request for a number of keys with given attributes to the multiple key request. More...
 

Public Attributes

 metadata
 (dict) metadata associated with the request
 
 simulate
 (bool) whether to check if the key is retrievable, or actually retrieve it.
 
 keys
 (list) list of keys to request
 

Detailed Description

Class used to request multiple keys with varying attributes.

Constructor & Destructor Documentation

◆ __init__()

def ionicsdk.agent.CreateKeysRequest.__init__ (   self,
  metadata = None,
  simulate = False 
)

Constructor for CreateKeyRequest.

Parameters
metadata(MetadataDict) Optional metadata to add to the call
simulate(boolean) If true, allows for testing of whether a create call would succeed without creating any keys. The response will contain keys that are allowed to be created with empty ID and key byte values.

Member Function Documentation

◆ addkeyrequest()

def ionicsdk.agent.CreateKeysRequest.addkeyrequest (   self,
  ref,
  count,
  attributes,
  mutableattributes = None 
)

Method for adding a request for a number of keys with given attributes to the multiple key request.

Parameters
ref(String) A string value that will be included with the created keys that can be used to match them with the provided attributes
count(int) The number of keys with the given attributes to be created
attributes(KeyAttributesDict) The attributes to be set for these keys
mutableattributes(KeyAttributesDict) The mutable attributes to be set for these keys
Returns
None

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