# OutKept Docs ## Documentation ### Introduction - [Overview](https://docs.outkept.com/index.md): Set up, configure and manage your phishing awareness campaign. ### Getting started - [Account creation](https://docs.outkept.com/account-creation.md): Register your organisation and get verified. - [Access management](https://docs.outkept.com/access-management.md): Give colleagues access, set what they can do, and check they are secured. ### Whitelisting - [Whitelisting setup](https://docs.outkept.com/whitelisting.md): Make sure our simulations reach the inbox rather than the quarantine. - [IP addresses and domains](https://docs.outkept.com/whitelisting-values.md): The values to enter wherever a whitelisting guide asks for ours. - [Google Workspace](https://docs.outkept.com/whitelisting-google-workspace.md): Direct Message Injection delivers simulations through the Gmail API. - [Testing your whitelisting](https://docs.outkept.com/whitelisting-testing.md): Confirm from the platform that our mail arrives and interactions are recorded. - [Whitelisting your own IP address](https://docs.outkept.com/whitelisting-your-ip.md): Stop our bot detection from discarding your own test interactions. #### Microsoft - [Microsoft 365](https://docs.outkept.com/whitelisting-microsoft-365.md): Where to start in a Microsoft environment, and what to add after that. - [Domain & IP whitelisting](https://docs.outkept.com/whitelisting-ms-domains-ips.md): The primary method: mail flow rule, Advanced delivery, and the connector. - [Safe Links](https://docs.outkept.com/whitelisting-ms-safe-links.md): Stop Safe Links rewriting the URLs in our simulations. - [Safe Attachments](https://docs.outkept.com/whitelisting-ms-safe-attachments.md): Stop sandbox detonation registering as a false attachment open. - [Web protection](https://docs.outkept.com/whitelisting-ms-web-protection.md): Allow our landing pages through SmartScreen, Defender XDR and content filtering. - [Whitelisting by header](https://docs.outkept.com/whitelisting-header.md): The fallback when whitelisting by IP and domain is not possible. #### Other security products - [Barracuda](https://docs.outkept.com/whitelisting-barracuda.md): Email Security Gateway, Intent Analysis, Sender Authentication, ATP and Sentinel. - [FortiNet](https://docs.outkept.com/whitelisting-fortinet.md): Allow our domains through the static URL filter. - [Vade](https://docs.outkept.com/whitelisting-vade.md): A mail flow rule that carries your Microsoft 365 whitelist through to Vade. - [WatchGuard](https://docs.outkept.com/whitelisting-watchguard.md): Firebox policy, WebBlocker, DNSWatch and SpamBlocker. ### Onboarding - [Email delivery](https://docs.outkept.com/email-delivery.md): Tell us which mail platform your organisation uses. - [Software tag and colleague names](https://docs.outkept.com/software-tag.md): Two settings that make simulations more believable. - [Preview and whitelisting test](https://docs.outkept.com/preview.md): Check the mapping, then confirm that our mail reaches the inbox. - [Campaign settings](https://docs.outkept.com/campaign-settings.md): Set your schedule, exclusions, active phishing domains and header value. #### How it works - [How it works](https://docs.outkept.com/onboarding-overview.md): How onboarding runs, from empty environment to running campaign. - [Checklist](https://docs.outkept.com/checklist.md): What to agree and collect with your stakeholders before you start. #### Importing data - [Importing your data](https://docs.outkept.com/import-data.md): Pick how your user data reaches the platform. - [Importing a CSV](https://docs.outkept.com/import-csv.md): Preparing and uploading a local file. - [Microsoft Entra ID](https://docs.outkept.com/import-active-directory.md): Preparing your directory and connecting Microsoft Azure. - [Google Workspace](https://docs.outkept.com/import-google-workspace.md): Connecting Google Workspace and syncing users automatically. ##### SCIM - [SCIM](https://docs.outkept.com/import-scim.md): Let your identity provider push users to OutKept using SCIM 2.0. - [Microsoft](https://docs.outkept.com/import-scim-microsoft.md): Set up SCIM provisioning from Microsoft Entra ID. - [Other](https://docs.outkept.com/import-scim-other.md): SCIM provisioning from any other identity provider. #### Mapping data - [Mapping data](https://docs.outkept.com/mapping-data.md): Turn the columns and values in your file into the tags and placeholders we use. - [Mapping column names](https://docs.outkept.com/mapping-column-names.md): Match the columns in your data to the columns on our platform. - [Mapping column values](https://docs.outkept.com/mapping-column-values.md): Match the values inside your columns to our tags, then confirm your organisation details. ### Reporting - [How it works](https://docs.outkept.com/reporting-overview.md): Give employees a button to report suspicious mail, and get feedback back to them. - [Google Workspace](https://docs.outkept.com/reporting-google-workspace.md): Install the OutKept Reporter from the Google Workspace Marketplace. #### Microsoft - [Microsoft](https://docs.outkept.com/reporting-microsoft.md): The OutKept add-in, or an integration with Outlook's built-in Report Phishing button. - [Report button add-in](https://docs.outkept.com/reporting-ms-addin-organisation.md): Deploy the OutKept Phishing Reporter add-in to everyone who uses Outlook. - [Outlook report button](https://docs.outkept.com/reporting-ms-outlook-integration.md): Route Outlook's built-in Report Phishing button through to OutKept. ### Learning - [Overview](https://docs.outkept.com/learning-overview.md): The two ways people learn on the platform. - [End user experience](https://docs.outkept.com/end-user-experience.md): What your employees see when they are invited to learning. - [Micro-learnings](https://docs.outkept.com/micro-learnings.md): The teaching that happens inside the simulation itself. #### Courses - [Courses](https://docs.outkept.com/courses.md): What is in the course library, and how to read the results. - [Inviting people to a course](https://docs.outkept.com/course-invites.md): Invite by hand, or let the platform do it on a schedule. - [Creating your own course](https://docs.outkept.com/create-course.md): Build a course here, or upload one you already have. ### Customisation - [Feedback mails & invites](https://docs.outkept.com/customisation-replies.md): Replace our default reply emails with your own. - [Educational landing pages](https://docs.outkept.com/customisation-landing-pages.md): Replace our default educational page with your own. ### Campaign analysis - [Dashboard](https://docs.outkept.com/campaign-dashboard.md): Reading your interaction data and filtering it usefully. - [Impact, history and personal statistics](https://docs.outkept.com/campaign-graphs.md): The three views that show how your campaign is developing. - [Emails](https://docs.outkept.com/emails-tab.md): Analysing an individual simulation. - [Monthly reports and exports](https://docs.outkept.com/monthly-reports-exports.md): Have the numbers sent to you, or take them out of the platform yourself. ### Phishing - [Campaign phishing](https://docs.outkept.com/campaign-phishing.md): Adding your own simulation to the running campaign. - [Spear phishing](https://docs.outkept.com/spear-phishing.md): Targeting specific individuals on a date you choose. ### Integrations - [Webhooks](https://docs.outkept.com/webhooks.md): Send real-time phishing events to your own endpoint. - [Vanta](https://docs.outkept.com/vanta.md): Link your course data to Vanta as compliance evidence. - [API](https://docs.outkept.com/api.md): A GraphQL API, with an Apollo Sandbox to explore it. ### Partners - [Partner dashboard](https://docs.outkept.com/partner-overview.md): An overview of every client you manage, in one place. - [Client management](https://docs.outkept.com/partner-client-management.md): Creating a new client organisation. - [Bulk actions](https://docs.outkept.com/partner-bulk-editor.md): Invite members and edit tag data across organisations at once. ### Templates - [Start campaign & reporting](https://docs.outkept.com/template-campaign-start.md): Announce the phishing simulations and how to report them. - [Start courses](https://docs.outkept.com/template-course-start.md): Announce the training and the invitation people will receive. ### Contact - [Contact](https://docs.outkept.com/contact.md): Reach out to us with issues or questions. ## Changelog ### Changelog - [Changelog](https://docs.outkept.com/changelog.md): New features, improvements and fixes on the OutKept platform. > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [Dutch (57 pages)](https://docs.outkept.com/_llms/nl.txt): Documentation for Dutch. - [French (57 pages)](https://docs.outkept.com/_llms/fr.txt): Documentation for French. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.