Repository Group Resource¶

Provides information on groups that are allowed access to a repository.

Version Added:: 4.0.11

Details¶

Name	`repository_group`
URI	`/api/repositories/{repository_id}/groups/{group_name}/`
Token Policy ID	`repository_group`
HTTP Methods	DELETE - Removes a group from the repository ACL. GET - Retrieve information on a review group.
Parent Resource	Repository Group List Resource
Child Resources	None

Fields¶

absolute_urlString	The absolute URL to the user’s page on the site. Added in 2.0
display_nameString	The human-readable name of the group, sometimes used as a short description.
extra_dataDictionary	Extra data as part of the review group. This can be set by the API or extensions. Added in 2.0
idInteger	The numeric ID of the review group.
invite_onlyBoolean	Whether or not the group is invite-only. An invite-only group is only accessible by members of the group. Added in 1.6
mailing_listString	The e-mail address that all posts on a review group are sent to.
nameString	The short name of the group, used in the reviewer list and the Dashboard.
urlString	Deprecated The URL to the user’s page on the site. This is deprecated and will be removed in a future version. Deprecated in 2.0
visibleBoolean	Whether or not the group is visible to users who are not members. This does not prevent users from accessing the group if they know it, though. Added in 1.6

Links¶

Name	Method	Resource
delete	DELETE	Repository Group Resource
group	GET	Repository Group Resource
self	GET	Repository Group Resource

HTTP DELETE¶

Removes a group from the repository ACL.

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.

HTTP GET¶

Retrieve information on a review group.

Some basic information on the review group is provided, including the name, description, and mailing list (if any) that e-mails to the group are sent to.

The group links to the list of users that are members of the 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.

Examples¶

application/vnd.reviewboard.org.repository-group+json¶

$ curl https://reviews.example.com/api/repositories/1/groups/privgroup/ -H "Accept: application/json"

HTTP 200 OK
Content-Length: 543
Content-Type: application/vnd.reviewboard.org.repository-group+json
ETag: b9ebf889b45de30c4064b06c46f827191a128187
Vary: Accept, Cookie
X-Content-Type-Options: nosniff

{
  "group": {
    "absolute_url": "https://reviews.example.com/groups/privgroup/",
    "display_name": "Private Group",
    "extra_data": {},
    "id": 4,
    "invite_only": false,
    "links": {
      "delete": {
        "href": "https://reviews.example.com/api/repositories/1/groups/privgroup/",
        "method": "DELETE"
      },
      "group": {
        "href": "/api/groups/privgroup/",
        "method": "GET"
      },
      "self": {
        "href": "https://reviews.example.com/api/repositories/1/groups/privgroup/",
        "method": "GET"
      }
    },
    "mailing_list": "",
    "name": "privgroup",
    "url": "/groups/privgroup/",
    "visible": true
  },
  "stat": "ok"
}