DeepSurface
DocumentationInstallation GuideOverviewLet DeepSurface Host For YouGetting StartedSystem RequirementsSelf Hosted Quick Start - Installing to Cloud PlatformsSelf Hosted - Installation Using an OVARegistration, Package Installation, and InitializationFirst Steps After Initialization of the ConsoleDeployment OptionsMain and Subordinate ConsolesAgent-Based DeploymentUser Managed Scan DeploymentCredentialed Scanning DeploymentMixed EnvironmentDeployment ToolsActive Directory Group PolicyMicrosoft Endpoint Configuration Manager (part of InTune)Tanium DeployHCL BigFixIvantiVirtual MachinesVMWareVirtual BoxVirtualBox Guest AdditionsAWS EC2 (BYOL)AWS EC2 (Usage Based)Azure CloudGoogle CloudAdditional Items to ConsiderMain Console Server CertificatesLDAPTOFUClock SyncDeepSurface CommandsMultiple Vulnerability SourcesAPI DocumentationUser GuideReportingDashboardsExportsRisk InsightHostsPatchesVulnerabilitiesVulnerability InstancesUsersRemediation Workflow ManagerPlansSettingsIntegrationsWorkflowExportingAccepted Risk PlansAccepted Risk WorkflowExploreModelPathsActivityTasksConfiguration AlertsScan LogsNotification SettingsScanningStatusAgentsUser ManagedCredentialed Scanning SettingsCredentialsScan GroupsGeneral SettingsCloud ScanningNetwork ConnectivitySubordinatesVulnerability SourcesSetupSensitive Assets: PolicesSensitive Assets: ManualAdmin SettingsSMTP SettingsCertificatesOutbound ProxyAuthentication ProvidersUsersTagsIntegrations GuideVulnerability SourcesCrowdStrike SpotlightSentinelOneCarbon Black CloudMicrosoft Defender for EndpointWazuhLansweeper CloudNessus APITenable.io APISecurity Center/Tenable.sc APIRapid7 InsightVM APIQualys APINozomi GuardianEclypsiumAWS InspectorRemediationJira SoftwareTanium (BETA)Authentication ProvidersLDAP (Active Directory)SAML (Azure Active Directory)SAML (Google)SAML (Okta)PAMCyberArkDelinea (Thycotic)Microsoft LAPSSecurity GuideFirewall ConfigurationBase Network RequirementsAgent Network RequirementsCredentialed Scanning Network RequirementsAPI Network RequirementsHow DeepSurface Scans WorkDomain (LDAP) ScanningHost Scanning RoutineReasons for the Administrative Access RequirementEndpoint Protection ConsiderationsOther ItemsScope of Data Storage and RetentionIPS/IDS ConsiderationsLoggingResetting the DSADMIN passwordProduct InformationChangelogsOpen source LicensesEnd User License Agreement (EULA)
Users on the DeepSurface console can be auto-provisioned using Google, leveraging the single sign on configuration that should be set up as documented here.
After you have set up the Google SAML application and your existing users can log in with their Google accounts, do the following:
- Create a custom attribute to contain the RBAC role that a DeepSurface user can be assigned through SAML auto-provisioning. Go to your Google Workspace administrative interface and access Directory -> Users -> More Options -> Manage custom attributes

- Click 'Add Custom Attributes' in the top right hand side of the page.

Category and Description can be whatever suits your environment. Under 'Custom Fields', add the values as identified below:
- name: 'role'
- Info type: 'Text'
- Visibility: 'Visible to Organization'
- No. of values: 'Single Value'
Go to Directory -> Users and select a user that you would like to assign a specific role to in the DeepSurface console. Acceptable values for the 'role' custom attribute are 'admin', 'report_manager', 'report_consumer'.
Under the user you have selected, click into the 'User Information' panel, and scroll to the category you designated for the custom attribute you created. Click the attribute to edit it, and enter one of the three values designated above. If you designate no value, the user will a 'report_consumer' in the DeepSurface console, if they have been given permission to use the SAML app you have created.
Log into the Google Admin interface and access Apps - > Web and mobile apps and select the SAML app that you created to use SSO authentication with DeepSurface.

- Click on Configure SAML atttribute mapping, and add the attributes as shown below. The 'role' attribute is your custom attribute, the 'App attributes' MUST be 'role'.

- Log into your DeepSurface console and assign your Google SAML provider to perform auto provisioning.

- Be sure your Google SAML app is enabled for everyone, or assigned to groups or organizational units in your Google Workspace that contain users you would like to be able to log in to the DeepSurface console.

- Navigate to your DeepSurface console and log in with a Google Workspace user that has the SAML app enabled for them. Their email, first name and last name will auto provision to the DeepSurface console when they complete the Google Authentication process.