Roles | Couchbase Docs (original) (raw)
A Couchbase role permits one or more resources to be accessed according to defined privileges.
Roles and Privileges
Couchbase roles each have a fixed association with a set of one or more privileges. Each privilege is associated with a resource. Privileges are actions such as Read, Write, Execute, Manage, Flush, and List; or a combination of some or all of these.
Roles are of the following kinds:
- Administative: Associated with cluster-wide privileges. Some of these roles are for administrators; who might manage cluster-configurations; or read statistics; or enforce security. Others are for users and user-defined applications that require access to specific, cluster-wide resources.
- Bucket: Associated with bucket administration, collection management, and application access. Roles in this category can each be applied to one, to multiple, or to all buckets on the cluster.
- Data, Views, and XDCR: Associated with the Data Service. This includes the reading, writing, monitoring, backing-up, and restoring of data; the administration of Views; and the administration of Cross Data-Center Replication (XDCR).
- Other Services: Roles for the administration of services other than the Data Service. These roles are organized under the following categories: Query & Index, Search, Analytics, and Backup. (Eventing administration is covered within the Administrative category.)
- Mobile: Associated with the administration of Sync Gateway.
When a user (meaning either an administrator or an application) attempts to access a resource, they must authenticate. The roles and privileges associated with the user-credentials thereby presented are checked by Couchbase Server. If the associated roles contain privileges that support the kind of access that is being attempted, access is granted; otherwise, it is denied.
Roles in Relation to Buckets
All data within a bucket is contained within some collection, within some scope. Permissions conveyed by bucket-related roles may be restricted in any of the following ways:
- By Bucket: Permissions apply to all data in the specified bucket: all scopes and collections are thus covered by the permissions.
- By Bucket and Scope: Permissions apply only to the collections within the specified scope (or scopes), within the specified bucket.
- By Bucket, Scope, and Collection: Permissions apply only to the data within the specified collection (or collections), within the specified scope (or scopes), within the specified bucket.
Commonly Used Roles
Couchbase Server users can largely be categorized as administrators, developers, and applications. Each user-category is supported by a different subset of roles.
- Administrators. Able to log into Couchbase Web Console and perform administrative tasks; but unable to read or write data.
The administrative tasks available are divided into multipleadminroles. For example, the Cluster Admin role allows the management of all cluster features except security; while the Read-Only Admin role allows only the reading of statistics; and the Bucket Admin role allows management only of one or more buckets. See the Admin roles listed below for full details. Note that depending on the administrator’s assigned roles, the content of Couchbase Web Console changes: for example, the entire Security screen is only visible to Full Admin administrators; and to administrators who possess both the Local User Security Admin and the External User Security Admin roles. - Applications. Able to read or write data; but unable to log into Couchbase Web Console, or in any way modify cluster-settings. For example, the Data Reader and Data Writer roles allows data to be respectively read and written to one or more collections, within one or more scopes, within one or more buckets. Other application-intended roles are Application Access, Data Writer, Data Backup & Restore, and Data Monitor. See below for details on each.
- Developers. Can be given a selection of roles, allowing the right degree of data and console access. For example, the Read-Only Admin role allows the reading of cluster-statistics, while the Data Read and Data Write roles allow access to data on one or more buckets.
The following list contains all roles supported by Couchbase Server, Enterprise Edition. Each role is explained by means of a description and (in most cases) a table: the table lists the privileges in association with resources. The header of each table states the role’s name, followed by its alias name in parentheses: alias names are used in commands and queries. In each table-body, where a privilege is associated with a resource, this is indicated with a check-mark. Where a privilege is not associated with a resource (or where association would not be applicable), this is indicated with a cross. Resources not referred to in a particular table have no privileges associated with them in the context of the role being described.
Note that some roles grant access to Couchbase Web Console; while others do not. The set of features displayed within the console varies, according to role.
Note also that any authentication failure will be logged in the log file for the resource on which access was attempted. See Manage Logging, for detailed information on using log files.
Full Admin
The Full Admin role (an Administrative role) supports full access to all Couchbase-Server features and resources, including those of security. The role allows access to Couchbase Web Console, and allows the reading and writing of bucket-data.
This role is also available in Couchbase Server Community Edition.
Cluster Admin
The Cluster Admin role (an Administrative role) allows the management of all cluster features except security. The role allows access to Couchbase Web Console, but does not permit the writing of data.
| Role: Cluster Admin (cluster_admin) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Cluster (except Passwords) |  |
|
|
|
| UI (except Passwords) | |
|
|
|
| Security (except Passwords) | |
 |
