Shawn O. Pearce | b2ff7c8 | 2010-03-20 16:57:36 -0700 | [diff] [blame] | 1 | gerrit create-account |
| 2 | ===================== |
| 3 | |
| 4 | NAME |
| 5 | ---- |
| 6 | gerrit create-account - Create a new batch/role account. |
| 7 | |
| 8 | SYNOPSIS |
| 9 | -------- |
| 10 | [verse] |
Shawn O. Pearce | 4776924 | 2011-06-14 16:40:48 -0700 | [diff] [blame] | 11 | 'ssh' -p <port> <host> 'gerrit create-account' |
| 12 | [--group <GROUP>] |
| 13 | [--full-name <FULLNAME>] |
| 14 | [--email <EMAIL>] |
| 15 | [--ssh-key - | <KEY>] |
Peter Jönsson | e402ea7 | 2012-09-04 22:09:29 +0200 | [diff] [blame] | 16 | [--http-password <PASSWORD>] |
Shawn O. Pearce | 4776924 | 2011-06-14 16:40:48 -0700 | [diff] [blame] | 17 | <USERNAME> |
Shawn O. Pearce | b2ff7c8 | 2010-03-20 16:57:36 -0700 | [diff] [blame] | 18 | |
| 19 | DESCRIPTION |
| 20 | ----------- |
| 21 | Creates a new internal only user account for batch/role access, such |
| 22 | as from an automated build system or event monitoring over |
| 23 | link:cmd-stream-events.html[gerrit stream-events]. |
| 24 | |
| 25 | If LDAP authentication is being used, the user account is created |
| 26 | without checking the LDAP directory. Consequently users can be |
| 27 | created in Gerrit that do not exist in the underlying LDAP directory. |
| 28 | |
| 29 | ACCESS |
| 30 | ------ |
Shawn O. Pearce | 7f48514 | 2011-06-16 13:49:42 -0700 | [diff] [blame] | 31 | Caller must be a member of the privileged 'Administrators' group, |
Fredrik Luthander | 79d3815 | 2012-03-13 09:52:22 +0100 | [diff] [blame] | 32 | or have been granted |
| 33 | link:access-control.html#capability_createAccount[the 'Create Account' global capability]. |
Shawn O. Pearce | b2ff7c8 | 2010-03-20 16:57:36 -0700 | [diff] [blame] | 34 | |
| 35 | SCRIPTING |
| 36 | --------- |
| 37 | This command is intended to be used in scripts. |
| 38 | |
| 39 | OPTIONS |
| 40 | ------- |
| 41 | <USERNAME>:: |
| 42 | Required; SSH username of the user account. |
| 43 | |
Shawn O. Pearce | 4776924 | 2011-06-14 16:40:48 -0700 | [diff] [blame] | 44 | --ssh-key:: |
Shawn O. Pearce | b2ff7c8 | 2010-03-20 16:57:36 -0700 | [diff] [blame] | 45 | 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. Pearce | 4776924 | 2011-06-14 16:40:48 -0700 | [diff] [blame] | 49 | --group:: |
| 50 | Name of the group to put the user into. Multiple --group |
Shawn O. Pearce | b2ff7c8 | 2010-03-20 16:57:36 -0700 | [diff] [blame] | 51 | options may be specified to add the user to multiple groups. |
| 52 | |
Shawn O. Pearce | 4776924 | 2011-06-14 16:40:48 -0700 | [diff] [blame] | 53 | --full-name:: |
Shawn O. Pearce | b2ff7c8 | 2010-03-20 16:57:36 -0700 | [diff] [blame] | 54 | Display name of the user account. |
| 55 | + |
Shawn O. Pearce | 4776924 | 2011-06-14 16:40:48 -0700 | [diff] [blame] | 56 | Names containing spaces should be quoted in single quotes ('). |
Shawn O. Pearce | b2ff7c8 | 2010-03-20 16:57:36 -0700 | [diff] [blame] | 57 | This most likely requires double quoting the value, for example |
Shawn O. Pearce | 4776924 | 2011-06-14 16:40:48 -0700 | [diff] [blame] | 58 | `--full-name "'A description string'"`. |
Shawn O. Pearce | b2ff7c8 | 2010-03-20 16:57:36 -0700 | [diff] [blame] | 59 | |
Shawn O. Pearce | 4776924 | 2011-06-14 16:40:48 -0700 | [diff] [blame] | 60 | --email:: |
Shawn O. Pearce | b2ff7c8 | 2010-03-20 16:57:36 -0700 | [diff] [blame] | 61 | Preferred email address for the user account. |
| 62 | |
Peter Jönsson | e402ea7 | 2012-09-04 22:09:29 +0200 | [diff] [blame] | 63 | --http-password:: |
| 64 | HTTP password for the user account. |
| 65 | |
Shawn O. Pearce | b2ff7c8 | 2010-03-20 16:57:36 -0700 | [diff] [blame] | 66 | EXAMPLES |
| 67 | -------- |
| 68 | Create a new user account called `watcher`: |
| 69 | |
| 70 | ==== |
Jyrki Puttonen | 135db6e | 2010-08-14 08:12:46 +0300 | [diff] [blame] | 71 | $ cat ~/.ssh/id_watcher.pub | ssh -p 29418 review.example.com gerrit create-account --ssh-key - watcher |
Shawn O. Pearce | b2ff7c8 | 2010-03-20 16:57:36 -0700 | [diff] [blame] | 72 | ==== |
| 73 | |
| 74 | GERRIT |
| 75 | ------ |
| 76 | Part of link:index.html[Gerrit Code Review] |