python-openstackclient/doc/source/command-objects/federation-protocol.rst
Huanxuan Ao 60639d76a7 Support bulk deletion for delete commands in identityv3
Support bulk deletion for delete commands in the list below
identity/v3/consumer
identity/v3/credential
identity/v3/domain
identity/v3/ec2creds
identity/v3/endpoint
identity/v3/federation_protocol
identity/v3/identity_provider
identity/v3/mapping
identity/v3/policy
identity/v3/region
identity/v3/service_provider
identity/v3/service

The unit test in identityv3 need to be refactored, so I add
some functional tests instead. I will add all unit tests at
one time after the refactor completed.

Change-Id: I82367570f59817b47c87b6c7bfeae95ccfe5c50e
Closes-Bug: #1592906
2016-07-19 09:49:36 +08:00

113 lines
2.5 KiB
ReStructuredText

===================
federation protocol
===================
Identity v3
`Requires: OS-FEDERATION extension`
federation protocol create
--------------------------
Create new federation protocol
.. program:: federation protocol create
.. code:: bash
os federation protocol create
--identity-provider <identity-provider>
--mapping <mapping>
<name>
.. option:: --identity-provider <identity-provider>
Identity provider that will support the new federation protocol (name or ID) (required)
.. option:: --mapping <mapping>
Mapping that is to be used (name or ID) (required)
.. describe:: <name>
New federation protocol name (must be unique per identity provider)
federation protocol delete
--------------------------
Delete federation protocol(s)
.. program:: federation protocol delete
.. code:: bash
os federation protocol delete
--identity-provider <identity-provider>
<federation-protocol> [<federation-protocol> ...]
.. option:: --identity-provider <identity-provider>
Identity provider that supports <federation-protocol> (name or ID) (required)
.. describe:: <federation-protocol>
Federation protocol(s) to delete (name or ID)
federation protocol list
------------------------
List federation protocols
.. program:: federation protocol list
.. code:: bash
os federation protocol list
--identity-provider <identity-provider>
.. option:: --identity-provider <identity-provider>
Identity provider to list (name or ID) (required)
federation protocol set
-----------------------
Set federation protocol properties
.. program:: federation protocol set
.. code:: bash
os federation protocol set
--identity-provider <identity-provider>
[--mapping <mapping>]
<federation-protocol>
.. option:: --identity-provider <identity-provider>
Identity provider that supports <federation-protocol> (name or ID) (required)
.. option:: --mapping <mapping>
Mapping that is to be used (name or ID)
.. describe:: <federation-protocol>
Federation protocol to modify (name or ID)
federation protocol show
------------------------
Display federation protocol details
.. program:: federation protocol show
.. code:: bash
os federation protocol show
--identity-provider <identity-provider>
<federation-protocol>
.. option:: --identity-provider <identity-provider>
Identity provider that supports <federation-protocol> (name or ID) (required)
.. describe:: <federation-protocol>
Federation protocol to display (name or ID)