.CloudAccountsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
addAnalyzedRegion	POST /api/v2/dspm/cloudAccounts/cloudProviders/analyzedRegions	Add a new region for data classification
addCloudAccounts	POST /api/v2/dspm/cloudAccounts/cloudProviders	Add cloud account connections to DSPM
generateAtlassianConfluenceAuthUrl	GET /api/v2/dspm/cloudAccounts/saasApps/atlassian-confluence/generateAuthUrl	Generate a Confluence authentication URL
generateAtlassianJiraAuthUrl	GET /api/v2/dspm/cloudAccounts/saasApps/atlassian-jira/generateAuthUrl	Generate a JIRA authentication URL
generateAzureAuthUrl	GET /api/v2/dspm/cloudAccounts/azure/generateAuthUrl	Generate azure authorization url
generateOffice365AuthUrl	GET /api/v2/dspm/cloudAccounts/saasApps/office365/generateAuthUrl	Generate a Microsoft 365 consent URL
generateSalesforceAuthUrl	GET /api/v2/dspm/cloudAccounts/saasApps/salesforce/generateAuthUrl	Generate a Salesforce consent URL
generateSlackAuthUrl	GET /api/v2/dspm/cloudAccounts/saasApps/slack/generateAuthUrl	Generate a Slack authentication URL
generateSnowflakeAuthUrl	POST /api/v2/dspm/cloudAccounts/saasApps/snowflake/generateAuthUrl	Validate and Generate a Snowflake OAuth URL
getAnalyzedRegionStatus	GET /api/v2/dspm/cloudAccounts/cloudProviders/analyzedRegions/status	Get the status of analyzer installation for a region
getAzureAdminConsentStatus	GET /api/v2/dspm/cloudAccounts/azure/getAdminConsentStatus	Get Azure admin consent status
getCloudAccountInstallationStatus	GET /api/v2/dspm/cloudAccounts/{cloudProvider}/{cloudAccountId}/installationStatus	Get the installation status of a cloud account
getDatabaseMetadata	POST /api/v2/dspm/cloudAccounts/saasApps/snowflake/getDatabaseMetadata	Get the metadata details of snowflake database.
getRefreshTokenExpiry	GET /api/v2/dspm/cloudAccounts/saasApps/snowflake/getRefreshTokenExpiry/{providerId}	Get Snowflake Refresh Token Expiry date
listLinkedAccounts	GET /api/v2/dspm/cloudAccounts/linkedAccounts	List cloud accounts connected to DSPM
removeAccounts	DELETE /api/v2/dspm/cloudAccounts/removeAccounts	Post cloud account ID connections to be removed
removeAccountsInstructions	GET /api/v2/dspm/cloudAccounts/removeAccountsInstructions	Post cloud account IDs and get instructions to remove the accounts
retrieveServiceAccountId	GET /api/v2/dspm/cloudAccounts/saasApps/google/retrieveServiceAccountId	Get Google Workspace authentication
snowflakeIntegrationScript	GET /api/v2/dspm/cloudAccounts/saasApps/snowflake/snowflakeIntegrationScript	Generate Snowflake Integration Script
submitGoogleWorkspaceAdminEmail	POST /api/v2/dspm/cloudAccounts/saasApps/google/submitAdminEmail	Submit email for service account authorization
submitOffice365TenantInfo	POST /api/v2/dspm/cloudAccounts/saasApps/office365/submitTenantInfo	Submit Microsoft 365 customer information
submitSalesforceAuthCode	POST /api/v2/dspm/cloudAccounts/saasApps/salesforce/submitAuthCodeInfo	Submit Salesforce customer information
submitSlackAuthCode	POST /api/v2/dspm/cloudAccounts/saasApps/slack/submitAuthCode	Submit a Slack authentication code
submitSnowflakeAuthCode	POST /api/v2/dspm/cloudAccounts/saasApps/snowflake/submitAuthCode	Submit Snowflake oAuth code

addAnalyzedRegion

AddAnalyzedRegion200Response addAnalyzedRegion(addAnalyzedRegionRequest)

Install a new analyzer in the specified region to enable data classification in that region.

Example

import { createConfiguration, CloudAccountsApi } from '';
import type { CloudAccountsApiAddAnalyzedRegionRequest } from '';

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

