openstacksdk/doc/source/user/proxies/key_manager.rst
Monty Taylor 40d425c595
Merge user and users sections of the docs
The openstack doc standard location is 'user', so go with that.
Incorporate pages from the shade and occ docs into the appropriate
places in the user index file.

This still leaves user/logging and user/guide/logging which need to be
rationalized. That will come in the next commit, as it also needs to
actually rationalize the logging helper functions.

Remove the Makefile, as it's not used by things.

Change-Id: I26f36370ef9651f4bcaa7dee3b903309463d9592
2018-01-15 19:19:50 -06:00

52 lines
1.9 KiB
ReStructuredText

KeyManager API
==============
For details on how to use key_management, see
:doc:`/user/guides/key_manager`
.. automodule:: openstack.key_manager.v1._proxy
The KeyManager Class
--------------------
The key_management high-level interface is available through the
``key_manager`` member of a :class:`~openstack.connection.Connection`
object. The ``key_manager`` member will only be added if the service is
detected.
Secret Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.key_manager.v1._proxy.Proxy
.. automethod:: openstack.key_manager.v1._proxy.Proxy.create_secret
.. automethod:: openstack.key_manager.v1._proxy.Proxy.update_secret
.. automethod:: openstack.key_manager.v1._proxy.Proxy.delete_secret
.. automethod:: openstack.key_manager.v1._proxy.Proxy.get_secret
.. automethod:: openstack.key_manager.v1._proxy.Proxy.find_secret
.. automethod:: openstack.key_manager.v1._proxy.Proxy.secrets
Container Operations
^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.key_manager.v1._proxy.Proxy
.. automethod:: openstack.key_manager.v1._proxy.Proxy.create_container
.. automethod:: openstack.key_manager.v1._proxy.Proxy.update_container
.. automethod:: openstack.key_manager.v1._proxy.Proxy.delete_container
.. automethod:: openstack.key_manager.v1._proxy.Proxy.get_container
.. automethod:: openstack.key_manager.v1._proxy.Proxy.find_container
.. automethod:: openstack.key_manager.v1._proxy.Proxy.containers
Order Operations
^^^^^^^^^^^^^^^^
.. autoclass:: openstack.key_manager.v1._proxy.Proxy
.. automethod:: openstack.key_manager.v1._proxy.Proxy.create_order
.. automethod:: openstack.key_manager.v1._proxy.Proxy.update_order
.. automethod:: openstack.key_manager.v1._proxy.Proxy.delete_order
.. automethod:: openstack.key_manager.v1._proxy.Proxy.get_order
.. automethod:: openstack.key_manager.v1._proxy.Proxy.find_order
.. automethod:: openstack.key_manager.v1._proxy.Proxy.orders