Skip to content

Latest commit

 

History

History
306 lines (192 loc) · 9.98 KB

ThirdPartyVendorsApi.md

File metadata and controls

306 lines (192 loc) · 9.98 KB

.ThirdPartyVendorsApi

All URIs are relative to http://localhost

Method HTTP request Description
getLinkedVendor GET /api/v2/dspm/linkedVendors/{vendorId}/cloudAccounts Get additional details of a specific third party vendor
getSingleLinkedVendor GET /api/v2/dspm/linkedVendors/{vendorId} Get the third party vendors list
listLinkedVendorDataStores GET /api/v2/dspm/linkedVendors/{vendorId}/dataStores Get the data stores associated with a third party vendor
listLinkedVendors GET /api/v2/dspm/linkedVendors Get the summary of a third party vendor
listTrustedAssets GET /api/v2/dspm/linkedVendors/trustedAssets Get a list of all the actual trusted assets

getLinkedVendor

Array getLinkedVendor()

Get additional details of a specific third party vendor, such as, customer account details, sensitivities summary, and so on.

Example

import { createConfiguration, ThirdPartyVendorsApi } from '';
import type { ThirdPartyVendorsApiGetLinkedVendorRequest } from '';

const configuration = createConfiguration();
const apiInstance = new ThirdPartyVendorsApi(configuration);

const request: ThirdPartyVendorsApiGetLinkedVendorRequest = {
    // The third party vendor\'s account ID
  vendorId: "123456789101",
};

const data = await apiInstance.getLinkedVendor(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
vendorId [string] The third party vendor's account ID defaults to undefined

Return type

Array

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 success * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -
400 Bad Request * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -
403 Forbidden * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -
500 Internal Server Error * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -
503 Service Unavailable -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSingleLinkedVendor

LinkedVendor getSingleLinkedVendor()

Get details about a third party vendor.

Example

import { createConfiguration, ThirdPartyVendorsApi } from '';
import type { ThirdPartyVendorsApiGetSingleLinkedVendorRequest } from '';

const configuration = createConfiguration();
const apiInstance = new ThirdPartyVendorsApi(configuration);

const request: ThirdPartyVendorsApiGetSingleLinkedVendorRequest = {
    // vendor id
  vendorId: "123456789101",
};

const data = await apiInstance.getSingleLinkedVendor(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
vendorId [string] vendor id defaults to undefined

Return type

LinkedVendor

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 success * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -
400 Bad Request * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listLinkedVendorDataStores

ListLinkedVendorDataStores200Response listLinkedVendorDataStores()

Get a list of all the data stores that a third party vendor can access. Find out whether the data stores have sensitivities and which role can access the data stores.

Example

import { createConfiguration, ThirdPartyVendorsApi } from '';
import type { ThirdPartyVendorsApiListLinkedVendorDataStoresRequest } from '';

const configuration = createConfiguration();
const apiInstance = new ThirdPartyVendorsApi(configuration);

const request: ThirdPartyVendorsApiListLinkedVendorDataStoresRequest = {
    // The third party vendor\'s account ID
  vendorId: "123456789101",
  
  filter: {
    cloudAccountId: "cloudAccountId_example",
    dataStoreId: "dataStoreId_example",
    dataStoreType: "dataStoreType_example",
    dataStoreName: "dataStoreName_example",
    cloudRegion: "cloudRegion_example",
    cloudProvider: "aws",
  },
  
  sort: {
    sortBy: "dataStoreId",
    sortOrder: 1,
  },
  
  pageSize: 3.14,
  
  nextToken: "nextToken_example",
};

const data = await apiInstance.listLinkedVendorDataStores(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
vendorId [string] The third party vendor's account ID defaults to undefined
filter ListVendorDataStoresFilterParameter (optional) defaults to undefined
sort ListLinkedVendorDataStoresSortParameter (optional) defaults to undefined
pageSize [number] (optional) defaults to undefined
nextToken [string] (optional) defaults to undefined

Return type

ListLinkedVendorDataStores200Response

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 success -
400 Bad Request * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listLinkedVendors

Array listLinkedVendors()

Get a list of all third party vendors associated to your cloud environments (relevant for the cloud environments connected to Guardium DSPM only).

Example

import { createConfiguration, ThirdPartyVendorsApi } from '';

const configuration = createConfiguration();
const apiInstance = new ThirdPartyVendorsApi(configuration);

const request = {};

const data = await apiInstance.listLinkedVendors(request);
console.log('API called successfully. Returned data:', data);

Parameters

This endpoint does not need any parameter.

Return type

Array

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 success * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -
400 Bad Request * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listTrustedAssets

Array listTrustedAssets()

Get a list of roles, buckets or service principles, and their entitled permissions associated to your cloud environments connected to Guardium DSPM.

Example

import { createConfiguration, ThirdPartyVendorsApi } from '';
import type { ThirdPartyVendorsApiListTrustedAssetsRequest } from '';

const configuration = createConfiguration();
const apiInstance = new ThirdPartyVendorsApi(configuration);

const request: ThirdPartyVendorsApiListTrustedAssetsRequest = {
  
  filter: {
    vendorId: "123456789101",
    dataStoreId: "123456789101",
    cloudAccountId: "123456789101",
  },
};

const data = await apiInstance.listTrustedAssets(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
filter ListTrusteesFilterParameter (optional) defaults to undefined

Return type

Array

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 success * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -
400 Bad Request * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]