Jump to >

Hosting Service Account Resource

Added in 1.6.7

Provides information and allows linking of hosting service accounts.

The list of accounts tied to hosting services can be retrieved, and new accounts can be linked through an HTTP POST.

Details

Name hosting_service_account
URI /api/hosting-service-accounts/{account_id}/
Token Policy ID hosting_service_account
HTTP Methods
  • GET - Retrieves information on a particular account.
Parent Resource Hosting Service Account List Resource
Child Resources
Anonymous Access Yes, if anonymous site access is enabled

Fields

idInteger The numeric ID of the hosting service account.
serviceString The ID of the service this account is on.
usernameString The username of the account.

HTTP GET

Retrieves information on a particular account.

This will only return very basic information on the account. Authentication information is not provided.

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.hosting-service-account+json

$ curl http://reviews.example.com/api/hosting-service-accounts/1/ -H "Accept: application/json"
Vary: Accept, Cookie
ETag: 34bafa9605140daecb455514bdaf88c64c2f8353
Content-Type: application/vnd.reviewboard.org.hosting-service-account+json
X-Content-Type-Options: nosniff
{
  "hosting_service_account": {
    "id": 1, 
    "links": {
      "remote_repositories": {
        "href": "http://reviews.example.com/api/hosting-service-accounts/1/remote-repositories/", 
        "method": "GET"
      }, 
      "self": {
        "href": "http://reviews.example.com/api/hosting-service-accounts/1/", 
        "method": "GET"
      }
    }, 
    "service": "github", 
    "username": "testuser"
  }, 
  "stat": "ok"
}