Get All Users Assigned to Location
You can get a collection resource representation of all users that are assigned to a location with the specified UID.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator, Company Owner, Company Administrator.
Request
To get a collection resource representation of all users that are assigned to a location, send the GET HTTP request to the URL of the /organizations/locations/{locationUid}/users collection.
HTTP Request
GET https://<hostname>:1280/api/v3/organizations/locations/{locationUid}/users |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
locationUid | Path | String (uuid) | Yes | — | Location UID |
limit | Query | Integer (int32) | No | 100 | Specifies the first N resources that must be returned in the output |
offset | Query | Integer (int32) | No | 0 | Excludes the first N resources from the query output |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message: application/json; charset=utf-8 |
Response Body
In the response body, Veeam Service Provider Console returns a collection resource representation based on the User schema.
Example 
The following request returns a representation of all users assigned to a location with UID b7aa7edd-eac0-4cf4-9975-d7db299bc14b.
Request: GET https://<hostname>:1280/api/v3/organizations/locations/b7aa7edd-eac0-4cf4-9975-d7db299bc14b/users
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 3, "count": 3, "offset": 0 } }, "data": [ { "instanceUid": "c3728f5b-82f7-4e1a-b36b-68c7d1b3w8eb", "organizationUid": "b7aa7edd-eac0-4cf4-9975-d7db299bc14b", "userName": "Alpha", "status": "enabled", "role": "CompanyOwner", "profile": { "firstName": null, "lastName": null, "title": "mr", "email": null, "address": null, "phone": null }, "credentials": { "userName": "Alpha", "password": null } }, { "instanceUid": "1ee4a452-7fda-49b7-9074-92db1dc87fa9", "organizationUid": "b7aa7edd-eac0-4cf4-9975-d7db299bc14b", "userName": "Beta", "status": "enabled", "role": "companyOwner", "profile": { "firstName": null, "lastName": null, "title": "mr", "email": null, "address": null, "phone": null }, "credentials": { "userName": "Beta", "password": null } }, { "instanceUid": "29aeca21-127e-4664-9c69-36a13b21f389", "organizationUid": "b7aa7edd-eac0-4cf4-9975-d7db299bc14b", "userName": "Delta", "status": "enabled", "role": "companyOwner", "profile": { "firstName": null, "lastName": null, "title": "mr", "email": null, "address": null, "phone": null }, "credentials": { "userName": "Delta", "password": null } } ] } |
