Skip to content

Commit 1cc5655

Browse files
committed
document enforce password change on next login
1 parent b08516d commit 1cc5655

File tree

5 files changed

+155
-0
lines changed

5 files changed

+155
-0
lines changed
203 KB
Loading
98.6 KB
Loading
169 KB
Loading
206 KB
Loading

source/adminguide/accounts.rst

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -901,6 +901,161 @@ password for a user:
901901
.. figure:: /_static/images/reset-password.png
902902
:align: center
903903

904+
Enforce Password Change for Users
905+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
906+
907+
Since version 4.23.0, CloudStack provides a security feature that allows administrators to
908+
**enforce a password change on the next login** for a User. This feature
909+
helps administrators comply with security policies such as periodic
910+
password rotation, compromised credential recovery, or administrative
911+
enforcement after manual password updates.
912+
913+
The enforcement can be applied by **Root Administrators** and
914+
**Domain Administrators** for Users within their scope.
915+
916+
When password change enforcement is enabled for a User:
917+
918+
- The User can successfully authenticate with their existing or temporary credentials.
919+
- Immediately after login, the User is redirected to a **Change Password** screen.
920+
- The User must set a new password before accessing any CloudStack resources.
921+
- Until the password is changed, no other UI actions or API operations are permitted.
922+
923+
Ways to Enforce Password Change
924+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
925+
926+
Password change enforcement can be applied in the following ways.
927+
928+
1. Enforce Password Change During User Creation
929+
"""""""""""""""""""""""""""""""""""""""""""""""
930+
931+
When creating a new User, administrators can choose to **enforce a
932+
password change on the User’s first login**.
933+
934+
This is particularly useful when:
935+
936+
- Initial passwords are set by administrators
937+
- Accounts are created in bulk
938+
- Temporary passwords are issued to new Users
939+
940+
**UI Flow:**
941+
942+
#. Navigate to **Accounts → Users**.
943+
#. Click **Add User**.
944+
#. Fill in the User details, including the initial password.
945+
#. Enable **User must change password at next login**.
946+
#. Add the User.
947+
948+
.. figure:: /_static/images/enforce-password-change-on-create.png
949+
:align: center
950+
:alt: Enforce password change during user creation
951+
952+
Upon first login, the User must change their password before accessing
953+
any resources.
954+
955+
2. Enforce Password Change When Changing a User Password
956+
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""
957+
958+
When an administrator changes a User’s password, CloudStack allows the
959+
administrator to **require the User to change the password on their next
960+
login**.
961+
962+
This ensures that:
963+
964+
- Administrators do not permanently know User passwords.
965+
- Temporary or reset passwords are only valid for a single login.
966+
967+
**UI Flow:**
968+
969+
#. Navigate to **Accounts → Users**.
970+
#. Open the required User details page.
971+
#. Select **Change Password**.
972+
#. Enable **User must change password at next login**.
973+
#. Save the changes.
974+
975+
.. figure:: /_static/images/enforce-password-change-on-update.png
976+
:align: center
977+
:alt: Enforce password change when updating user password
978+
979+
At the next login, the User must immediately choose a new password.
980+
981+
3. Enforce Password Change Without Changing the Password (Quick Action)
982+
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
983+
984+
Administrators can enforce a password change **without modifying the
985+
current password**. This is useful when enforcing security policies such
986+
as:
987+
988+
- Periodic password rotation
989+
- Organization-wide password policy updates
990+
- Suspected credential exposure
991+
992+
A **Quick Action** is available directly from the User details page.
993+
994+
**UI Flow:**
995+
996+
#. Navigate to **Accounts → Users**.
997+
#. Open the required User details page.
998+
#. Click **Enforce Password Change** from the actions menu.
999+
#. Confirm the action.
1000+
1001+
.. figure:: /_static/images/enforce-password-change-quick-action.png
1002+
:align: center
1003+
:alt: Enforce password change using quick action
1004+
1005+
The User will be forced to change their password on the next successful
1006+
login, even though their current password remains valid for authentication.
1007+
1008+
User Login Experience
1009+
^^^^^^^^^^^^^^^^^^^^^
1010+
1011+
When enforcement is active, the User login flow is as follows:
1012+
1013+
#. The User enters username, domain, and password.
1014+
#. Authentication succeeds.
1015+
#. The User is redirected to the **Change Password** page.
1016+
#. The User must set a new password that complies with configured
1017+
password policies.
1018+
#. Upon successful password update, normal access is granted.
1019+
1020+
.. figure:: /_static/images/force-password-change-login.png
1021+
:align: center
1022+
:alt: User prompted to change password after login
1023+
1024+
Permissions and Scope
1025+
^^^^^^^^^^^^^^^^^^^^^
1026+
1027+
- **Root Administrators** and **Domain Administrators** can enforce password changes for any User in the system.
1028+
- Regular Users cannot enforce password changes for themselves or others.
1029+
1030+
API Support
1031+
^^^^^^^^^^^
1032+
1033+
Password change enforcement can also be managed using CloudStack APIs when
1034+
updating a User.
1035+
Refer to the API documentation for the ``createUser`` and ``updateUser``
1036+
commands for details on password change enforcement parameters.
1037+
1038+
Notes and Limitations
1039+
^^^^^^^^^^^^^^^^^^^^^
1040+
1041+
.. note::
1042+
1043+
- This feature applies only to **CloudStack-managed username/password
1044+
authentication**.
1045+
- Enforcement of password change is not supported for Users authenticated via **LDAP, SAML, or OAuth2**.
1046+
- API key and secret key-based authentication is not affected by
1047+
password change enforcement.
1048+
1049+
Security Benefits
1050+
^^^^^^^^^^^^^^^^^
1051+
1052+
Enforcing password changes helps administrators:
1053+
1054+
- Reduce the risk of credential reuse
1055+
- Comply with organizational security standards
1056+
- Safely assist Users during account recovery
1057+
- Enforce password rotation policies without service disruption
1058+
9041059
Using API Key and Secret Key based Authentication
9051060
-------------------------------------------------
9061061
Users can generate API key and Secret key to directly access CloudStack APIs.

0 commit comments

Comments
 (0)