You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
DOC-12750 Authentication improvements - Ability to enable/disable Couchbase User (#3853)
* manage users n groups n blocking user
* lock n unlock users n manage password page
* Updated manage users and roles page for cli n api
* Added auditing user activity and rewrote manage auditing
* Added Reference section contents
* Enterprise Edition note added
* whats new entries
* image fix
* Implemented technical review inputs
* Implemented editorial review comments
* Minor edit Enterprise to Enterprise Edition
XDCR now supports the identification of Incoming Replications on a cluster.
319
+
The Incoming Replications can be:
320
+
321
+
* Viewed on the XDCR tab of the UI. See xref:manage:manage-xdcr/incoming-xdcr-replications.adoc#view-incoming-replications[View Incoming Replications] in xref:manage:manage-xdcr/incoming-xdcr-replications.adoc[Incoming Replications].
322
+
* Retrieved by using the REST API command `GET /xdcr/sourceClusters`. See xref:rest-api:rest-xdcr-list-incoming-replications.adoc[Listing Incoming Replications].
As an administrator, you can force a local domain user account to change their password when they next authenticate with Couchbase Server.
338
+
This feature is useful for assigning a temporary password to new user accounts by selecting the option to force the user to change their password when creating a new user.
339
+
+
340
+
For more information, see xref:learn:security/usernames-and-passwords.adoc#force-password-change[Force Password Change].
Copy file name to clipboardExpand all lines: modules/learn/pages/security/auditing.adoc
+32-6Lines changed: 32 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,19 +14,45 @@ The output is written to a log-file, which is periodically rotated.
14
14
[#adit_event_types]
15
15
== Audit Event-Types
16
16
17
-
Events generated by Couchbase Server are of two kinds:
17
+
The following types of events are generated by Couchbase Server:
18
18
19
-
* _Admin_ events, which track administrative and configuration changes to the cluster.
19
+
* Admin eventsand Data events:
20
20
21
-
*_Data_ events, which track attempts to access and change data.
21
+
** Admin events, which track administrative and configuration changes to the cluster.
22
22
23
-
Note that event-auditing occurs on a _per node_ basis: each node captures its own events only.
24
-
If a cluster-wide record is needed, the individual per node records must be manually consolidated by the administrator.
23
+
** Data events, which track attempts to access and change data.
24
+
+
25
+
[NOTE]
26
+
.Event auditing occurs on a per node basis
27
+
====
28
+
Each node captures its own events only.
29
+
If a cluster-wide record is needed, the individual per node records must be manually consolidated by the administrator.
30
+
====
31
+
32
+
* User Activity, which records the date and time of the user’s last request to the server.
25
33
26
34
This page explains frequently used audit fields, and gives examples of record-structures.
27
-
For information on managing auditing, see xref:manage:manage-security/manage-auditing.adoc[Manage Auditing].
35
+
For information about managing auditing, see xref:manage:manage-security/manage-auditing.adoc[Manage Auditing].
28
36
See the reference page xref:audit-event-reference:audit-event-reference.adoc[Audit Event Reference], for a complete list of events that can be audited.
29
37
38
+
[#audit-user-activity]
39
+
== Audit User Activity
40
+
41
+
IMPORTANT: This is a Couchbase Server Enterprise Edition feature.
42
+
43
+
Auditing user activity allows administrators to track the last time a local user made a request to the Cluster Manager.
44
+
This feature helps identify dormant accounts, improve security, and support compliance with organizational policies.
45
+
The system does not record every action but instead stores the timestamp of the most recent request.
46
+
This approach minimizes performance overhead while still providing useful insight into account usage.
47
+
48
+
User activity auditing applies only to the local domain users.
49
+
Externally authenticated users, such as those managed by LDAP or SAML, are not tracked.
50
+
Administrators can configure which roles and groups are included in activity tracking.
51
+
52
+
The last recorded connection time is visible on the UI in the xref:manage:manage-security:manage-security-settings.adoc[Security] section and can also be retrieved through the REST API.
53
+
This makes it easier for administrators to monitor active and inactive accounts.
54
+
To enable and configure user activity auditing, see xref:manage:manage-security/manage-auditing.adoc#auditing-user-activity[Auditing User Activity] in xref:manage:manage-security/manage-auditing.adoc[Manage Auditing].
55
+
30
56
== Audit Fields
31
57
32
58
The table below lists frequently used audit fields, with corresponding descriptions.
Copy file name to clipboardExpand all lines: modules/learn/pages/security/authentication-overview.adoc
+35-2Lines changed: 35 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ For more information about single sign-on, see xref:learn:security/authenticatio
22
22
The recommended method for application-authentication when connecting to Couchbase Server is to use x.509 _certificate-based_ authentication.
23
23
This ensures that only approved users, machines, or endpoints are authenticated, and provides what is known as _mutual authentication_.
24
24
25
-
_Mutual-TLS_ (mTLS) certificate-based authentication relies on a _Certificate Authority_ (CA) to validate identities and issue certificates.
25
+
Mutual-TLS (mTLS) certificate-based authentication relies on a _Certificate Authority_ (CA) to validate identities and issue certificates.
26
26
When using this method, no sensitive credentials are shared over the network; and all communication between application and server is performed over an _encrypted channel_, to prevent eavesdropping and impersonation.
27
27
28
28
For a complete overview of Couchbase Server’s certificate-handling mechanisms, see xref:learn:security/certificates.adoc[Certificates].
@@ -138,7 +138,40 @@ The _local_ domain contains users defined locally, on Couchbase Server.
138
138
The _external_ domain contains users defined externally on an LDAP server, a SAML IdP provider, or Linux systems that are accessed by means of _PAM_.
139
139
For a complete overview, see xref:learn:security/authentication-domains.adoc[Authentication Domains].
140
140
141
+
In addition to a username and password requirement,
142
+
SAML can require _Two-Factor Authentication_ (TFA) such as a one-time code sent via text message or a code generated by an authentication module or app.
143
+
SAML can also provide _Single Sign On_ (SSO), where a user that has already authenticated with another application is automatically authenticated to use.
141
144
145
+
[#blocking-user-authentication]
146
+
== Blocking User Authentication
142
147
148
+
IMPORTANT: This is a Couchbase Server Enterprise Edition feature.
143
149
144
-
In addition to a username and password requirement, SAML can require _Two-Factor Authentication_ (TFA) such as a one-time code sent via text message or a code generated by an authentication module or app. SAML can also provide _Single Sign On_ (SSO), where a user that has already authenticated with another application is automatically authenticated to use
150
+
Administrators can lock user accounts by blocking their authentication.
151
+
This is enforced through account locking.
152
+
After an account is marked as locked, it prevents the user from logging in or from continuing the existing sessions.
153
+
Locking an account terminates all active UI sessions and long-running connections such as Memcached or streaming connections.
154
+
155
+
[IMPORTANT]
156
+
====
157
+
* This feature is only available after the entire cluster is upgraded to version 8.0 or later.
158
+
159
+
* Only local domain user accounts can be locked or unlocked.
160
+
External domain user accounts cannot be locked or unlocked.
161
+
====
162
+
163
+
This feature is useful for preventing users from connecting to the database during maintenance.
164
+
165
+
Administrators can block authentication manually through the UI, REST API, or CLI,
166
+
or automatically through inactivity-based locking after a defined idle period (using TTL).
167
+
TTL based locking also allows accounts to be blocked temporarily, with automatic unlocking after the configured duration.
168
+
By default, automatic blocking rules can exclude System Administrators and other critical roles, to maintain uninterrupted operations.
169
+
170
+
From the authentication flow perspective, any login attempt against a blocked account is denied,
171
+
and the login screen displays a clear error message indicating that the account has been locked.
172
+
The server communicates this state consistently across interfaces; UI responses, CLI status, REST API outputs, and SDK error codes all reflect the locked status.
173
+
174
+
For auditing and compliance, every lock event is logged with details of who performed the action and under what conditions.
175
+
This ensures that blocking user authentication is both transparent and reversible while maintaining strong security boundaries.
176
+
177
+
For more information about locking or unlocking user accounts from the UI, see xref:manage:manage-security/manage-users-and-roles.adoc#lock-and-unlock-user-accounts[Lock and Unlock User Accounts].
Copy file name to clipboardExpand all lines: modules/learn/pages/security/usernames-and-passwords.adoc
+32Lines changed: 32 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,3 +87,35 @@ Therefore, once a user has authenticated, their role-assignment is examined, and
87
87
See xref:learn:security/authorization-overview.adoc[Authorization], for details.
88
88
89
89
Note that usernames and role-names are _case sensitive_.
90
+
91
+
== Changing Passwords
92
+
93
+
Administrators can configure and enforce security policies to make sure that users maintain secure and up-to-date passwords.
94
+
Couchbase Server supports temporary passwords.
95
+
These controls help prevent unauthorized access and reduce the risk of weak or repeated passwords.
96
+
97
+
All local users can change their passwords through the UI, REST API, or CLI.
98
+
99
+
When local users authenticate with the UI, the system prompts them to change their password at their next login.
100
+
The CLI provides the `couchbase-cli user-change-password` command, and the REST API supports password updates through the `/controller/changePassword` endpoint.
101
+
For more information, see xref:manage:manage-security/manage-passwords.adoc[Manage Passwords].
102
+
103
+
Even users whose accounts do not have privileges to use the Couchbase Web Console can sign in using the UI login page to change their password.
104
+
105
+
The users managed by external systems, such as LDAP or SAML, must use the tools provided by their external authentication provider to update their passwords.
106
+
107
+
[#force-password-change]
108
+
=== Force Password Change
109
+
110
+
Administrators can enforce a password change on the user’s next login.
111
+
This option is useful when issuing a temporary password or resetting a compromised account.
112
+
113
+
Enforcing password change results in the following:
114
+
115
+
* The user is prompted to set a new password before accessing the Couchbase Server.
116
+
The user can set a new password using the UI, REST API, or CLI.
117
+
* When authenticating from the UI, users are prompted to set a new password and cannot access any features until they have updated their password.
118
+
119
+
This feature ensures that only the user knows their active password and that temporary or shared credentials cannot be reused indefinitely.
120
+
121
+
For more information, see xref:manage:manage-security/manage-passwords.adoc#force-password-update[Force Password Update].
0 commit comments