summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2015-05-06 15:40:48 +0000
committerGerrit Code Review <review@openstack.org>2015-05-06 15:40:48 +0000
commitc6c1098d2ec4e329828c9681077dbb2e45ab516a (patch)
treedc5e71092c3ab3f42bc90ccf0047a12385a7b4a9 /doc/source/command-objects
parentec6fbe1abfa6d6d6e624aed0dac274b69d982b80 (diff)
parentcaf91e69bace8f1f8201d6719b338ce3d78f42e4 (diff)
downloadpython-openstackclient-c6c1098d2ec4e329828c9681077dbb2e45ab516a.tar.gz
Merge "Add docs for service provider CRUD"
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