blob: 16b2eb528e7cbff64e3ecd886a03dab452c3435f [file] [log] [blame]
Shawn O. Pearceb2ff7c82010-03-20 16:57:36 -07001gerrit create-account
2=====================
3
4NAME
5----
6gerrit create-account - Create a new batch/role account.
7
8SYNOPSIS
9--------
10[verse]
Shawn O. Pearce47769242011-06-14 16:40:48 -070011'ssh' -p <port> <host> 'gerrit create-account'
12 [--group <GROUP>]
13 [--full-name <FULLNAME>]
14 [--email <EMAIL>]
15 [--ssh-key - | <KEY>]
Peter Jönssone402ea72012-09-04 22:09:29 +020016 [--http-password <PASSWORD>]
Shawn O. Pearce47769242011-06-14 16:40:48 -070017 <USERNAME>
Shawn O. Pearceb2ff7c82010-03-20 16:57:36 -070018
19DESCRIPTION
20-----------
21Creates a new internal only user account for batch/role access, such
22as from an automated build system or event monitoring over
23link:cmd-stream-events.html[gerrit stream-events].
24
25If LDAP authentication is being used, the user account is created
26without checking the LDAP directory. Consequently users can be
27created in Gerrit that do not exist in the underlying LDAP directory.
28
29ACCESS
30------
Shawn O. Pearce7f485142011-06-16 13:49:42 -070031Caller must be a member of the privileged 'Administrators' group,
Fredrik Luthander79d38152012-03-13 09:52:22 +010032or have been granted
33link:access-control.html#capability_createAccount[the 'Create Account' global capability].
Shawn O. Pearceb2ff7c82010-03-20 16:57:36 -070034
35SCRIPTING
36---------
37This command is intended to be used in scripts.
38
39OPTIONS
40-------
41<USERNAME>::
42 Required; SSH username of the user account.
43
Shawn O. Pearce47769242011-06-14 16:40:48 -070044--ssh-key::
Shawn O. Pearceb2ff7c82010-03-20 16:57:36 -070045 Content of the public SSH key to load into the account's
46 keyring. If `-` the key is read from stdin, rather than
47 from the command line.
48
Shawn O. Pearce47769242011-06-14 16:40:48 -070049--group::
50 Name of the group to put the user into. Multiple --group
Shawn O. Pearceb2ff7c82010-03-20 16:57:36 -070051 options may be specified to add the user to multiple groups.
52
Shawn O. Pearce47769242011-06-14 16:40:48 -070053--full-name::
Shawn O. Pearceb2ff7c82010-03-20 16:57:36 -070054 Display name of the user account.
55+
Shawn O. Pearce47769242011-06-14 16:40:48 -070056Names containing spaces should be quoted in single quotes (').
Shawn O. Pearceb2ff7c82010-03-20 16:57:36 -070057This most likely requires double quoting the value, for example
Shawn O. Pearce47769242011-06-14 16:40:48 -070058`--full-name "'A description string'"`.
Shawn O. Pearceb2ff7c82010-03-20 16:57:36 -070059
Shawn O. Pearce47769242011-06-14 16:40:48 -070060--email::
Shawn O. Pearceb2ff7c82010-03-20 16:57:36 -070061 Preferred email address for the user account.
62
Peter Jönssone402ea72012-09-04 22:09:29 +020063--http-password::
64 HTTP password for the user account.
65
Shawn O. Pearceb2ff7c82010-03-20 16:57:36 -070066EXAMPLES
67--------
68Create a new user account called `watcher`:
69
70====
Jyrki Puttonen135db6e2010-08-14 08:12:46 +030071 $ cat ~/.ssh/id_watcher.pub | ssh -p 29418 review.example.com gerrit create-account --ssh-key - watcher
Shawn O. Pearceb2ff7c82010-03-20 16:57:36 -070072====
73
74GERRIT
75------
76Part of link:index.html[Gerrit Code Review]