summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
authorSteve Martinelli <stevemar@ca.ibm.com>2015-03-28 03:39:07 -0400
committerSteve Martinelli <stevemar@ca.ibm.com>2015-04-15 05:09:48 +0000
commitcaf91e69bace8f1f8201d6719b338ce3d78f42e4 (patch)
tree5e481b1464a3ec786acd85569e6150c6050743bb /doc/source/command-objects
parentba7ad20942061eface8a0f11f302147744b59418 (diff)
downloadpython-openstackclient-caf91e69bace8f1f8201d6719b338ce3d78f42e4.tar.gz
Add docs for service provider CRUD
This patch adds service providers to command-objects, and makes a few changes to the help text, to align it more with the already established identity provider resource. Change-Id: Ibf3d2bc04bf5588d1fc9c37b8ca28c007496c021
Diffstat (limited to 'doc/source/command-objects')
-rw-r--r--doc/source/command-objects/service-provider.rst125
1 files changed, 125 insertions, 0 deletions
diff --git a/doc/source/command-objects/service-provider.rst b/doc/source/command-objects/service-provider.rst
new file mode 100644
index 00000000..963493b4
--- /dev/null
+++ b/doc/source/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
+
+ os 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
+
+.. program:: service provider delete
+.. code:: bash
+
+ os service provider delete
+ <service-provider>
+
+.. describe:: <service-provider>
+
+ Service provider to delete
+
+service provider list
+---------------------
+
+List service providers
+
+.. program:: service provider list
+.. code:: bash
+
+ os service provider list
+
+service provider set
+--------------------
+
+Set service provider properties
+
+.. program:: service provider set
+.. code:: bash
+
+ os 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
+
+ os service provider show
+ <service-provider>
+
+.. describe:: <service-provider>
+
+ Service provider to display