Doug Hellmann 9599ffe65d 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>
2017-06-23 11:54:32 +02:00

128 lines
2.5 KiB
ReStructuredText

=================
identity provider
=================
Identity v3
`Requires: OS-FEDERATION extension`
identity provider create
------------------------
Create new identity provider
.. program:: identity provider create
.. code:: bash
openstack identity provider create
[--remote-id <remote-id> [...] | --remote-id-file <file-name>]
[--description <description>]
[--enable | --disable]
<name>
.. option:: --remote-id <remote-id>
Remote IDs to associate with the Identity Provider
(repeat option to provide multiple values)
.. option:: --remote-id-file <file-name>
Name of a file that contains many remote IDs to associate with the identity
provider, one per line
.. option:: --description
New identity provider description
.. option:: --enable
Enable the identity provider (default)
.. option:: --disable
Disable the identity provider
.. describe:: <name>
New identity provider name (must be unique)
identity provider delete
------------------------
Delete identity provider(s)
.. program:: identity provider delete
.. code:: bash
openstack identity provider delete
<identity-provider> [<identity-provider> ...]
.. describe:: <identity-provider>
Identity provider(s) to delete
identity provider list
----------------------
List identity providers
.. program:: identity provider list
.. code:: bash
openstack identity provider list
identity provider set
---------------------
Set identity provider properties
.. program:: identity provider set
.. code:: bash
openstack identity provider set
[--remote-id <remote-id> [...] | --remote-id-file <file-name>]
[--description <description>]
[--enable | --disable]
<identity-provider>
.. option:: --remote-id <remote-id>
Remote IDs to associate with the Identity Provider
(repeat option to provide multiple values)
.. option:: --remote-id-file <file-name>
Name of a file that contains many remote IDs to associate with the identity
provider, one per line
.. option:: --description
Set identity provider description
.. option:: --enable
Enable the identity provider
.. option:: --disable
Disable the identity provider
.. describe:: <identity-provider>
Identity provider to modify
identity provider show
----------------------
Display identity provider details
.. program:: identity provider show
.. code:: bash
openstack identity provider show
<identity-provider>
.. describe:: <identity-provider>
Identity provider to display