Getting Started

Before logging into the cloud platform to manage PII leak vulnerabilities and RoPA reports for compliance, you will need to complete the following steps:

1. Activate your account on app.hounddog.ai: Ensure that your organization has been properly onboarded and has an active account in the cloud platform. As part of the onboarding process, you will choose the authentication mechanism for logging in, such as Google SSO, Azure AD, Microsoft Entra ID, or SAML-based authentication (supporting Okta and other providers).
2. Generate an API key: Navigate to API Keys and click the "New API Key" button to create a new API key that can be used by the scanner.
3. Run the scanner at any stage of the development cycle.
   1. Manual CLI-based scanning: Use a stand-alone binary installed on your machine or a Docker image. Refer to the documentation [here]. This method is ideal for POCs or when code repositories do not change frequently.
   2. Install an IDE plug-in: Leverage one of the published IDE plug-ins to identify PII leaks as you write code.
   3. Schedule daily or weekly scans with Managed Scans: For self-hosted source control management platforms (e.g., GitHub Enterprise Server, GitLab Enterprise, Bitbucket Data Center), install the HoundDog.ai Broker. The Broker acts as a proxy between the HoundDog.ai Cloud Platform and your on-premises services. Once connected, select the repositories to import and schedule scans at the org or repo level. **As of January 2025, Managed Scans is supported for Bitbucket Data Center, with additional integrations coming soon.
   4. Integrate the scanner into your CI pipeline: Run the scanner continuously before code is merged into the main branch. Follow the instructions in the CI/CD Integrations section and ensure that the HOUNDDOG_API_KEY environment variable is used to unlock the vulnerability detection capabilities.