admin-role-manage

admin-role-manage

Manage user roles

SYNTAX

couchbase-cli admin-role-manage [--cluster <url>] [--username <user>] [--password <password>] [--my-roles] [--get-roles] [--set-users <user_list>] [--set-names <name_list>] [--roles] [--delete-users <user_list>]

DESCRIPTION

DEPRECATED: This command was in 5.0.0 deprecated and will be removed in future releases. Please use the couchbase-cli-user-manage1 subcommand which provides similar functionality to this command.

This command is used to manage LDAP user roles.

OPTIONS

-c
--cluster

Specfies the hostname of a node in the cluster. See the HOST FORMATS section for more information on specifying a hostname.

-u
--user <username>

Specifies the username of the user executing the command. If you do not have a user account with permision to execute the command then it will fail with an unauthorized error.

-p
--password <password>

Specifies the password of the user executing the command. If you do not have a user account with permision to execute the command then it will fail with an unauthorized error. If this argument is specified, but no password is given then the command will prompt the user for a password through non-echoed stdin. You may also specify your password by using the environment variable CB_REST_PASSWORD.

--my-roles

Show the current users roles.

--get-roles

Show all valid users and roles.

--set-users <user_list>

A comma-delimited list of user ids to set acess-control roles for.

--set-names <name_list>

A optional quoted, comma-delimited list names, one for each specified user id.

--roles

A comma-delimited list of roles to set for users.

--delete-users <user_list>

A comma-delimited list of users to remove from access control.

HOST FORMATS

When specifying a host for the couchbase-cli command the following formats are expected:

  • couchbase://<addr>

  • <addr>:<port>

  • http://<addr>:<port>

It is recommended to use the couchbase://<addr> format for standard installations. The other two formats allow an option to take a port number which is needed for non-default installations where the admin port has been set up on a port other that 8091.

EXAMPLES

To show the current users roles run the following command.

$ couchbase-cli admin-role-manage -c 192.168.1.5 -u Administrator \
 -p password --my-roles

To see a list of all available roles in Couchbase Server run the following command.

$ couchbase-cli admin-role-manage -c 192.168.1.5 -u Administrator \
 -p password --get-roles

To set roles for a new user "Alice Meyers" with username "alice" and the cluster administrator and replication administrator roles run the following command.

$ couchbase-cli admin-role-manage -c 192.168.1.5 -u Administrator \
 -p password --set-users alice --set-names "Alice Meyers" \
 --roles cluster_admin,replication_admin

You can also specify multiple users at the same time when using the set users flag. For example if you want to add Alice Meyers and Barry Dillon to the same set of roles you could run the following command.

$ couchbase-cli admin-role-manage -c 192.168.1.5 -u Administrator \
 -p password --set-users alice,barry \
 --set-names "Alice Meyers,Barry Dillon" \
 --roles cluster_admin,replication_admin

To delete the user alice you can run the following command.

$ couchbase-cli admin-role-manage -c 192.168.1.5 -u Administrator \
 -p password --delete-users alice

You also delete multiple users at the same time. For example if you want to delete both alic and barry then you can do so by running the following command.

$ couchbase-cli admin-role-manage -c 192.168.1.5 -u Administrator \
 -p password --delete-users alice,barry

ENVIRONMENT AND CONFIGURATION VARIABLES

CB_REST_PASSWORD Specifies the password of the user executing the command. This environment variable allows you to specify a default argument for the -p/--password argument on the command line. It also allows the user to ensure that their password are not cached in their command line history.

CB_REST_PASSWORD Specifies the password of the user executing the command. This environment variable allows you to specify a default argument for the -p/--password argument on the command line.