Skip to content

Latest commit

 

History

History

README.md

IBM Guardium Data Security Center Bash client

Overview

This is a Bash client script for accessing IBM Guardium Data Security Center service.

The script uses cURL underneath for making all REST calls.

Usage

# Make sure the script has executable rights
$ chmod u+x ./client.sh

# Print the list of operations available on the service
$ ./client.sh -h

# Print the service description
$ ./client.sh --about

# Print detailed information about specific operation
$ ./client.sh <operationId> -h

# Make GET request
$ ./client.sh --host http://<hostname>:<port> --accept xml <operationId> <queryParam1>=<value1> <header_key1>:<header_value2>

# Make GET request using arbitrary curl options (must be passed before <operationId>) to an SSL service using username:password
$ ./client.sh -k -sS --tlsv1.2 --host https://<hostname> -u <user>:<password> --accept xml <operationId> <queryParam1>=<value1> <header_key1>:<header_value2>

# Make POST request
$ echo '<body_content>' | ./client.sh --host <hostname> --content-type json <operationId> -

# Make POST request with simple JSON content, e.g.:
# {
#   "key1": "value1",
#   "key2": "value2",
#   "key3": 23
# }
$ echo '<body_content>' | ./client.sh --host <hostname> --content-type json <operationId> key1==value1 key2=value2 key3:=23 -

# Make POST request with form data
$ ./client.sh --host <hostname> <operationId> key1:=value1 key2:=value2 key3:=23

# Preview the cURL command without actually executing it
$ ./client.sh --host http://<hostname>:<port> --dry-run <operationid>

Docker image

You can easily create a Docker image containing a preconfigured environment for using the REST Bash client including working autocompletion and short welcome message with basic instructions, using the generated Dockerfile:

docker build -t my-rest-client .
docker run -it my-rest-client

By default you will be logged into a Zsh environment which has much more advanced auto completion, but you can switch to Bash, where basic autocompletion is also available.

Shell completion

Bash

The generated bash-completion script can be either directly loaded to the current Bash session using:

source .bash-completion

Alternatively, the script can be copied to the /etc/bash-completion.d (or on OSX with Homebrew to /usr/local/etc/bash-completion.d):

sudo cp .bash-completion /etc/bash-completion.d/

OS X

On OSX you might need to install bash-completion using Homebrew:

brew install bash-completion

and add the following to the ~/.bashrc:

if [ -f $(brew --prefix)/etc/bash_completion ]; then
  . $(brew --prefix)/etc/bash_completion
fi

Zsh

In Zsh, the generated _ Zsh completion file must be copied to one of the folders under $FPATH variable.

Documentation for API Endpoints

All URIs are relative to **