const request: CloudAccountsApiAddAnalyzedRegionRequest = {
  
  addAnalyzedRegionRequest: {
    cloudProvider: "aws",
    region: "europe-west1",
    regions: [
      "regions_example",
    ],
    customerTags: [
      {
        key: "Owner",
        value: "polarsec",
      },
    ],
  },
};

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

Parameters

Name	Type	Description	Notes
addAnalyzedRegionRequest	AddAnalyzedRegionRequest

Return type

AddAnalyzedRegion200Response

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
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]

addCloudAccounts

AddCloudAccounts200Response addCloudAccounts(addCloudAccountsRequest)

You can add a single or multiple cloud account connections from the same cloud provider.
Adding these cloud account connections will trigger Guardium DSPM for data store discovery.
To enable data classification, run the 'Add a new region for data classification' API.

Example

import { createConfiguration, CloudAccountsApi } from '';
import type { CloudAccountsApiAddCloudAccountsRequest } from '';

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

const request: CloudAccountsApiAddCloudAccountsRequest = {
  
  addCloudAccountsRequest: {
    cloudProvider: "aws",
    cloudAccounts: [
      {
        cloudAccountId: "123456789101",
        cloudAccountName: "my cloud account name",
        environment: "development",
      },
    ],
    mainAccountId: "mainAccountId_example",
  },
};

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

Parameters

Name	Type	Description	Notes
addCloudAccountsRequest	AddCloudAccountsRequest

Return type

AddCloudAccounts200Response

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
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]

generateAtlassianConfluenceAuthUrl

AuthUrl generateAtlassianConfluenceAuthUrl()

Generate an Atlassian authentication URL for Confluence integration.

Example

import { createConfiguration, CloudAccountsApi } from '';

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

const request = {};

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

Parameters

This endpoint does not need any parameter.

Return type

AuthUrl

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]

generateAtlassianJiraAuthUrl

AuthUrl generateAtlassianJiraAuthUrl()

Generate an Atlassian authentication URL for JIRA integration.

Example

import { createConfiguration, CloudAccountsApi } from '';

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

const request = {};

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

Parameters

This endpoint does not need any parameter.

Return type

AuthUrl

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]

generateAzureAuthUrl

AuthUrl generateAzureAuthUrl()

Generate azure authorization url.

Example

import { createConfiguration, CloudAccountsApi } from '';
import type { CloudAccountsApiGenerateAzureAuthUrlRequest } from '';

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

const request: CloudAccountsApiGenerateAzureAuthUrlRequest = {
    // Tenant Id of the new Azure account, GUID format. (optional)
  tenantId: "tenantId_example",
};

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

Parameters

Name	Type	Description	Notes
tenantId	[string]	Tenant Id of the new Azure account, GUID format.	(optional) defaults to undefined

Return type

AuthUrl

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]

generateOffice365AuthUrl

AuthUrl generateOffice365AuthUrl()

Generate an administrator consent URL for Microsoft 365 integration.

Example

import { createConfiguration, CloudAccountsApi } from '';

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

const request = {};

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

Parameters

This endpoint does not need any parameter.

Return type

AuthUrl

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]

generateSalesforceAuthUrl

AuthUrl generateSalesforceAuthUrl()

Generate an administrator consent URL for Salesforce integration.

Example

import { createConfiguration, CloudAccountsApi } from '';

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

const request = {};

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

Parameters

This endpoint does not need any parameter.

Return type

AuthUrl

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]

generateSlackAuthUrl

AuthUrl generateSlackAuthUrl()

Generate a Slack authentication URL.

Example

import { createConfiguration, CloudAccountsApi } from '';

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

const request = {};

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

Parameters

This endpoint does not need any parameter.

Return type

AuthUrl

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]

generateSnowflakeAuthUrl

AuthUrl generateSnowflakeAuthUrl(clientInfo)

Generate an administrator consent URL for Snowflake integration.

Example

import { createConfiguration, CloudAccountsApi } from '';
import type { CloudAccountsApiGenerateSnowflakeAuthUrlRequest } from '';

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

const request: CloudAccountsApiGenerateSnowflakeAuthUrlRequest = {
  
  clientInfo: {
    clientId: "clientId_example",
    clientSecret: "clientSecret_example",
    authEndpoint: "authEndpoint_example",
  },
};

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

Parameters

Name	Type	Description	Notes
clientInfo	ClientInfo

Return type

AuthUrl

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
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]

getAnalyzedRegionStatus

GetAnalyzedRegionStatus200Response getAnalyzedRegionStatus()

