1<!DOCTYPE html>
2<html lang="en">
3<head>
4<meta charset="UTF-8">
5<meta http-equiv="X-UA-Compatible" content="IE=edge">
6<meta name="viewport" content="width=device-width, initial-scale=1.0">
7<meta name="generator" content="Asciidoctor 2.0.9">
8<meta name="author" content="Couchbase">
9<title>couchbase-cli-user-manage(1)</title>
10<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
11<style>
12/* Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
13/* Uncomment @import statement to use as custom stylesheet */
14/*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/
15article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}
16audio,video{display:inline-block}
17audio:not([controls]){display:none;height:0}
18html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
19a{background:none}
20a:focus{outline:thin dotted}
21a:active,a:hover{outline:0}
22h1{font-size:2em;margin:.67em 0}
23abbr[title]{border-bottom:1px dotted}
24b,strong{font-weight:bold}
25dfn{font-style:italic}
26hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
27mark{background:#ff0;color:#000}
28code,kbd,pre,samp{font-family:monospace;font-size:1em}
29pre{white-space:pre-wrap}
30q{quotes:"\201C" "\201D" "\2018" "\2019"}
31small{font-size:80%}
32sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
33sup{top:-.5em}
34sub{bottom:-.25em}
35img{border:0}
36svg:not(:root){overflow:hidden}
37figure{margin:0}
38fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
39legend{border:0;padding:0}
40button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
41button,input{line-height:normal}
42button,select{text-transform:none}
43button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
44button[disabled],html input[disabled]{cursor:default}
45input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
46button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
47textarea{overflow:auto;vertical-align:top}
48table{border-collapse:collapse;border-spacing:0}
49*,*::before,*::after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
50html,body{font-size:100%}
51body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
52a:hover{cursor:pointer}
53img,object,embed{max-width:100%;height:auto}
54object,embed{height:100%}
55img{-ms-interpolation-mode:bicubic}
56.left{float:left!important}
57.right{float:right!important}
58.text-left{text-align:left!important}
59.text-right{text-align:right!important}
60.text-center{text-align:center!important}
61.text-justify{text-align:justify!important}
62.hide{display:none}
63img,object,svg{display:inline-block;vertical-align:middle}
64textarea{height:auto;min-height:50px}
65select{width:100%}
66.center{margin-left:auto;margin-right:auto}
67.stretch{width:100%}
68.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
69div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
70a{color:#2156a5;text-decoration:underline;line-height:inherit}
71a:hover,a:focus{color:#1d4b8f}
72a img{border:0}
73p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
74p aside{font-size:.875em;line-height:1.35;font-style:italic}
75h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
76h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
77h1{font-size:2.125em}
78h2{font-size:1.6875em}
79h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
80h4,h5{font-size:1.125em}
81h6{font-size:1em}
82hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
83em,i{font-style:italic;line-height:inherit}
84strong,b{font-weight:bold;line-height:inherit}
85small{font-size:60%;line-height:inherit}
86code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
87ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
88ul,ol{margin-left:1.5em}
89ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
90ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
91ul.square{list-style-type:square}
92ul.circle{list-style-type:circle}
93ul.disc{list-style-type:disc}
94ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
95dl dt{margin-bottom:.3125em;font-weight:bold}
96dl dd{margin-bottom:1.25em}
97abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
98abbr{text-transform:none}
99blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
100blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
101blockquote cite::before{content:"\2014 \0020"}
102blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
103blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
104@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
105h1{font-size:2.75em}
106h2{font-size:2.3125em}
107h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
108h4{font-size:1.4375em}}
109table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
110table thead,table tfoot{background:#f7f8f7}
111table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
112table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
113table tr.even,table tr.alt{background:#f8f8f7}
114table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
115h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
116h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
117.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
118.clearfix::after,.float-group::after{clear:both}
119:not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word}
120:not(pre)>code.nobreak{word-wrap:normal}
121:not(pre)>code.nowrap{white-space:nowrap}
122pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
123pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
124pre>code{display:block}
125pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
126em em{font-style:normal}
127strong strong{font-weight:400}
128.keyseq{color:rgba(51,51,51,.8)}
129kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
130.keyseq kbd:first-child{margin-left:0}
131.keyseq kbd:last-child{margin-right:0}
132.menuseq,.menuref{color:#000}
133.menuseq b:not(.caret),.menuref{font-weight:inherit}
134.menuseq{word-spacing:-.02em}
135.menuseq b.caret{font-size:1.25em;line-height:.8}
136.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
137b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
138b.button::before{content:"[";padding:0 3px 0 2px}
139b.button::after{content:"]";padding:0 2px 0 3px}
140p a>code:hover{color:rgba(0,0,0,.9)}
141#header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
142#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
143#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
144#content{margin-top:1.25em}
145#content::before{content:none}
146#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
147#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
148#header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
149#header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}
150#header .details span:first-child{margin-left:-.125em}
151#header .details span.email a{color:rgba(0,0,0,.85)}
152#header .details br{display:none}
153#header .details br+span::before{content:"\00a0\2013\00a0"}
154#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
155#header .details br+span#revremark::before{content:"\00a0|\00a0"}
156#header #revnumber{text-transform:capitalize}
157#header #revnumber::after{content:"\00a0"}
158#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
159#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
160#toc>ul{margin-left:.125em}
161#toc ul.sectlevel0>li>a{font-style:italic}
162#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
163#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
164#toc li{line-height:1.3334;margin-top:.3334em}
165#toc a{text-decoration:none}
166#toc a:active{text-decoration:underline}
167#toctitle{color:#7a2518;font-size:1.2em}
168@media screen and (min-width:768px){#toctitle{font-size:1.375em}
169body.toc2{padding-left:15em;padding-right:0}
170#toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
171#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
172#toc.toc2>ul{font-size:.9em;margin-bottom:0}
173#toc.toc2 ul ul{margin-left:0;padding-left:1em}
174#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
175body.toc2.toc-right{padding-left:0;padding-right:15em}
176body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
177@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
178#toc.toc2{width:20em}
179#toc.toc2 #toctitle{font-size:1.375em}
180#toc.toc2>ul{font-size:.95em}
181#toc.toc2 ul ul{padding-left:1.25em}
182body.toc2.toc-right{padding-left:0;padding-right:20em}}
183#content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
184#content #toc>:first-child{margin-top:0}
185#content #toc>:last-child{margin-bottom:0}
186#footer{max-width:100%;background:rgba(0,0,0,.8);padding:1.25em}
187#footer-text{color:rgba(255,255,255,.8);line-height:1.44}
188#content{margin-bottom:.625em}
189.sect1{padding-bottom:.625em}
190@media screen and (min-width:768px){#content{margin-bottom:1.25em}
191.sect1{padding-bottom:1.25em}}
192.sect1:last-child{padding-bottom:0}
193.sect1+.sect1{border-top:1px solid #e7e7e9}
194#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
195#content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
196#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
197#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
198#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
199details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
200details>summary:first-of-type{cursor:pointer;display:list-item;outline:none;margin-bottom:.75em}
201.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
202table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
203.paragraph.lead>p,#preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
204table.tableblock #preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:inherit}
205.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
206.admonitionblock>table td.icon{text-align:center;width:80px}
207.admonitionblock>table td.icon img{max-width:none}
208.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
209.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6)}
210.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
211.exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}
212.exampleblock>.content>:first-child{margin-top:0}
213.exampleblock>.content>:last-child{margin-bottom:0}
214.sidebarblock{border-style:solid;border-width:1px;border-color:#dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;-webkit-border-radius:4px;border-radius:4px}
215.sidebarblock>:first-child{margin-top:0}
216.sidebarblock>:last-child{margin-bottom:0}
217.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
218.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
219.literalblock pre,.listingblock>.content>pre{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;overflow-x:auto;padding:1em;font-size:.8125em}
220@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
221@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
222.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class="highlight"],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
223.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
224.listingblock>.content{position:relative}
225.listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
226.listingblock:hover code[data-lang]::before{display:block}
227.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
228.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
229.listingblock pre.highlightjs{padding:0}
230.listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
231.listingblock pre.prettyprint{border-width:0}
232.prettyprint{background:#f7f7f8}
233pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
234pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
235pre.prettyprint li code[data-lang]::before{opacity:1}
236pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
237table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
238table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
239table.linenotable td.code{padding-left:.75em}
240table.linenotable td.linenos{border-right:1px solid currentColor;opacity:.35;padding-right:.5em}
241pre.pygments .lineno{border-right:1px solid currentColor;opacity:.35;display:inline-block;margin-right:.75em}
242pre.pygments .lineno::before{content:"";margin-right:-.125em}
243.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
244.quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em}
245.quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
246.quoteblock blockquote{margin:0;padding:0;border:0}
247.quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
248.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
249.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
250.verseblock{margin:0 1em 1.25em}
251.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
252.verseblock pre strong{font-weight:400}
253.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
254.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
255.quoteblock .attribution br,.verseblock .attribution br{display:none}
256.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
257.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
258.quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
259.quoteblock.abstract{margin:0 1em 1.25em;display:block}
260.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
261.quoteblock.excerpt,.quoteblock .quoteblock{margin:0 0 1.25em;padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
262.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
263.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;text-align:left;margin-right:0}
264table.tableblock{max-width:100%;border-collapse:separate}
265p.tableblock:last-child{margin-bottom:0}
266td.tableblock>.content>:last-child{margin-bottom:-1.25em}
267td.tableblock>.content>:last-child.sidebarblock{margin-bottom:0}
268table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
269table.grid-all>thead>tr>.tableblock,table.grid-all>tbody>tr>.tableblock{border-width:0 1px 1px 0}
270table.grid-all>tfoot>tr>.tableblock{border-width:1px 1px 0 0}
271table.grid-cols>*>tr>.tableblock{border-width:0 1px 0 0}
272table.grid-rows>thead>tr>.tableblock,table.grid-rows>tbody>tr>.tableblock{border-width:0 0 1px}
273table.grid-rows>tfoot>tr>.tableblock{border-width:1px 0 0}
274table.grid-all>*>tr>.tableblock:last-child,table.grid-cols>*>tr>.tableblock:last-child{border-right-width:0}
275table.grid-all>tbody>tr:last-child>.tableblock,table.grid-all>thead:last-child>tr>.tableblock,table.grid-rows>tbody>tr:last-child>.tableblock,table.grid-rows>thead:last-child>tr>.tableblock{border-bottom-width:0}
276table.frame-all{border-width:1px}
277table.frame-sides{border-width:0 1px}
278table.frame-topbot,table.frame-ends{border-width:1px 0}
279table.stripes-all tr,table.stripes-odd tr:nth-of-type(odd),table.stripes-even tr:nth-of-type(even),table.stripes-hover tr:hover{background:#f8f8f7}
280th.halign-left,td.halign-left{text-align:left}
281th.halign-right,td.halign-right{text-align:right}
282th.halign-center,td.halign-center{text-align:center}
283th.valign-top,td.valign-top{vertical-align:top}
284th.valign-bottom,td.valign-bottom{vertical-align:bottom}
285th.valign-middle,td.valign-middle{vertical-align:middle}
286table thead th,table tfoot th{font-weight:bold}
287tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
288tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
289p.tableblock>code:only-child{background:none;padding:0}
290p.tableblock{font-size:1em}
291ol{margin-left:1.75em}
292ul li ol{margin-left:1.5em}
293dl dd{margin-left:1.125em}
294dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
295ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
296ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
297ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
298ul.unstyled,ol.unstyled{margin-left:0}
299ul.checklist{margin-left:.625em}
300ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
301ul.checklist li>p:first-child>input[type="checkbox"]:first-child{margin-right:.25em}
302ul.inline{display:-ms-flexbox;display:-webkit-box;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
303ul.inline>li{margin-left:1.25em}
304.unstyled dl dt{font-weight:400;font-style:normal}
305ol.arabic{list-style-type:decimal}
306ol.decimal{list-style-type:decimal-leading-zero}
307ol.loweralpha{list-style-type:lower-alpha}
308ol.upperalpha{list-style-type:upper-alpha}
309ol.lowerroman{list-style-type:lower-roman}
310ol.upperroman{list-style-type:upper-roman}
311ol.lowergreek{list-style-type:lower-greek}
312.hdlist>table,.colist>table{border:0;background:none}
313.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
314td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
315td.hdlist1{font-weight:bold;padding-bottom:1.25em}
316.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
317.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
318.colist td:not([class]):first-child img{max-width:none}
319.colist td:not([class]):last-child{padding:.25em 0}
320.thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd}
321.imageblock.left{margin:.25em .625em 1.25em 0}
322.imageblock.right{margin:.25em 0 1.25em .625em}
323.imageblock>.title{margin-bottom:0}
324.imageblock.thumb,.imageblock.th{border-width:6px}
325.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
326.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
327.image.left{margin-right:.625em}
328.image.right{margin-left:.625em}
329a.image{text-decoration:none;display:inline-block}
330a.image object{pointer-events:none}
331sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
332sup.footnote a,sup.footnoteref a{text-decoration:none}
333sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
334#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
335#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
336#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
337#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
338#footnotes .footnote:last-of-type{margin-bottom:0}
339#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
340.gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
341.gist .file-data>table td.line-data{width:99%}
342div.unbreakable{page-break-inside:avoid}
343.big{font-size:larger}
344.small{font-size:smaller}
345.underline{text-decoration:underline}
346.overline{text-decoration:overline}
347.line-through{text-decoration:line-through}
348.aqua{color:#00bfbf}
349.aqua-background{background:#00fafa}
350.black{color:#000}
351.black-background{background:#000}
352.blue{color:#0000bf}
353.blue-background{background:#0000fa}
354.fuchsia{color:#bf00bf}
355.fuchsia-background{background:#fa00fa}
356.gray{color:#606060}
357.gray-background{background:#7d7d7d}
358.green{color:#006000}
359.green-background{background:#007d00}
360.lime{color:#00bf00}
361.lime-background{background:#00fa00}
362.maroon{color:#600000}
363.maroon-background{background:#7d0000}
364.navy{color:#000060}
365.navy-background{background:#00007d}
366.olive{color:#606000}
367.olive-background{background:#7d7d00}
368.purple{color:#600060}
369.purple-background{background:#7d007d}
370.red{color:#bf0000}
371.red-background{background:#fa0000}
372.silver{color:#909090}
373.silver-background{background:#bcbcbc}
374.teal{color:#006060}
375.teal-background{background:#007d7d}
376.white{color:#bfbfbf}
377.white-background{background:#fafafa}
378.yellow{color:#bfbf00}
379.yellow-background{background:#fafa00}
380span.icon>.fa{cursor:default}
381a span.icon>.fa{cursor:inherit}
382.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
383.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
384.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
385.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
386.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
387.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
388.conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
389.conum[data-value] *{color:#fff!important}
390.conum[data-value]+b{display:none}
391.conum[data-value]::after{content:attr(data-value)}
392pre .conum[data-value]{position:relative;top:-.125em}
393b.conum *{color:inherit!important}
394.conum:not([data-value]):empty{display:none}
395dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
396h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
397p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
398p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
399p{margin-bottom:1.25rem}
400.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
401.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
402.print-only{display:none!important}
403@page{margin:1.25cm .75cm}
404@media print{*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
405html{font-size:80%}
406a{color:inherit!important;text-decoration:underline!important}
407a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
408a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
409abbr[title]::after{content:" (" attr(title) ")"}
410pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
411thead{display:table-header-group}
412svg{max-width:100%}
413p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
414h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
415#toc,.sidebarblock,.exampleblock>.content{background:none!important}
416#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
417body.book #header{text-align:center}
418body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
419body.book #header .details{border:0!important;display:block;padding:0!important}
420body.book #header .details span:first-child{margin-left:0!important}
421body.book #header .details br{display:block}
422body.book #header .details br+span::before{content:none!important}
423body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
424body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
425.listingblock code[data-lang]::before{display:block}
426#footer{padding:0 .9375em}
427.hide-on-print{display:none!important}
428.print-only{display:block!important}
429.hide-for-print{display:none!important}
430.show-for-print{display:inherit!important}}
431@media print,amzn-kf8{#header>h1:first-child{margin-top:1.25rem}
432.sect1{padding:0!important}
433.sect1+.sect1{border:0}
434#footer{background:none}
435#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
436@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
437</style>
438</head>
439<body class="manpage">
440<div id="header">
441<h1>couchbase-cli-user-manage(1) Manual Page</h1>
442<h2 id="_name">NAME</h2>
443<div class="sectionbody">
444<p>couchbase-cli-user-manage - Manage RBAC users</p>
445</div>
446</div>
447<div id="content">
448<div class="sect1">
449<h2 id="_synopsis">SYNOPSIS</h2>
450<div class="sectionbody">
451<div class="verseblock">
452<pre class="content"><em>couchbase-cli user-manage</em> [--cluster &lt;url&gt;] [--username &lt;user&gt;]
453    [--password &lt;password&gt;] [--delete] [--list] [--my-roles] [--set]
454    [--rbac-username &lt;username&gt;] [--rbac-password &lt;password&gt;]
455    [--rbac-name &lt;name&gt;] [--roles &lt;roles_list&gt;] [--auth_domain &lt;domain&gt;]</pre>
456</div>
457</div>
458</div>
459<div class="sect1">
460<h2 id="_description">DESCRIPTION</h2>
461<div class="sectionbody">
462<div class="paragraph">
463<p>This command allows administrators to assign and manage roles to different users
464in their organization. Users can either be managed locally by Couchbase or
465externally through the use of an external domain.</p>
466</div>
467</div>
468</div>
469<div class="sect1">
470<h2 id="_options">OPTIONS</h2>
471<div class="sectionbody">
472<div class="dlist">
473<dl>
474<dt class="hdlist1">-c</dt>
475<dt class="hdlist1">--cluster</dt>
476<dd>
477<p>Specfies the hostname of a node in the cluster. See the HOST FORMATS
478section for more information on specifying a hostname.</p>
479</dd>
480<dt class="hdlist1">-u</dt>
481<dt class="hdlist1">--user &lt;username&gt;</dt>
482<dd>
483<p>Specifies the username of the user executing the command. If you do not have
484a user account with permision to execute the command then it will fail with
485an unauthorized error.</p>
486</dd>
487<dt class="hdlist1">-p</dt>
488<dt class="hdlist1">--password &lt;password&gt;</dt>
489<dd>
490<p>Specifies the password of the user executing the command. If you do not have
491a user account with permision to execute the command then it will fail with
492an unauthorized error. If this argument is specified, but no password is
493given then the command will prompt the user for a password through
494non-echoed stdin. You may also specify your password by using the
495environment variable CB_REST_PASSWORD.</p>
496</dd>
497<dt class="hdlist1">--delete</dt>
498<dd>
499<p>Deletes an RBAC user profile from the cluster. You must have full
500administrator privileges in order to delete a user profile.</p>
501</dd>
502<dt class="hdlist1">--list</dt>
503<dd>
504<p>Lists all RBAC user profiles in the cluster and show their roles. You must
505have full administrator privileges in order to list all user profiles.</p>
506</dd>
507<dt class="hdlist1">--my-roles</dt>
508<dd>
509<p>Shows the current users RBAC user profile.</p>
510</dd>
511<dt class="hdlist1">--set</dt>
512<dd>
513<p>Creates or updates an RBAC user profile. You must have full administrator
514privileges in order to create or update a user profile.</p>
515</dd>
516<dt class="hdlist1">--rbac-username &lt;username&gt;</dt>
517<dd>
518<p>Specifies the username of the RBAC user to modify. This option is used when
519deleting, creating, or updating an RBAC user profile.</p>
520</dd>
521<dt class="hdlist1">--rbac-password &lt;password&gt;</dt>
522<dd>
523<p>Specifies the password to be used for an RBAC user profile. This option is
524used only when creating or updating a <em>local</em> RBAC user profile. Couchbase
525does not store password for <em>external</em> RBAC roles.</p>
526</dd>
527<dt class="hdlist1">--rbac-name &lt;name&gt;</dt>
528<dd>
529<p>Specifies the name to be used for an RBAC user profile. This option is used
530when creating or updating an RBAC user profile and it is recommanded that
531this option be set to the users full name.</p>
532</dd>
533<dt class="hdlist1">--roles &lt;roles_list&gt;</dt>
534<dd>
535<p>Specifies the roles to be given to an RBAC user profile. This option is used
536when creating or updating an RBAC user profile and it is specified as a
537comma separated list of roles. See the ROLES section for more details on the
538available roles in Couchbase.</p>
539</dd>
540<dt class="hdlist1">--auth-domain &lt;domain&gt;</dt>
541<dd>
542<p>Specifies the auth_domain to used for an RBAC user profile. This option is
543used when deleting, creating or updating an RBAC user profile and it if may
544be set to either <em>local</em> or <em>external</em>. Loacl users are users that are
545managed directly by the Couchbase cluster. External users are users
546managed by an external source suchas LDAP.</p>
547</dd>
548</dl>
549</div>
550</div>
551</div>
552<div class="sect1">
553<h2 id="_host_formats">HOST FORMATS</h2>
554<div class="sectionbody">
555<div class="paragraph">
556<p>When specifying a host for the couchbase-cli command the following formats are expected:</p>
557</div>
558<div class="ulist">
559<ul>
560<li>
561<p><code>couchbase://&lt;addr&gt;</code></p>
562</li>
563<li>
564<p><code>&lt;addr&gt;:&lt;port&gt;</code></p>
565</li>
566<li>
567<p><code>http://&lt;addr&gt;:&lt;port&gt;</code></p>
568</li>
569</ul>
570</div>
571<div class="paragraph">
572<p>It is recommended to use the couchbase://&lt;addr&gt; format for standard
573installations. The other two formats allow an option to take a port number which
574is needed for non-default installations where the admin port has been set up on
575a port other that 8091.</p>
576</div>
577<div class="sect2">
578<h3 id="_roles">ROLES</h3>
579<div class="dlist">
580<div class="title">Cluster-Wide Roles:</div>
581<dl>
582<dt class="hdlist1">admin</dt>
583<dd>
584<p>Give the user permissions to manage all Couchbase configuration settings,
585and read and write all data in the cluster. This user can make changes to
586anything in the cluster.</p>
587</dd>
588<dt class="hdlist1">bucket_admin[&#8230;&#8203;]</dt>
589<dd>
590<p>Gives the user permissions to manage bucket settings. This role can be
591assigned globally to all buckets or to a particular bucket. For XDCR
592operations, the user can start/stop replication for the buckets they
593administer, but they cannot set up the XDCR cluster references. To give
594a user the ability to manage all bucket settings set their role to
595bucket_admin[*]. To give the user permission to manage bucket settings on a
596single bucket named <em>default</em> then specify the role as
597bucket_admin[default]. If the user needs to be manage multiple buckets, for
598example <em>default</em> and <em>app</em>, then set the role as bucket[default],bucket[app].</p>
599</dd>
600<dt class="hdlist1">cluster_admin</dt>
601<dd>
602<p>Gives the user permissions to read, write and manage all cluster-level
603settings except security.</p>
604</dd>
605<dt class="hdlist1">replication_admin</dt>
606<dd>
607<p>Allows the user to configure XDCR topology and manage XDCR replications.</p>
608</dd>
609<dt class="hdlist1">ro_admin</dt>
610<dd>
611<p>Gives the user read-only access and cannot make any changes to the system.
612This user has read-only access to cluster overview, design documents
613(without the ability to create or query views), bucket summaries (without
614the ability to create or view documents), XDCR cluster references, XDCR
615replications, and cluster settings.</p>
616</dd>
617<dt class="hdlist1">view_admin[&#8230;&#8203;]</dt>
618<dd>
619<p>Gives the user privileges to define views and then run these views on data
620to ensure that views are defined properly. This applies both to the
621map-reduce and spatial views. To give a user the ability to manage views on
622all buckets set their role to views_admin[*]. To give the user permission to
623manage views on a single bucket named <em>default</em> then specify the role as
624views_admin[default]. If the user needs to be manage views for multiple
625buckets, for example <em>default</em> and <em>app</em>, then set the role as
626views_admin[default],views_admin[app].</p>
627</dd>
628</dl>
629</div>
630<div class="dlist">
631<div class="title">Data Service Roles:</div>
632<dl>
633<dt class="hdlist1">data_reader[&#8230;&#8203;]</dt>
634<dd>
635<p>Gives the user permission to read data through Couchbases key-value APIs.
636To give a user read-only access for all buckets set their role to
637data_reader[*]. To give the user read-only access to data on a single
638bucket named <em>default</em> then specify their role as data_reader[default].
639If the user needs read-only access to data for multiple buckets, for example
640<em>default</em> and <em>app</em>, then set their role as data_reader[default,app].</p>
641</dd>
642<dt class="hdlist1">data_reader_writer[&#8230;&#8203;]</dt>
643<dd>
644<p>Gives the user permission to read and write data through Couchbases
645key-value APIs. The user cannot however modify the settings of a bucket.
646To give a user read-write access for all buckets set their role to
647data_reader_writer[*]. To give the user read-write access to data on a
648single bucket named <em>default</em> then specify their role as
649data_reader_writer[default]. If the user needs read-write access to data
650for multiple buckets, for example <em>default</em> and <em>app</em>, then set their role
651as data_reader_writer[default],date_read_writer[app].</p>
652</dd>
653<dt class="hdlist1">data_dcp_reader[&#8230;&#8203;]</dt>
654<dd>
655<p>Gives the user permission to create Couchbase DCP connections. To give a
656user the ability to create DCP connections for all buckets set their role to
657data_dcp_reader[*]. To give the user the ability to create DCP connections
658on a single bucket named <em>default</em> then specify their role as
659data_dcp_reader[default]. If the user needs to be able to create DCP
660connections for multiple buckets, for example <em>default</em> and <em>app</em>, then set
661their role as data_dcp_reader[default],data_dcp_reader[app].</p>
662</dd>
663<dt class="hdlist1">data_backup[&#8230;&#8203;]</dt>
664<dd>
665<p>Gives the user permission to backup and restore data in Couchbase. To give a
666user the ability to backup and restore data for all buckets set their role
667to data_backup[*]. To give the user the ability to backup and restore data
668on a single bucket named <em>default</em> then specify their role as
669data_backup[default]. If the user needs to be able to backup and restore
670data for multiple buckets, for example <em>default</em> and <em>app</em>, then set their
671role as data_backup[default],data_backup[app].</p>
672</dd>
673<dt class="hdlist1">data_monitoring[&#8230;&#8203;]</dt>
674<dd>
675<p>Gives the user permission to read monitoring data related to the data
676service in Couchbase. To give a user the ability to monitor data for all
677buckets set their role to data_monitoring[*]. To give the user the ability
678to monitor data on a single bucket named <em>default</em> then specify their role
679as data_monitoring[default]. If the user needs to be able to monitor data
680for multiple buckets, for example <em>default</em> and <em>app</em>, then set their role
681as data_monitoring[default],data_monitoring[app].</p>
682</dd>
683</dl>
684</div>
685<div class="dlist">
686<div class="title">Full Text Service Roles:</div>
687<dl>
688<dt class="hdlist1">fts_admin[&#8230;&#8203;]</dt>
689<dd>
690<p>Gives the user full administrator access for the Full Text Indexing service
691for the specified buckets. To give a user full administrator access for FTS
692on all buckets set their role to fts_admin[*]. To give the user full
693administrator access for FTS on a single bucket named <em>default</em> then specify
694their role as fts_admin[default]. If the user needs full administrator
695access for FTS for multiple buckets, for example <em>default</em> and <em>app</em>, then
696set their role as fts_admin[default],fts_admin[app].</p>
697</dd>
698<dt class="hdlist1">fts_searcher[&#8230;&#8203;]</dt>
699<dd>
700<p>Allows the user to query full text indexes for the specified buckets. To
701give a user the ability to query full text indexes on all buckets set their
702role to fts_searcher[*]. To give the ability to query FTS indexes on a
703single bucket named <em>default</em> then specify their role as
704fts_searcher[default]. If the user needs to query FTS indexes on multiple
705multiple buckets, for example <em>default</em> and <em>app</em>, then set their role as
706fts_searcher[default],fts_searcher[app].</p>
707</dd>
708</dl>
709</div>
710<div class="dlist">
711<div class="title">Query Service Roles:</div>
712<dl>
713<dt class="hdlist1">manage_index[&#8230;&#8203;]</dt>
714<dd>
715<p>Allows the user to create and delete indexes on the specified buckets. To
716give a user the ability to create and delete indexes on all buckets set
717their role to manage_index[*]. To give the user permission to create and
718delete indexes on a single bucket named <em>default</em> then specify their role
719as manage_index[default]. If the user needs to be create and delete indexes
720for multiple buckets, for example <em>default</em> and <em>app</em>, then set their role
721as manage_index[default],manage_index[app].</p>
722</dd>
723<dt class="hdlist1">query_delete[&#8230;&#8203;]</dt>
724<dd>
725<p>Allows the user to execute DELETE query statements on the specified buckets.
726To give a user the ability execute DELETE statements on all buckets set
727their role to query_delete[*]. To give the user permission to execute
728DELETE statements on a single bucket named <em>default</em> then specify their role
729as query_delete[default]. If the user needs to be execute DELETE statements
730for multiple buckets, for example <em>default</em> and <em>app</em>, then set their role
731as query_delete[default],query_delete[app].</p>
732</dd>
733<dt class="hdlist1">query_insert[&#8230;&#8203;]</dt>
734<dd>
735<p>Allows the user to execute INSERT query statements on the specified buckets.
736To give a user the ability execute INSERT statements on all buckets set
737their role to query_insert[*]. To give the user permission to execute
738INSERT statements on a single bucket named <em>default</em> then specify their role
739as query_insert[default]. If the user needs to be execute INSERT statements
740for multiple buckets, for example <em>default</em> and <em>app</em>, then set their role
741as query_insert[default],query_insert[app].</p>
742</dd>
743<dt class="hdlist1">query_select[&#8230;&#8203;]</dt>
744<dd>
745<p>Allows the user to execute SELECT query statements on the specified buckets.
746To give a user the ability execute SELECT statements on all buckets set
747their role to query_select[*]. To give the user permission to execute
748SELECT statements on a single bucket named <em>default</em> then specify their role
749as query_select[default]. If the user needs to be execute SELECT statements
750for multiple buckets, for example <em>default</em> and <em>app</em>, then set their role
751as query_select[default],query_select[app].</p>
752</dd>
753<dt class="hdlist1">query_update[&#8230;&#8203;]</dt>
754<dd>
755<p>Allows the user to execute UPDATE query statements on the specified buckets.
756To give a user the ability execute UPDATE statements on all buckets set
757their role to query_update[*]. To give the user permission to execute
758UPDATE statements on a single bucket named <em>default</em> then specify their role
759as query_update[default]. If the user needs to be execute UPDATE statements
760for multiple buckets, for example <em>default</em> and <em>app</em>, then set their role
761as query_update[default],query_update[app].</p>
762</dd>
763<dt class="hdlist1">system_catalog[&#8230;&#8203;]</dt>
764<dd>
765<p>Allows the users to run queries against the system catalog on the specified
766buckets. To give a user the ability to run queries against the system
767catalog on all buckets set their role to system_catalog[*]. To give the user
768permission to run queires against the system catalog on a single bucket
769named <em>default</em> then specify their role as system_catalog[default]. If the
770user needs to be run queries against the system catalog for multiple
771buckets, for example <em>default</em> and <em>app</em>, then set their role as
772system_catalog[default],system_catalog[app].</p>
773</dd>
774</dl>
775</div>
776</div>
777</div>
778</div>
779<div class="sect1">
780<h2 id="_examples">EXAMPLES</h2>
781<div class="sectionbody">
782<div class="paragraph">
783<p>To create an local RBAC user profile for a user named "John Doe" with username
784jdoe and password cbpass with roles to manage the <em>default</em> bucket and all
785XDCR replication run the following command</p>
786</div>
787<div class="literalblock">
788<div class="content">
789<pre>$ couchbase-cli user-manage -c 127.0.0.1:8091 -u Administrator \
790 -p password --set --rbac-username jdoe --rbac-password cbpass \
791 --rbac-name "John Doe" --roles bucket_admin[default],replication_admin \
792 --auth-domain local</pre>
793</div>
794</div>
795<div class="paragraph">
796<p>If you have external user source setup in your cluster and you want to add a
797user "John Doe" with username jdoe who should have the ability to manage only
798views for all bucket run the following command</p>
799</div>
800<div class="literalblock">
801<div class="content">
802<pre>$ couchbase-cli user-manage -c 127.0.0.1:8091 -u Administrator \
803 -p password --set --rbac-username jdoe --rbac-name "John Doe" \
804 --roles view_admin[*] --auth-domain external</pre>
805</div>
806</div>
807<div class="paragraph">
808<p>To list the current RBAC user profiles run the following command.</p>
809</div>
810<div class="literalblock">
811<div class="content">
812<pre>$ couchbase-cli user-manage -c 127.0.0.1:8091 -u Administrator \
813 -p password --list</pre>
814</div>
815</div>
816<div class="paragraph">
817<p>To delete an external user named jdoe run the following command.</p>
818</div>
819<div class="literalblock">
820<div class="content">
821<pre>$ couchbase-cli user-manage -c 127.0.0.1:8091 -u Administrator \
822 -p password --delete --rbac-username jdoe --auth-domain external</pre>
823</div>
824</div>
825<div class="paragraph">
826<p>To delete a local user named jdoe run the following command.</p>
827</div>
828<div class="literalblock">
829<div class="content">
830<pre>$ couchbase-cli user-manage -c 127.0.0.1:8091 -u Administrator \
831 -p password --delete --rbac-username jdoe --auth-domain local</pre>
832</div>
833</div>
834<div class="paragraph">
835<p>To see the user profile for a user with the username jdoe and password cbpass
836run the following command.</p>
837</div>
838<div class="literalblock">
839<div class="content">
840<pre>$ couchbase-cli user-manage -c 127.0.0.1:8091 -u jdoe -p cbpass \
841 --my-roles</pre>
842</div>
843</div>
844</div>
845</div>
846<div class="sect1">
847<h2 id="_environment_and_configuration_variables">ENVIRONMENT AND CONFIGURATION VARIABLES</h2>
848<div class="sectionbody">
849<div class="dlist">
850<dl>
851<dt class="hdlist1">CB_REST_PASSWORD</dt>
852<dd>
853<p>Specifies the password of the user executing the command. This environment
854variable allows you to specify a default argument for the -p/--password
855argument on the command line. It also allows the user to ensure that their
856password are not cached in their command line history.</p>
857</dd>
858<dt class="hdlist1">CB_REST_PASSWORD</dt>
859<dd>
860<p>Specifies the password of the user executing the command. This environment
861variable allows you to specify a default argument for the -p/--password
862argument on the command line.</p>
863</dd>
864</dl>
865</div>
866</div>
867</div>
868<div class="sect1">
869<h2 id="_see_also">SEE ALSO</h2>
870<div class="sectionbody">
871<div class="paragraph">
872<p><a href="couchbase-cli-setting-ldap.html">couchbase-cli-setting-ldap(1)</a></p>
873</div>
874</div>
875</div>
876<div class="sect1">
877<h2 id="_couchbase_cli">COUCHBASE-CLI</h2>
878<div class="sectionbody">
879<div class="paragraph">
880<p>Part of the <a href="couchbase-cli.html">couchbase-cli(1)</a> suite</p>
881</div>
882</div>
883</div>
884</div>
885</body>
886</html>