Skip to main content

register_auth

Register security serializer.

def register_auth(
key: string = None,
key_password: string = None,
cert: string = None,
store: string = None,
digest: string = DEFAULT_SECURITY_DIGEST,
serializer: string = 'json'
) - > null

Register security serializer.

Parameters

NameTypeDescription
keystring = NoneThe private key used for signing messages.
key_passwordstring = NoneThe passphrase required to decrypt the private key.
certstring = NoneThe certificate used for verifying message signatures.
storestring = NoneThe path to the file system certificate store.
digeststring = DEFAULT_SECURITY_DIGESTThe hashing algorithm used for message digests.
serializerstring = 'json'The underlying serialization format, such as 'json' or 'pickle'.

Returns

TypeDescription
nullNothing is returned; the serializer is registered globally within the registry.