python-openstackclient/doc/source/command-objects/service-provider.rst
Kevin_Zheng 446e6f2fa8 change os in command example to openstack(3)
In the current doc, the command examples are like
"os server create" but the acutal command should
be started with "openstack" instead of "os", it
is misleading to first time users.

Change-Id: Ie67c0152d8ff8b7c456f91dc8b9a9164437ee9d1
2016-12-20 09:26:15 +08:00

126 lines
2.3 KiB
ReStructuredText

================
service provider
================
Identity v3
`Requires: OS-FEDERATION extension`
service provider create
-----------------------
Create new service provider
.. program:: service provider create
.. code:: bash
openstack service provider create
[--description <description>]
[--enable | --disable]
--auth-url <auth-url>
--service-provider-url <sp-url>
<name>
.. option:: --auth-url
Authentication URL of remote federated service provider (required)
.. option:: --service-provider-url
A service URL where SAML assertions are being sent (required)
.. option:: --description
New service provider description
.. option:: --enable
Enable the service provider (default)
.. option:: --disable
Disable the service provider
.. describe:: <name>
New service provider name (must be unique)
service provider delete
-----------------------
Delete service provider(s)
.. program:: service provider delete
.. code:: bash
openstack service provider delete
<service-provider> [<service-provider> ...]
.. describe:: <service-provider>
Service provider(s) to delete
service provider list
---------------------
List service providers
.. program:: service provider list
.. code:: bash
openstack service provider list
service provider set
--------------------
Set service provider properties
.. program:: service provider set
.. code:: bash
openstack service provider set
[--enable | --disable]
[--description <description>]
[--auth-url <auth-url>]
[--service-provider-url <sp-url>]
<service-provider>
.. option:: --service-provider-url
New service provider URL, where SAML assertions are sent
.. option:: --auth-url
New Authentication URL of remote federated service provider
.. option:: --description
New service provider description
.. option:: --enable
Enable the service provider
.. option:: --disable
Disable the service provider
.. describe:: <service-provider>
Service provider to modify
service provider show
---------------------
Display service provider details
.. program:: service provider show
.. code:: bash
openstack service provider show
<service-provider>
.. describe:: <service-provider>
Service provider to display