Jump to >

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}/
Token Policy ID review_group_user
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_htmlDictionary

HTML for rendering the avatar at specified sizes. This is only populated if using ?render-avatars-at=... for GET requests or render_avatars_at=... for POST requests.

Added in 3.0.14

avatar_urlString Deprecated

The URL for an avatar representing the user, if available.

Added in 1.6.14

Deprecated in 3.0

avatar_urlsString

The URLs for an avatar representing the user, if available.

Added in 3.0

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.
is_activeBoolean

Whether or not the user is active. Inactive usersare not able to log in or make changes to Review Board.

Added in 2.5.9

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
112 - OAuth2 Missing Scope ErrorHTTP 403 - Forbidden Your OAuth2 token lacks the necessary scopes for this request.
113 - OAuth2 Access Denied ErrorHTTP 403 - Forbidden OAuth2 token access for this resource is prohibited.
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”.

Request Parameters

render-avatars-atString A comma-separated list of avatar pixel sizes to render. Renders for each specified size be available in the avatars_html dictionary. If not provided, avatars will not be rendered.

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
105 - Invalid Form DataHTTP 400 - Bad Request One or more fields had errors
112 - OAuth2 Missing Scope ErrorHTTP 403 - Forbidden Your OAuth2 token lacks the necessary scopes for this request.
113 - OAuth2 Access Denied ErrorHTTP 403 - Forbidden OAuth2 token access for this resource is prohibited.

Examples

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

$ curl http://reviews.example.com/apidevgroup/doc/ -H "Accept: application/json"
Vary: Accept, Cookie
ETag: d31ca86ab4b65b18914a18f4cd12e24e7141cf18
Content-Type: application/vnd.reviewboard.org.review-group-user+json
X-Content-Type-Options: nosniff
{
  "stat": "ok", 
  "user": {
    "avatar_html": null, 
    "avatar_url": "https://secure.gravatar.com/avatar/b0f1ae4342591db2695fb11313114b3e?s=48&d=mm", 
    "avatar_urls": {
      "1x": "https://secure.gravatar.com/avatar/b0f1ae4342591db2695fb11313114b3e?s=48&d=mm", 
      "2x": "https://secure.gravatar.com/avatar/b0f1ae4342591db2695fb11313114b3e?s=96&d=mm", 
      "3x": "https://secure.gravatar.com/avatar/b0f1ae4342591db2695fb11313114b3e?s=144&d=mm"
    }, 
    "email": "doc@example.com", 
    "first_name": "Doc", 
    "fullname": "Doc Dwarf", 
    "id": 2, 
    "is_active": true, 
    "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"
  }
}