.. _org.freedesktop.impl.portal.Secret:

==================================
 Secret
==================================

-----------
Description
-----------

.. _org.freedesktop.impl.portal.Secret Description:

Secret portal backend interface

The Secret portal allows sandboxed applications to retrieve a
per-application master secret.



.. _org.freedesktop.impl.portal.Secret Properties:

----------
Properties
----------

.. _org.freedesktop.impl.portal.Secret:version:

org.freedesktop.impl.portal.Secret:version
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

::

    version readable u




.. _org.freedesktop.impl.portal.Secret Methods:

-------
Methods
-------

.. _org.freedesktop.impl.portal.Secret.RetrieveSecret:

org.freedesktop.impl.portal.Secret.RetrieveSecret
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

::

    RetrieveSecret (
      IN handle o,
      IN app_id s,
      IN fd h,
      IN options a{sv},
      OUT response u,
      OUT results a{sv}
    )



Retrieves a master secret for a sandboxed application.

Supported keys in the ``options`` vardict include:

* ``token`` (``s``)

  An opaque string associated with the retrieve secret.



handle
  Object path for the :ref:`org.freedesktop.impl.portal.Request` object representing this call

app_id
  App id of the application

fd
  Writable file descriptor for transporting the secret

options
  Vardict with optional further information

response
  Numeric response

results
  Vardict with the results of the call