Review Board 2.0 Documentation

Need help? Talk to us today about a support contract!

This documentation covers Review Board 2.0. You can see the latest Review Board documentation or all other versions.

Review Group User Resource¶

Provides information on users that are members of a review group.

Details¶

Name	`review_group_user`
URI	`/api/groups/{group_name}/users/{username}/`
HTTP Methods	DELETE - Removes a user from a review group. GET - Retrieve information on a registered user.
Parent Resource	Review Group User List Resource
Child Resources	None
Anonymous Access	Yes, if anonymous site access is enabled

Fields¶

avatar_urlString	The URL for an avatar representing the user.
emailString	The user’s e-mail address
first_nameString	The user’s first name.
fullnameString	The user’s full name (first and last).
idInteger	The numeric ID of the user.
last_nameString	The user’s last name.
urlString	The URL to the user’s page on the site. This is deprecated and will be removed in a future version.
usernameString	The user’s username.

HTTP DELETE¶

Removes a user from a review group.

Errors¶

100 - Does Not ExistHTTP 404 - Not Found	Object does not exist
101 - Permission DeniedHTTP 403 - Forbidden	You don’t have permission for this
103 - Not Logged InHTTP 401 - Unauthorized	You are not logged in
208 - Invalid UserHTTP 400 - Bad Request	User does not exist.

HTTP GET¶

Retrieve information on a registered user.

This mainly returns some basic information (username, full name, e-mail address) and links to that user’s root Watched Items resource, which is used for keeping track of the groups and review requests that the user has “starred”.

Errors¶

100 - Does Not ExistHTTP 404 - Not Found	Object does not exist
101 - Permission DeniedHTTP 403 - Forbidden	You don’t have permission for this
103 - Not Logged InHTTP 401 - Unauthorized	You are not logged in

Examples¶

application/vnd.reviewboard.org.review-group-user+json¶

$ curl http://reviews.example.com/api/groups/devgroup/users/doc/ -H "Accept: application/json"

Vary: Accept, Cookie
ETag: 7fedbf38458450f150114998790f8929b1eea07b
Content-Type: application/vnd.reviewboard.org.review-group-user+json
X-Content-Type-Options: nosniff

{
  "stat": "ok", 
  "user": {
    "avatar_url": "http://www.gravatar.com/avatar/b0f1ae4342591db2695fb11313114b3e", 
    "email": "doc@example.com", 
    "first_name": "Doc", 
    "fullname": "Doc Dwarf", 
    "id": 2, 
    "last_name": "Dwarf", 
    "links": {
      "delete": {
        "href": "http://reviews.example.com/api/groups/devgroup/users/doc/", 
        "method": "DELETE"
      }, 
      "self": {
        "href": "http://reviews.example.com/api/groups/devgroup/users/doc/", 
        "method": "GET"
      }, 
      "user": {
        "href": "/api/users/doc/", 
        "method": "GET"
      }
    }, 
    "url": "/users/doc/", 
    "username": "doc"
  }
}