This page describes the account related REST endpoints. Please also take note of the general information on the REST API.
Account Endpoints
Get Account
'GET /accounts/link:#account-id[\{account-id\}]'
Returns an account as an AccountInfo entity.
GET /accounts/self HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "_account_id": 1000096, "name": "John Doe", "email": "john.doe@example.com", "username": "john" }
Create Account
'PUT /accounts/link:#username[\{username\}]'
Creates a new account.
In the request body additional data for the account can be provided as AccountInput.
PUT /accounts/john HTTP/1.0 Content-Type: application/json;charset=UTF-8 { "name": "John Doe", "email": "john.doe@example.com", "ssh_key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA0T...YImydZAw==", "http_password": "19D9aIn7zePb", "groups": [ "MyProject-Owners" ] }
As response a detailed AccountInfo entity is returned that describes the created account.
HTTP/1.1 201 Created Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "_account_id": 1000195, "name": "John Doe", "email": "john.doe@example.com" }
Get Account Name
'GET /accounts/link:#account-id[\{account-id\}]/name'
Retrieves the full name of an account.
GET /accounts/self/name HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' "John Doe"
If the account does not have a name an empty string is returned.
Set Account Name
'PUT /accounts/link:#account-id[\{account-id\}]/name'
Sets the full name of an account.
The new account name must be provided in the request body inside an AccountNameInput entity.
PUT /accounts/self/name HTTP/1.0 Content-Type: application/json;charset=UTF-8 { "name": "John F. Doe" }
As response the new account name is returned.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' "John F. Doe"
If the name was deleted the response is "204 No Content
".
Some realms may not allow to modify the account name. In this case the
request is rejected with "405 Method Not Allowed
".
Delete Account Name
'DELETE /accounts/link:#account-id[\{account-id\}]/name'
Deletes the name of an account.
DELETE /accounts/self/name HTTP/1.0
HTTP/1.1 204 No Content
Get Username
'GET /accounts/link:#account-id[\{account-id\}]/username'
Retrieves the username of an account.
GET /accounts/self/username HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' "john.doe"
If the account does not have a username the response is 404 Not Found
.
Get Active
'GET /accounts/link:#account-id[\{account-id\}]/active'
Checks if an account is active.
GET /accounts/john.doe@example.com/active HTTP/1.0
As response 200 OK
is returned for an active account and
404 Not Found
is returned for an inactive account.
HTTP/1.1 200 OK
Set Active
'PUT /accounts/link:#account-id[\{account-id\}]/active'
Sets the account state to active.
PUT /accounts/john.doe@example.com/active HTTP/1.0
HTTP/1.1 201 Created
If the account was already active the response is 200 OK
.
Delete Active
'DELETE /accounts/link:#account-id[\{account-id\}]/active'
Sets the account state to inactive.
DELETE /accounts/john.doe@example.com/active HTTP/1.0
HTTP/1.1 204 No Content
If the account was already inactive the response is 404 Not Found
.
Get HTTP Password
'GET /accounts/link:#account-id[\{account-id\}]/password.http'
Retrieves the HTTP password of an account.
GET /accounts/john.doe@example.com/password.http HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' "ETxgpih8xrNs"
If the account does not have an HTTP password the response is 404 Not Found
.
Set/Generate HTTP Password
'PUT /accounts/link:#account-id[\{account-id\}]/password.http'
Sets/Generates the HTTP password of an account.
The options for setting/generating the HTTP password must be provided in the request body inside a HttpPasswordInput entity.
PUT /accounts/self/password.http HTTP/1.0 Content-Type: application/json;charset=UTF-8 { "generate": true }
As response the new HTTP password is returned.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' "ETxgpih8xrNs"
If the HTTP password was deleted the response is "204 No Content
".
Delete HTTP Password
'DELETE /accounts/link:#account-id[\{account-id\}]/password.http'
Deletes the HTTP password of an account.
DELETE /accounts/self/password.http HTTP/1.0
HTTP/1.1 204 No Content
List Account Emails
'GET /accounts/link:#account-id[\{account-id\}]/emails'
Returns the email addresses that are configured for the specified user.
GET /accounts/self/emails HTTP/1.0
As response the email addresses of the user are returned as a list of EmailInfo entities.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' [ { "email": "john.doe@example.com", "preferred": true }, { "email": "j.doe@example.com" } ]
Get Account Email
'GET /accounts/link:#account-id[\{account-id\}]/emails/link:#email-id[\{email-id\}]'
Retrieves an email address of a user.
GET /accounts/self/emails/john.doe@example.com HTTP/1.0
As response an EmailInfo entity is returned that describes the email address.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "email": "john.doe@example.com", "preferred": true }
Create Account Email
'PUT /accounts/link:#account-id[\{account-id\}]/emails/link:#email-id[\{email-id\}]'
Registers a new email address for the user. A verification email is
sent with a link that needs to be visited to confirm the email address,
unless DEVELOPMENT_BECOME_ANY_ACCOUNT
is used as authentication type.
For the development mode email addresses are directly added without
confirmation. A Gerrit administrator may add an email address without
confirmation by setting no_confirmation
in the
EmailInput.
In the request body additional data for the email address can be provided as EmailInput.
PUT /accounts/self/emails/john.doe@example.com HTTP/1.0
As response the new email address is returned as EmailInfo entity.
HTTP/1.1 201 Created Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "email": "john.doe@example.com", "pending_confirmation": true }
Delete Account Email
'DELETE /accounts/link:#account-id[\{account-id\}]/emails/link:#email-id[\{email-id\}]'
Deletes an email address of an account.
DELETE /accounts/self/emails/john.doe@example.com HTTP/1.0
HTTP/1.1 204 No Content
Set Preferred Email
'PUT /accounts/link:#account-id[\{account-id\}]/emails/link:#email-id[\{email-id\}]/preferred'
Sets an email address as preferred email address for an account.
PUT /accounts/self/emails/john.doe@example.com/preferred HTTP/1.0
HTTP/1.1 201 Created
If the email address was already the preferred email address of the
account the response is "200 OK
".
List SSH Keys
'GET /accounts/link:#account-id[\{account-id\}]/sshkeys'
Returns the SSH keys of an account.
GET /accounts/self/sshkeys HTTP/1.0
As response the SSH keys of the account are returned as a list of SshKeyInfo entities.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' [ { "seq": 1, "ssh_public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA0T...YImydZAw\u003d\u003d john.doe@example.com", "encoded_key": "AAAAB3NzaC1yc2EAAAABIwAAAQEA0T...YImydZAw\u003d\u003d", "algorithm": "ssh-rsa", "comment": "john.doe@example.com", "valid": true } ]
Get SSH Key
'GET /accounts/link:#account-id[\{account-id\}]/sshkeys/link:#ssh-key-id[\{ssh-key-id\}]'
Retrieves an SSH key of a user.
GET /accounts/self/sshkeys/1 HTTP/1.0
As response an SshKeyInfo entity is returned that describes the SSH key.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "seq": 1, "ssh_public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA0T...YImydZAw\u003d\u003d john.doe@example.com", "encoded_key": "AAAAB3NzaC1yc2EAAAABIwAAAQEA0T...YImydZAw\u003d\u003d", "algorithm": "ssh-rsa", "comment": "john.doe@example.com", "valid": true }
Add SSH Key
'POST /accounts/link:#account-id[\{account-id\}]/sshkeys'
Adds an SSH key for a user.
The SSH public key must be provided as raw content in the request body.
POST /accounts/self/sshkeys HTTP/1.0 Content-Type: plain/text AAAAB3NzaC1yc2EAAAABIwAAAQEA0T...YImydZAw\u003d\u003d
As response an SshKeyInfo entity is returned that describes the new SSH key.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "seq": 2, "ssh_public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA0T...YImydZAw\u003d\u003d john.doe@example.com", "encoded_key": "AAAAB3NzaC1yc2EAAAABIwAAAQEA0T...YImydZAw\u003d\u003d", "algorithm": "ssh-rsa", "comment": "john.doe@example.com", "valid": true }
Delete SSH Key
'DELETE /accounts/link:#account-id[\{account-id\}]/sshkeys/link:#ssh-key-id[\{ssh-key-id\}]'
Deletes an SSH key of a user.
DELETE /accounts/self/sshkeys/2 HTTP/1.0
HTTP/1.1 204 No Content
List Account Capabilities
'GET /accounts/link:#account-id[\{account-id\}]/capabilities'
Returns the global capabilities that are enabled for the specified user.
If the global capabilities for the calling user should be listed,
self
can be used as account-id. This can be used by UI tools to
discover if administrative features are available to the caller, so
they can hide (or show) relevant UI actions.
GET /accounts/self/capabilities HTTP/1.0
As response the global capabilities of the user are returned as a CapabilityInfo entity.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "queryLimit": { "min": 0, "max": 500 }, "emailReviewers": true }
Administrator that has authenticated with digest authentication:
GET /a/accounts/self/capabilities HTTP/1.0 Authorization: Digest username="admin", realm="Gerrit Code Review", nonce="...
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "administrateServer": true, "queryLimit": { "min": 0, "max": 500 }, "createAccount": true, "createGroup": true, "createProject": true, "emailReviewers": true, "killTask": true, "viewCaches": true, "flushCaches": true, "viewConnections": true, "viewQueue": true, "runGC": true }
To filter the set of global capabilities the q
parameter can be used.
Filtering may decrease the response time by avoiding looking at every
possible alternative for the caller.
GET /a/accounts/self/capabilities?q=createAccount&q=createGroup HTTP/1.0 Authorization: Digest username="admin", realm="Gerrit Code Review", nonce="...
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "createAccount": true, "createGroup": true }
Check Account Capability
'GET /accounts/link:#account-id[\{account-id\}]/capabilities/link:#capability-id[\{capability-id\}]'
Checks if a user has a certain global capability.
GET /a/accounts/self/capabilities/createGroup HTTP/1.0
If the user has the global capability the string ok
is returned.
HTTP/1.1 200 OK ok
If the user doesn’t have the global capability the response is
404 Not Found
.
List Groups
'GET /accounts/link:#account-id[\{account-id\}]/groups/'
Lists all groups that contain the specified user as a member.
GET /a/accounts/self/groups/ HTTP/1.0
As result a list of GroupInfo entries is returned.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' [ { "kind": "gerritcodereview#group", "id": "global%3AAnonymous-Users", "url": "#/admin/groups/uuid-global%3AAnonymous-Users", "options": { }, "description": "Any user, signed-in or not", "group_id": 2, "owner_id": "6a1e70e1a88782771a91808c8af9bbb7a9871389" }, { "kind": "gerritcodereview#group", "id": "834ec36dd5e0ed21a2ff5d7e2255da082d63bbd7", "url": "#/admin/groups/uuid-834ec36dd5e0ed21a2ff5d7e2255da082d63bbd7", "options": { "visible_to_all": true, }, "group_id": 6, "owner_id": "834ec36dd5e0ed21a2ff5d7e2255da082d63bbd7" }, { "kind": "gerritcodereview#group", "id": "global%3ARegistered-Users", "url": "#/admin/groups/uuid-global%3ARegistered-Users", "options": { }, "description": "Any signed-in user", "group_id": 3, "owner_id": "6a1e70e1a88782771a91808c8af9bbb7a9871389" } ]
Get Avatar
'GET /accounts/link:#account-id[\{account-id\}]/avatar'
Retrieves the avatar image of the user.
With the size
option (alias s
) you can specify the preferred size
in pixels (height and width).
GET /a/accounts/john.doe@example.com/avatar?s=20 HTTP/1.0
The response redirects to the URL of the avatar image.
HTTP/1.1 302 Found Location: https://profiles/avatar/john_doe.jpeg?s=20x20
Get Avatar Change URL
'GET /accounts/link:#account-id[\{account-id\}]/avatar.change.url'
Retrieves the URL where the user can change the avatar image.
GET /a/accounts/self/avatar.change.url HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: text/plain;charset=UTF-8 https://profiles/pictures/john.doe
Get Diff Preferences
'GET /accounts/link:#account-id[\{account-id\}]/preferences.diff'
Retrieves the diff preferences of a user.
GET /a/accounts/self/preferences.diff HTTP/1.0
As result the diff preferences of the user are returned as a DiffPreferencesInfo entity.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "context": 10, "ignore_whitespace": "IGNORE_ALL_SPACE", "intraline_difference": true, "line_length": 100, "show_tabs": true, "show_whitespace_errors": true, "syntax_highlighting": true, "tab_size": 8 }
Set Diff Preferences
'PUT /accounts/link:#account-id[\{account-id\}]/preferences.diff'
Sets the diff preferences of a user.
The new diff preferences must be provided in the request body as a DiffPreferencesInput entity.
GET /a/accounts/self/preferences.diff HTTP/1.0 Content-Type: application/json;charset=UTF-8 { "context": 10, "ignore_whitespace": "IGNORE_ALL_SPACE", "intraline_difference": true, "line_length": 100, "show_line_endings": true, "show_tabs": true, "show_whitespace_errors": true, "syntax_highlighting": true, "tab_size": 8 }
As result the new diff preferences of the user are returned as a DiffPreferencesInfo entity.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "context": 10, "ignore_whitespace": "IGNORE_ALL_SPACE", "intraline_difference": true, "line_length": 100, "show_line_endings": true, "show_tabs": true, "show_whitespace_errors": true, "syntax_highlighting": true, "tab_size": 8 }
Get Starred Changes
'GET /accounts/link:#account-id[\{account-id\}]/starred.changes'
Gets the changes starred by the identified user account. This
URL endpoint is functionally identical to the changes query
GET /changes/?q=is:starred
. The result is a list of
ChangeInfo entities.
GET /a/accounts/self/starred.changes
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' [ { "kind": "gerritcodereview#change", "id": "myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940", "project": "myProject", "branch": "master", "change_id": "I8473b95934b5732ac55d26311a706c9c2bde9940", "subject": "Implementing Feature X", "status": "NEW", "created": "2013-02-01 09:59:32.126000000", "updated": "2013-02-21 11:16:36.775000000", "mergeable": true, "_sortkey": "0023412400000f7d", "_number": 3965, "owner": { "name": "John Doe" } } ]
Star Change
'PUT /accounts/link:#account-id[\{account-id\}]/starred.changes/link:rest-api-changes.html#change-id[\{change-id\}]'
Star a change. Starred changes are returned for the search query
is:starred
or starredby:USER
and automatically notify the user
whenever updates are made to the change.
PUT /a/accounts/self/starred.changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940 HTTP/1.0
HTTP/1.1 204 No Content
Unstar Change
'DELETE /accounts/link:#account-id[\{account-id\}]/starred.changes/link:rest-api-changes#change-id[\{change-id\}]'
Unstar a change. Removes the starred flag, stopping notifications.
DELETE /a/accounts/self/starred.changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940 HTTP/1.0
HTTP/1.1 204 No Content
IDs
{account-id}
Identifier that uniquely identifies one account.
This can be:
-
a string of the format "Full Name <email@example.com>"
-
just the email address ("email@example")
-
a full name if it is unique ("Full Name")
-
an account ID ("18419")
-
a user name ("username")
-
self
for the calling user
{capability-id}
Identifier of a global capability. Valid values are all field names of the CapabilityInfo entity.
{email-id}
An email address, or preferred
for the preferred email address of the
user.
{username}
The user name.
{ssh-key-id}
The sequence number of the SSH key.
JSON Entities
AccountInfo
The AccountInfo
entity contains information about an account.
Field Name | Description | |
---|---|---|
|
The numeric ID of the account. |
|
|
optional |
The full name of the user. |
|
optional |
The email address the user prefers to be contacted through. |
|
optional |
The username of the user. |
AccountInput
The AccountInput
entity contains information for the creation of
a new account.
Field Name | Description | |
---|---|---|
|
optional |
The user name. If provided, must match the user name from the URL. |
|
optional |
The full name of the user. |
|
optional |
The email address of the user. |
|
optional |
The public SSH key of the user. |
|
optional |
The HTTP password of the user. |
|
optional |
A list of group IDs that identify the groups to which the user should be added. |
AccountNameInput
The AccountNameInput
entity contains information for setting a name
for an account.
Field Name | Description | |
---|---|---|
|
optional |
The new full name of the account. |
CapabilityInfo
The CapabilityInfo
entity contains information about the global
capabilities of a user.
Field Name | Description | |
---|---|---|
|
not set if |
Whether the user has the Administrate Server capability. |
|
The Query Limit of the user as QueryLimitInfo. |
|
|
not set if |
Whether the user has the Create Account capability. |
|
not set if |
Whether the user has the Create Group capability. |
|
not set if |
Whether the user has the Create Project capability. |
|
not set if |
Whether the user has the Email Reviewers capability. |
|
not set if |
Whether the user has the Kill Task capability. |
|
not set if |
Whether the user has the View Caches capability. |
|
not set if |
Whether the user has the Flush Caches capability. |
|
not set if |
Whether the user has the View Connections capability. |
|
not set if |
Whether the user has the View Queue capability. |
|
not set if |
Whether the user has the Run Garbage Collection capability. |
DiffPreferencesInfo
The DiffPreferencesInfo
entity contains information about the diff
preferences of a user.
Field Name | Description | |
---|---|---|
|
The number of lines of context when viewing a patch. |
|
|
not set if |
Whether all inline comments should be automatically expanded. |
|
Whether whitespace changes should be ignored and if yes, which
whitespace changes should be ignored. |
|
|
not set if |
Whether intraline differences should be highlighted. |
|
Number of characters that should be displayed in one line. |
|
|
not set if |
Whether the Reviewed flag should not be set automatically on a patch when it is viewed. |
|
not set if |
Whether the header that is displayed above the patch (that either shows the commit message, the diff preferences, the patch sets or the files) should be retained on file switch. |
|
not set if |
Whether Windows EOL/Cr-Lf should be displayed as \r in a dotted-line box. |
|
not set if |
Whether tabs should be shown. |
|
not set if |
Whether whitespace errors should be shown. |
|
not set if |
Whether deleted files should be skipped on file switch. |
|
not set if |
Whether uncommented files should be skipped on file switch. |
|
not set if |
Whether syntax highlighting should be enabled. |
|
Number of spaces that should be used to display one tab. |
DiffPreferencesInput
The DiffPreferencesInput
entity contains information for setting the
diff preferences of a user. Fields which are not set will not be
updated.
Field Name | Description | |
---|---|---|
|
optional |
The number of lines of context when viewing a patch. |
|
optional |
Whether all inline comments should be automatically expanded. |
|
optional |
Whether whitespace changes should be ignored and if yes, which
whitespace changes should be ignored. |
|
optional |
Whether intraline differences should be highlighted. |
|
optional |
Number of characters that should be displayed in one line. |
|
optional |
Whether the Reviewed flag should not be set automatically on a patch when it is viewed. |
|
optional |
Whether the header that is displayed above the patch (that either shows the commit message, the diff preferences, the patch sets or the files) should be retained on file switch. |
|
optional |
Whether Windows EOL/Cr-Lf should be displayed as \r in a dotted-line box. |
|
optional |
Whether tabs should be shown. |
|
optional |
Whether whitespace errors should be shown. |
|
optional |
Whether deleted files should be skipped on file switch. |
|
optional |
Whether uncommented files should be skipped on file switch. |
|
optional |
Whether syntax highlighting should be enabled. |
|
optional |
Number of spaces that should be used to display one tab. |
EmailInfo
The EmailInfo
entity contains information about an email address of a
user.
Field Name | Description | |
---|---|---|
|
The email address. |
|
|
not set if |
Whether this is the preferred email address of the user. |
|
not set if |
Set true if the user must confirm control of the email address by following a verification link before Gerrit will permit use of this address. |
EmailInput
The EmailInput
entity contains information for registering a new
email address.
Field Name | Description | |
---|---|---|
|
The email address. If provided, must match the email address from the URL. |
|
|
|
Whether the new email address should become the preferred email address
of the user (only supported if |
|
|
Whether the email address should be added without confirmation. In this
case no verification email is sent to the user. |
HttpPasswordInput
The HttpPasswordInput
entity contains information for setting/generating
an HTTP password.
Field Name | Description | |
---|---|---|
|
|
Whether a new HTTP password should be generated |
|
optional |
The new HTTP password. Only Gerrit administrators may set the HTTP
password directly. |
QueryLimitInfo
The QueryLimitInfo
entity contains information about the
Query Limit of a user.
Field Name | Description |
---|---|
|
Lower limit. |
|
Upper limit. |
SshKeyInfo
The SshKeyInfo
entity contains information about an SSH key of a
user.
Field Name | Description | |
---|---|---|
|
The sequence number of the SSH key. |
|
|
The complete public SSH key. |
|
|
The encoded key. |
|
|
The algorithm of the SSH key. |
|
|
optional |
The comment of the SSH key. |
|
Whether the SSH key is valid. |
Part of Gerrit Code Review