openstack/python-openstackclient
Code Issues Proposed changes
61025bf102
python-openstackclient/doc/source/cli/command-objects/identity-provider.rst

134 lines
2.7 KiB
ReStructuredText
Raw Normal View History

Command doc: identity provider Change-Id: Ie73accfaa3d45205a2521e6e61efd16142c460b2
2015-01-06 01:59:59 -05:00
=================
identity provider
=================
Identity v3
`Requires: OS-FEDERATION extension`
identity provider create
------------------------
Create new identity provider
.. program:: identity provider create
.. code:: bash
change os in command example to openstack(2) In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: I80c96f0938cec382f2f714a500138bd5a2c81aa0
2016-12-20 09:18:55 +08:00
openstack identity provider create
Add support to remote_id The federation APIs for the identity providers introduce a new parameter for every identity provider, named remote_ids, which contains a list of entity ID associated with. This parameter can be provided during the creation of the identity provider and can be updated at any time. For more information look at the blueprint: https://blueprints.launchpad.net/keystone/+spec/idp-id-registration This patch add the support to this new parameter in the command line by inserting the option "--remote-id" in the following commands: - "identity provider create" - "identity provider set" Additionally, the values can be read from a file, specified by "--remote-id-file", containing an entity id per line. Change-Id: Ie93340ee57e54128daa70d8a7bd0a9975ff7eef4 Depends-On: I12a262c55b5f6b5cc7007865edf30f14269da537 Implements: blueprint idp-id-registration
2015-03-04 17:24:07 +01:00
[--remote-id <remote-id> [...] | --remote-id-file <file-name>]
Command doc: identity provider Change-Id: Ie73accfaa3d45205a2521e6e61efd16142c460b2
2015-01-06 01:59:59 -05:00
[--description <description>]
Add domain parameter to Identity Provider Identity providers are now associated with domains. This change allows a user to specify a domain by ID or by name when creating an identity provider. [0] This also adds the column for Domain ID in listing. Updating a domain for an identity provider is not supported, so that isn't changed. [0]. Id18b8b2fe853b97631bc990df8188ed64a6e1275 Closes-Bug: 1698390 Change-Id: Icc408e2fe88f257d5863bd3df716a777d52befcc
2017-06-16 15:04:40 -04:00
[--domain <domain>]
Command doc: identity provider Change-Id: Ie73accfaa3d45205a2521e6e61efd16142c460b2
2015-01-06 01:59:59 -05:00
[--enable | --disable]
<name>
Add support to remote_id The federation APIs for the identity providers introduce a new parameter for every identity provider, named remote_ids, which contains a list of entity ID associated with. This parameter can be provided during the creation of the identity provider and can be updated at any time. For more information look at the blueprint: https://blueprints.launchpad.net/keystone/+spec/idp-id-registration This patch add the support to this new parameter in the command line by inserting the option "--remote-id" in the following commands: - "identity provider create" - "identity provider set" Additionally, the values can be read from a file, specified by "--remote-id-file", containing an entity id per line. Change-Id: Ie93340ee57e54128daa70d8a7bd0a9975ff7eef4 Depends-On: I12a262c55b5f6b5cc7007865edf30f14269da537 Implements: blueprint idp-id-registration
2015-03-04 17:24:07 +01:00
.. option:: --remote-id <remote-id>
Doc: Unify repeatable option comments There are lots of "this option can be repeated" comments in the doc, which are not consistent to other similar docs. This patch changes them to the following format: "repeat option to do something" Change-Id: I54e01053091c428bf87bb36bb95f73a0b80ab6e7
2016-04-12 15:57:17 +08:00
Remote IDs to associate with the Identity Provider
(repeat option to provide multiple values)
Add support to remote_id The federation APIs for the identity providers introduce a new parameter for every identity provider, named remote_ids, which contains a list of entity ID associated with. This parameter can be provided during the creation of the identity provider and can be updated at any time. For more information look at the blueprint: https://blueprints.launchpad.net/keystone/+spec/idp-id-registration This patch add the support to this new parameter in the command line by inserting the option "--remote-id" in the following commands: - "identity provider create" - "identity provider set" Additionally, the values can be read from a file, specified by "--remote-id-file", containing an entity id per line. Change-Id: Ie93340ee57e54128daa70d8a7bd0a9975ff7eef4 Depends-On: I12a262c55b5f6b5cc7007865edf30f14269da537 Implements: blueprint idp-id-registration
2015-03-04 17:24:07 +01:00
.. option:: --remote-id-file <file-name>
Name of a file that contains many remote IDs to associate with the identity
provider, one per line
Command doc: identity provider Change-Id: Ie73accfaa3d45205a2521e6e61efd16142c460b2
2015-01-06 01:59:59 -05:00
.. option:: --description
New identity provider description
Add domain parameter to Identity Provider Identity providers are now associated with domains. This change allows a user to specify a domain by ID or by name when creating an identity provider. [0] This also adds the column for Domain ID in listing. Updating a domain for an identity provider is not supported, so that isn't changed. [0]. Id18b8b2fe853b97631bc990df8188ed64a6e1275 Closes-Bug: 1698390 Change-Id: Icc408e2fe88f257d5863bd3df716a777d52befcc
2017-06-16 15:04:40 -04:00
.. option:: --domain
Name or ID of the domain to associate with the identity provider. If not
specified, one will be created automatically
Command doc: identity provider Change-Id: Ie73accfaa3d45205a2521e6e61efd16142c460b2
2015-01-06 01:59:59 -05:00
.. 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
------------------------
Support bulk deletion for delete commands in identityv3 Support bulk deletion for delete commands in the list below identity/v3/consumer identity/v3/credential identity/v3/domain identity/v3/ec2creds identity/v3/endpoint identity/v3/federation_protocol identity/v3/identity_provider identity/v3/mapping identity/v3/policy identity/v3/region identity/v3/service_provider identity/v3/service The unit test in identityv3 need to be refactored, so I add some functional tests instead. I will add all unit tests at one time after the refactor completed. Change-Id: I82367570f59817b47c87b6c7bfeae95ccfe5c50e Closes-Bug: #1592906
2016-07-12 12:44:55 +08:00
Delete identity provider(s)
Command doc: identity provider Change-Id: Ie73accfaa3d45205a2521e6e61efd16142c460b2
2015-01-06 01:59:59 -05:00
.. program:: identity provider delete
.. code:: bash
change os in command example to openstack(2) In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: I80c96f0938cec382f2f714a500138bd5a2c81aa0
2016-12-20 09:18:55 +08:00
openstack identity provider delete
Support bulk deletion for delete commands in identityv3 Support bulk deletion for delete commands in the list below identity/v3/consumer identity/v3/credential identity/v3/domain identity/v3/ec2creds identity/v3/endpoint identity/v3/federation_protocol identity/v3/identity_provider identity/v3/mapping identity/v3/policy identity/v3/region identity/v3/service_provider identity/v3/service The unit test in identityv3 need to be refactored, so I add some functional tests instead. I will add all unit tests at one time after the refactor completed. Change-Id: I82367570f59817b47c87b6c7bfeae95ccfe5c50e Closes-Bug: #1592906
2016-07-12 12:44:55 +08:00
<identity-provider> [<identity-provider> ...]
Command doc: identity provider Change-Id: Ie73accfaa3d45205a2521e6e61efd16142c460b2
2015-01-06 01:59:59 -05:00
.. describe:: <identity-provider>
Support bulk deletion for delete commands in identityv3 Support bulk deletion for delete commands in the list below identity/v3/consumer identity/v3/credential identity/v3/domain identity/v3/ec2creds identity/v3/endpoint identity/v3/federation_protocol identity/v3/identity_provider identity/v3/mapping identity/v3/policy identity/v3/region identity/v3/service_provider identity/v3/service The unit test in identityv3 need to be refactored, so I add some functional tests instead. I will add all unit tests at one time after the refactor completed. Change-Id: I82367570f59817b47c87b6c7bfeae95ccfe5c50e Closes-Bug: #1592906
2016-07-12 12:44:55 +08:00
Identity provider(s) to delete
Command doc: identity provider Change-Id: Ie73accfaa3d45205a2521e6e61efd16142c460b2
2015-01-06 01:59:59 -05:00
identity provider list
----------------------
List identity providers
.. program:: identity provider list
.. code:: bash
change os in command example to openstack(2) In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: I80c96f0938cec382f2f714a500138bd5a2c81aa0
2016-12-20 09:18:55 +08:00
openstack identity provider list
Command doc: identity provider Change-Id: Ie73accfaa3d45205a2521e6e61efd16142c460b2
2015-01-06 01:59:59 -05:00
identity provider set
---------------------
Set identity provider properties
.. program:: identity provider set
.. code:: bash
change os in command example to openstack(2) In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: I80c96f0938cec382f2f714a500138bd5a2c81aa0
2016-12-20 09:18:55 +08:00
openstack identity provider set
Add support to remote_id The federation APIs for the identity providers introduce a new parameter for every identity provider, named remote_ids, which contains a list of entity ID associated with. This parameter can be provided during the creation of the identity provider and can be updated at any time. For more information look at the blueprint: https://blueprints.launchpad.net/keystone/+spec/idp-id-registration This patch add the support to this new parameter in the command line by inserting the option "--remote-id" in the following commands: - "identity provider create" - "identity provider set" Additionally, the values can be read from a file, specified by "--remote-id-file", containing an entity id per line. Change-Id: Ie93340ee57e54128daa70d8a7bd0a9975ff7eef4 Depends-On: I12a262c55b5f6b5cc7007865edf30f14269da537 Implements: blueprint idp-id-registration
2015-03-04 17:24:07 +01:00
[--remote-id <remote-id> [...] | --remote-id-file <file-name>]
Add capability to update description of an IdP Change-Id: I854067642bbfde6fdf84b22b9cc1de8afc7767c0 Closes-Bug: #1515815
2015-11-12 16:49:45 -08:00
[--description <description>]
Command doc: identity provider Change-Id: Ie73accfaa3d45205a2521e6e61efd16142c460b2
2015-01-06 01:59:59 -05:00
[--enable | --disable]
<identity-provider>
Add support to remote_id The federation APIs for the identity providers introduce a new parameter for every identity provider, named remote_ids, which contains a list of entity ID associated with. This parameter can be provided during the creation of the identity provider and can be updated at any time. For more information look at the blueprint: https://blueprints.launchpad.net/keystone/+spec/idp-id-registration This patch add the support to this new parameter in the command line by inserting the option "--remote-id" in the following commands: - "identity provider create" - "identity provider set" Additionally, the values can be read from a file, specified by "--remote-id-file", containing an entity id per line. Change-Id: Ie93340ee57e54128daa70d8a7bd0a9975ff7eef4 Depends-On: I12a262c55b5f6b5cc7007865edf30f14269da537 Implements: blueprint idp-id-registration
2015-03-04 17:24:07 +01:00
.. option:: --remote-id <remote-id>
Doc: Unify repeatable option comments There are lots of "this option can be repeated" comments in the doc, which are not consistent to other similar docs. This patch changes them to the following format: "repeat option to do something" Change-Id: I54e01053091c428bf87bb36bb95f73a0b80ab6e7
2016-04-12 15:57:17 +08:00
Remote IDs to associate with the Identity Provider
(repeat option to provide multiple values)
Add support to remote_id The federation APIs for the identity providers introduce a new parameter for every identity provider, named remote_ids, which contains a list of entity ID associated with. This parameter can be provided during the creation of the identity provider and can be updated at any time. For more information look at the blueprint: https://blueprints.launchpad.net/keystone/+spec/idp-id-registration This patch add the support to this new parameter in the command line by inserting the option "--remote-id" in the following commands: - "identity provider create" - "identity provider set" Additionally, the values can be read from a file, specified by "--remote-id-file", containing an entity id per line. Change-Id: Ie93340ee57e54128daa70d8a7bd0a9975ff7eef4 Depends-On: I12a262c55b5f6b5cc7007865edf30f14269da537 Implements: blueprint idp-id-registration
2015-03-04 17:24:07 +01:00
.. option:: --remote-id-file <file-name>
Name of a file that contains many remote IDs to associate with the identity
provider, one per line
Add capability to update description of an IdP Change-Id: I854067642bbfde6fdf84b22b9cc1de8afc7767c0 Closes-Bug: #1515815
2015-11-12 16:49:45 -08:00
.. option:: --description
Set identity provider description
Command doc: identity provider Change-Id: Ie73accfaa3d45205a2521e6e61efd16142c460b2
2015-01-06 01:59:59 -05:00
.. 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
change os in command example to openstack(2) In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: I80c96f0938cec382f2f714a500138bd5a2c81aa0
2016-12-20 09:18:55 +08:00
openstack identity provider show
Command doc: identity provider Change-Id: Ie73accfaa3d45205a2521e6e61efd16142c460b2
2015-01-06 01:59:59 -05:00
<identity-provider>
.. describe:: <identity-provider>
Identity provider to display
Copy Permalink