diff options
| author | Eric Fried <openstack@fried.cc> | 2019-11-04 17:16:34 -0600 |
|---|---|---|
| committer | Monty Taylor <mordred@inaugust.com> | 2020-06-08 16:34:27 -0500 |
| commit | 26878e7d53a531adb67c9ddde8fd6d3c3092ce34 (patch) | |
| tree | 1ebf5ccc543312981f9861fb21e813959f82d2fd /doc/source/cli/command-objects/user.rst | |
| parent | 00e88822e3fcb288d9fe8d019ee7d1bf8dd74630 (diff) | |
| download | python-openstackclient-26878e7d53a531adb67c9ddde8fd6d3c3092ce34.tar.gz | |
identity: autogenerate docs
$namespace = openstack.identity.v{2|3}
The subcommand documents for $namespace were hardcoded and thus prone to
drift over time. This commit removes the hardcoded content and uses the
autoprogram-cliff directive to generate them automatically from the
subcommand configuration classes.
Special things:
- Some reorganization happened here. Certain subcommand names, such as
`endpoint` and `project`, are shared by identify v2 and v3. Previously
the hardcoded documents had them combined and interleaved. Attempting
to preserve this with autoprogram-cliff would have required
significant additional infrastructure. However, since most readers
care completely about one and not at all about the other, we instead
split the v2 and v3 versions of these commands into separate pages. In
case links to the old pages exist in the wild, they are preserved, but
moved (with redirects) to a hidden directory, and populated simply
with links to the new version-specific generated documents.
- The `federation domain` and `federation project` subcommands were
previously absent from the docs. They are added. These are such small
commands and they seem related, so they're put into a single document.
- Some pages were already being generated but were listing operations
individually instead of using wildcards (possibly because they were
created before wildcarding was supported by cliff). These are changed
to use wildcarding. (We want to do this wherever possible as it is
more future-proof in the event that more operations are added to a
subcommand later.)
- The `service provider` document was incorrectly titled `identity
provider`. Fixed.
Change-Id: I2030f9fe370038c5908b6eb6bed9692a73fe5067
Diffstat (limited to 'doc/source/cli/command-objects/user.rst')
| -rw-r--r-- | doc/source/cli/command-objects/user.rst | 349 |
1 files changed, 0 insertions, 349 deletions
diff --git a/doc/source/cli/command-objects/user.rst b/doc/source/cli/command-objects/user.rst deleted file mode 100644 index d0fc3f87..00000000 --- a/doc/source/cli/command-objects/user.rst +++ /dev/null @@ -1,349 +0,0 @@ -==== -user -==== - -Identity v2, v3 - -user create ------------ - -Create new user - -.. program:: user create -.. code:: bash - - openstack user create - [--domain <domain>] - [--project <project> [--project-domain <project-domain>]] - [--password <password>] - [--password-prompt] - [--email <email-address>] - [--description <description>] - [--multi-factor-auth-rule <rule>] - [--ignore-lockout-failure-attempts| --no-ignore-lockout-failure-attempts] - [--ignore-password-expiry| --no-ignore-password-expiry] - [--ignore-change-password-upon-first-use| --no-ignore-change-password-upon-first-use] - [--enable-lock-password| --disable-lock-password] - [--enable-multi-factor-auth| --disable-multi-factor-auth] - [--enable | --disable] - [--or-show] - <user-name> - -.. option:: --domain <domain> - - Default domain (name or ID) - - .. versionadded:: 3 - -.. option:: --project <project> - - Default project (name or ID) - -.. option:: --project-domain <project-domain> - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. option:: --password <password> - - Set user password - -.. option:: --password-prompt - - Prompt interactively for password - -.. option:: --email <email-address> - - Set user email address - -.. option:: --description <description> - - User description - - .. versionadded:: 3 - -.. option:: --ignore-lockout-failure-attempts - - Opt into ignoring the number of times a user has authenticated and - locking out the user as a result - -.. option:: --no-ignore-lockout-failure-attempts - - Opt out of ignoring the number of times a user has authenticated - and locking out the user as a result - -.. option:: --ignore-change-password-upon-first-use - - Control if a user should be forced to change their password immediately - after they log into keystone for the first time. Opt into ignoring - the user to change their password during first time login in keystone. - -.. option:: --no-ignore-change-password-upon-first-use - - Control if a user should be forced to change their password immediately - after they log into keystone for the first time. Opt out of ignoring - the user to change their password during first time login in keystone. - -.. option:: --ignore-password-expiry - - Opt into allowing user to continue using passwords that may be - expired - -.. option:: --no-ignore-password-expiry - - Opt out of allowing user to continue using passwords that may be - expired - -.. option:: --enable-lock-password - - Disables the ability for a user to change its password through - self-service APIs - -.. option:: --disable-lock-password - - Enables the ability for a user to change its password through - self-service APIs - -.. option:: --enable-multi-factor-auth - - Enables the MFA (Multi Factor Auth) - -.. option:: --disable-multi-factor-auth - - Disables the MFA (Multi Factor Auth) - -.. option:: --multi-factor-auth-rule <rule> - - Set multi-factor auth rules. For example, to set a rule requiring the - "password" and "totp" auth methods to be provided, - use: "--multi-factor-auth-rule password,totp". - May be provided multiple times to set different rule combinations. - -.. option:: --enable - - Enable user (default) - -.. option:: --disable - - Disable user - -.. option:: --or-show - - Return existing user - - If the username already exist return the existing user data and do not fail. - -.. describe:: <user-name> - - New user name - -user delete ------------ - -Delete user(s) - -.. program:: user delete -.. code:: bash - - openstack user delete - [--domain <domain>] - <user> [<user> ...] - -.. option:: --domain <domain> - - Domain owning :ref:`\<user\> <user_delete-user>` (name or ID) - - .. versionadded:: 3 - -.. _user_delete-user: -.. describe:: <user> - - User(s) to delete (name or ID) - -user list ---------- - -List users - -.. program:: user list -.. code:: bash - - openstack user list - [--project <project>] - [--domain <domain>] - [--group <group> | --project <project>] - [--long] - -.. option:: --project <project> - - Filter users by `<project>` (name or ID) - -.. option:: --domain <domain> - - Filter users by `<domain>` (name or ID) - - *Identity version 3 only* - -.. option:: --group <group> - - Filter users by `<group>` membership (name or ID) - - *Identity version 3 only* - -.. option:: --long - - List additional fields in output - -user set --------- - -Set user properties - -.. program:: user set -.. code:: bash - - openstack user set - [--name <name>] - [--project <project> [--project-domain <project-domain>]] - [--password <password>] - [--password-prompt] - [--email <email-address>] - [--description <description>] - [--multi-factor-auth-rule <rule>] - [--ignore-lockout-failure-attempts| --no-ignore-lockout-failure-attempts] - [--ignore-password-expiry| --no-ignore-password-expiry] - [--ignore-change-password-upon-first-use| --no-ignore-change-password-upon-first-use] - [--enable-lock-password| --disable-lock-password] - [--enable-multi-factor-auth| --disable-multi-factor-auth] - [--enable|--disable] - <user> - -.. option:: --name <name> - - Set user name - -.. option:: --domain <domain> - - Domain the user belongs to (name or ID). - This can be used in case collisions between user names exist. - - .. versionadded:: 3 - -.. option:: --project <project> - - Set default project (name or ID) - -.. option:: --project-domain <project-domain> - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. option:: --password <password> - - Set user password - -.. option:: --password-prompt - - Prompt interactively for password - -.. option:: --email <email-address> - - Set user email address - -.. option:: --description <description> - - Set user description - - .. versionadded:: 3 - -.. option:: --ignore-lockout-failure-attempts - - Opt into ignoring the number of times a user has authenticated and - locking out the user as a result - -.. option:: --no-ignore-lockout-failure-attempts - - Opt out of ignoring the number of times a user has authenticated - and locking out the user as a result - -.. option:: --ignore-change-password-upon-first-use - - Control if a user should be forced to change their password immediately - after they log into keystone for the first time. Opt into ignoring - the user to change their password during first time login in keystone. - -.. option:: --no-ignore-change-password-upon-first-use - - Control if a user should be forced to change their password immediately - after they log into keystone for the first time. Opt out of ignoring - the user to change their password during first time login in keystone. - -.. option:: --ignore-password-expiry - - Opt into allowing user to continue using passwords that may be - expired - -.. option:: --no-ignore-password-expiry - - Opt out of allowing user to continue using passwords that may be - expired - -.. option:: --enable-lock-password - - Disables the ability for a user to change its password through - self-service APIs - -.. option:: --disable-lock-password - - Enables the ability for a user to change its password through - self-service APIs - -.. option:: --enable-multi-factor-auth - - Enables the MFA (Multi Factor Auth) - -.. option:: --disable-multi-factor-auth - - Disables the MFA (Multi Factor Auth) - -.. option:: --multi-factor-auth-rule <rule> - - Set multi-factor auth rules. For example, to set a rule requiring the - "password" and "totp" auth methods to be provided, - use: "--multi-factor-auth-rule password,totp". - May be provided multiple times to set different rule combinations. - -.. option:: --enable - - Enable user (default) - -.. option:: --disable - - Disable user - -.. describe:: <user> - - User to modify (name or ID) - -user show ---------- - -Display user details - -.. program:: user show -.. code:: bash - - openstack user show - [--domain <domain>] - <user> - -.. option:: --domain <domain> - - Domain owning :ref:`\<user\> <user_show-user>` (name or ID) - - .. versionadded:: 3 - -.. _user_show-user: -.. describe:: <user> - - User to display (name or ID) |
