A newer version of this documentation is available.

View Latest


Alter the administrative role: add or remove users.


The basic syntax is:

couchbase-cli alter-role -c [host]:8091 -u [admin] -p [password] [options]


Use this command to add users to an administrative role, or to remove users from the role.


The following are the command options:

Table 1. external-authentication options
Options Description

[add | remove]

To add or remove UID from a role


admin:full,``admin:readonly, admin:cluster, admin:replication, admin:bucket, admin:view

--bucketname=[* | bucketname]

A valid option for bucketadmin and viewadmin. Default is *.


A list of admin users configured in LDAP to be mapped or unmapped. Each admin user is comma-separated; for example : joe, don, bob.


couchbase-cli alter-role -c -u Administrator -p password