Latest revision as of 12:23, 31 January 2014

[edit] GET /accounts/{accountId}/users

Returns a list of users in an account

[edit] Request

GET /accounts/{accountId}/users

[edit] Request Parameters

accountId - string

The Id of the account

[edit] URI Parameters

None

[edit] Request Headers

Authorization - HTTP Authorization header [1]

The Authentication credentials of the client application.

[edit] Response

[edit] Status Code

200 OK

Success

304 Not changed

The list of users hasn't changed since the last request; the client should use its locally cached copy instead.

401 Unauthorized

The authorization header contained an invalid value

403 Forbidden

Successfully authenticated, but client is not allowed to view the list of users. Access is only permitted for agents and account owners of this account. An account owner is a user with the "sitecontrol_account_owner" role.

404 Not Found

The account in question does not exist

[edit] Response Body

{
  "list": [
    {
      "userName": "{userName}",
      "details": "https://api.hostway.com/accounts/{accountId}/users/{userName}"
    },
    ...
  ],
  "links": [
    {"href": "https://api.hostway.com/accounts/{accountId}/users", "rel": "self"}
  ]
}
 

[edit] Parameters

accountNumber

the Id of the account

userName

the username of the user

[edit] See Also

• Account
• Common Features