> ## Documentation Index
> Fetch the complete documentation index at: https://docs.threataware.com/llms.txt
> Use this file to discover all available pages before exploring further.

# RealVNC

> Connect ThreatAware to RealVNC for remote access device management and monitoring

## Overview

The RealVNC integration enables ThreatAware to access your RealVNC platform data, providing visibility into remote access devices and management activities. This helps you maintain inventory of remote-accessed devices and validate remote access controls.

<Info>
  **Connection Method**: API
  **Setup Time**: 10 minutes
  **Access Required**: RealVNC Account Administrator
</Info>

## Data collected

The RealVNC integration provides:

* Remote access device inventory
* Device management information
* Device connectivity status
* Remote access device details

## Use cases

<CardGroup cols={2}>
  <Card title="Remote Device Inventory" icon="desktop">
    Track and monitor all RealVNC-managed remote access devices
  </Card>

  <Card title="Access Management" icon="shield">
    Verify remote access controls and device authentication
  </Card>

  <Card title="Device Health" icon="heart-pulse">
    Monitor device connectivity and health status
  </Card>

  <Card title="Compliance Support" icon="clipboard-check">
    Generate reports on remote access device management
  </Card>
</CardGroup>

## Setup instructions

<Steps>
  <Step title="Log in to ThreatAware">
    * Navigate to the ThreatAware dashboard
    * Go to **Settings** and select **Systems**
    * Use the search bar to find **RealVNC**
    * Click **Connect** - a pop-up window will appear
  </Step>

  <Step title="Access RealVNC Management Portal">
    * Visit [RealVNC Manage Account](https://manage.realvnc.com/)
    * Sign in using your RealVNC platform credentials
    * Ensure you are logged in with an administrator account
  </Step>

  <Step title="Navigate to API Access Keys">
    * In the RealVNC management portal, click **Add-ons** in the left menu
    * Select **API ACCESS KEYS** from the options
  </Step>

  <Step title="Create API Access Key">
    * Click **Create Access Key**
    * Fill in the **Label** field with "ThreatAware" (or similar identifier)
    * Check the box for **List Entries** permission
      * This allows ThreatAware to retrieve device listings
    * Review other available permissions as needed for your requirements
    * Click **Submit** or **Create** to generate the key
  </Step>

  <Step title="Copy API Credentials">
    * The system will display the **Access Key** and **Access Key ID**
    * Copy the **Access Key ID**
    * Copy the **Access Key** (the secret credential)
    * Store both credentials securely
  </Step>

  <Step title="Configure in ThreatAware">
    In the ThreatAware pop-up window, enter:

    * **Access Key ID**: The Access Key ID from RealVNC
    * **Access Key**: The Access Key from RealVNC
    * Click **Authorize** or **Connect** to establish the integration
  </Step>

  <Step title="Verify Connection">
    * Check the integration status on the ThreatAware dashboard
    * Verify it shows as **Active** or **Connected**
    * Data collection will begin within 1 hour
    * Confirm RealVNC device data appears in ThreatAware
  </Step>
</Steps>

## Required credentials

<AccordionGroup>
  <Accordion title="Access Key ID" icon="key">
    **Field Name**: RealVNC Access Key ID
    **Type**: String
    **Description**: The unique identifier for your RealVNC API access key

    * Generated when creating the API access key in RealVNC
    * Required for API authentication
    * Typically displayed as part of the key pair
  </Accordion>

  <Accordion title="Access Key" icon="lock">
    **Field Name**: RealVNC Access Key
    **Type**: Password (encrypted)
    **Description**: The secret credential for authenticating to the RealVNC API

    <Tip>
      Store this credential securely in your organisation's password manager. Keep track of your keys in case regeneration is needed.
    </Tip>
  </Accordion>
</AccordionGroup>

## Verification and testing

After setup, verify the integration is working correctly:

1. **Check Integration Status**
   * Navigate to **Settings → Integrations** in ThreatAware
   * Confirm RealVNC shows **Active** or **Connected** status
   * Check the last sync timestamp

2. **Verify Device Data**
   * Wait 60 minutes for the initial data poll
   * Search for a known RealVNC device in ThreatAware
   * Verify device details match the RealVNC management portal

3. **Test Device Queries**
   * Create a test query to filter devices from RealVNC
   * Verify the device data is accurate and complete

## Troubleshooting

<AccordionGroup>
  <Accordion title="Invalid Credentials Error" icon="triangle-exclamation">
    **Symptoms**: Integration status shows authentication failure

    **Solutions**:

    * Verify the **Access Key ID** and **Access Key** are correct
    * Ensure credentials were copied completely without extra spaces
    * Check that the access key is active and has not been revoked
    * Confirm the "List Entries" permission is enabled for the key
    * If needed, create a new access key and update ThreatAware
  </Accordion>

  <Accordion title="Permission Issues" icon="ban">
    **Symptoms**: Integration connects but no device data appears

    **Solutions**:

    * Verify the access key has the **List Entries** permission enabled
    * Check that your RealVNC account has administrator privileges
    * Ensure the access key scope includes all devices you want to monitor
    * Review [RealVNC API Documentation](#) for permission requirements
    * Regenerate the access key with correct permissions if needed
  </Accordion>

  <Accordion title="Connection Failed" icon="link">
    **Symptoms**: Integration fails to connect or connection timeout occurs

    **Solutions**:

    * Verify the RealVNC API service is accessible
    * Check your internet connection and firewall settings
    * Ensure outbound HTTPS (443) traffic is allowed to RealVNC servers
    * Test the RealVNC management portal in a browser to verify accessibility
    * Wait a few moments and retry the connection
  </Accordion>

  <Accordion title="No Devices After 1 Hour" icon="database">
    **Symptoms**: Integration shows active but no RealVNC devices appear

    **Solutions**:

    * Verify you have devices registered and active in RealVNC
    * Check that devices are not in offline or excluded state
    * Confirm the access key has "List Entries" permission
    * Ensure your RealVNC account manages the devices you expect to see
    * Wait additional time - first sync may take longer than 1 hour
    * Review ThreatAware integration logs for error messages
  </Accordion>
</AccordionGroup>

## Important notes

<Info>
  **API Key Security**

  * Store API access keys securely in your organisation's password manager
  * Do not share keys with unauthorized users
  * If a key is compromised, revoke it immediately in RealVNC
  * Create dedicated keys for each integration rather than reusing keys
</Info>

<Tip>
  **Permission Setup**

  * Ensure the "List Entries" permission is enabled for the access key
  * You may enable additional permissions if needed for your use case
  * Review RealVNC's API documentation for available permissions
  * Test with minimal permissions first, then expand as needed
</Tip>

## Additional resources

<CardGroup cols={2}>
  <Card title="RealVNC API Documentation" icon="book" href="https://manage.realvnc.com/">
    Official RealVNC documentation for API setup and permissions
  </Card>

  <Card title="ThreatAware Support" icon="life-ring" href="mailto:help@threataware.com">
    Contact ThreatAware support for integration assistance
  </Card>
</CardGroup>

## Best practices

<Tip>
  **Access Key Management**

  * Create a dedicated access key specifically for ThreatAware integration
  * Label keys descriptively (e.g., "ThreatAware Integration")
  * Document your access keys and their purpose
  * Rotate access keys annually or per your security policy
  * Review and monitor access key usage in RealVNC audit logs
</Tip>

<Tip>
  **Integration Maintenance**

  * Verify the integration status regularly
  * Monitor for any authentication or permission errors
  * Test the connection periodically to ensure uninterrupted data flow
  * Keep your RealVNC account settings and ThreatAware up to date
  * Document any changes to your RealVNC device inventory
</Tip>