|
|
| Bucket Data | |
|
|
|
Local User Security Admin
The Local User Security Admin role (an Administrative role) allows the management of local user roles and the reading of all cluster statistics. The role does not permit the granting of the Full Admin, the Read-Only Admin, the Local User Security Admin, or the External User Security Admin role; and does not permit the administrator to change their own role (which therefore remains Local User Security Admin). The role supports access to Couchbase Web Console, but does not support the reading of data.
| Role: Local User Security Admin (security_admin_local) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Cluster | |
|
|
|
| UI (except Local User and Group Security) | |
|
|
|
| Local User and Group Security (including UI) | |
|
|
|
| Bucket Data | |
|
|
|
External User Security Admin
The External User Security Admin role (an Administrative role) allows the management of external user roles and the reading of all cluster statistics. The role does not permit the granting of the Full Admin, the Read-Only Admin, the Local User Security Admin, or the External User Security Admin role; and does not permit the administrator to change their own role (which therefore remains External User Security Admin). The role supports access to Couchbase Web Console, but does not support the reading of data.
| Role: External User Security Admin (security_admin_external) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Cluster | |
|
|
|
| UI (except External User Security) | |
|
|
|
| Security (including UI) | |
|
|
|
| Bucket Data | |
|
|
|
Read-Only Admin
The Read-Only Admin role (an Administrative role) supports the reading of Couchbase Server statistics. This information includes registered usernames with roles and authentication domains, but excludes passwords. Since Couchbase Server version 7.6.2, users with this role can also read Backup Service data to monitor backup plans and tasks. The role allows access to Couchbase Server Web Console.
This role is also available in Couchbase Server Community Edition.
| Role: Read-Only Admin (ro_admin) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Cluster | |
|
|
|
| UI (except Passwords) | |
|
|
|
| Security (except Passwords) | |
|
|
|
| Bucket Data | |
|
|
|
| Backup Service (tasks and plans) Couchbase Server 7.6.2 | |
|
|
|
External Stats Reader
The External Stats Reader role (an Administrative role) grants access to the /metrics and /prometheus_sd_config endpoints for Prometheus integration. All statistics for all services can be read. The role does not allow access to Couchbase Web Console.
| Role: External Stats Reader (external_stats_reader) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Admin : stats_export | |
|
|
|
XDCR Admin
The XDCR Admin role (an XDCR role) allows use of XDCR features, to create cluster references and replication streams. The role allows access to Couchbase Web Console and allows the reading of data.
| Role: XDCR Admin (replication_admin) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| XDCR for Cluster and Bucket | |
|
|
|
| Bucket Data | |
|
|
|
| Bucket Settings | |
|
|
|
| Bucket Statistics | |
|
|
|
| UI (XDCR) | |
|
|
|
| UI (Other) | |
|
|
|
Query Curl Access
The Query Curl Access role (a Query & Index role) allows the SQL++ CURL function to be executed by an externally authenticated user. The user can access Couchbase Web Console, but cannot read data, other than that returned by the SQL++ CURL function.
Note that the Query Curl Access role should be assigned with caution, since it entails risk: CURL runs within the local Couchbase Server network; therefore, the assignee of the Query Curl Access role is permitted to run GET and POST requests on the internal network, while being themselves externally located.
For an account of limitations on CURL, see CURL Function.
In versions of Couchbase Server prior to 5.5, this role was referred to as Query External Access.
| Role: Query Curl Access (query_external_access) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Bucket : SQL++, curl | |
|
|
|
| Bucket settings | |
|
|
|
| UI | |
|
|
|
| Pools | |
|
|
|
Query System Catalog
The Query System Catalog role (a Query & Index role) allows information to be looked up by means of SQL++ in the system catalog: this includes system:indexes, system:prepareds, and tables listing current and past queries. This role is designed for troubleshooters, who need to debug queries. The role allows access to Couchbase Web Console, but does not permit the reading of bucket-items.
| Role: Query System Catalog (query_system_catalog) | |||||
|---|---|---|---|---|---|
| Resources | Privileges | ||||
| Read | Write | Execute | Manage | List | |
| Bucket : SQL++, INDEX | |
|
|
|
|
| Bucket : SQL++, Meta | |
|
|
|
|
| Bucket Settings | |
|
|
|
|
| UI | |
|
|
|
|
| Pools | |
|
|
|
|
Manage Global Functions
The Manage Global Functions role (a Query & Index role) allows global SQL++ functions to be managed. The user can access Couchbase Web Console, but cannot read data.
| Role: Manage Global Functions (query_manage_global_functions) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| SQL++, udf | |
|
|
|
| UI | |
|
|
|
| Pools | |
|
|
|
Execute Global Functions
The Execute Global Functions role (a Query & Index role) allows global SQL++ functions to be executed. The user can access Couchbase Web Console, but cannot read data.
| Role: Execute Global Functions (query_execute_global_functions) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| SQL++, udf | |
|
|
|
| UI | |
|
|
|
| Pools | |
|
|
|
Manage Scope Functions (Query and Index)
The Manage Scope Functions role (a Query & Index role) allows SQL++ and user defined functions to be managed for a given scope, given corresponding specification of bucket. The user can access Couchbase Web Console, but cannot read data.
| Role: Manage Scope Functions (query_manage_functions) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Bucket, Scope: SQL++, udf | |
|
|
|
| UI | |
|
|
|
| Pools | |
|
|
|
Execute Scope Functions
The Execute Scope Functions role (a Query & Index role) allows SQL++ and user defined functions to be executed for a given scope, given corresponding specification of bucket. The user can access Couchbase Web Console, but cannot read data.
| Role: Execute Scope Functions (query_execute_functions) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Collection, Bucket, Scope: SQL++, udf | |
|
|
|
| UI | |
|
|
|
| Pools | |
|
|
|
Manage Global External Functions
The Manage Global External Functions role (a Query & Index role) allows global external language functions to be managed. The user can access Couchbase Web Console, but cannot read data.
| Role: Manage Global External Functions (query_manage_global_external_functions) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| SQL++, udf_external | |
|
|
|
| UI | |
|
|
|
| Pools | |
|
|
|
Execute Global External Functions
The Execute Global External Functions role (a Query & Index role) allows global SQL++ functions to be executed. The user can access Couchbase Web Console, but cannot read data.
| Role: Execute Global External Functions (query_execute_global_external_functions) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| SQL++, udf_external | |
|
|
|
| UI | |
|
|
|
| Pools | |
|
|
|
Manage Scope External Functions
The Manage Scope External Functions role (a Query & Index role) allows external language functions to be managed for a given scope, given corresponding specification of bucket. The user can access Couchbase Web Console, but cannot read data.
| Role: Manage Scope External Functions (query_manage_external_functions) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Collection, Bucket, Scope: SQL++, udf_external | |
|
|
|
| UI | |
|
|
|
| Pools | |
|
|
|
Execute Scope External Functions
The Execute Scope External Functions role (a Query & Index role) allows external language functions to be executed for a given scope, given corresponding specification of bucket. The user can access Couchbase Web Console, but cannot read data.
| Role: Execute Scope External Functions (query_execute_external_functions) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Collection, Bucket, Scope: SQL++, udf_external | |
|
|
|
| UI | |
|
|
|
| Pools | |
|
|
|
Analytics Reader
The Analytics Reader role (an Analytics role) allows querying of shadow data-sets. The role allows access to Couchbase Web Console, and permits the reading of data.
| Role: Analytics Reader (analytics_reader) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Bucket : Analytics | |
|
|
|
| UI | |
|
|
|
| Pools | |
|
|
|
Analytics Admin
The Analytics Admin role (an Analytics role) allows management of dataverses; management of all Analytics Service links; and management of all datasets. The role allows access to Couchbase Web Console, but does not permit the reading of data.
| Role: Analytics Admin (analytics_admin) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Dataverse : Analytics | |
|
|
|
| Bucket : Analytics | |
|
|
|
| Bucket : UI | |
|
|
|
| Other : UI | |
|
|
|
| Pools | |
|
|
|
Bucket Admin
The Bucket Admin role (which is a Bucket role) allows the management of all per bucket features (including starting and stopping XDCR). The role allows access to Couchbase Web Console, but does not permit the reading or writing of data.
| Role: Bucket Admin (bucket_admin) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Cluster | |
|
|
|
| Bucket (including XDCR) | |
|
|
|
| Bucket Data | |
|
|
|
| Bucket UI | |
|
|
|
| Other UI | |
|
|
|
Manage Scopes
The Manage Scopes role (a Bucket role) allows the creation and deletion of scopes, and the creation and deletion of collections per scope, given the corresponding specification of bucket. The role allows no access to data, and does not permit access to Couchbase Web Console. The role is intended for application use only.
| Role: Manage Scopes (scope_admin) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Manage Scopes | |
|
|
|
| UI | |
|
|
|
Application Access
The Application Access role (a Bucket role) provides read and write access to data, per bucket. The role does not allow access to Couchbase Web Console: it is intended for applications, rather than users. Note that this role is also available in the Community Edition of Couchbase Server.
The role is provided in support of buckets that were created on versions of Couchbase Server prior to 5.0. Such buckets were accessed by specifying bucket-name and bucket-password: however, bucket-passwords are not recognized by Couchbase Server 5.0 and after. Therefore, for each pre-existing bucket, the upgrade-process for 5.0 and after creates a new user, whose username is identical to the bucket-name; and whose password is identical to the former bucket-password, if one existed. If no bucket-password existed, the user is created with no password. This migration-process allows the same name-combination as before to be used in authentication. To ensure backwards compatibility, each system-created user is assigned the Application Access role, which authorizes the same read-write access to bucket-data as was granted before 5.0.
Use of the Application Access role is deprecated for buckets created on Couchbase Server 5.0 and after: use the other bucket-access roles provided. Note that in versions of Couchbase Server prior to 5.5, this role was referred to as Bucket Full Access.
| Role: Application Access (bucket_full_access) | |||||
|---|---|---|---|---|---|
| Resources | Privileges | ||||
| Read | Write | Execute | Manage | Flush | |
| Bucket Data | |
|
|
|
|
| Bucket Views | |
|
|
|
|
| SQL++: Index | |
|
|
|
|
| SQL++: Other | |
|
|
|
|
| Bucket | |
|
|
|
|
| Pools | |
|
|
|
|
XDCR Inbound
The XDCR Inbound role (which is an XDCR role) allows the creation of inbound XDCR streams, per bucket. It does not allow access to Couchbase Web Console, and does not permit the reading of data.
In versions of Couchbase Server prior to 5.5, this role was referred to as Replication Target.
| Role: XDCR Inbound (replication_target) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Bucket : Settings | |
|
|
|
| Bucket : Meta | |
|
|
|
| Bucket : Stats | |
|
|
|
| Pools | |
|
|
|
Sync Gateway
The Sync Gateway role (which is a Mobile role) allows full access to data per bucket, as required by Sync Gateway. The role does not allow access to Couchbase Web Console. The user can, by means of Sync Gateway, read and write data, manage indexes and views, and read some cluster information.
| Role: Sync Gateway (mobile_sync_gateway) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| UI | |
|
|
|
| Bucket : Data | |
|
|
|
| Bucket : Views | |
|
|
|
| Bucket : Indexes | |
|
|
|
| Bucket : Query | |
|
|
|
| Bucket : Flush | |
|
|
|
| Bucket : Settings | |
|
|
|
| Auto-compaction | |
|
|
|
| Admin: Memcached: Idle | |
|
|
|
| Pools | |
|
|
|
Sync Gateway Architect
The Sync Gateway Architect role (which is a Mobile role) allows management of Sync Gateway databases; and of Sync Gateway users and roles; and allows access to Sync Gateway’s /metrics endpoint. The role does not allow access to Couchbase Web Console; and does not allow reading of application data. For information on Sync Gateway users and roles, see Access Control Concepts.
| Role: Sync Gateway Architect (sync_gateway_configurator) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| UI | |
|
|
|
| Collection: Data | |
|
|
|
| Collection: Sync Gateway Users and Roles | |
|
|
|
| Metrics: Sync Gateway | |
|
|
|
Sync Gateway Application
The Sync Gateway Application role (which is a Mobile role) allows management of Sync Gateway users and roles; and allows application data to be read and written through Sync Gateway. The role does not allow access to Couchbase Web Console. For information on Sync Gateway users and roles, see Access Control Concepts.
| Role: Sync Gateway Application (sync_gateway_app) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| UI | |
|
|
|
| Collection: Sync Gateway Users and Roles | |
|
|
|
| Collection: Sync Gateway Application Data | |
|
|
|
Sync Gateway Application Read Only
The Sync Gateway Application Read Only role (which is a Mobile role) allows reading of Sync Gateway users and roles; and allows application data to be read through Sync Gateway. The role does not allow access to Couchbase Web Console. For information on Sync Gateway users and roles, see Access Control Concepts.
| Role: Sync Gateway Application Read Only (sync_gateway_app_ro) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| UI | |
|
|
|
| Collection: Sync Gateway Users and Roles | |
|
|
|
| Collection: Sync Gateway Application Data | |
|
|
|
Sync Gateway Replicator
The Sync Gateway Replicator role (which is a Mobile role) allows management of Sync Gateway replications. The role does not allow access to Couchbase Web Console.
| Role: Sync Gateway Replicator (sync_gateway_replicator) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| UI | |
|
|
|
| Collection: Sync Gateway Replications | |
|
|
|
Sync Gateway Dev Ops
The Sync Gateway Dev Ops role (which is a Mobile role) allows management of Sync Gateway node-level configuration; and allows access to Syn Gateway’s /metrics endpoint, for Prometheus integration. The role does not allow access to Couchbase Web Console.
| Role: Sync Gateway Dev Ops (sync_gateway_dev_ops) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| UI | |
|
|
|
| Dev Ops: Sync Gateway | |
|
|
|
| Metrics: Sync Gateway | |
|
|
|
Data Reader
The Data Reader role (which is a Data role) allows data to be read per collection, given corresponding specifications for bucket and scope. Note that the role does not permit the running of SQL++ queries (such as SELECT) against data. The role does not allow access to Couchbase Web Console: it is intended to support applications, rather than users.
| Role: Data Reader (data_reader) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Bucket Docs | |
|
|
|
| Bucket : Meta | |
|
|
|
| Bucket : Xattr | |
|
|
|
| Pools | |
|
|
|
Data Writer
The Data Writer role (which is a Data role) allows data to be written per collection, given corresponding specifications for bucket and scope. The role does not allow access to Couchbase Web Console: it is intended to support applications, rather than users.
| Role: Data Writer (data_writer) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Bucket : Docs | |
|
|
|
| Bucket : Xattr | |
|
|
|
| Pools | |
|
|
|
Data DCP Reader
The Data DCP Reader role (which is a Data role) allows DCP streams to be initiated per collection, given corresponding specifications for bucket and scope. The role does not allow access to Couchbase Web Console: it is intended to support applications, rather than users. The role does allow the reading of data.
| Role: Data DCP Reader (data_dcp_reader) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Bucket: : Data | |
|
|
|
| Bucket: : DCP | |
|
|
|
| Bucket: : Sxattr | |
|
|
|
| Admin: Memcached: Idle | |
|
|
|
| Pools | |
|
|
|
Data Backup & Restore
The Data Backup & Restore role (which is a Data role) allows data to be backed up and restored, per bucket. The role supports the reading of data. The role does not allow access to Couchbase Web Console: it is intended to support applications, rather than users.
The privileges represented in this table are, from left to right, Read, Write, Execute, Manage, Select, Backup, Create, List, and Build.
| Role: Data Backup & Restore (data_backup) | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| Resources | Privileges | ||||||||
| Rd | Wrt | Exec | Mng | Slct | Bckp | Crt | Lst | Bld | |
| Bucket: : Data | |
|
|
|
|
|
|
|
|
| Bucket: : Views | |
|
|
|
|
|
|
|
|
| Bucket: : FTS | |
|
|
|
|
|
|
|
|
| Bucket: : Stats | |
|
|
|
|
|
|
|
|
| Bucket: : Settings | |
|
|
|
|
|
|
|
|
| Bucket: : SQL++, Index | |
|
|
|
|
|
|
|
|
| Bucket: : SQL++, Meta | |
|
|
|
|
|
|
|
|
| Bucket: : Analytics | |
|
|
|
|
|
|
|
|
| Analytics: | |
|
|
|
|
|
|
|
|
| Pools | |
|
|
|
|
|
|
|
|
Data Monitor
The Data Monitor role (which is a Data role) allows statistics to be read for a given bucket, scope, or collection. It does not allow access to Couchbase Web Console, and does not permit the reading of data. This role is intended to support application-access, rather than user-access.
In versions of Couchbase Server prior to 5.5, this role was referred to as Data Monitoring.
| Role: Data Monitor (data_monitoring) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Bucket : Stats | |
|
|
|
| Pools | |
|
|
|
Views Admin
The Views Admin role (which is a Views role) allows the management of views, per bucket. The role allows access to Couchbase Web Console.
| Role: Views Admin (views_admin) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Bucket Data (Views) | |
|
|
|
| Bucket Data (Other) | |
|
|
|
| Bucket Statistics | |
|
|
|
| Bucket Settings | |
|
|
|
| Bucket (SQL++) | |
|
|
|
| UI (Views) | |
|
|
|
| UI (Other) | |
|
|
|
Views Reader
The Views Reader role (which is an Administrative role) allows data to be read from views, per bucket. This role does not allow access to Couchbase Web Console, and is intended to support applications, rather than users.
| Role: Views Reader (views_reader) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Bucket : Docs | |
|
|
|
| Bucket : Views | |
|
|
|
| Pools | |
|
|
|
Query Select
The Query Select role (which is a Query & Index role) allows the SELECT statement to be executed per collection, given corresponding specifications for bucket and scope. This role allows access to Couchbase Web Console; it also supports the reading of data, and of bucket settings.
| Role: Query Select (query_select) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Bucket : SQL++, SELECT | |
|
|
|
| Bucket : Docs | |
|
|
|
| Bucket Settings | |
|
|
|
| UI | |
|
|
|
| Pools | |
|
|
|
Query Update
The Query Update role (which is a Query & Index role) allows the UPDATE statement to be executed per collection, given corresponding specifications for bucket and scope. The role supports access to Couchbase Web Console, and allows the writing (but not the reading) of data. It allows the reading of bucket settings.
| Role: Query Update (query_update) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Bucket : SQL++, UPDATE | |
|
|
|
| Bucket : Docs | |
|
|
|
| Bucket Settings | |
|
|
|
| UI | |
|
|
|
| Pools | |
|
|
|
Query Insert
The Query Insert role (which is a Query & Index role) allows the INSERT statement to be executed per collection, given corresponding specifications for bucket and scope. The role supports access to Couchbase Web Console, and allows the writing (but not the reading) of data. It allows the reading of bucket settings.
| Role: Query Insert (query_insert) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Bucket : SQL++, INSERT | |
|
|
|
| Bucket : Docs | |
|
|
|
| Bucket Settings | |
|
|
|
| UI | |
|
|
|
| Pools | |
|
|
|
Query Delete
The Query Delete role (which is a Query & Index role) allows the DELETE statement to be executed per collection, given corresponding specifications for bucket and scope. The role supports access to Couchbase Server Web Console, and allows the deletion of data. It allows the reading of bucket settings.
| Role: Query Delete (query_delete) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Bucket : SQL++, DELETE | |
|
|
|
| Bucket : Docs Delete | |
|
|
|
| Bucket Settings | |
|
|
|
| UI | |
|
|
|
| Pools | |
|
|
|
Query Use Sequential Scan
The Query Use Sequential Scan role, located under Query & Index in the Web Console’s roles list, allows users' queries to perform a sequential scan of a keyspace. The query planner only decides to use a sequential scan when there is no suitable index for the keyspace. Only queries by users with this role can use a sequential scan to access data because scanning a large unindexed keyspace can be expensive. This role does not grant the user the ability to read or mutate data or access to the Web Console. Administrators' queries automatically have permission to perform sequential scans when necessary.
| Role: Query Use Sequential Scan (query_use_sequential_scans) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Sequential Scans | |
|
|
|
| Bucket : Docs | |
|
|
|
| Bucket Settings | |
|
|
|
| UI | |
|
|
|
| Pools | |
|
|
|
Query Manage Index
The Query Manage Index role (which is a Query & Index role) allows indexes to be managed per collection, given corresponding specifications for bucket and scope. The role allows access to Couchbase Web Console, but does not permit the reading of data.
| Role: Query Manage Index (query_manage_index) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Bucket : SQL++, INDEX | |
|
|
|
| Bucket Settings | |
|
|
|
| Bucket Statistics | |
|
|
|
| Index Settings | |
|
|
|
| UI | |
|
|
|
| Pools | |
|
|
|
Eventing Full Admin
The Eventing Full Admin role (which is an Eventing role) allows creation and management of eventing functions. The role allows access to Couchbase Web Console.
| Role: Eventing Full Admin (eventing_admin) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Data | |
|
|
|
| SQL++ | |
|
|
|
| Eventing | |
|
|
|
| Analytics | |
|
|
|
| UI | |
|
|
|
Manage Scope Functions (Eventing)
The Manage Scope Functions role (which is an Eventing role) allows eventing functions for a given scope to be managed. The role allows access to Couchbase Web Console.
| Role: Manage Scope Functions (eventing_manage_functions) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Bucket, Collection: Functions for Scope | |
|
|
|
| Bucket Statistics | |
|
|
|
| UI | |
|
|
|
Backup Full Admin
The Backup Full Admin role (which is a Backup role) allows performance of backup-related tasks. The role allows access to Couchbase Web Console.
| Role: Backup Full Admin (backup_admin) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Data | |
|
|
|
| Cluster Settings | |
|
|
|
| Bucket Settings | |
|
|
|
| Backup Service | |
|
|
|
| UI | |
|
|
|
Search Admin
The Search Admin role (which is a Search role) allows management of all features of the Search Service, per bucket. The role allows access to Couchbase Web Console.
In versions of Couchbase Server prior to 5.5, this role was referred to as FTS Admin.
| Role: Search Admin (fts_admin) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Bucket Data (Search) | |
|
|
|
| Bucket Data (Other) | |
|
|
|
| Bucket Settings | |
|
|
|
| Search Settings | |
|
|
|
| UI (Other) | |
|
|
|
| Pools | |
|
|
|
Search Reader
The role Search Reader (which is a Search role) allows Full Text Search indexes to be searched for bucket, scope, and collection. The role allows access to Couchbase Web Console, and supports the reading of data.
In versions of Couchbase Server prior to 5.5, this role was referred to as FTS Searcher.
| Role: Search Reader (fts_searcher) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Bucket : FTS | |
|
|
|
| Settings: FTS | |
|
|
|
| UI | |
|
|
|
| Pools | |
|
|
|
Analytics Select
The Analytics Select role (which is an Analytics role) allows the querying of datasets for bucket, scope. and collection. The role allows access to Couchbase Web Console, and permits the reading of some data.
| Role: Analytics Select (analytics_select) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Bucket : Analytics | |
|
|
|
| UI | |
|
|
|
| Pools | |
|
|
|
Analytics Manager
The Analytics Manager role (which is an Analytics role) allows the management and querying of datasets created per bucket; and the management of Analytics Service local links. The role allows access to Couchbase Web Console, and permits the reading of some data.
| Role: Analytics Manager (analytics_manager) | ||||
|---|---|---|---|---|
| Resources | Privileges | |||
| Read | Write | Execute | Manage | |
| Bucket : Analytics | |
|
|
|
| UI | |
|
|
|
| Pools | |
|
|
|