summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/service-provider.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-13 15:55:33 -0400
committerAndreas Jaeger <aj@suse.com>2017-06-23 11:54:32 +0200
commit9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch)
tree9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/cli/command-objects/service-provider.rst
parent19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff)
downloadpython-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz
reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'doc/source/cli/command-objects/service-provider.rst')
-rw-r--r--doc/source/cli/command-objects/service-provider.rst125
1 files changed, 125 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/service-provider.rst b/doc/source/cli/command-objects/service-provider.rst
new file mode 100644
index 00000000..63ef44e1
--- /dev/null
+++ b/doc/source/cli/command-objects/service-provider.rst
@@ -0,0 +1,125 @@
+================
+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