blob: 897d6889b5a5a7af87ad7523b691a3ac6c854c70 [file] [log] [blame]
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08001= gerrit set-account
Deniz Turkoglu2c4bbcf2012-04-13 15:26:01 +02002
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08003== NAME
Deniz Turkoglu2c4bbcf2012-04-13 15:26:01 +02004gerrit set-account - Change an account's settings.
5
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08006== SYNOPSIS
Yuxuan 'fishy' Wangd85b6872013-11-15 11:47:46 -08007--
Deniz Turkoglu2c4bbcf2012-04-13 15:26:01 +02008set-account [--full-name <FULLNAME>] [--active|--inactive] \
9 [--add-email <EMAIL>] [--delete-email <EMAIL> | ALL] \
10 [--add-ssh-key - | <KEY>] \
Peter Jönssone402ea72012-09-04 22:09:29 +020011 [--delete-ssh-key - | <KEY> | ALL] \
12 [--http-password <PASSWORD>] <USER>
Yuxuan 'fishy' Wangd85b6872013-11-15 11:47:46 -080013--
Deniz Turkoglu2c4bbcf2012-04-13 15:26:01 +020014
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080015== DESCRIPTION
Deniz Turkoglu2c4bbcf2012-04-13 15:26:01 +020016Modifies a given user's settings. This command can be useful to
Peter Jönssone402ea72012-09-04 22:09:29 +020017deactivate an account, set HTTP password, add/delete ssh keys without
18going through the UI.
Deniz Turkoglu2c4bbcf2012-04-13 15:26:01 +020019
20It also allows managing email addresses, which bypasses the
21verification step we force within the UI.
22
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080023== ACCESS
Deniz Turkoglu2c4bbcf2012-04-13 15:26:01 +020024Caller must be a member of the privileged 'Administrators' group.
25
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080026== SCRIPTING
Deniz Turkoglu2c4bbcf2012-04-13 15:26:01 +020027This command is intended to be used in scripts.
28
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080029== OPTIONS
Deniz Turkoglu2c4bbcf2012-04-13 15:26:01 +020030<USER>::
31 Required; Full name, email-address, SSH username or account id.
32
33--full-name::
34 Display name of the user account.
35+
36Names containing spaces should be quoted in single quotes (').
37This most likely requires double quoting the value, for example
38`--full-name "'A description string'"`.
39
40--active::
41 Set the account state to be active.
42
43--inactive::
44 Set the account state to be inactive. This prevents the
45 user from logging in.
46
47--add-email::
48 Add another email to the user's account. This doesn't
49 trigger the mail validation and adds the email directly
50 to the user's account.
51 May be supplied more than once to add multiple emails to
52 an account in a single command execution.
53
54--delete-email::
55 Delete an email from this user's account if it exists.
56 If the email provided is 'ALL', all associated emails are
57 deleted from this account.
58 Maybe supplied more than once to remove multiple emails
59 from an account in a single command execution.
60
61--add-ssh-key::
62 Content of the public SSH key to add to the account's
63 keyring. If `-` the key is read from stdin, rather than
64 from the command line.
65 May be supplied more than once to add multiple SSH keys
66 in a single command execution.
67
68--delete-ssh-key::
69 Content of the public SSH key to remove from the account's
70 keyring or the comment associated with this key.
71 If `-` the key is read from stdin, rather than from the
72 command line. If the key provided is 'ALL', all
73 associated SSH keys are removed from this account.
74 May be supplied more than once to delete multiple SSH
75 keys in a single command execution.
76
Peter Jönssone402ea72012-09-04 22:09:29 +020077--http-password::
78 Set the HTTP password for the user account.
79
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080080== EXAMPLES
Deniz Turkoglu2c4bbcf2012-04-13 15:26:01 +020081Add an email and SSH key to `watcher`'s account:
82
83====
84 $ cat ~/.ssh/id_watcher.pub | ssh -p 29418 review.example.com gerrit set-account --add-ssh-key - --add-email mail@example.com watcher
85====
86
87GERRIT
88------
89Part of link:index.html[Gerrit Code Review]
Yuxuan 'fishy' Wang99cb68d2013-10-31 17:26:00 -070090
91SEARCHBOX
92---------