--- title: Security API description: The REST API supports all aspects of Couchbase-Server security pubDate: 2026-08-17T09:53:44.266Z antora: editUrl: https://github.com/couchbaselabs/docs-enterprise-analytics/edit/release/2.0/modules/reference/pages/rest-security.adoc xref: xref:2.0@enterprise-analytics:reference:rest-security.adoc[] --- [Consult the llms.txt file for a full list of contents](/llms.txt) [View original HTML](/enterprise-analytics/2.0/reference/rest-security.html) # Security API > The REST API supports all aspects of Couchbase-Server security ## [](#apis-in-this-section)APIs in this Section The Security REST API provides the endpoints for general security, for authentication, and for authorization. For a list of the endpoints, see the tables below. ### [](#general-security)General Security | HTTP Method | URI | Documented at | | ----------- | ------------------------------------------ | ------------------------------------------------------------------------------- | | GET | ./whoami | [Who Am I?](rest-whoami.md) | | GET | /settings/audit | [Configure Auditing](rest-auditing.md) | | POST | /settings/audit | [Configure Auditing](rest-auditing.md) | | GET | /settings/audit/descriptors | [Configure Auditing](rest-auditing.md) | | GET | /settings/security | [Restrict Node-Addition](rest-specify-node-addition-conventions.md) | | POST | /settings/security | [Restrict Node-Addition](rest-specify-node-addition-conventions.md) | | POST | /clusterInit | [Initialize a Cluster](rest-initialize-cluster.md) | | GET | /settings/security/\[service-name\] | [Configure On-the-Wire Security](#reference:rest-setting-security.adoc) | | POST | /settings/security/\[service-name\] | [Configure On-the-Wire Security](#reference:rest-setting-security.adoc) | | POST | /node/controller/rotateInternalCredentials | [Rotate Internal Credentials](#reference:rest-rotate-internal-credentials.adoc) | | GET | /settings/security/responseHeaders | [Configure HSTS](#reference:rest-setting-hsts.adoc) | | POST | /settings/security/responseHeaders | [Configure HSTS](#reference:rest-setting-hsts.adoc) | | DELETE | /settings/security/responseHeaders | [Configure HSTS](#reference:rest-setting-hsts.adoc) | ### [](#authentication)Authentication | HTTP Method | URI | Documented at | | ----------- | ----------------------------------------------------------- | --------------------------------------------------------------------- | | GET | /settings/ldap | [Configure LDAP](rest-configure-ldap.md#get-settingsldap) | | POST | /settings/ldap | [Configure LDAP](rest-configure-ldap.md#post-settingsldap) | | GET | /settings/saml | [Configure SAML](rest-configure-saml.md#get-settingssaml) | | POST | /settings/saml | [Configure SAML](rest-configure-saml.md#post-settingssaml) | | GET | /settings/saslauthdAuth | [Configure saslauthd](rest-configure-saslauthd.md) | | POST | /settings/saslauthdAuth | [Configure saslauthd](rest-configure-saslauthd.md) | | GET | /settings/passwordPolicy | [Set Password Policy](rest-set-password-policy.md) | | POST | /settings/passwordPolicy | [Set Password Policy](rest-set-password-policy.md) | | POST | /controller/changePassword | [Change Password](rest-set-password.md) | | POST | /node/controller/loadTrustedCAs | [Load Root Certificates](load-trusted-cas.md) | | GET | /node/controller/loadTrustedCAs | [Get Root Certificates](get-trusted-cas.md) | | DELETE | /pools/default/trustedCAs/ | [Delete Root Certificates](delete-trusted-cas.md) | | GET | /pools/default/certificates | [Retrieve All Node Certificates](retrieve-all-node-certs.md) | | POST | /node/controller/reloadCertificate | [Upload and Retrieve Node Certificates](upload-retrieve-node-cert.md) | | GET | /pools/default/certificate/node/ | [Upload and Retrieve Node Certificates](upload-retrieve-node-cert.md) | | POST | /controller/regenerateCertificate | [Regenerate All Certificates](rest-regenerate-all-certs.md) | ### [](#authorization)Authorization | HTTP Method | URI | Documented at | | ----------- | ------------------------------------------------- | -------------------------------------------------------------------------------- | | GET | /settings/rbac/roles | [List Roles](rbac.md#list-roles) | | GET | /settings/rbac/users | [List Current Users and Their Roles](rbac.md#list-current-users-and-their-roles) | | POST | /pools/default/checkPermissions | [Check Permissions](rbac.md#check-permissions) | | GET | /settings/rbac/groups | [List Currently Defined Groups](rbac.md#list-currently-defined-groups) | | PUT | /settings/rbac/users/local/ | [Create a Local User](rbac.md#create-a-local-user-and-assign-roles) | | PATCH | /settings/rbac/users/local/ | [Create a Local User](rbac.md#create-a-local-user-and-assign-roles) | | PUT | /settings/rbac/users/local/ | [Create an External User](rbac.md#create-an-external-user-and-assign-roles) | | PUT | /settings/rbac/groups/ | [Create a Group](rbac.md#create-a-group-and-assign-it-roles) | | DELETE | /settings/rbac/users/local/ | [Delete Users and Groups](rbac.md#delete-users-and-groups) | | DELETE | /settings/rbac/users/external/ | [Delete Users and Groups](rbac.md#delete-users-and-groups) | | DELETE | /settings/rbac/groups/ | [Delete Users and Groups](rbac.md#delete-users-and-groups) | ### [](#system-secrets)System Secrets | HTTP Method | URI | Documented at | | ----------- | ------------------------------------- | -------------------------------------------------------------------------- | | GET | /nodes/self/secretsManagement | [Configuring System Secrets](#reference:system-secrets-configuration.adoc) | | POST | /node/controller/secretsManagement | [Configuring System Secrets](#reference:system-secrets-configuration.adoc) | | POST | /node/controller/changeMasterPassword | [Changing the Master Password](#reference:change-master-password.adoc) | | POST | /node/controller/rotateDataKey | [Rotating the Data Key](#reference:rotate-data-key.adoc) |