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