HeldUserOrGroupResponseInfo

Contains information about all the VMs assigned to the held user and their states. Also contains other general information related to the held user or group.

JSON Example

{
    "ad_user_or_group_id": "S-1-5-21-1111111111-2222222222-3333333333-513",
    "errors": [
        {
            "error_key": "inventory.machine.not.found",
            "error_message": "username cannot be empty"
        }
    ],
    "machines_data": [
        {
            "machine_id": "vm-416",
            "machine_state": "Connected",
            "name": "Win10"
        }
    ],
    "status_code": 200,
    "timestamp": 1561939200000
}

string

ad_user_or_group_id

Optional

Unique SID representing held user or group.

array of APIError

errors

Optional

List of error objects containing error key and error message.

array of HeldVMInfo

machines_data

Optional

List of objects containing information related to held Virtual Machines.

integer As int32 As int32

status_code

Optional

Response HTTP status code of the operation.

integer As int64 As int64

timestamp

Optional

Timestamp in milliseconds when the operation failed. Measured as epoch time.