Get the installation status of Guardium DSPM for a region.

Example

import { createConfiguration, CloudAccountsApi } from '';
import type { CloudAccountsApiGetAnalyzedRegionStatusRequest } from '';

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

const request: CloudAccountsApiGetAnalyzedRegionStatusRequest = {
    // The cloud provider for the cloud account
  cloudProvider: "aws",
    // The region code
  region: "europe-west1",
};

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

Parameters

Name	Type	Description	Notes
cloudProvider	CloudServiceProvider	The cloud provider for the cloud account	defaults to undefined
region	[string]	The region code	defaults to undefined

Return type

GetAnalyzedRegionStatus200Response

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]

getAzureAdminConsentStatus

boolean getAzureAdminConsentStatus()

Get Azure admin consent status.

Example

import { createConfiguration, CloudAccountsApi } from '';

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

const request = {};

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

Parameters

This endpoint does not need any parameter.

Return type

boolean

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	true if the customer has granted admin permissions, false otherwise	-
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]

getCloudAccountInstallationStatus

CloudAccountInstallationStatus getCloudAccountInstallationStatus()

Get the installation status of a cloud account.

Example

import { createConfiguration, CloudAccountsApi } from '';
import type { CloudAccountsApiGetCloudAccountInstallationStatusRequest } from '';

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

const request: CloudAccountsApiGetCloudAccountInstallationStatusRequest = {
    // The cloud provider of the cloud account
  cloudProvider: "aws",
    // The cloud account identifier
  cloudAccountId: "12345678910",
};

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

Parameters

Name	Type	Description	Notes
cloudProvider	CloudServiceProvider	The cloud provider of the cloud account	defaults to undefined
cloudAccountId	[string]	The cloud account identifier	defaults to undefined

Return type

CloudAccountInstallationStatus

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]

getDatabaseMetadata

DBMetadataInfo getDatabaseMetadata(dbInfo)

Get the metadata details of snowflake database from saas-asset-store.

Example

import { createConfiguration, CloudAccountsApi } from '';
import type { CloudAccountsApiGetDatabaseMetadataRequest } from '';

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

const request: CloudAccountsApiGetDatabaseMetadataRequest = {
  
  dbInfo: {
    dataStoreId: "dataStoreId_example",
  },
};

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

Parameters

Name	Type	Description	Notes
dbInfo	DbInfo

Return type

DBMetadataInfo

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
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]

getRefreshTokenExpiry

TokenExpiryInfo getRefreshTokenExpiry()

Get Snowflake Refresh Token Expiry date.

Example

import { createConfiguration, CloudAccountsApi } from '';
import type { CloudAccountsApiGetRefreshTokenExpiryRequest } from '';

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

const request: CloudAccountsApiGetRefreshTokenExpiryRequest = {
    // The ID of the provider
  providerId: "providerId_example",
};

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

Parameters

Name	Type	Description	Notes
providerId	[string]	The ID of the provider	defaults to undefined

Return type

TokenExpiryInfo

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]

listLinkedAccounts

Array listLinkedAccounts()

Get a list of all the connected cloud accounts monitored by Guardium DSPM.

Example

import { createConfiguration, CloudAccountsApi } from '';

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

const request = {};

const data = await apiInstance.listLinkedAccounts(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]

removeAccounts

void removeAccounts()

Post cloud account ID connections to be removed from Guardium DSPM.

Example

import { createConfiguration, CloudAccountsApi } from '';
import type { CloudAccountsApiRemoveAccountsRequest } from '';

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

const request: CloudAccountsApiRemoveAccountsRequest = {
  
  accountIds: ["1234567891011"],
  
  serviceProvider: "aws",
};

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

Parameters

Name	Type	Description	Notes
accountIds	Array<string>		defaults to undefined
serviceProvider	ServiceProvider		defaults to undefined

Return type

void

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
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 -
404	Not Found	* 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 -

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

removeAccountsInstructions

RemoveAccountsInstructions200Response removeAccountsInstructions()

Post cloud accounts IDs and get instructions to remove the accounts from the cloud service provider.

Example

import { createConfiguration, CloudAccountsApi } from '';
import type { CloudAccountsApiRemoveAccountsInstructionsRequest } from '';

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

const request: CloudAccountsApiRemoveAccountsInstructionsRequest = {
  
  accountIds: ["1234567891011"],
  
  serviceProvider: "aws",
};

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

Parameters

