3.0.ipv8.REST.identity_endpoint
===============================

.. py:module:: 3.0.ipv8.REST.identity_endpoint


Attributes
----------

.. autoapisummary::

   3.0.ipv8.REST.identity_endpoint.PseudonymListResponseSchema
   3.0.ipv8.REST.identity_endpoint.CredentialSchema
   3.0.ipv8.REST.identity_endpoint.CredentialListResponseSchema


Classes
-------

.. autoapisummary::

   3.0.ipv8.REST.identity_endpoint.IdentityEndpoint


Functions
---------

.. autoapisummary::

   3.0.ipv8.REST.identity_endpoint.ez_b64_encode
   3.0.ipv8.REST.identity_endpoint.ez_b64_decode


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

.. py:data:: PseudonymListResponseSchema

.. py:data:: CredentialSchema

.. py:data:: CredentialListResponseSchema

.. py:function:: ez_b64_encode(s: bytes) -> str

   Encode bytes as base 64.


.. py:function:: ez_b64_decode(s: str) -> bytes

   Decode bytes from base 64.


.. py:class:: IdentityEndpoint(middlewares: 3.0.ipv8.REST.base_endpoint.MiddleWaresType = ())

   Bases: :py:obj:`3.0.ipv8.REST.base_endpoint.BaseEndpoint`\ [\ :py:obj:`3.0.ipv8.types.IPv8`\ ]


   Endpoint to spawn and manipulate Self-Sovereign Identities.


   .. py:attribute:: communication_manager
      :type:  3.0.ipv8.attestation.communication_manager.CommunicationManager | None
      :value: None



   .. py:method:: initialize(session: 3.0.ipv8.types.IPv8) -> None

      Initialize this endpoint for the given session instance.



   .. py:method:: setup_routes() -> None

      Register the names to make this endpoint callable.



   .. py:method:: list_pseudonyms(request: aiohttp.abc.Request) -> 3.0.ipv8.REST.base_endpoint.Response
      :async:


      List our pseudonyms.



   .. py:method:: list_schemas(request: aiohttp.abc.Request) -> 3.0.ipv8.REST.base_endpoint.Response
      :async:


      List our available identity schemas.



   .. py:method:: get_pseudonym_public_key(request: aiohttp.abc.Request) -> 3.0.ipv8.REST.base_endpoint.Response
      :async:


      Get the public key for a pseudonym.



   .. py:method:: unload_pseudonym(request: aiohttp.abc.Request) -> 3.0.ipv8.REST.base_endpoint.Response
      :async:


      Unload a pseudonym.



   .. py:method:: remove_pseudonym(request: aiohttp.abc.Request) -> 3.0.ipv8.REST.base_endpoint.Response
      :async:


      Remove a pseudonym.



   .. py:method:: list_pseudonym_credentials(request: aiohttp.abc.Request) -> 3.0.ipv8.REST.base_endpoint.Response
      :async:


      List a pseudonym's credentials.



   .. py:method:: list_subject_credentials(request: aiohttp.abc.Request) -> 3.0.ipv8.REST.base_endpoint.Response
      :async:


      List a subject's credentials.



   .. py:method:: list_pseudonym_peers(request: aiohttp.abc.Request) -> 3.0.ipv8.REST.base_endpoint.Response
      :async:


      List a pseudonym's peers.



   .. py:method:: allow_pseudonym_verification(request: aiohttp.abc.Request) -> 3.0.ipv8.REST.base_endpoint.Response
      :async:


      Verify a credential.



   .. py:method:: disallow_pseudonym_verification(request: aiohttp.abc.Request) -> 3.0.ipv8.REST.base_endpoint.Response
      :async:


      Disallow verification of a credential.



   .. py:method:: create_pseudonym_credential(request: aiohttp.abc.Request) -> 3.0.ipv8.REST.base_endpoint.Response
      :async:


      Create a credential.



   .. py:method:: attest_pseudonym_credential(request: aiohttp.abc.Request) -> 3.0.ipv8.REST.base_endpoint.Response
      :async:


      Attest to a credential.



   .. py:method:: verify_pseudonym_credential(request: aiohttp.abc.Request) -> 3.0.ipv8.REST.base_endpoint.Response
      :async:


      Request verification of a credential.



   .. py:method:: list_pseudonym_outstanding_attestations(request: aiohttp.abc.Request) -> 3.0.ipv8.REST.base_endpoint.Response
      :async:


      List the oustanding requests for attestations by others.



   .. py:method:: list_pseudonym_outstanding_verifications(request: aiohttp.abc.Request) -> 3.0.ipv8.REST.base_endpoint.Response
      :async:


      List the oustanding requests for verification by others.



   .. py:method:: list_pseudonym_verification_output(request: aiohttp.abc.Request) -> 3.0.ipv8.REST.base_endpoint.Response
      :async:


      Return the output of our verification requests.



   .. py:method:: on_shutdown(_: aiohttp.abc.Application) -> None
      :async:


      Callback when the shutdown signal fires.