python-openstackclient/doc/source/cli/command-objects/credential.rst

==========
credential
==========

Identity v3

credential create
-----------------

Create new credential

.. program:: credential create
.. code:: bash

    openstack credential create
        [--type <type>]
        [--project <project>]
        <user> <data>

.. option:: --type <type>

    New credential type: cert, ec2, totp and so on

.. option:: --project <project>

    Project which limits the scope of the credential (name or ID)

.. _credential_create:
.. describe:: <user>

    User that owns the credential (name or ID)

.. describe:: <data>

    New credential data

credential delete
-----------------

Delete credential(s)

.. program:: credential delete
.. code:: bash

    openstack credential delete
        <credential-id> [<credential-id> ...]

.. _credential_delete:
.. describe:: <credential-id>

    ID(s) of credential to delete

credential list
---------------

List credentials

.. program:: credential list
.. code:: bash

    openstack credential list
        [--user <user> [--user-domain <user-domain>]]
        [--type <type>]

.. option:: --user <user>

    Filter credentials by <user> (name or ID)

.. option:: --user-domain <user-domain>

    Domain the user belongs to (name or ID). This can be
    used in case collisions between user names exist.

.. option:: --type <type>

    Filter credentials by type: cert, ec2, totp and so on

credential set
--------------

Set credential properties

.. program:: credential set
.. code:: bash

    openstack credential set
        [--user <user>]
        [--type <type>]
        [--data <data>]
        [--project <project>]
        <credential-id>

.. option:: --user <user>

    User that owns the credential (name or ID)

.. option:: --type <type>

    New credential type: cert, ec2, totp and so on.

.. option:: --data <data>

    New credential data

.. option:: --project <project>

    Project which limits the scope of the credential (name or ID)

.. _credential_set:
.. describe:: <credential-id>

    ID of credential to change

credential show
---------------

Display credential details

.. program:: credential show
.. code:: bash

    openstack credential show
        <credential-id>

.. _credential_show:
.. describe:: <credential-id>

    ID of credential to display
Update doc for credential in indentityv3 Change-Id: I5f49c038a75ea67674b6d9279a6e60d6ded8d12f 2016-07-13 17:33:52 +08:00			`==========`
Changed the nomenclature of credentials command Removed the "s" of the "credentials command" in the documentation and renaming the file to credential.rst (instead of credentials) Change-Id: If1df15b9a630a5452e05d14fb45e9ebb124583a7 2016-05-14 13:22:13 -03:00			`credential`
Update doc for credential in indentityv3 Change-Id: I5f49c038a75ea67674b6d9279a6e60d6ded8d12f 2016-07-13 17:33:52 +08:00			`==========`
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28 2014-11-17 22:59:57 -06:00
Add versioning to the docs that missed it Change-Id: I8cb90e0d5aca58c4992271e007af91f8cf782643 2015-01-09 19:12:18 -05:00			`Identity v3`

Changed the nomenclature of credentials command Removed the "s" of the "credentials command" in the documentation and renaming the file to credential.rst (instead of credentials) Change-Id: If1df15b9a630a5452e05d14fb45e9ebb124583a7 2016-05-14 13:22:13 -03:00			`credential create`
Update doc for credential in indentityv3 Change-Id: I5f49c038a75ea67674b6d9279a6e60d6ded8d12f 2016-07-13 17:33:52 +08:00			`-----------------`
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28 2014-11-17 22:59:57 -06:00
Update doc for credential in indentityv3 Change-Id: I5f49c038a75ea67674b6d9279a6e60d6ded8d12f 2016-07-13 17:33:52 +08:00			`Create new credential`
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28 2014-11-17 22:59:57 -06:00
Update doc for credential in indentityv3 Change-Id: I5f49c038a75ea67674b6d9279a6e60d6ded8d12f 2016-07-13 17:33:52 +08:00			`.. program:: credential create`
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28 2014-11-17 22:59:57 -06:00			`.. code:: bash`

change os in command example to openstack 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: Ic7686257725e1aa8e4e0d65a712eff1c079927a8 2016-12-20 09:03:29 +08:00			`openstack credential create`
Update doc for credential in indentityv3 Change-Id: I5f49c038a75ea67674b6d9279a6e60d6ded8d12f 2016-07-13 17:33:52 +08:00			`[--type <type>]`
			`[--project <project>]`
			`<user> <data>`

			`.. option:: --type <type>`

Fix credentials in create, update and list. Now, keystone has supported serverl auth method, like 'totp'. Before we use this method, we should create the credential first. And we need create it with type 'totp'. But now we cannot create credential with this method. Also, I think the type should not have constrains. We can create any type in keystone project. So, we should do these actions too. The type would be more which We cannot control. Change-Id: Ie0482da3133fb515e4bb8e45f8c54f509589cc5e Closes-bug: #1731848 2017-11-17 11:39:15 +08:00			`New credential type: cert, ec2, totp and so on`
Update doc for credential in indentityv3 Change-Id: I5f49c038a75ea67674b6d9279a6e60d6ded8d12f 2016-07-13 17:33:52 +08:00
			`.. option:: --project <project>`

			`Project which limits the scope of the credential (name or ID)`

			`.. _credential_create:`
			`.. describe:: <user>`

			`User that owns the credential (name or ID)`

			`.. describe:: <data>`

			`New credential data`

			`credential delete`
			`-----------------`

			`Delete credential(s)`

			`.. program:: credential delete`
			`.. code:: bash`

