diff options
| author | Steve Martinelli <s.martinelli@gmail.com> | 2017-08-17 12:17:39 -0400 |
|---|---|---|
| committer | Steve Martinelli <s.martinelli@gmail.com> | 2017-10-06 00:57:04 +0000 |
| commit | 0d94a76d956c0322e9c4607fb5ce824f7653f038 (patch) | |
| tree | 5044ef180d214ce9a161739c5a6d748970e94766 /doc/source/cli/command-objects/federation-protocol.rst | |
| parent | a87bd58fb4de5dc5f99193b88d2a3f8bd1338c52 (diff) | |
| download | python-openstackclient-0d94a76d956c0322e9c4607fb5ce824f7653f038.tar.gz | |
auto-generate docs for v3 identity resources
skipped shared v2/v3 identity resources.
Change-Id: I9e1fb5dee5506780fd79a0cbfbde059d0ccd1489
Diffstat (limited to 'doc/source/cli/command-objects/federation-protocol.rst')
| -rw-r--r-- | doc/source/cli/command-objects/federation-protocol.rst | 116 |
1 files changed, 13 insertions, 103 deletions
diff --git a/doc/source/cli/command-objects/federation-protocol.rst b/doc/source/cli/command-objects/federation-protocol.rst index e1f98174..3a99fd72 100644 --- a/doc/source/cli/command-objects/federation-protocol.rst +++ b/doc/source/cli/command-objects/federation-protocol.rst @@ -2,111 +2,21 @@ federation protocol =================== -Identity v3 +A **federation protocol** is used by the Identity service's OS-FEDERATION +extension. It is used by **identity providers** and **mappings**. Applicable to +Identity v3. -`Requires: OS-FEDERATION extension` +.. autoprogram-cliff:: openstack.identity.v3 + :command: federation protocol create -federation protocol create --------------------------- +.. autoprogram-cliff:: openstack.identity.v3 + :command: federation protocol delete -Create new federation protocol +.. autoprogram-cliff:: openstack.identity.v3 + :command: federation protocol list -.. program:: federation protocol create -.. code:: bash +.. autoprogram-cliff:: openstack.identity.v3 + :command: federation protocol set - openstack 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 - - openstack 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 - - openstack 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 - - openstack 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 - - openstack 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) +.. autoprogram-cliff:: openstack.identity.v3 + :command: federation protocol show |