Class Method HTTP request Description
AssetsServiceApi assetsServiceAssetIngestion POST /api/v3/assets/ingestion AssetIngestion - Asset Ingestion Api to ingest assets from different applications including asset extensibility assets.
AssetsServiceApi assetsServiceAssetIngestionManualTrigger POST /api/v3/assets/ingestion/trigger AssetIngestionManualTrigger - Manual trigger for Scheduled Asset Ingestion of databases.
AssetsServiceApi assetsServiceCancelCSVImport DELETE /api/v3/assets/csv/cancel/{csv_id} CancelCSVImport - Cancel the import of CSV and update the status in import log table
AssetsServiceApi assetsServiceClonePolicy POST /api/v3/assets/policies/{policy_id}/clone ClonePolicy - Clone a policy.
AssetsServiceApi assetsServiceCompareCSVToExistingAssets GET /api/v3/assets/csv/compare/{csv_id} CompareCSVToExistingAssets - Compare CSV with existing assets and return list of assets(existing/to be imported/both) on demand from csv.
AssetsServiceApi assetsServiceCreateUpdatePolicy POST /api/v3/assets/policies CreateUpdatePolicy - Create/update new Policy.
AssetsServiceApi assetsServiceDeleteFilterTemplateForAssets DELETE /api/v3/assets/filters/template/{template_id} DeleteFilterTemplateForAssets - Deleting a template using TemplateID in manage assets.
AssetsServiceApi assetsServiceDeletePolicies DELETE /api/v3/assets/policies DeletePolicies - Delete Policy returns response code and message.
AssetsServiceApi assetsServiceFetchAssetChangeLog POST /api/v3/assets/logs FetchAssetChangeLog - Fetch the logs for any actions performed on assets.
AssetsServiceApi assetsServiceFetchAssetDashboard GET /api/v3/assets/dashboard/{widget_type} FetchAssetDashboard - Gets Filter Templates for Dshboard Widgets.
AssetsServiceApi assetsServiceFetchAssetList POST /api/v3/assets FetchAssetList - Asset Fetch Api .
AssetsServiceApi assetsServiceFetchAssetsForMergeSplit GET /api/v3/assets/configuration FetchAssetsForMergeSplit : Fetch assets for Merge and Split.
AssetsServiceApi assetsServiceFindAssetName GET /api/v3/assets/name FindAssetName - Checks if the given Asset Name has already been assigned to an asset.
AssetsServiceApi assetsServiceGetAssetOverview GET /api/v3/assets/overview GetAssetOverview - Get asset overview widgets data for a particular asset.
AssetsServiceApi assetsServiceGetAssetTopology POST /api/v3/assets/topology GetAssetTopology- Get list of topology for a parent asset.
AssetsServiceApi assetsServiceGetFilterTemplateForAssets GET /api/v3/assets/filters/templates GetFilterTemplateForAssets - Get list of filters query templates for manage assets.
AssetsServiceApi assetsServiceGetFiltersForAssets GET /api/v3/assets/filters GetFiltersForAssets - Get a list of filters category and sub category with all data.
AssetsServiceApi assetsServiceImportCSV POST /api/v3/assets/csv/import/{csv_id} ImportCSV - Start the async asset import from CSV by starting the db procedure and send notification at the end.
AssetsServiceApi assetsServiceListPolicy GET /api/v3/assets/policies ListPolicy - List all policies.
AssetsServiceApi assetsServiceListRule GET /api/v3/assets/policies/{policy_id}/rules ListRule - List all rules for a policy.
AssetsServiceApi assetsServiceListTagDomains GET /api/v3/assets/tags/categories ListTagDomains - Get Tag categories by request parameters .
AssetsServiceApi assetsServiceListTags GET /api/v3/assets/tags ListTags - Get Tags for Manage Tags listing screen .
AssetsServiceApi assetsServiceMergeOrSplitAssets POST /api/v3/assets/configuration MergeOrSplitAssets - Merge or split the selected assets.
AssetsServiceApi assetsServiceSaveAssignedTags POST /api/v3/assets/tags/assign SaveAssignedTags - Save Assigned Tags to TAG_DSDEF_MAP table.
AssetsServiceApi assetsServiceSaveTagConceptData POST /api/v3/assets/tags SaveTagConceptData - creates a custom tag
AssetsServiceApi assetsServiceSaveTagDomainData POST /api/v3/assets/tags/categories SaveTagDomainData - creates a custom category to be assigned to a tag
AssetsServiceApi assetsServiceSaveUpdateFilterTemplateForAssets POST /api/v3/assets/filters/templates SaveUpdateFilterTemplateForAssets - Save/Update a filters query to use as template in manage assets along with reordering of template list.
AssetsServiceApi assetsServiceSetBannerState PUT /api/v3/assets/banner SetBannerState - Set banner state for asset inventory page.
AssetsServiceApi assetsServiceUpdateAssetName PUT /api/v3/assets/name UpdateAssetName - Udates the name of the asset as given by the user.
AssetsServiceApi assetsServiceUpdatePolicy PUT /api/v3/assets/policies UpdatePolicy - Update existing Policy status.
AuditServiceApi auditServiceGetActivityRecords GET /api/v3/activity Summary: Get activity records
Description: Return activity records that match the arguments passed in the request.
Multiple values can be passed to the (UID, Context, ActionTaken, PerformedBy) fields by supplying a
comma-separated list to the corresponding fields in the request. For instance to check for
multiple Contexts set the field to &quot;op1, op2, op3&quot;.
AuditServiceApi auditServicePutDownloadActivityRecord POST /api/v3/activity Summary: Put download activity record
Description: Create an activity log record with the arguments passed in the request.
AuthServerServiceApi authServerServiceCreateOauthClient POST /api/v3/oauth/clients Summary: Create Oauth client
Description: Create/register new Oauth client.
AuthServerServiceApi authServerServiceDeleteOauthClient DELETE /api/v3/oauth/clients/{client_id} Summary: Delete Oauth client
Description: Delete registered Oauth client by clientId.
AuthServerServiceApi authServerServiceGetAccessToken GET /api/v3/oauth/token Summary: Get access token
Description: Get access token from passed clientId and secret.
AuthServerServiceApi authServerServiceGetOauthClient GET /api/v3/oauth/clients/{client_id} Summary: Get Oauth client
Description: Get registered Oauth client by clientId.
AuthServerServiceApi authServerServiceGetUser GET /api/v3/auth/user Summary: Get user
Description: Get user.
AuthServerServiceApi authServerServiceListOauthClient GET /api/v3/oauth/clients Summary: List Oauth client
Description: List all registered Oauth client.
CloudAccountsApi addAnalyzedRegion POST /api/v2/dspm/cloudAccounts/cloudProviders/analyzedRegions Add a new region for data classification
CloudAccountsApi addCloudAccounts POST /api/v2/dspm/cloudAccounts/cloudProviders Add cloud account connections to DSPM
CloudAccountsApi generateAtlassianConfluenceAuthUrl GET /api/v2/dspm/cloudAccounts/saasApps/atlassian-confluence/generateAuthUrl Generate a Confluence authentication URL
CloudAccountsApi generateAtlassianJiraAuthUrl GET /api/v2/dspm/cloudAccounts/saasApps/atlassian-jira/generateAuthUrl Generate a JIRA authentication URL
CloudAccountsApi generateAzureAuthUrl GET /api/v2/dspm/cloudAccounts/azure/generateAuthUrl Generate azure authorization url
CloudAccountsApi generateOffice365AuthUrl GET /api/v2/dspm/cloudAccounts/saasApps/office365/generateAuthUrl Generate a Microsoft 365 consent URL
CloudAccountsApi generateSalesforceAuthUrl GET /api/v2/dspm/cloudAccounts/saasApps/salesforce/generateAuthUrl Generate a Salesforce consent URL
CloudAccountsApi generateSlackAuthUrl GET /api/v2/dspm/cloudAccounts/saasApps/slack/generateAuthUrl Generate a Slack authentication URL
CloudAccountsApi generateSnowflakeAuthUrl POST /api/v2/dspm/cloudAccounts/saasApps/snowflake/generateAuthUrl Validate and Generate a Snowflake OAuth URL
CloudAccountsApi getAnalyzedRegionStatus GET /api/v2/dspm/cloudAccounts/cloudProviders/analyzedRegions/status Get the status of analyzer installation for a region
CloudAccountsApi getAzureAdminConsentStatus GET /api/v2/dspm/cloudAccounts/azure/getAdminConsentStatus Get Azure admin consent status
CloudAccountsApi getCloudAccountInstallationStatus GET /api/v2/dspm/cloudAccounts/{cloudProvider}/{cloudAccountId}/installationStatus Get the installation status of a cloud account
CloudAccountsApi getDatabaseMetadata POST /api/v2/dspm/cloudAccounts/saasApps/snowflake/getDatabaseMetadata Get the metadata details of snowflake database.
CloudAccountsApi getRefreshTokenExpiry GET /api/v2/dspm/cloudAccounts/saasApps/snowflake/getRefreshTokenExpiry/{providerId} Get Snowflake Refresh Token Expiry date
CloudAccountsApi listLinkedAccounts GET /api/v2/dspm/cloudAccounts/linkedAccounts List cloud accounts connected to DSPM
CloudAccountsApi removeAccounts DELETE /api/v2/dspm/cloudAccounts/removeAccounts Post cloud account ID connections to be removed
CloudAccountsApi removeAccountsInstructions GET /api/v2/dspm/cloudAccounts/removeAccountsInstructions Post cloud account IDs and get instructions to remove the accounts
CloudAccountsApi retrieveServiceAccountId GET /api/v2/dspm/cloudAccounts/saasApps/google/retrieveServiceAccountId Get Google Workspace authentication
CloudAccountsApi snowflakeIntegrationScript GET /api/v2/dspm/cloudAccounts/saasApps/snowflake/snowflakeIntegrationScript Generate Snowflake Integration Script
CloudAccountsApi submitGoogleWorkspaceAdminEmail POST /api/v2/dspm/cloudAccounts/saasApps/google/submitAdminEmail Submit email for service account authorization
CloudAccountsApi submitOffice365TenantInfo POST /api/v2/dspm/cloudAccounts/saasApps/office365/submitTenantInfo Submit Microsoft 365 customer information
CloudAccountsApi submitSalesforceAuthCode POST /api/v2/dspm/cloudAccounts/saasApps/salesforce/submitAuthCodeInfo Submit Salesforce customer information
CloudAccountsApi submitSlackAuthCode POST /api/v2/dspm/cloudAccounts/saasApps/slack/submitAuthCode Submit a Slack authentication code
CloudAccountsApi submitSnowflakeAuthCode POST /api/v2/dspm/cloudAccounts/saasApps/snowflake/submitAuthCode Submit Snowflake oAuth code
ComplianceAcceleratorApi complianceAcceleratorCreateWorkspace POST /api/v3/compliance/workspace Summary: Create workspace
Description: Create a workspace.
ComplianceAcceleratorApi complianceAcceleratorDeleteComplianceWorkspaces DELETE /api/v3/compliance Summary: Delete compliance workspaces
Description: Delete workspaces.
ComplianceAcceleratorApi complianceAcceleratorGetComplianceInfo GET /api/v3/compliance Summary: Get compliance info
Description: Return stored compliance data.
ComplianceAcceleratorApi complianceAcceleratorHydrateWorkspace POST /api/v3/compliance/workspace/hydrate HydrateWorkspace - Hydrates specified objects within a workspace
ComplianceAcceleratorApi complianceAcceleratorStoreComplianceInfo POST /api/v3/compliance Summary: Store compliance info
Description: Store compliance data.
ConnectionsServiceApi connectionsServiceCreateConnectionsAccounts POST /api/v3/connections/accounts Summary: Create Connections accounts
Description: Create Connections acccounts.
ConnectionsServiceApi connectionsServiceCreateConnectionsConfigs POST /api/v3/connections/configs Summary: Create connections configs
Description: Create Connection config by connection type.
ConnectionsServiceApi connectionsServiceCreatePlugin POST /api/v3/connections/plugins Summary: Create plugin
Description: Create UC generic plugin
ConnectionsServiceApi connectionsServiceCreateSettings POST /api/v3/connections/settings Summary: Create settings
Description: Create Settings.
ConnectionsServiceApi connectionsServiceDeleteConnectionsAccounts DELETE /api/v3/connections/accounts/{account_id} Summary: Delete Connections accounts
Description: Delete Connections acccounts.
ConnectionsServiceApi connectionsServiceDeleteConnectionsConfigs DELETE /api/v3/connections/configs/{connection_id} Summary: Delete connections configs
Description: Delete Connection config by connection id.
ConnectionsServiceApi connectionsServiceDeleteConnector DELETE /api/v3/connections/{connection_id} Summary: Delete connector
Description: Delete a Connection.
ConnectionsServiceApi connectionsServiceDeletePlugin DELETE /api/v3/connections/plugins/{id} Summary: Delete plugin.
Description: Delete plugin.
ConnectionsServiceApi connectionsServiceGeneratePackage PUT /api/v3/connections/plugins/{id}/package Summary: Generate package.
Description: Generate package.
ConnectionsServiceApi connectionsServiceGetBannerState GET /api/v3/connections/banner Summary: Get banner state for object verb page.
Description: Get banner state for object verb page.
ConnectionsServiceApi connectionsServiceGetConnectionsAccounts GET /api/v3/connections/accounts Summary: Get Connections accounts
Description: Get Connections acccounts.
ConnectionsServiceApi connectionsServiceGetConnectionsConfigs GET /api/v3/connections/configs Summary: Get connections configs
Description: Get Connection config by connection type.
ConnectionsServiceApi connectionsServiceGetConnectionsWithFilters POST /api/v3/connections Summary: Get connections with filters
Description: Get connections with filters.
ConnectionsServiceApi connectionsServiceGetConnectorsSummary GET /api/v3/connections/summary Summary: Get connectors summary
Description: Get a summary of Connectors.
ConnectionsServiceApi connectionsServiceGetDataSources GET /api/v3/connections/datasources Summary: Get data sources
Description: Get a list of data sources.
ConnectionsServiceApi connectionsServiceGetGuardRecordFields GET /api/v3/connections/fields Summary: Get list of guard record fields.
Description: Get list of guard record fields.
ConnectionsServiceApi connectionsServiceGetHeaders GET /api/v3/connections/headers Summary: Get headers
Description: Get a list of Headers.
ConnectionsServiceApi connectionsServiceGetPlugins GET /api/v3/connections/plugins Summary: Get plugins
Description: Get custom universal connector plugins
ConnectionsServiceApi connectionsServiceGetSettings GET /api/v3/connections/settings Summary: Get settings
Description: Get a list of Settings.
ConnectionsServiceApi connectionsServicePartialUpdateConnectors PATCH /api/v3/connections Summary: Partial update connectors
Description: Partial update of Connectors.
ConnectionsServiceApi connectionsServicePostStapCommand POST /api/v3/stap/commands Summary: Post stap command
Description: Send a STAP command down to kafka for snif-assist.
ConnectionsServiceApi connectionsServiceUpdateBannerState PUT /api/v3/connections/banner Summary: Update banner state for object verb page.
Description: Update banner state for object verb page.
ConnectionsServiceApi connectionsServiceUpdateConnectionsAccounts PUT /api/v3/connections/accounts Summary: Update Connections accounts
Description: Update Connections acccounts.
ConnectionsServiceApi connectionsServiceUpdateConnectionsConfigs PATCH /api/v3/connections/configs Summary: Update connections configs
Description: Update Connection config by connection id.
ConnectionsServiceApi connectionsServiceUpdateConnectors PUT /api/v3/connections Summary: Update connectors
Description: Update a list of Connectors.
ConnectionsServiceApi connectionsServiceUpdatePlugin PUT /api/v3/connections/plugins/{id} Summary: Update plugin.
Description: Update plugin.
ConnectionsServiceApi connectionsServiceUpdateSettings PUT /api/v3/connections/settings Summary: Update settings
Description: Update Settings.
ConnectionsServiceApi connectionsServiceValidateAwsConnection POST /api/v3/connections/validate/aws Summary: Validate an AWS connection.
Description: Validate an AWS connection.
ConnectionsServiceApi connectionsServiceValidateAzureConnection POST /api/v3/connections/validate/azure Summary: Validate an Azure connection.
Description: Validate an Azure connection.
ConnectionsServiceApi connectionsServiceValidateGcpConnection POST /api/v3/connections/validate/gcp Summary: Validate a GCP connection.
Description: Validate a GCP connection.
DashboardsServiceApi dashboardsServiceCreateDashboard POST /api/v3/dashboards Summary: Create dashboard
Description: Create a unique dashboard.
DashboardsServiceApi dashboardsServiceDeleteDashboard DELETE /api/v3/dashboards/{dashboard_id} Summary: Delete dashboard
Description: Delete a unique dashboard.
DashboardsServiceApi dashboardsServiceGetDashboards GET /api/v3/dashboards Summary: Get dashboards
Description: Get a list of dashboards with all data.
DashboardsServiceApi dashboardsServiceUpdateDashboard PUT /api/v3/dashboards/{dashboard_id} Summary: Update dashboard
Description: Update a dashboard.
DataMovementsApi getActualFlow GET /api/v2/dspm/dataMovements/actualFlows/{id} Get actual flow by providing its ID
DataMovementsApi getActualFlowsSummary GET /api/v2/dspm/dataMovements/actualFlows/summary Get summary of actual flows
DataMovementsApi getPotentialFlow GET /api/v2/dspm/dataMovements/potentialFlows/{flowId} Get potential flow by providing its ID
DataMovementsApi getPotentialFlowPath GET /api/v2/dspm/dataMovements/potentialFlows/paths/{flowPathId} Get potential flow path by providing its ID
DataMovementsApi getPotentialFlowsSummary GET /api/v2/dspm/dataMovements/potentialFlows/summary Get summary of potential flows according to the filter applied
DataMovementsApi listActualFlowPaths GET /api/v2/dspm/dataMovements/actualFlowPaths Get summary of actual flows according to the filter applied
DataMovementsApi listActualFlows GET /api/v2/dspm/dataMovements/actualFlows List actual flows
DataMovementsApi listPotentialFlows GET /api/v2/dspm/dataMovements/potentialFlows List potential flows
DataMovementsApi listPotentialFlowsPaths GET /api/v2/dspm/dataMovements/potentialFlows/paths List potential flow paths
DataResourcesApi getDataResource GET /api/v2/dspm/dataResources/{dataResourceId} Get a specific data resource by its ID
DataResourcesApi getDataResourcesSummary GET /api/v2/dspm/dataResources/summary Data resources summary
DataResourcesApi listDataResources GET /api/v2/dspm/dataResources List data resources that match a given filter
DataResourcesApi listDataResourcesNames GET /api/v2/dspm/dataResources/names List names of data resources
DataResourcesApi removeResource DELETE /api/v2/dspm/dataResources/{dataResourceId}/removeResource Remove resource from DSPM
DataResourcesApi updateResourceReviewStatus PUT /api/v2/dspm/dataResources/{dataResourceId}/reviewed Set review status of a data resource
DataSensitivitiesApi getSensitivitiesSummary GET /api/v2/dspm/sensitivities/summary Get the summary of sensitivities
DataSensitivitiesApi getSensitivity GET /api/v2/dspm/sensitivities/{sensitivityId} Get sensitivity details by providing its ID
DataSensitivitiesApi listSensitivities GET /api/v2/dspm/sensitivities List sensitivities
DataStoresApi getDataStore GET /api/v2/dspm/dataStores/{dataStoreId} Get a data store by its ID
DataStoresApi getDataStoresSummary GET /api/v2/dspm/dataStores/summary Get summary of data stores
DataStoresApi listAllDataStoresLabels GET /api/v2/dspm/dataStores/labels List labels of data stores.
DataStoresApi listDataStores GET /api/v2/dspm/dataStores List data stores
DataStoresApi listDataStoresCloudTagsKeys GET /api/v2/dspm/dataStores/cloudTags/keys List the cloud tag keys of data stores that can be filtered on the basis of prefixes.
DataStoresApi listDataStoresCloudTagsValues GET /api/v2/dspm/dataStores/cloudTags/values List the cloud tag values of data stores that can be filtered on the basis of prefixes and cloud tag key names.
DataStoresApi listDataStoresNames GET /api/v2/dspm/dataStores/filters/name List name of filterable data stores
DataStoresApi rescanDataStore POST /api/v2/dspm/dataStores/rescan Post data store rescan request
DataStoresApi setDataStoreLabel PUT /api/v2/dspm/dataStores/{dataStoreId}/labels Label a data store with an existing or new label
DataStoresApi updateDatastoreCustodian POST /api/v2/dspm/dataStores/custodian Update the name of a Data store custodian
DataVulnerabilitiesApi addVulnerabilityStatusComment POST /api/v2/dspm/vulnerabilities/{vulnerabilityId}/statuses/{statusId}/comments Add vulnerability status comment
DataVulnerabilitiesApi getVulnerabilitiesSummary GET /api/v2/dspm/vulnerabilities/summary Get vulnerabilities summary
DataVulnerabilitiesApi getVulnerability GET /api/v2/dspm/vulnerabilities/{vulnerabilityId} Get vulnerability details by ID
DataVulnerabilitiesApi listVulnerabilities GET /api/v2/dspm/vulnerabilities List vulnerabilities based on an applied filter
DataVulnerabilitiesApi listVulnerabilitiesByDataStore GET /api/v2/dspm/vulnerabilities/byDataStore List vulnerabilities of data stores
DataVulnerabilitiesApi removeVulnerabilityStatusComment DELETE /api/v2/dspm/vulnerabilities/{vulnerabilityId}/statuses/{statusId}/comments/{commentId} Delete vulnerability status comment
DataVulnerabilitiesApi setVulnerabilityStatus POST /api/v2/dspm/vulnerabilities/{vulnerabilityId}/statuses Set status of a vulnerability
DataVulnerabilitiesApi updateVulnerabilityStatusComment PUT /api/v2/dspm/vulnerabilities/{vulnerabilityId}/statuses/{statusId}/comments/{commentId} Set vulnerability status
DatabootstrapperServiceApi databootstrapperServiceLoadData POST /api/v3/databootstrapper/data Summary: Load data
Description: Load data for a tenant.
DatamartProcessorServiceApi datamartProcessorServiceGetDatamartInfo GET /api/v3/datamarts/info Summary: Get datamarts
Description: Return a list of files inside a datamart to the caller.
DatamartProcessorServiceApi datamartProcessorServiceGetDatamarts GET /api/v3/datamarts Summary: Get datamarts
Description: Return a list of datamarts for a time interval to the caller.
DatamartProcessorServiceApi datamartProcessorServiceGetEarliestStartTime GET /api/v3/datamarts/earliest_start_time Summary: Get rarliest start time
Description: Return the earliest time period of data available in database.
DatamartProcessorServiceApi datamartProcessorServiceSendAllCompleteFilesToQueue POST /api/v3/datamarts/repush_files
DatamartProcessorServiceApi datamartProcessorServiceStoreExtractionLogs POST /api/v3/datamarts/{request_id}/dm_extraction_logs Summary: Store extraction logs
Description: Store the datamart extraction logs inside GI.
DatamartProcessorServiceApi uploadDatamart POST /api/v3/datamarts/upload Summary: Upload datamart
Description: Upload datamart file for ingestion.
EcosystemServiceApi ecosystemServiceCreateDataset POST /api/v3/integrations/datasets Summary: Create dataset
Description: Save a definition in the database.
EcosystemServiceApi ecosystemServiceDataInsert POST /api/v3/integrations/datasets/{dataset_name} Summary: Data insert
Description: Process Data received from webhook API and insert.
EcosystemServiceApi ecosystemServiceDeleteDatasets DELETE /api/v3/integrations/datasets Summary: Delete datasets
Description: Delete an array of datasets.
EcosystemServiceApi ecosystemServiceGetDatasetData GET /api/v3/integrations/datasets/{dataset_name}/data Summary: Get dataset data
Description: Return data report for a given dataset.
EcosystemServiceApi ecosystemServiceGetDatasetDetail GET /api/v3/integrations/datasets/{dataset_name}/details Summary: Get dataset detail
Description: Return detail on a dataset definition.
EcosystemServiceApi ecosystemServiceGetDatasets GET /api/v3/integrations/datasets Summary: Get datasets
Description: Return dataset list that matches the specified filter.
EcosystemServiceApi ecosystemServiceGetPurgableRows POST /api/v3/integrations/purge Summary: Get purgable rows
Description: Check the number of rows that can be purged.
EcosystemServiceApi ecosystemServicePurgeData DELETE /api/v3/integrations/datasets/data Summary: Purge data
Description: Purge data.
EcosystemServiceApi ecosystemServiceTestIntegration POST /api/v3/integrations/setup/test Summary: Test integration
Description: Test the integration connection with the arguments passed in the TestIntegrationRequest. When possible
a test message is sent to the integration to ensure it is functional.
Currently this API only supports API_IMPORT type integrations
FeatureFlagsServiceApi featureFlagsServiceDeleteFeatureFlagOverrides DELETE /api/v3/feature_flags/overrides Summary: Delete feature Flag overrides
Description: Delete feature Flag overrides from database.
FeatureFlagsServiceApi featureFlagsServiceGetFeatureFlagOverrides GET /api/v3/feature_flags/overrides Summary: Get feature Flag overrides
Description: Get feature Flag overrides by Feature Flag Name.
FeatureFlagsServiceApi featureFlagsServiceGetFeatureFlags GET /api/v3/feature_flags Summary: Get feature flags
Description: Get feature flags by Feature Flag Name.
FeatureFlagsServiceApi featureFlagsServiceUpdateFeatureFlagOverrides PUT /api/v3/feature_flags/overrides Summary: Update feature Flag overrides
Description: Update feature Flag overrides in the database.
GroupBuilderApi groupBuilderCancelImportGroup DELETE /api/v3/groups_import Summary: Cancel import group
Description: Cancel import refresh for selected groups.
GroupBuilderApi groupBuilderCreateGroup POST /api/v3/groups Summary: Create group
Description: Create new groups.
GroupBuilderApi groupBuilderDeleteGroup DELETE /api/v3/groups Summary: Delete group
Description: Delete specified groups if the group ID is not used for reports.
GroupBuilderApi groupBuilderEditGroup PATCH /api/v3/groups/{group_id} Summary: Edit group
Description: Add or delete group members.
GroupBuilderApi groupBuilderExportGroup POST /api/v3/groups_export Summary: Export group
Description: Export group content to a file based on a group ID.
GroupBuilderApi groupBuilderGetGroupDetails GET /api/v3/groups/{group_id} Summary: Get group details
Description: Get details of group specified by group ID.
GroupBuilderApi groupBuilderGetGroupMembers POST /api/v3/groups/search Summary: Get group members
Description: Get members of all the group ids provided in the request. To be consumed by policy builder ms.
GroupBuilderApi groupBuilderGetGroupSyncMapping GET /api/v3/groups/mappings/sync Summary: Get GDP to gi group mapping
Description: Get GDSC to GDP group sync mapping.
GroupBuilderApi groupBuilderGetGroupTypeMapping GET /api/v3/groups-mappings Summary: Get group type mapping
Description: Get GDSC to GDP group types mapping.
GroupBuilderApi groupBuilderGetGroupTypes GET /api/v3/group_types Summary: Get group types
Description: Get a list of available group types.
GroupBuilderApi groupBuilderGetGroups GET /api/v3/groups Summary: Get groups
Description: Get a list of imported group members.
GroupBuilderApi groupBuilderGetImportGroups GET /api/v3/groups_import Summary: Get import groups
Description: Get unsynchronized groups from a central manager.
GroupBuilderApi groupBuilderImportGroup POST /api/v3/groups_import Summary: Import group
Description: Import selected groups from a central manager. (This API is called from GDP only)
GroupBuilderApi groupBuilderRefreshGroups POST /api/v3/groups/refresh Summary: Refresh groups
Description: Refresh tenants selected imported groups.
GroupBuilderApi groupBuilderResetGroups POST /api/v3/groups/reset Summary: Reset groups
Description: Resets tenants selected predefined groups.
GroupBuilderApi groupBuilderStoreGroupMembersGdp POST /api/v3/central_managers/{central_manager_id}/groups/members Summary: Store group members Gdp
Description: Store GDP groups. (This API is called from GDP only)
GroupBuilderApi groupBuilderStoreGroupsGdp POST /api/v3/central_managers/{central_manager_id}/groups Summary: Store groups Gdp
Description: Store GDP groups. (This API is called from GDP only)
GuardiumConnectorApi guardiumConnectorAddCM POST /api/v3/central_managers Summary: Add CM
Description: Add a Central Manager to the tenant database.
GuardiumConnectorApi guardiumConnectorAddDatamarts POST /api/v3/central_managers/{central_manager_id}/datamarts Description: stores datamarts details from GDP. (This API is called from GDP only)
GuardiumConnectorApi guardiumConnectorAddDmExclusion POST /api/v3/datamarts/exclusion_list Summary: Add DM exclusion
Description: Add datamart to exclusion list.
GuardiumConnectorApi guardiumConnectorAddTask POST /api/v3/central_managers/{central_manager_id}/tasks Summary: Add task
Description: Add a task to be executed on GDP. (This API is called from GDP only)
GuardiumConnectorApi guardiumConnectorBlockUser POST /api/v3/block_user Summary: Block user
Description: Block a database user on Guardium Data Protection or on a supported Database as a Service instance.
GuardiumConnectorApi guardiumConnectorConfigureAggregatorExport PUT /api/v3/central_managers/{central_manager_id}/aggregator_config_export Summary: Configure aggregator export
Description: Configure datamart export from the Aggregators to GI.
GuardiumConnectorApi guardiumConnectorConfigureCollectorExport PUT /api/v3/central_managers/{central_manager_id}/collector_config_export Summary: Configure collector export
Description: Schedule export historical data for collectors.
GuardiumConnectorApi guardiumConnectorConfigureStreaming POST /api/v3/central_managers/{central_manager_id}/streaming Summary: Configure streaming
Description: Enable or disable streaming.
GuardiumConnectorApi guardiumConnectorDatamartVersionCheck POST /api/v3/central_managers/{central_manager_id}/datamart_version Description: validates if central manager has v5 datamart support. (This API is called from GDP only)
GuardiumConnectorApi guardiumConnectorDeleteCM DELETE /api/v3/central_managers/{central_manager_id} Summary: Delete CM
Description: Delete a Central Manager by ID (Name, Hostname or IP).
GuardiumConnectorApi guardiumConnectorDeleteDmExclusion DELETE /api/v3/datamarts/exclusion_list Summary: Delete DM exclusion
Description: Delete a datamart from exclusion list.
GuardiumConnectorApi guardiumConnectorDeleteTask DELETE /api/v3/central_managers/{central_manager_id}/tasks/{task_id} Summary: Delete task
Description: Delete a task by central manager id and task id. (This API is called from GDP only)
GuardiumConnectorApi guardiumConnectorDeleteTasks DELETE /api/v3/central_managers/{central_manager_id}/tasks Summary: Delete tasks
Description: Delete a central manager's tasks by central manager id. (This API is called from GDP only)
GuardiumConnectorApi guardiumConnectorGetAggregatorsConfig GET /api/v3/central_managers/{central_manager_id}/aggregators_config Summary: Get aggregators config
Description: Return a list of managed units from the config collection in tenant database.
GuardiumConnectorApi guardiumConnectorGetCMs GET /api/v3/central_managers Summary: Get CMs
Description: Return a list of Central Managers from the tenant database with additional processing.
GuardiumConnectorApi guardiumConnectorGetCMsConfig GET /api/v3/central_managers_config Summary: Get CMs config
Description: Return a list of Central Managers from the tenant database.
GuardiumConnectorApi guardiumConnectorGetCollectorsConfig GET /api/v3/central_managers/{central_manager_id}/collectors_config Summary: Get collectors config
Description: Return the list of collectors configuration from the tenant database.
GuardiumConnectorApi guardiumConnectorGetDatamarts GET /api/v3/central_managers/{central_manager_id}/datamarts Description: returns full list of supported datamarts including type (historical or non-historical)
GuardiumConnectorApi guardiumConnectorGetDmExclusion GET /api/v3/datamarts/exclusion_list Summary: Get DM exclusion
Description: Return datamarts in the exclusion list.
GuardiumConnectorApi guardiumConnectorGetGdpPolicyInfo GET /api/v3/central_managers/{central_manager_id}/policies/info Summary: Get guardium policy definition
Description: returns the policy definition on the cm
GuardiumConnectorApi guardiumConnectorGetGdpPolicySummaries GET /api/v3/central_managers/{central_manager_id}/policies/summaries Summary: Get guardium policy summary
Description: returns the summaries of all policies on that central manager
GuardiumConnectorApi guardiumConnectorGetHealthInfo GET /api/v3/central_managers/{central_manager_id}/health_info Summary: Get health info
Description: Get health information from Guardium Data Protection central mamangers. (This API is for CMs registered in legacy pull mode. Supported on-premises only)
GuardiumConnectorApi guardiumConnectorGetLatestDMExtractionProfile GET /api/v3/central_managers/{central_manager_id}/datamart_extraction_profile Summary: Get latest DM extraction profile
Description: Return the Datamart Extraction Profile for GDSC.
GuardiumConnectorApi guardiumConnectorGetStreamingStatus GET /api/v3/central_managers/{central_manager_id}/streaming Summary: Get streaming status
Description: Return the streaming configuration.
GuardiumConnectorApi guardiumConnectorGetSyncDMs GET /api/v3/central_managers/{central_manager_id}/sync Summary: Get sync DMs
Description: Return the list of tasks from a central manager. (This API is called from GDP only)
GuardiumConnectorApi guardiumConnectorGetTaskTypes GET /api/v3/central_managers/task_types Summary: Get task types
Description: Return the list of supported task types.
GuardiumConnectorApi guardiumConnectorGetTasks GET /api/v3/central_managers/{central_manager_id}/tasks Summary: Get tasks
Description: Return the list of tasks from a central manager. (This API is called from GDP only)
GuardiumConnectorApi guardiumConnectorRunGDPReport POST /api/v3/central_managers/{central_manager_id}/run_report Summary: Run GDP report
Description: Run GDP report. (This API is for CMs registered in legacy pull mode. Supported on-premises only)
GuardiumConnectorApi guardiumConnectorSetupCM POST /api/v3/central_managers/setup Summary: Setup CM
Description: Set up the registration between a GDP Central manager and GDSC. (This API is called from GDP only)
GuardiumConnectorApi guardiumConnectorSetupDatamarts POST /api/v3/central_managers/{central_manager_id}/datamarts/setup Description: setup custom datamart execution mode
GuardiumConnectorApi guardiumConnectorTaskError POST /api/v3/central_managers/{central_manager_id}/tasks/error Summary: Task error
Description: Log error messages from GDP task execution. (This API is called from GDP only)
GuardiumConnectorApi guardiumConnectorTestDatabaseConnection POST /api/v3/test_database Summary: Test database connection
Description: Return database connection results.
GuardiumConnectorApi guardiumConnectorUpdateDmExclusion PUT /api/v3/datamarts/exclusion_list Summary: Update DM exclusion
Description: Update the atamart exclusion list.
GuardiumConnectorApi guardiumConnectorUpdateStreaming PUT /api/v3/central_managers/{central_manager_id}/streaming Summary: Update streaming
Description: Update streaming status into GI. (This API is called from GDP only)
GuardiumConnectorApi guardiumConnectorUpdateTask PUT /api/v3/central_managers/{central_manager_id}/tasks/{task_id} Summary: Update task
Description: Update a task that gets executed on GDP. (This API is called from GDP only)
HealthCollectorApi healthCollectorGetDataWarehouseUsage GET /api/v3/metrics/warehouse/{type} Summary: Get data warehouse usage info
Description: Get information from data warehouse related to usage
HealthCollectorApi healthCollectorGetGDPHealthInfo GET /api/v3/health Summary: Get GDP health info
Description: Get information from MongoDB for Guardium central managers using health-connector service.
HealthCollectorApi healthCollectorGetHistoricalHealthInfo GET /api/v3/health/history Summary: Get historical health info
Description: Retrieve historical s-tap related statistics from health-collector service.
HealthCollectorApi healthCollectorGetObjectStorageUsage GET /api/v3/metrics/object_storage/{type} Summary: Get object storage usage info
Description: Get information from object storage about tenant bucket usage
HealthCollectorApi healthCollectorGetPVCUsage GET /api/v3/metrics/pvc/{type} Summary: Get the PVC usage information
Description: Get information about the PVC usage in the OCP cluster
HealthCollectorApi healthCollectorGetPodRestarts GET /api/v3/metrics/pods/{type} Summary: Get the pod restart information
Description: Get information about the number of restarts by pod in OCP
HealthCollectorApi healthCollectorGetStreamsIngestion GET /api/v3/metrics/streams/{type} Summary: Get streams ingestion volume over a given time
Description: Get information about streams ingestion volume
HealthCollectorApi healthCollectorGetTopGDPCollectors GET /api/v3/metrics/collectors/{type} Summary: Get the top GDP collectors which send data to GI
Description: Get information about the top GDP collectors
HealthCollectorApi healthCollectorStoreHealthInfo POST /api/v3/health/central_managers/{central_manager_id}/health_info Summary: Store health info
Description: Store health info from GDP into GI. (This API is called from GDP only)
JumpboxServiceApi jumpboxServiceAuthorize POST /api/v3/authorization Summary: Authorize
Description: Authenticate a user and return a JWT.
JumpboxServiceApi jumpboxServiceDeleteAccount DELETE /api/v3/accounts/{account_id} Summary: Delete account
Description: Delete an account.
JumpboxServiceApi jumpboxServiceDeleteTenant DELETE /api/v3/tenants/{tenant_id} Summary: Delete tenant
Description: Delete a tenant.
JumpboxServiceApi jumpboxServiceDeleteUser DELETE /api/v3/users/{user_id} Summary: Delete user
Description: Delete the user.
JumpboxServiceApi jumpboxServiceGetAccount GET /api/v3/accounts/{account_id} Summary: Get account
Description: Get an account.
JumpboxServiceApi jumpboxServiceGetAccounts GET /api/v3/accounts Summary: Get accounts
Description: Get all accounts based on UID.
JumpboxServiceApi jumpboxServiceGetTenant GET /api/v3/tenants/{tenant_id} Summary: Get tenant
Description: Get a tenant.
JumpboxServiceApi jumpboxServiceGetTenants GET /api/v3/tenants Summary: Get tenants
Description: Get all tenant base on UID.
JumpboxServiceApi jumpboxServiceGetUsers GET /api/v3/users Summary: Get users
Description: Get all users base on a tenantID.
JumpboxServiceApi jumpboxServicePostAccount POST /api/v3/accounts Summary: Post account
Description: Create an Account.
JumpboxServiceApi jumpboxServicePostTenants POST /api/v3/tenants Summary: Post tenants
Description: Create a tenant.
JumpboxServiceApi jumpboxServicePostUsers POST /api/v3/users Summary: Post users
Description: Create users.
JumpboxServiceApi jumpboxServiceResumeAccount PATCH /api/v3/accounts/{account_id}/resume Summary: Resume account
Description: Resume an account.
JumpboxServiceApi jumpboxServiceSearchUsers POST /api/v3/users/search Summary: Search users
Description: Search for all users matching the provided string.
JumpboxServiceApi jumpboxServiceSuspendAccount PATCH /api/v3/accounts/{account_id}/suspend Summary: Suspend Account
Description: Suspend an account
JumpboxServiceApi jumpboxServiceTestUser POST /api/v3/users/test Summary: Test user
Description: Test a user lookup to a given LDAP.
JumpboxServiceApi jumpboxServiceUpdateAccount PATCH /api/v3/accounts/{account_id} Summary: Update Account
Description: Updates an account.
JumpboxServiceApi jumpboxServiceUpdateTenant PATCH /api/v3/tenants/{tenant_id} Summary: Update tenant
Description: Update a tenant.
JumpboxServiceApi jumpboxServiceUpdateUsers PATCH /api/v3/users Summary: Update users
Description: Update an array of users.
NotificationsServiceApi notificationsServiceCreateTicket POST /api/v3/integrations/ticket Summary: Create ticket
Description: Create ticket based on information passed in.
NotificationsServiceApi notificationsServiceGetFolders POST /api/v3/integrations/folders Summary: Get folders
Description: Get folder for the integration connection provided.
NotificationsServiceApi notificationsServiceGetNotificationFilename GET /api/v3/notifications/filename Summary: Get notification filename
Description: Return filename associated with the notifications record referenced in the associated context record.
The notification id is required but may be set in the associated authentication token or explicitly in the request.
NotificationsServiceApi notificationsServiceGetNotificationRecord GET /api/v3/notifications/details/{notification_id} Summary: Get notification record
Description: Return notifications record with the specified ID.
NotificationsServiceApi notificationsServiceGetNotificationRecords GET /api/v3/notifications Summary: Get notification records
Description: Return notifications records that match the specified filter.
NotificationsServiceApi notificationsServiceGetTicketStatus GET /api/v3/integrations/ticket/status Summary: Get ticket status
Description: Get the status of the given ticket
NotificationsServiceApi notificationsServicePostNotificationRecord POST /api/v3/notifications Summary: For PostNotificationRecord notification only
Description: Sends notification with recipients and returns a status
NotificationsServiceApi notificationsServiceSearchNotificationRecords POST /api/v3/notifications/search Summary: Search notification records
Description: Return notification records using pipeline of filters
NotificationsServiceApi notificationsServiceTestIntegration POST /api/v3/integrations/test Summary: Test integration
Description: Test the integration connection with the arguments passed in the TestIntegrationRequest. When possible
a test message is sent to the integration to ensure it is functional.
NotificationsServiceApi notificationsServiceUpdateNotificationRecord PUT /api/v3/notifications Summary: Update notification record
Description: Update a notification record with the specified values. The ID field is required and must match an existing notification.
All fields other than the ID are optional.
Creation timestamp, user and other administrative fields can not updated.
OutliersEngineApi outliersEngineGetSourceStatistics GET /api/v3/outliers/source/statistics Summary: Get source statistics
Description: Return statistics regarding the input source, including distribution of verbs, source program, working hours etc.
OutliersEngineApi outliersEngineGetStatistics GET /api/v3/outliers/statistics Summary: Get statistics
Description: Return statistics regarding number of outliers, clusters and un/completed periods.
OutliersEngineApi outliersEngineGetWorkingHoursPeriods GET /api/v3/outliers/working_hours_periods Summary: Get working hours periods
Description: Get a list of the working hours periods.
OutliersEngineApi outliersEngineRunSimulator POST /api/v3/outliers/simulator Summary: Run simulator
Description: Run outlier simulator.
OutliersEngineApi outliersEngineUpdateWorkingHoursPeriods PUT /api/v3/outliers/working_hours_periods Summary: Update working hours periods
Description: Update the working hours periods values.
OutliersEngineApi outliersEngineUploadAndAnalyzePeriod POST /api/v3/outliers Summary: Upload and analyze period
Description: Run outliers detection on ready periods.
OutliersEngineApi outliersEngineUserClustering POST /api/v3/outliers/clusters Summary: User clustering
Description: Run user-clustering on current sources.
PipelineconfigServiceApi pipelineconfigServiceDeleteTenantResources DELETE /api/v3/resources/{tenant_id}/{resource} Summary: Delete a tenant resource
Description: Delete tenant specific resources such as data warehouse, mongo, postgres and s3.
PolicyBuilderApi policyBuilderClonePolicy POST /api/v3/policies/clone/{policy_id} Summary: Clone policy
Description: Clone a policy.
PolicyBuilderApi policyBuilderCreatePolicy POST /api/v3/policies Summary: Create policy
Description: Create Policy returns response code and message.
PolicyBuilderApi policyBuilderDeleteGdpSyncEntry DELETE /api/v3/policies/sync_entry Summary: Delete GDP policy sync entry
Description: Deletes GDP policy from sync collection
PolicyBuilderApi policyBuilderDeletePolicies DELETE /api/v3/policies Summary: Delete policies
Description: Delete Policy returns response code and message.
PolicyBuilderApi policyBuilderGetGdpPolicyMetaData GET /api/v3/policies/metadata_list Summary: Get GDP policy summary information
Description: Get GDP's CM's policy summary from mogodb
PolicyBuilderApi policyBuilderGetPolicies GET /api/v3/policies Summary: Get policies
Description: Return a list of policies to the caller.
PolicyBuilderApi policyBuilderGetPolicyDetails GET /api/v3/policies/{policy_id}/details Summary: Get policy details
Description: Return a list of rules inside the policy.
PolicyBuilderApi policyBuilderGetPolicyNamesFromRuleIDs POST /api/v3/policies/policy_names Summary: GetPolicy names from rule IDs
Description: Return a map where the key is the rule ID and value is the policy name that has the rule ID.
PolicyBuilderApi policyBuilderGetPolicySyncList GET /api/v3/policies/sync_list Summary: Get list of synced polices
Description: Returns the list and status of sync entries
PolicyBuilderApi policyBuilderGetPolicyVersion GET /api/v3/policies/{policy_id}/details/versions/{version} Summary: Get a particular version of the policy
Description: Returns a particular version of policy and response code and message
PolicyBuilderApi policyBuilderGetPolicyVersionsInfo GET /api/v3/policies/{policy_id}/versions/metdata Summary: Gets policy versions info
Description: Returns information of all versions of a policy and response code and message
PolicyBuilderApi policyBuilderGetReceivers GET /api/v3/policies/receivers Summary: Get receivers
Description: Get all the receivers associated with actions.
PolicyBuilderApi policyBuilderGetRuleMetadata GET /api/v3/rules/metadata Summary: Get rule metadata
Description: Return a list of rule parameters and actions to the caller.
PolicyBuilderApi policyBuilderInsertGdpPolicy POST /api/v3/policies/sync_entry Summary: Insert GDP policy sync entry
Description: Inserts GDP policy's name into sync collection
PolicyBuilderApi policyBuilderInsertGdpPolicyMetaData POST /api/v3/central_managers/{central_manager_id}/policies/policy_metadata Summary: Insert GDP policy summaries
Description: Inserts GDP's CM's policy summary information into mogodb. (This API is called from GDP only)
PolicyBuilderApi policyBuilderInstallPolicies PUT /api/v3/policies/install Summary: Install policies
Description: Activate Policies request performs activations.
PolicyBuilderApi policyBuilderIntegrationCheck GET /api/v3/policies/integration_check/{integration_id} Summary: Integration check
Description: Check if integration id is being used in policies.
PolicyBuilderApi policyBuilderPoliciesGroups GET /api/v3/policies/groups Summary: Policies groups
Description: Get policy groups.
PolicyBuilderApi policyBuilderRuleValidation POST /api/v3/rules/validate Summary: Rule validation
Description: Validate a rule parameters and actions.
PolicyBuilderApi policyBuilderStorePoliciesGdp POST /api/v3/policies/{central_manager_id} Summary: Store policies Gdp
Description: Store policies. (This API is called from GDP only)
PolicyBuilderApi policyBuilderUpdatePolicy PUT /api/v3/policies Summary: Update policy
Description: Update Policy returns response code and message.
QSDataLoaderApi qSDataLoaderQSfileValidator POST /api/v3/data/validation QSfileValidator - validate the files before insert happend .
QSDataLoaderApi qSDataLoaderUploadSyntheticDataLoader POST /api/v3/data/synthetic UploadSyntheticDataLoader - Insert data into Db after read from .sql file .
QSDataManagerApi qSDataManagerGetMasterData GET /api/v3/datamanager/master-data Summary: master data for all entities
Description: Retrieves All Dimension and Fact tables data.
QSDataManagerApi qSDataManagerGetPluginData GET /api/v3/datamanager/plugin Summary: Plugins Details
Description: Retrieves All plugins information.
QSDataManagerApi qSDataManagerRegisterScan POST /api/v3/datamanager/scan Summary: Insert ScanDetails
Description: Register new data into scan dimension table.
QSDataManagerApi qSDataManagerRetrieveScan GET /api/v3/datamanager/scan/{scan_id}/data Summary: Fetch ScanDetails
Description: Fetch details from scan dimension table.
QSPluginManagerApi qSPluginManagerInvokeAppProv POST /api/v3/plugins/{plugin_id}/application Summary: Invoke only application provisioning data plugin
Description:Parses app input file and triggers dataload
QSPluginManagerApi qSPluginManagerInvokeExplorerV1 POST /api/v3/plugins/{plugin_id}/explorer Summary: Invoke only explorer inventory data plugin
Description:Parses explorer input file and triggers dataload
QSPluginManagerApi qSPluginManagerInvokeExplorerV2 POST /api/v3/plugins/{plugin_id}/explorer/analytics Summary: Invoke only explorer analytics data plugin
Description:Parses explorer input file and triggers dataload
QSPluginManagerApi qSPluginManagerInvokePlugin POST /api/v3/plugins/{plugin_id}/network Summary: Invoke consolidated or only network data plugin
Description:Parses input files and triggers dataload
QSPluginManagerApi qSPluginManagerInvokePolicy POST /api/v3/plugins/{plugin_id}/policy Summary: Invoke only policy data plugin
Description:Parses policy input file and triggers dataload
QSPolicyManagerApi qSPolicyManagerBatchStatusUpdate PUT /api/v3/policy_manager/tickets/status BatchStatusUpdate - trigger the batch to update the status of the Ticket .
QSPolicyManagerApi qSPolicyManagerConfigUpdate PATCH /api/v3/policy_manager/configs ConfigUpdate - this function update Crypto Risk Factor Weight in Db2 as well as Mongodb.
QSPolicyManagerApi qSPolicyManagerCreateTicket POST /api/v3/policy_manager/ticket CreateTicket - Create a new Incident .
QSPolicyManagerApi qSPolicyManagerFetchFilesfromBuckets GET /api/v3/policy_manager/os-files FetchFilesfromBuckets - fetch the file(s) from bucket of the object storage
QSPolicyManagerApi qSPolicyManagerProcessPolicyDimentionRecords POST /api/v3/policy_manager/policy/process ProcessPolicyDimentionRecords - fetch the records from Policy Dimention and update Policy Fact table
QSPolicyManagerApi qSPolicyManagerUpdateTicketStatus PUT /api/v3/policy_manager/ticket/status UpdateTicketStatus - Update the ticket status based on the IntegrationId and TicketId .
ReportsRunnerApi reportsRunnerGetActiveQueries POST /api/v3/queries/search Summary: Get running queries
Description: Get queries that are running more than certain time
ReportsRunnerApi reportsRunnerGetAuditDataCount POST /api/v3/reports/{report_id}/audit_count Summary: Get audit data count
Description: Get audit data.
ReportsRunnerApi reportsRunnerGetChartData POST /api/v3/charts/run Summary: Get chart data
Description: Get Chart data by chart ID or by specifying report definition and chart settings.
ReportsRunnerApi reportsRunnerGetChartDatav2 POST /api/v3/flex-charts/run
ReportsRunnerApi reportsRunnerGetReportColumnFacet POST /api/v3/reports/facet Summary: Get report column facet
Description: Get counts that is group by values for the selected column.
ReportsRunnerApi reportsRunnerGetReportDataCount POST /api/v3/reports/count Summary: Get report data count
Description: Get report data.
ReportsRunnerApi reportsRunnerRunAuditReport POST /api/v3/audit/{report_id}/run Summary: Run audit report
Description: Run task report by SQL based ob report ID and filter definition.
ReportsRunnerApi reportsRunnerRunReport POST /api/v3/reports/run Summary: Run report
Description: Run report by report ID or by specifying report definition.
ReportsRunnerApi reportsRunnerStopQuery POST /api/v3/queries/stop Summary: Stop query
Description: Stop a query based on the id
ReportsServiceApi reportsServiceCreateCategory POST /api/v3/reports/categories Summary: Create a category
Description: Create a report category
ReportsServiceApi reportsServiceCreateChart POST /api/v3/charts Summary: Create chart
Description: Create custom chart based on provided properties.
ReportsServiceApi reportsServiceCreateChartTemplatev2 POST /api/v3/flex-charts/templates Summary: Create chart template v2
Description: Create custom VEGA chart template.
ReportsServiceApi reportsServiceCreateChartv2 POST /api/v3/flex-charts Summary: Create chart v2
Description: Create custom VEGA chart based on provided properties.
ReportsServiceApi reportsServiceCreateControl POST /api/v3/compliance/controls Summary: Create Control.
Description: Create a unique Control.
ReportsServiceApi reportsServiceCreateFieldsByCategory POST /api/v3/reports/fields Summary - Create fields by category
Description: Cteate category fields based on provided properties.
ReportsServiceApi reportsServiceCreateGrade POST /api/v3/compliance/grades Summary: Create Grade.
Description: Create a unique Grade.
ReportsServiceApi reportsServiceCreateJoin POST /api/v3/reports/categories/joins Summary: Create a join
Description: Create a custom report join
ReportsServiceApi reportsServiceCreateMeasure POST /api/v3/compliance/measures Summary: Create measure.
Description: Create a unique measure.
ReportsServiceApi reportsServiceCreateMetric POST /api/v3/compliance/metrics Summary: Create metric.
Description: Create a unique metric.
ReportsServiceApi reportsServiceCreateProgram POST /api/v3/compliance/programs Summary: Create Program.
Description: Create a unique Program.
ReportsServiceApi reportsServiceCreateReport POST /api/v3/reports Summary: Create report
Description: Create custom report based on provided properties.
ReportsServiceApi reportsServiceCreateRequirement POST /api/v3/compliance/requirements Summary: Create Requirement.
Description: Create a unique Requirement.
ReportsServiceApi reportsServiceCreateVariant POST /api/v3/reports/variants Summary: Create a variant
Description: Create a variant for reports
ReportsServiceApi reportsServiceDeleteCategory DELETE /api/v3/reports/categories Summary: Delete a category
Description: Delete a report category
ReportsServiceApi reportsServiceDeleteChart DELETE /api/v3/charts/{chart_id} Summary: Delete chart
Description: Delete a custom chart.
ReportsServiceApi reportsServiceDeleteChartTemplatev2 DELETE /api/v3/flex-charts/templates/{template_id} Summary: Delete chart template v2
Description: Delete a custom VEGA chart template.
ReportsServiceApi reportsServiceDeleteChartv2 DELETE /api/v3/flex-charts/{chart_id} Summary: Delete chart v2
Description: Delete a custom VEGA chart.
ReportsServiceApi reportsServiceDeleteControl DELETE /api/v3/compliance/controls/{control_id} Summary: Delete Control
Description: Delete a Control.
ReportsServiceApi reportsServiceDeleteFieldsByCategory DELETE /api/v3/reports/fields Summary - Delete fields by category
Description: Delete category fields based on provided properties.
ReportsServiceApi reportsServiceDeleteGrade DELETE /api/v3/compliance/grades/{grade_id} Summary: Delete Grade
Description: Delete a Grade.
ReportsServiceApi reportsServiceDeleteJoin DELETE /api/v3/reports/categories/joins/{join_id} Summary: Delete a join
Description: Delete a custom join
ReportsServiceApi reportsServiceDeleteMeasure DELETE /api/v3/compliance/measures/{measure_id} Summary: Delete measure
Description: Delete a measure.
ReportsServiceApi reportsServiceDeleteMetric DELETE /api/v3/compliance/metrics/{metric_id} Summary: Delete metric
Description: Delete a metric.
ReportsServiceApi reportsServiceDeleteProgram DELETE /api/v3/compliance/programs/{program_id} Summary: Delete Program
Description: Delete a Program.
ReportsServiceApi reportsServiceDeleteReport DELETE /api/v3/reports/{report_id} Summary: Delete report
Description: Delete a custom report.
ReportsServiceApi reportsServiceDeleteRequirement DELETE /api/v3/compliance/requirements/{requirement_id} Summary: Delete Requirement
Description: Delete a Requirement.
ReportsServiceApi reportsServiceDeleteVariant DELETE /api/v3/reports/variants/{variant_id} Summary: Delete a variant
Description: Delete a variant
ReportsServiceApi reportsServiceGetCategories GET /api/v3/reports/categories Summary: Get all available report categories.
Description: Get all category related fields or all possible fields.
ReportsServiceApi reportsServiceGetChartSettings GET /api/v3/charts Summary: Get chart settings
Description: Get a custom chart based on provided report id.
ReportsServiceApi reportsServiceGetChartSettingsv2 GET /api/v3/flex-charts Summary: Get chart settings v2
Description: Get a custom VEGA chart based on provided report id.
ReportsServiceApi reportsServiceGetChartTemplatesv2 GET /api/v3/flex-charts/templates Summary: Get chart template v2
Description: Get all custom VEGA chart templates.
ReportsServiceApi reportsServiceGetControls GET /api/v3/compliance/controls Summary: Get controls
Description: Get a list of controls with all data.
ReportsServiceApi reportsServiceGetFieldsByCategories GET /api/v3/reports/fields/categories Summary: Get fields by categories
Description: Get all category related fields or all possible fields based on a list of categories.
ReportsServiceApi reportsServiceGetFieldsByCategory GET /api/v3/reports/fields Summary: Get fields by category
Description: Get all category related fields or all possible fields.
ReportsServiceApi reportsServiceGetGrades GET /api/v3/compliance/grades Summary: Get grades
Description: Get a list of grades with all data.
ReportsServiceApi reportsServiceGetJoins GET /api/v3/reports/categories/joins Summary: Get all joins
Description: Get all custom joins.
ReportsServiceApi reportsServiceGetMeasures GET /api/v3/compliance/measures Summary: Get measures
Description: Get a list of measures with all data.
ReportsServiceApi reportsServiceGetMetrics GET /api/v3/compliance/metrics Summary: Get metrics
Description: Get a list of metrics with all data.
ReportsServiceApi reportsServiceGetPrograms GET /api/v3/compliance/programs Summary: Get controls
Description: Get a list of controls with all data.
ReportsServiceApi reportsServiceGetQueryByReportDefinition POST /api/v3/reports/query/definition Summary: Get query by report definition
Description: Get query by report definition.
ReportsServiceApi reportsServiceGetQueryByReportID POST /api/v3/reports/query/id Summary: Get query by report ID
Description: Get query by report ID.
ReportsServiceApi reportsServiceGetReportDefinition GET /api/v3/reports/{report_id}/definition Summary: Get report definition
Description: Get report definition.
ReportsServiceApi reportsServiceGetReportGroups GET /api/v3/reports_groups Summary: Get report groups
Description: Get reports used by the provided groups.
ReportsServiceApi reportsServiceGetReportSynopsis GET /api/v3/reports/{report_id}/synopsis Summary: Get report synopsis
Description: Return BriefReport.
ReportsServiceApi reportsServiceGetReportTimestampHeader GET /api/v3/reports/headers/timestamp/default Summary: Get report timestamp header
Description: Get where to take a report timestamp given an entity.
ReportsServiceApi reportsServiceGetReports GET /api/v3/reports Summary: Get reports
Description: Get reports list.
ReportsServiceApi reportsServiceGetReportsForJoin GET /api/v3/reports/categories/joins/{join_id}/reports Summary: Get the reports that use a join
Description: Get the reports that use a join and the headers that are imported by the reports using the join
ReportsServiceApi reportsServiceGetReportsTags GET /api/v3/reports/tags Summary: Get reports tags
Description: Get all report distinct tags.
ReportsServiceApi reportsServiceGetRequirements GET /api/v3/compliance/requirements Summary: Get requirements
Description: Get a list of requirements with all data.
ReportsServiceApi reportsServiceGetVariant GET /api/v3/reports/variants/{variant_id} Summary: Get a variant
Description: Get a given variant
ReportsServiceApi reportsServiceGetVariants GET /api/v3/reports/variants Summary: Get all variants
Description: Get all variants in reports
ReportsServiceApi reportsServicePartialChartUpdate PATCH /api/v3/charts/{chart_id} Summary: Partial chart update
Description: Update a custom chart with partial information.
ReportsServiceApi reportsServicePartialReportUpdate PATCH /api/v3/reports/{report_id} Summary: Partial report update
Description: Update a custom report with partial information.
ReportsServiceApi reportsServiceRunGrades POST /api/v3/compliance/grades/run Summary: Refresh metrics via grades.
Description: Refresh metrics via grades.
ReportsServiceApi reportsServiceRunVariantOperation POST /api/v3/reports/variants/run Summary: Run a variant
Description: Run the operations in a variant
ReportsServiceApi reportsServiceTranspose POST /api/v3/reports/transpose Summary: Transpose
Description: Return the corresponding full sql data.
ReportsServiceApi reportsServiceUpdateChart PUT /api/v3/charts/{chart_id} Summary: Update chart
Description: Update a custom chart.
ReportsServiceApi reportsServiceUpdateChartv2 PUT /api/v3/flex-charts/{chart_id} Summary: Update chart v2
Description: Update a custom VEGA chart.
ReportsServiceApi reportsServiceUpdateControl PUT /api/v3/compliance/controls/{control_id} Summary: Update Control.
Description: Update a Control.
ReportsServiceApi reportsServiceUpdateGrade PUT /api/v3/compliance/grades/{grade_id} Summary: Update Grade.
Description: Update a Grade.
ReportsServiceApi reportsServiceUpdateJoin PUT /api/v3/reports/categories/joins/{join_id} Summary: Update a join
Description: Update a custom join
ReportsServiceApi reportsServiceUpdateMeasure PUT /api/v3/compliance/measures/{measure_id} Summary: Update measure.
Description: Update a measure.
ReportsServiceApi reportsServiceUpdateMetric PUT /api/v3/compliance/metrics/{metric_id} Summary: Update metric.
Description: Update a metric.
ReportsServiceApi reportsServiceUpdateProgram PUT /api/v3/compliance/programs/{program_id} Summary: Update Program.
Description: Update a Program.
ReportsServiceApi reportsServiceUpdateReport PUT /api/v3/reports/{report_id} Summary: Update report
Description: Update a custom report.
ReportsServiceApi reportsServiceUpdateRequirement PUT /api/v3/compliance/requirements/{requirement_id} Summary: Update Requirement.
Description: Update a Requirement.
ReportsServiceApi reportsServiceUpdateVariantOverride PUT /api/v3/reports/variants/{variant_id} Summary: Update a variant
Description: Update a variant with a custom override
RiskAnalyticsControllerApi riskAnalyticsControllerEnableDisableRiskEventFeedback PUT /api/v3/risk_feedback/status Summary: Enable disable risk rvent feedback
Description: Enable or disable the collect feedback process.
RiskAnalyticsControllerApi riskAnalyticsControllerEnableDisableRiskEventProcess PUT /api/v3/risk_process/status Summary: Enable disable risk event process
Description: Enable or disable the risk event process.
RiskAnalyticsControllerApi riskAnalyticsControllerGetAllClassificationsList GET /api/v3/risk_events/classifications Summary: Get all classifications
Description: Get all possible classifications for a risk event.
RiskAnalyticsControllerApi riskAnalyticsControllerGetRiskEventClassificationsList GET /api/v3/risk_events/{risk_id}/feedback Summary: Get risk event classifications list
Description: retrieves the ClassificationMatchDetails for a given risk id; classification that did not matched will be with class_value 0.
RiskAnalyticsControllerApi riskAnalyticsControllerGetRiskEventDataForSummarization GET /api/v3/risk_events/{risk_id}/summarization/data Summary: Get risk event data needed for summarization task
Description: Retrieve the full information about this risk event including all findings data
RiskAnalyticsControllerApi riskAnalyticsControllerGetRiskEventDetails GET /api/v3/risk_events/{risk_id}/details Summary: Get risk event details
Description: Return the details of a risk event, including risk general info and a list of observations.
RiskAnalyticsControllerApi riskAnalyticsControllerGetRiskEventProcessStatus GET /api/v3/risk_process/status Summary: Get risk event process status
Description: Get the risk event process status.
RiskAnalyticsControllerApi riskAnalyticsControllerGetRiskEventRow GET /api/v3/risk_events Summary: Get risk event row
Description: Return a list of risk events.
RiskAnalyticsControllerApi riskAnalyticsControllerGetRiskEventVulnerabilityAssessmentDetails PUT /api/v3/risk_events/{risk_id}/va Summary: Get vulnerability assessment details for a given risk event
Description: Retrieve the information about failed VA tests for assets database and db user
RiskAnalyticsControllerApi riskAnalyticsControllerGetRiskFeedback GET /api/v3/risk_events/feedback Summary: Get risk feedback
Description: Get all feedbacks that are in status NEW/WIP and change them to status WIP.
RiskAnalyticsControllerApi riskAnalyticsControllerGetRiskObservationDetails GET /api/v3/risk_events/observations Summary: Get risk observation details
Description: Return details of a single risk observation.
RiskAnalyticsControllerApi riskAnalyticsControllerGetUserUISettings GET /api/v3/risk_events/user_ui_settings Summary: Get user UI settings
Description: Get the user settings by user id to display the risk in the UI.
RiskAnalyticsControllerApi riskAnalyticsControllerRiskEventTuning PUT /api/v3/risk_events/tuning Summary: Risk event tuning
Description: Perform tuning risk event actions.
RiskAnalyticsControllerApi riskAnalyticsControllerSetRiskEventStatus PUT /api/v3/risk_events/status Summary: Set risk event status
Description: Update the risk status and justification.
RiskAnalyticsControllerApi riskAnalyticsControllerSetUserUISettings PUT /api/v3/risk_events/user_ui_settings Summary: Set user UI settings
Description: Set the user settings by user id in the mongo collection. WARNING: this API should not be used manually or by a system external to GDSC. Using this API to change a user settings may prevent the user from using the Risk Event function within GDSC.
RiskAnalyticsControllerApi riskAnalyticsControllerUpdateRiskFeedback PUT /api/v3/risk_events/feedback Summary: Update risk feedback
Description: Provide feedback for one or more risk events
RiskAnalyticsDataProcessorApi riskAnalyticsDataProcessorGetRiskContext GET /api/v3/risk_events/{risk_id}/context Summary: Get Risk Event Context
Description: Retrieve the context of the given risk ID. This context will be used for LLM interactions.
RiskAnalyticsDataProcessorApi riskAnalyticsDataProcessorGetRiskPredefinedQuestions GET /api/v3/risk_events/{risk_id}/questions Summary: Get Risk Event Predefined Questions
Description: Retrieve the Predefined Questions of the given risk ID. This Predefined Questions will be used quick actions recommendations.
RiskAnalyticsEngineApi riskAnalyticsEngineGetLeadGeneratorConfig GET /api/v3/risk/lead_generator Summary: Get lead generator config
Description: Retrieve the configuration of a lead generator.
RiskAnalyticsEngineApi riskAnalyticsEngineUpdateLeadGeneratorConfig PUT /api/v3/risk/lead_generator Summary: Update lead generator config
Description: Update the configuration of a leads generator.
RiskAnalyticsMlClassificationApi riskAnalyticsMlClassificationResetModelToDefaults POST /api/v3/classification/ml/models/reset Summary: Reset the model to its default weights.
Description: Load the initial model instead of the existing model - this action is irreversible.
SchedulerServiceApi schedulerServiceCreateScheduledJob POST /api/v3/schedules Summary: Create scheduled job
Description: Create a new scheduled job with tasks.
SchedulerServiceApi schedulerServiceDeleteScheduledJob DELETE /api/v3/schedules/{schedule_id} Summary: Delete scheduled job
Description: Delete a single scheduled job.
SchedulerServiceApi schedulerServiceGetDependencies GET /api/v3/schedules/dependencies Summary: Get dependencies
Description: returns IDs of distribution rules, response templates, or processing rules that are in use
SchedulerServiceApi schedulerServiceGetDistributionRules GET /api/v3/schedules/distribution_rules Summary: Get distribution rules
Description: Return a list of distribution rule IDs that are used by the scheduler
Distribution rules can't be edited if it is used by a scheduled job.
SchedulerServiceApi schedulerServiceGetScheduledJobDetails GET /api/v3/schedules/{schedule_id}/details Summary: Get scheduled job
Description: Return a single ScheduledJob in detail.
SchedulerServiceApi schedulerServiceGetScheduledJobs GET /api/v3/schedules Summary: Get scheduled jobs
Description: Return a list of scheduled jobs and the linked tasks.
SchedulerServiceApi schedulerServiceGetSchedulesByReport POST /api/v3/schedules/searchByReport/{report_id} Summary: Get schedules by report
Description: Return an array of scheduled job IDs that run the report_id. An empty array is returned if the report_id is not scheduled.
SchedulerServiceApi schedulerServiceGetTags GET /api/v3/schedules/tags Summary: Get tags
Description: Return an array of all the unique tags from scheduled jobs.
SchedulerServiceApi schedulerServiceSearchScheduledJobs POST /api/v3/schedules/search Summary: Search scheduled jobs
Description: Return a filtered list of scheduled jobs and the linked tasks.
SchedulerServiceApi schedulerServiceSearchScheduledTaskRuns POST /api/v3/schedules/runs/search Summary: Search scheduled task runs
Description: Return a list of scheduled task run, start date, end date, status
SchedulerServiceApi schedulerServiceUpdateScheduledJob PATCH /api/v3/schedules/{schedule_id} Summary: Update scheduled job
Description: Update a single schedule job.
SnifAssistServiceApi snifAssistServiceGetSnifConfig GET /api/v3/snif/config Summary: Get sniffer configuration parameters
Description: Get edge sniffer configuration parameters from GI-mothership.
SnifAssistServiceApi snifAssistServiceGetSnifPolicy GET /api/v3/snif/policy Summary: Get sniffer policy
Description: Get edge sniffer policy from GI-mothership.
SnifAssistServiceApi snifAssistServicePostSnifFeedback POST /api/v3/snif/feedback Summary: Post sniffer feedback
Description: Post policy installation feedback to policy-builder service.
SnifAssistServiceApi snifAssistServiceTestRegex POST /api/v3/snif/test_regex Summary: Test regex
Description: Match a text string with a regular expression using the same sniffer
code used in production to match a regex.
StreamsServiceApi streamsServiceCheckAWSCredentials POST /api/v3/streams/credentials Summary: Check AWS credentials
Description: Service to verify AWS credentials.
StreamsServiceApi streamsServiceCheckAzureEventHub POST /api/v3/streams/azure_eventhub Summary: Check Azure event hub
Description: Service to check Azure event hub.
StreamsServiceApi streamsServiceCheckAzureStorageString POST /api/v3/streams/azure_storage Summary: Check Azure storage string
Description: Service to verify Azure storage connection.
StreamsServiceApi streamsServiceGetAWSRegions GET /api/v3/streams/regions Summary: Get AWS regions
Description: Service to get AWS regions.
StreamsServiceApi streamsServiceListAWSStreams POST /api/v3/streams Summary: List AWS streams
Description: Service to list AWS Kinesis streams.
TenantuserApi tenantuserCreateAPIKey POST /api/v3/apikeys Summary: Create API key
Description: Create API Key.
TenantuserApi tenantuserDeleteAPIKey DELETE /api/v3/apikeys/{id} Summary: Delete API key
Description: Delete APIKey Document based on the document id.
TenantuserApi tenantuserDeleteRole DELETE /api/v3/roles/{role_id} Summary: Delete role
Description: Delete a role.
TenantuserApi tenantuserGetAPIKeys GET /api/v3/apikeys Summary: Get API keys
Description: Get all APIKeys base on a tenant ID.
TenantuserApi tenantuserGetCurrentUser GET /api/v3/currentuser Summary: Get current user
Description: Return the currently authenticated user.
TenantuserApi tenantuserGetPrivilege GET /api/v3/privileges/{privilege.privilege_id} Summary: Get privilege
Description: Return privilege.
TenantuserApi tenantuserGetPrivileges GET /api/v3/privileges Summary: Get privileges
Description: Return all available privileges (pages, restapi, reports, etc) if no roles are specified
If roles are specified, returns cumulative privileges for the list of roles.
TenantuserApi tenantuserGetRole GET /api/v3/roles/{role_id} Summary: Get role
Description: Return single role.
TenantuserApi tenantuserGetRoles GET /api/v3/roles Summary: Get roles
Description: Return all roles without privileges.
TenantuserApi tenantuserGetUser GET /api/v3/users/user/{user_id} Summary: Get user
Description: Return full user for specified user_id.
TenantuserApi tenantuserGetUserNames POST /api/v3/users/names Summary: Get user names
Description: Get user names.
TenantuserApi tenantuserGetUserTenant GET /api/v3/users/tenant/{user_id} Summary: Get user tenant
Description: Return the user plus tenant information.
TenantuserApi tenantuserPostPrivilegesBulk POST /api/v3/privileges Summary: Post privileges bulk
Description: Perform bulk user add preivilege.
TenantuserApi tenantuserPostRole POST /api/v3/roles Summary: Post role
Description: Create a new role.
TenantuserApi tenantuserUpdatePrivilege PATCH /api/v3/privileges/{privilege_id} Summary: Update privilege
Description: Update privilege.
TenantuserApi tenantuserUpdatePrivilegesRoleBulk PATCH /api/v3/privileges Summary: Update privileges role bulk
Description: Perform bulk user update role.
TenantuserApi tenantuserUpdateRole PATCH /api/v3/roles/{role_id} Summary: Update role
Description: Update single role.
TenantuserApi tenantuserUpdateUserRoleBulk PATCH /api/v3/users/role Summary: Update user role bulk
Description: Perform bulk user add or remove role.
ThirdPartyVendorsApi getLinkedVendor GET /api/v2/dspm/linkedVendors/{vendorId}/cloudAccounts Get additional details of a specific third party vendor
ThirdPartyVendorsApi getSingleLinkedVendor GET /api/v2/dspm/linkedVendors/{vendorId} Get the third party vendors list
ThirdPartyVendorsApi listLinkedVendorDataStores GET /api/v2/dspm/linkedVendors/{vendorId}/dataStores Get the data stores associated with a third party vendor
ThirdPartyVendorsApi listLinkedVendors GET /api/v2/dspm/linkedVendors Get the summary of a third party vendor
ThirdPartyVendorsApi listTrustedAssets GET /api/v2/dspm/linkedVendors/trustedAssets Get a list of all the actual trusted assets
UniversalConnectorManagerApi universalConnectorManagerGetCertificate GET /api/v3/certificates Summary: Get certificate
Description: Get the certificate that allows secure communication between data sources and universal connections in GDSC.
UniversalConnectorManagerApi universalConnectorManagerGetConnectors GET /api/v3/connectors Summary: Get connectors
Description: Get all the connectors Universal Connector can support. Includes a list of event pipelines (input--filter pairs), along with the supported data source types and platforms.
UniversalConnectorManagerApi universalConnectorManagerGetUCSetup GET /api/v3/universal_connections/configurations/{plugin_id} Gets information to setup the new Universal connection.
UniversalConnectorManagerApi universalConnectorManagerListConnectionsSummary GET /api/v3/universal_connections Summary: List connections summary
Description: List a summary of Universal Connector configured connections (AKA datasources).
UniversalConnectorManagerApi universalConnectorManagerPluginsList GET /api/v3/plugins Summary: Plugins list
Description: List of all universal connector plugins.
UniversalConnectorManagerApi universalConnectorManagerUploadPlugin POST /api/v3/plugins Summary: Upload plugin
Description: Upload a plugin-package for Universal Connector.
VulnerabilityManagementServiceApi vulnerabilityManagementServiceCreateVulnerability POST /api/v3/vulnerabilities/ingestion Summary: Create a vulnerability
Description: Create a vulnerability based on request
VulnerabilityManagementServiceApi vulnerabilityManagementServiceGetFiltersForVulnerabilities GET /api/v3/vulnerabilities/filters/metadata Summary: Get filters for vulnerabilities
Description: Get a list of filters category and sub category with all data.
VulnerabilityManagementServiceApi vulnerabilityManagementServiceGetVulnerabilities POST /api/v3/vulnerabilities/search Summary: Get vulnerabilities
Description: Returns a list of vulnerabilities.
VulnerabilityManagementServiceApi vulnerabilityManagementServiceGetVulnerabilitiesStats GET /api/v3/vulnerabilities/stats/data Summary: Get vulnerabilities stats
Description: Get various vulnerabilities stats.
VulnerabilityManagementServiceApi vulnerabilityManagementServiceGetVulnerability GET /api/v3/vulnerabilities/{vulnerability_id} Summary: Get vulnerability
Description: Returns a vulnerability based on vulnerability.
VulnerabilityManagementServiceApi vulnerabilityManagementServiceUpdateVulnerabilities PATCH /api/v3/vulnerabilities Updates comments, assignee, and status for vulnerabilities
VulnerabilityManagementServiceApi vulnerabilityManagementServiceVulnerabilityIngestionManualTrigger POST /api/v3/vulnerabilities/ingestion/trigger Summary: Vulnerability ingest manual trigger
Description: Manual trigger for Scheduled Vulnerability Ingestion.
WorkflowApi workflowCreateCase POST /api/v3/cases Summary: Create case
Description: Create single case.
WorkflowApi workflowCreateProductEntity POST /api/v3/workflow/productentities Summary: Create product entity
Description: Create single product entity.
WorkflowApi workflowCreateTask POST /api/v3/cases/{case_id}/tasks Summary: Create task
Description: Create single task within a parent case.
WorkflowApi workflowCreateWorkflowEvent POST /api/v3/workflow/event Summary: Post event for processing by workflow rules
Description: Find matching workflow rule and run it
WorkflowApi workflowDeleteProductEntity DELETE /api/v3/workflow/productentities/{entity_id} Summary: Delete a product entity
Description: Delete a single product entity.
WorkflowApi workflowGetCases GET /api/v3/cases Summary: Get cases
Description: Return all cases requested.
WorkflowApi workflowGetCasesCount POST /api/v3/cases/count Summary: Get cases count
Description: Get case count.
WorkflowApi workflowGetFilename GET /api/v3/cases/{case_id}/tasks/{task_id}/filename Summary: Get filename
Description: Return filename associated with the task referenced in the associated context record.
WorkflowApi workflowGetJobsCount POST /api/v3/cases/{case_id}/jobs/count Summary: Get jobs count
Description: Get jobs count.
WorkflowApi workflowGetProductEntities GET /api/v3/workflow/productentities Summary: Get products and their associated event entities
Description: Return a list of integrated products and their associated event entities
WorkflowApi workflowGetProductEntity GET /api/v3/workflow/productentities/{entity_id} Summary: Get event entity field names, field labels, and field data types
Description: Return a list of fields similar to report headers
WorkflowApi workflowGetReportResult GET /api/v3/cases/{case_id}/tasks/{task_id}/result Summary: Get report result
Description: Return a page of results.
WorkflowApi workflowGetTasks GET /api/v3/cases/{case_id}/tasks Summary: Get tasks
Description: Return all tasks requested.
WorkflowApi workflowGetTasksCount POST /api/v3/cases/{case_id}/tasks/count Summary: Get cases count
Description: Get case count.
WorkflowApi workflowSearchCases POST /api/v3/cases/search Summary: Search cases
Description: Return a subset of cases.
WorkflowApi workflowSearchReports POST /api/v3/cases/reports Summary: Get a list of report IDs
Description: Returns a list of report IDs referenced in all cases and tasks
WorkflowApi workflowSearchTasks POST /api/v3/cases/{case_id}/tasks/search Summary: Search cases
Description: Return a subset of cases.
WorkflowApi workflowUpdateCases PUT /api/v3/cases Summary: Update cases
Description: Update multiple cases in one request.
WorkflowApi workflowUpdateProductEntity PUT /api/v3/workflow/productentities/{entity_id} Summary: Update a product entity
Description: Update a single product entity.
WorkflowApi workflowUpdateTasks PUT /api/v3/cases/{case_id}/tasks Summary: Update tasks
Description: Update multiple tasks for the same parent in one request.

Documentation For Models

Documentation For Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: authorization
  • Location: HTTP header

BasicAuth

  • Type: HTTP basic authentication