signer.serializers
==================

.. py:module:: signer.serializers

.. autoapi-nested-parse::

   Serializers for Signer-related API endpoints.





Module Contents
---------------

.. py:class:: SignerSerializer(instance=None, data=empty, **kwargs)

   Bases: :py:obj:`rest_framework.serializers.ModelSerializer`\ [\ :py:obj:`signer.models.SignerModel`\ ]


   Serializer for Signer instances.


   .. py:attribute:: certificate_cn


   .. py:attribute:: certificate_not_valid_after


   .. py:attribute:: signature_suite


   .. py:class:: Meta

      Metadata for SignerSerializer, defining model and serialized fields.


      .. py:attribute:: model


      .. py:attribute:: fields
         :type:  ClassVar[list[str]]
         :value: ['id', 'unique_name', 'certificate_cn', 'certificate_not_valid_after', 'signature_suite',...



      .. py:attribute:: read_only_fields
         :type:  ClassVar[list[str]]
         :value: ['id', 'unique_name', 'certificate_cn', 'certificate_not_valid_after', 'signature_suite',...




.. py:class:: SignHashRequestSerializer(instance=None, data=empty, **kwargs)

   Bases: :py:obj:`rest_framework.serializers.Serializer`\ [\ :py:obj:`Any`\ ]


   Serializer for sign hash request.


   .. py:attribute:: signer_id


   .. py:attribute:: hash_value


   .. py:method:: validate_signer_id(value)

      Validate that the signer exists.



   .. py:method:: validate_hash_value(value)

      Validate that the hash value is a valid hexadecimal string.



.. py:class:: SignHashResponseSerializer(instance=None, data=empty, **kwargs)

   Bases: :py:obj:`rest_framework.serializers.Serializer`\ [\ :py:obj:`Any`\ ]


   Serializer for sign hash response.


   .. py:attribute:: signer_id


   .. py:attribute:: signer_name


   .. py:attribute:: hash_algorithm


   .. py:attribute:: hash_value


   .. py:attribute:: signature


   .. py:attribute:: signed_message_id


   .. py:attribute:: created_at


.. py:class:: SignerCertificateSerializer(instance=None, data=empty, **kwargs)

   Bases: :py:obj:`rest_framework.serializers.Serializer`\ [\ :py:obj:`Any`\ ]


   Serializer for signer certificate response.


   .. py:attribute:: signer_id


   .. py:attribute:: signer_name


   .. py:attribute:: certificate_pem


.. py:class:: SignedMessageSerializer(instance=None, data=empty, **kwargs)

   Bases: :py:obj:`rest_framework.serializers.ModelSerializer`\ [\ :py:obj:`signer.models.SignedMessageModel`\ ]


   Serializer for SignedMessage instances.


   .. py:attribute:: signer_name


   .. py:class:: Meta

      Metadata for SignedMessageSerializer, defining model and serialized fields.


      .. py:attribute:: model


      .. py:attribute:: fields
         :type:  ClassVar[list[str]]
         :value: ['id', 'signer', 'signer_name', 'hash_value', 'signature', 'created_at']



      .. py:attribute:: read_only_fields
         :value: ['id', 'signer', 'signer_name', 'hash_value', 'signature', 'created_at']