Name	Type	Description	Notes
accountIds	Array<string>		defaults to undefined
serviceProvider	ServiceProvider		defaults to undefined

Return type

RemoveAccountsInstructions200Response

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	string	* 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 -
404	Not Found	* 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 -

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

retrieveServiceAccountId

ServiceAccountClientId retrieveServiceAccountId()

Retrieve a service account ID to use it for Google Workspace authentication.

Example

import { createConfiguration, CloudAccountsApi } from '';

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

const request = {};

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

Parameters

This endpoint does not need any parameter.

Return type

ServiceAccountClientId

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]

snowflakeIntegrationScript

Script snowflakeIntegrationScript()

Generate Snowflake integration Script.

Example

import { createConfiguration, CloudAccountsApi } from '';

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

const request = {};

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

Parameters

This endpoint does not need any parameter.

Return type

Script

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]

submitGoogleWorkspaceAdminEmail

ServiceAccountInstallationStatus submitGoogleWorkspaceAdminEmail(submitAdminEmailParams)

Submit admin email for service account authorization and return service-account authorization status.

Example

import { createConfiguration, CloudAccountsApi } from '';
import type { CloudAccountsApiSubmitGoogleWorkspaceAdminEmailRequest } from '';

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

const request: CloudAccountsApiSubmitGoogleWorkspaceAdminEmailRequest = {
  
  submitAdminEmailParams: {
    adminEmail: "admin@email.com",
  },
};

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

Parameters

Name	Type	Description	Notes
submitAdminEmailParams	SubmitAdminEmailParams

Return type

ServiceAccountInstallationStatus

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
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]

submitOffice365TenantInfo

Office365TenantInfo submitOffice365TenantInfo(tenantInfo)

Submit customer information for Microsoft 365 integration.

Example

import { createConfiguration, CloudAccountsApi } from '';
import type { CloudAccountsApiSubmitOffice365TenantInfoRequest } from '';

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

const request: CloudAccountsApiSubmitOffice365TenantInfoRequest = {
  
  tenantInfo: {
    tenantId: "1234",
  },
};

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

Parameters

Name	Type	Description	Notes
tenantInfo	TenantInfo

Return type

Office365TenantInfo

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
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]

submitSalesforceAuthCode

void submitSalesforceAuthCode(authCode)

Submit customer information for Salesforce integration.

Example

import { createConfiguration, CloudAccountsApi } from '';
import type { CloudAccountsApiSubmitSalesforceAuthCodeRequest } from '';

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

const request: CloudAccountsApiSubmitSalesforceAuthCodeRequest = {
  
  authCode: {
    code: "1234",
  },
};

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

Parameters

Name	Type	Description	Notes
authCode	AuthCode

Return type

void

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
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 -
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]

submitSlackAuthCode

any submitSlackAuthCode(submitAuthCode)

Submit a Slack authentication code.

Example

import { createConfiguration, CloudAccountsApi } from '';
import type { CloudAccountsApiSubmitSlackAuthCodeRequest } from '';

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

const request: CloudAccountsApiSubmitSlackAuthCodeRequest = {
  
  submitAuthCode: {
    code: "code_example",
  },
};

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

Parameters

Name	Type	Description	Notes
submitAuthCode	SubmitAuthCode

Return type

any

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
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]

submitSnowflakeAuthCode

void submitSnowflakeAuthCode(authInfo)

Storing code that is returned from Snowflake oAuth.

Example

import { createConfiguration, CloudAccountsApi } from '';
import type { CloudAccountsApiSubmitSnowflakeAuthCodeRequest } from '';

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

const request: CloudAccountsApiSubmitSnowflakeAuthCodeRequest = {
  
  authInfo: {
    code: "1234",
    providerId: "1234",
  },
};

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

Parameters

Name	Type	Description	Notes
authInfo	AuthInfo

Return type

void

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
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 -
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]

FilesExpand file tree

CloudAccountsApi.md

Latest commit

History

CloudAccountsApi.md

File metadata and controls

.CloudAccountsApi

addAnalyzedRegion

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

addCloudAccounts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

generateAtlassianConfluenceAuthUrl

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

generateAtlassianJiraAuthUrl

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

generateAzureAuthUrl

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

generateOffice365AuthUrl

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

generateSalesforceAuthUrl

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

generateSlackAuthUrl

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

generateSnowflakeAuthUrl

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getAnalyzedRegionStatus

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getAzureAdminConsentStatus

Example

Parameters