python-openstackclient/doc/source/command-objects/identity-provider.rst
lin-hua-cheng 51f2fda041 Add capability to update description of an IdP
Change-Id: I854067642bbfde6fdf84b22b9cc1de8afc7767c0
Closes-Bug: #1515815
2015-11-12 16:49:45 -08:00

128 lines
2.4 KiB
ReStructuredText

=================
identity provider
=================
Identity v3
`Requires: OS-FEDERATION extension`
identity provider create
------------------------
Create new identity provider
.. program:: identity provider create
.. code:: bash
os 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 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
.. program:: identity provider delete
.. code:: bash
os identity provider delete
<identity-provider>
.. describe:: <identity-provider>
Identity provider to delete
identity provider list
----------------------
List identity providers
.. program:: identity provider list
.. code:: bash
os identity provider list
identity provider set
---------------------
Set identity provider properties
.. program:: identity provider set
.. code:: bash
os 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 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
os identity provider show
<identity-provider>
.. describe:: <identity-provider>
Identity provider to display