change os in command example to openstack 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: Ic7686257725e1aa8e4e0d65a712eff1c079927a8 2016-12-20 09:03:29 +08:00			`openstack credential delete`
Update doc for credential in indentityv3 Change-Id: I5f49c038a75ea67674b6d9279a6e60d6ded8d12f 2016-07-13 17:33:52 +08:00			`<credential-id> [<credential-id> ...]`

			`.. _credential_delete:`
			`.. describe:: <credential-id>`

			`ID(s) of credential to delete`

			`credential list`
			`---------------`

			`List credentials`

			`.. program:: credential list`
			`.. code:: bash`

change os in command example to openstack 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: Ic7686257725e1aa8e4e0d65a712eff1c079927a8 2016-12-20 09:03:29 +08:00			`openstack credential list`
Add optional parameter "user_id" and "type" to list credentials In keystone version 3.5, "type" optional attribute has been added to list credentials. This patch add "user_id" and "type" optional parameter in openstack client. Change-Id: Ia09ee7c39204fdff2dfd7b9b606d888d007caac5 2017-07-25 15:48:27 +08:00			`[--user <user> [--user-domain <user-domain>]]`
			`[--type <type>]`

			`.. option:: --user <user>`

			`Filter credentials by <user> (name or ID)`

			`.. option:: --user-domain <user-domain>`

			`Domain the user belongs to (name or ID). This can be`
			`used in case collisions between user names exist.`

			`.. option:: --type <type>`

Fix credentials in create, update and list. Now, keystone has supported serverl auth method, like 'totp'. Before we use this method, we should create the credential first. And we need create it with type 'totp'. But now we cannot create credential with this method. Also, I think the type should not have constrains. We can create any type in keystone project. So, we should do these actions too. The type would be more which We cannot control. Change-Id: Ie0482da3133fb515e4bb8e45f8c54f509589cc5e Closes-bug: #1731848 2017-11-17 11:39:15 +08:00			`Filter credentials by type: cert, ec2, totp and so on`
Update doc for credential in indentityv3 Change-Id: I5f49c038a75ea67674b6d9279a6e60d6ded8d12f 2016-07-13 17:33:52 +08:00
			`credential set`
			`--------------`

			`Set credential properties`

			`.. program:: credential set`
			`.. code:: bash`

change os in command example to openstack 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: Ic7686257725e1aa8e4e0d65a712eff1c079927a8 2016-12-20 09:03:29 +08:00			`openstack credential set`
Update doc for credential in indentityv3 Change-Id: I5f49c038a75ea67674b6d9279a6e60d6ded8d12f 2016-07-13 17:33:52 +08:00			`[--user <user>]`
			`[--type <type>]`
			`[--data <data>]`
			`[--project <project>]`
			`<credential-id>`

			`.. option:: --user <user>`

			`User that owns the credential (name or ID)`

			`.. option:: --type <type>`

Fix credentials in create, update and list. Now, keystone has supported serverl auth method, like 'totp'. Before we use this method, we should create the credential first. And we need create it with type 'totp'. But now we cannot create credential with this method. Also, I think the type should not have constrains. We can create any type in keystone project. So, we should do these actions too. The type would be more which We cannot control. Change-Id: Ie0482da3133fb515e4bb8e45f8c54f509589cc5e Closes-bug: #1731848 2017-11-17 11:39:15 +08:00			`New credential type: cert, ec2, totp and so on.`
Update doc for credential in indentityv3 Change-Id: I5f49c038a75ea67674b6d9279a6e60d6ded8d12f 2016-07-13 17:33:52 +08:00
			`.. option:: --data <data>`

			`New credential data`

			`.. option:: --project <project>`

			`Project which limits the scope of the credential (name or ID)`

			`.. _credential_set:`
			`.. describe:: <credential-id>`

			`ID of credential to change`
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28 2014-11-17 22:59:57 -06:00
Changed the nomenclature of credentials command Removed the "s" of the "credentials command" in the documentation and renaming the file to credential.rst (instead of credentials) Change-Id: If1df15b9a630a5452e05d14fb45e9ebb124583a7 2016-05-14 13:22:13 -03:00			`credential show`
Update doc for credential in indentityv3 Change-Id: I5f49c038a75ea67674b6d9279a6e60d6ded8d12f 2016-07-13 17:33:52 +08:00			`---------------`

			`Display credential details`
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28 2014-11-17 22:59:57 -06:00
Update doc for credential in indentityv3 Change-Id: I5f49c038a75ea67674b6d9279a6e60d6ded8d12f 2016-07-13 17:33:52 +08:00			`.. program:: credential show`
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28 2014-11-17 22:59:57 -06:00			`.. code:: bash`

change os in command example to openstack 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: Ic7686257725e1aa8e4e0d65a712eff1c079927a8 2016-12-20 09:03:29 +08:00			`openstack credential show`
Update doc for credential in indentityv3 Change-Id: I5f49c038a75ea67674b6d9279a6e60d6ded8d12f 2016-07-13 17:33:52 +08:00			`<credential-id>`

			`.. _credential_show:`
			`.. describe:: <credential-id>`

			`ID of credential to display`