Falcon::D4cRegistration

All URIs are relative to https://api.us-2.crowdstrike.com

Method	HTTP request	Description
connect_d4_cgcp_account	POST /cloud-connect-gcp/entities/account/v2	Creates a new GCP account with newly-uploaded service account or connects with existing service account with only the following fields: parent_id, parent_type and service_account_id
create_d4_c_aws_account	POST /cloud-connect-aws/entities/account/v2	Creates a new account in our system for a customer and generates a script for them to run in their AWS cloud environment to grant us access.
create_d4_c_gcp_account	POST /cloud-connect-gcp/entities/account/v1	Creates a new account in our system for a customer and generates a new service account for them to add access to in their GCP environment to grant us access.
create_discover_cloud_azure_account	POST /cloud-connect-azure/entities/account/v1	Creates a new account in our system for a customer and generates a script for them to run in their cloud environment to grant us access.
delete_d4_c_aws_account	DELETE /cloud-connect-aws/entities/account/v2	Deletes an existing AWS account or organization in our system.
delete_d4_cgcp_account	DELETE /cloud-connect-gcp/entities/account/v1	Deletes a GCP account from the system.
get_d4_c_aws_account	GET /cloud-connect-aws/entities/account/v2	Returns information about the current status of an AWS account.
get_d4_c_aws_console_setup_urls	GET /cloud-connect-aws/entities/console-setup-urls/v1	Return a URL for customer to visit in their cloud environment to grant us access to their AWS environment.
get_d4_c_gcp_account	GET /cloud-connect-gcp/entities/account/v1	Returns information about the current status of an GCP account.
get_d4_c_gcp_user_scripts	GET /cloud-connect-gcp/entities/user-scripts/v1	Return a script for customer to run in their cloud environment to grant us access to their GCP environment
get_d4_caws_account_scripts_attachment	GET /cloud-connect-aws/entities/user-scripts-download/v1	Return a script for customer to run in their cloud environment to grant us access to their AWS environment as a downloadable attachment.
get_d4_cgcp_service_accounts_ext	GET /cloud-connect-gcp/entities/service-accounts/v1	Returns the service account id and client email for external clients.
get_d4_cgcp_user_scripts_attachment	GET /cloud-connect-gcp/entities/user-scripts-download/v1	Return a script for customer to run in their cloud environment to grant us access to their GCP environment as a downloadable attachment
get_discover_cloud_azure_account	GET /cloud-connect-azure/entities/account/v1	Return information about Azure account registration
get_discover_cloud_azure_tenant_ids	GET /cloud-connect-azure/entities/tenant-id/v1	Return available tenant ids for discover for cloud
get_discover_cloud_azure_user_scripts	GET /cloud-connect-azure/entities/user-scripts/v1	Return a script for customer to run in their cloud environment to grant us access to their Azure environment
get_discover_cloud_azure_user_scripts_attachment	GET /cloud-connect-azure/entities/user-scripts-download/v1	Return a script for customer to run in their cloud environment to grant us access to their Azure environment as a downloadable attachment
get_horizon_d4_c_scripts	GET /settings-discover/entities/gen/scripts/v1	Returns static install scripts for Horizon.
update_d4_cgcp_service_accounts_ext	PATCH /cloud-connect-gcp/entities/service-accounts/v1	Patches the service account key for external clients.
update_discover_cloud_azure_account_client_id	PATCH /cloud-connect-azure/entities/client-id/v1	Update an Azure service account in our system by with the user-created client_id created with the public key we've provided

connect_d4_cgcp_account

connect_d4_cgcp_account(body)

Creates a new GCP account with newly-uploaded service account or connects with existing service account with only the following fields: parent_id, parent_type and service_account_id

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::D4cRegistration.new
body = Falcon::RegistrationGCPAccountExtRequestV2.new({resources: [Falcon::RegistrationGCPAccountReqObjV2.new({parent_id: 'parent_id_example'})]}) # RegistrationGCPAccountExtRequestV2 | 

begin
  # Creates a new GCP account with newly-uploaded service account or connects with existing service account with only the following fields: parent_id, parent_type and service_account_id
  result = api_instance.connect_d4_cgcp_account(body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->connect_d4_cgcp_account: #{e}"
end

Using the connect_d4_cgcp_account_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> connect_d4_cgcp_account_with_http_info(body)

begin
  # Creates a new GCP account with newly-uploaded service account or connects with existing service account with only the following fields: parent_id, parent_type and service_account_id
  data, status_code, headers = api_instance.connect_d4_cgcp_account_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RegistrationGCPAccountResponseExtV2>
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->connect_d4_cgcp_account_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
body	RegistrationGCPAccountExtRequestV2

Return type

RegistrationGCPAccountResponseExtV2

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

create_d4_c_aws_account

create_d4_c_aws_account(body)

Creates a new account in our system for a customer and generates a script for them to run in their AWS cloud environment to grant us access.

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::D4cRegistration.new
body = Falcon::RegistrationAWSAccountCreateRequestD4CExtV2.new({resources: [Falcon::RegistrationAWSAccountD4CExtV2.new({account_id: 'account_id_example', cloudtrail_region: 'cloudtrail_region_example', iam_role_arn: 'iam_role_arn_example', organization_id: 'organization_id_example'})]}) # RegistrationAWSAccountCreateRequestD4CExtV2 | 

begin
  # Creates a new account in our system for a customer and generates a script for them to run in their AWS cloud environment to grant us access.
  result = api_instance.create_d4_c_aws_account(body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->create_d4_c_aws_account: #{e}"
end

Using the create_d4_c_aws_account_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_d4_c_aws_account_with_http_info(body)

begin
  # Creates a new account in our system for a customer and generates a script for them to run in their AWS cloud environment to grant us access.
  data, status_code, headers = api_instance.create_d4_c_aws_account_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RegistrationAWSAccountResponseV2>
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->create_d4_c_aws_account_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
body	RegistrationAWSAccountCreateRequestD4CExtV2

Return type

RegistrationAWSAccountResponseV2

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

create_d4_c_gcp_account

create_d4_c_gcp_account(body)

Creates a new account in our system for a customer and generates a new service account for them to add access to in their GCP environment to grant us access.

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::D4cRegistration.new
body = Falcon::RegistrationGCPAccountCreateRequestExtV1.new({resources: [Falcon::RegistrationGCPAccountExtV1.new({parent_id: 'parent_id_example'})]}) # RegistrationGCPAccountCreateRequestExtV1 | 

begin
  # Creates a new account in our system for a customer and generates a new service account for them to add access to in their GCP environment to grant us access.
  result = api_instance.create_d4_c_gcp_account(body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->create_d4_c_gcp_account: #{e}"
end

Using the create_d4_c_gcp_account_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_d4_c_gcp_account_with_http_info(body)

begin
  # Creates a new account in our system for a customer and generates a new service account for them to add access to in their GCP environment to grant us access.
  data, status_code, headers = api_instance.create_d4_c_gcp_account_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RegistrationGCPAccountResponseV1>
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->create_d4_c_gcp_account_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
body	RegistrationGCPAccountCreateRequestExtV1

Return type

RegistrationGCPAccountResponseV1

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

create_discover_cloud_azure_account

create_discover_cloud_azure_account(body)

Creates a new account in our system for a customer and generates a script for them to run in their cloud environment to grant us access.

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::D4cRegistration.new
body = Falcon::RegistrationAzureAccountCreateRequestExternalV1.new({resources: [Falcon::RegistrationAzureAccountExternalV1.new]}) # RegistrationAzureAccountCreateRequestExternalV1 | 

begin
  # Creates a new account in our system for a customer and generates a script for them to run in their cloud environment to grant us access.
  result = api_instance.create_discover_cloud_azure_account(body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->create_discover_cloud_azure_account: #{e}"
end

Using the create_discover_cloud_azure_account_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_discover_cloud_azure_account_with_http_info(body)

begin
  # Creates a new account in our system for a customer and generates a script for them to run in their cloud environment to grant us access.
  data, status_code, headers = api_instance.create_discover_cloud_azure_account_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RegistrationAzureAccountResponseV1>
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->create_discover_cloud_azure_account_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
body	RegistrationAzureAccountCreateRequestExternalV1

Return type

RegistrationAzureAccountResponseV1

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

delete_d4_c_aws_account

delete_d4_c_aws_account(opts)

Deletes an existing AWS account or organization in our system.

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::D4cRegistration.new
opts = {
  ids: ['inner_example'], # Array<String> | AWS account IDs to remove
  organization_ids: ['inner_example'] # Array<String> | AWS organization IDs to remove
}

begin
  # Deletes an existing AWS account or organization in our system.
  result = api_instance.delete_d4_c_aws_account(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->delete_d4_c_aws_account: #{e}"
end

Using the delete_d4_c_aws_account_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> delete_d4_c_aws_account_with_http_info(opts)

begin
  # Deletes an existing AWS account or organization in our system.
  data, status_code, headers = api_instance.delete_d4_c_aws_account_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MsaspecResponseFields>
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->delete_d4_c_aws_account_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
ids	Array<String>	AWS account IDs to remove	[optional]
organization_ids	Array<String>	AWS organization IDs to remove	[optional]

Return type

MsaspecResponseFields

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

delete_d4_cgcp_account

delete_d4_cgcp_account(opts)

Deletes a GCP account from the system.

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::D4cRegistration.new
opts = {
  ids: ['inner_example'] # Array<String> | Hierarchical Resource IDs of accounts
}

begin
  # Deletes a GCP account from the system.
  result = api_instance.delete_d4_cgcp_account(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->delete_d4_cgcp_account: #{e}"
end

Using the delete_d4_cgcp_account_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> delete_d4_cgcp_account_with_http_info(opts)

begin
  # Deletes a GCP account from the system.
  data, status_code, headers = api_instance.delete_d4_cgcp_account_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MsaBaseEntitiesResponse>
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->delete_d4_cgcp_account_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
ids	Array<String>	Hierarchical Resource IDs of accounts	[optional]

Return type

MsaBaseEntitiesResponse

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_d4_c_aws_account

get_d4_c_aws_account(opts)

Returns information about the current status of an AWS account.

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::D4cRegistration.new
opts = {
  scan_type: 'scan_type_example', # String | Type of scan, dry or full, to perform on selected accounts
  ids: ['inner_example'], # Array<String> | AWS account IDs
  organization_ids: ['inner_example'], # Array<String> | AWS organization IDs
  status: 'status_example', # String | Account status to filter results by.
  limit: 56, # Integer | The maximum records to return. Defaults to 100.
  offset: 56, # Integer | The offset to start retrieving records from
  migrated: 'true' # String | Only return migrated d4c accounts
}

begin
  # Returns information about the current status of an AWS account.
  result = api_instance.get_d4_c_aws_account(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->get_d4_c_aws_account: #{e}"
end

Using the get_d4_c_aws_account_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_d4_c_aws_account_with_http_info(opts)

begin
  # Returns information about the current status of an AWS account.
  data, status_code, headers = api_instance.get_d4_c_aws_account_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RegistrationAWSAccountResponseV2>
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->get_d4_c_aws_account_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
scan_type	String	Type of scan, dry or full, to perform on selected accounts	[optional]
ids	Array<String>	AWS account IDs	[optional]
organization_ids	Array<String>	AWS organization IDs	[optional]
status	String	Account status to filter results by.	[optional]
limit	Integer	The maximum records to return. Defaults to 100.	[optional][default to 100]
offset	Integer	The offset to start retrieving records from	[optional]
migrated	String	Only return migrated d4c accounts	[optional]

Return type

RegistrationAWSAccountResponseV2

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_d4_c_aws_console_setup_urls

get_d4_c_aws_console_setup_urls(opts)

Return a URL for customer to visit in their cloud environment to grant us access to their AWS environment.

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::D4cRegistration.new
opts = {
  region: 'region_example' # String | Region
}

begin
  # Return a URL for customer to visit in their cloud environment to grant us access to their AWS environment.
  result = api_instance.get_d4_c_aws_console_setup_urls(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->get_d4_c_aws_console_setup_urls: #{e}"
end

Using the get_d4_c_aws_console_setup_urls_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_d4_c_aws_console_setup_urls_with_http_info(opts)

begin
  # Return a URL for customer to visit in their cloud environment to grant us access to their AWS environment.
  data, status_code, headers = api_instance.get_d4_c_aws_console_setup_urls_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RegistrationAWSConsoleURLResponseV2>
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->get_d4_c_aws_console_setup_urls_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
region	String	Region	[optional]

Return type

RegistrationAWSConsoleURLResponseV2

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_d4_c_gcp_account

get_d4_c_gcp_account(opts)

Returns information about the current status of an GCP account.

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::D4cRegistration.new
opts = {
  parent_type: 'Folder', # String | GCP Hierarchy Parent Type, organization/folder/project
  ids: ['inner_example'], # Array<String> | Hierarchical Resource IDs of accounts
  scan_type: 'dry', # String | Type of scan, dry or full, to perform on selected accounts
  status: 'operational', # String | Account status to filter results by.
  limit: 56, # Integer | The maximum records to return. Defaults to 100.
  offset: 56, # Integer | The offset to start retrieving records from
  sort: 'sort_example' # String | Order fields in ascending or descending order. Ex: parent_type|asc.
}

begin
  # Returns information about the current status of an GCP account.
  result = api_instance.get_d4_c_gcp_account(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->get_d4_c_gcp_account: #{e}"
end

Using the get_d4_c_gcp_account_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_d4_c_gcp_account_with_http_info(opts)

begin
  # Returns information about the current status of an GCP account.
  data, status_code, headers = api_instance.get_d4_c_gcp_account_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RegistrationGCPAccountResponseV1>
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->get_d4_c_gcp_account_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
parent_type	String	GCP Hierarchy Parent Type, organization/folder/project	[optional]
ids	Array<String>	Hierarchical Resource IDs of accounts	[optional]
scan_type	String	Type of scan, dry or full, to perform on selected accounts	[optional]
status	String	Account status to filter results by.	[optional]
limit	Integer	The maximum records to return. Defaults to 100.	[optional][default to 100]
offset	Integer	The offset to start retrieving records from	[optional]
sort	String	Order fields in ascending or descending order. Ex: parent_type	asc.

Return type

RegistrationGCPAccountResponseV1

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_d4_c_gcp_user_scripts

get_d4_c_gcp_user_scripts(opts)

Return a script for customer to run in their cloud environment to grant us access to their GCP environment

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::D4cRegistration.new
opts = {
  parent_type: 'Folder' # String | GCP Hierarchy Parent Type, organization/folder/project
}

begin
  # Return a script for customer to run in their cloud environment to grant us access to their GCP environment
  result = api_instance.get_d4_c_gcp_user_scripts(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->get_d4_c_gcp_user_scripts: #{e}"
end

Using the get_d4_c_gcp_user_scripts_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_d4_c_gcp_user_scripts_with_http_info(opts)

begin
  # Return a script for customer to run in their cloud environment to grant us access to their GCP environment
  data, status_code, headers = api_instance.get_d4_c_gcp_user_scripts_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RegistrationGCPProvisionGetUserScriptResponseV1>
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->get_d4_c_gcp_user_scripts_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
parent_type	String	GCP Hierarchy Parent Type, organization/folder/project	[optional]

Return type

RegistrationGCPProvisionGetUserScriptResponseV1

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_d4_caws_account_scripts_attachment

get_d4_caws_account_scripts_attachment(opts)

Return a script for customer to run in their cloud environment to grant us access to their AWS environment as a downloadable attachment.

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::D4cRegistration.new
opts = {
  ids: ['inner_example'], # Array<String> | AWS account IDs
  template: 'aws-bash', # String | Template to be rendered
  accounts: ['inner_example'], # Array<String> | The list of accounts to register
  behavior_assessment_enabled: 'true', # String | 
  sensor_management_enabled: 'true', # String | 
  dspm_enabled: 'true', # String | 
  dspm_regions: ['inner_example'], # Array<String> | 
  dspm_role: 'dspm_role_example', # String | 
  use_existing_cloudtrail: 'true', # String | 
  organization_id: 'organization_id_example', # String | The AWS organization ID to be registered
  aws_profile: 'aws_profile_example', # String | The AWS profile to be used during registration
  custom_role_name: 'custom_role_name_example' # String | The custom IAM role to be used during registration
}

begin
  # Return a script for customer to run in their cloud environment to grant us access to their AWS environment as a downloadable attachment.
  result = api_instance.get_d4_caws_account_scripts_attachment(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->get_d4_caws_account_scripts_attachment: #{e}"
end

Using the get_d4_caws_account_scripts_attachment_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_d4_caws_account_scripts_attachment_with_http_info(opts)

begin
  # Return a script for customer to run in their cloud environment to grant us access to their AWS environment as a downloadable attachment.
  data, status_code, headers = api_instance.get_d4_caws_account_scripts_attachment_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RegistrationAWSProvisionGetAccountScriptResponseV2>
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->get_d4_caws_account_scripts_attachment_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
ids	Array<String>	AWS account IDs	[optional]
template	String	Template to be rendered	[optional][default to 'aws-bash']
accounts	Array<String>	The list of accounts to register	[optional]
behavior_assessment_enabled	String		[optional]
sensor_management_enabled	String		[optional]
dspm_enabled	String		[optional]
dspm_regions	Array<String>		[optional]
dspm_role	String		[optional]
use_existing_cloudtrail	String		[optional]
organization_id	String	The AWS organization ID to be registered	[optional]
aws_profile	String	The AWS profile to be used during registration	[optional]
custom_role_name	String	The custom IAM role to be used during registration	[optional]

Return type

RegistrationAWSProvisionGetAccountScriptResponseV2

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/octet-stream

get_d4_cgcp_service_accounts_ext

get_d4_cgcp_service_accounts_ext(opts)

Returns the service account id and client email for external clients.

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::D4cRegistration.new
opts = {
  id: 'id_example' # String | Service Account ID
}

begin
  # Returns the service account id and client email for external clients.
  result = api_instance.get_d4_cgcp_service_accounts_ext(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->get_d4_cgcp_service_accounts_ext: #{e}"
end

Using the get_d4_cgcp_service_accounts_ext_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_d4_cgcp_service_accounts_ext_with_http_info(opts)

begin
  # Returns the service account id and client email for external clients.
  data, status_code, headers = api_instance.get_d4_cgcp_service_accounts_ext_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RegistrationGCPServiceAccountResponseExtV1>
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->get_d4_cgcp_service_accounts_ext_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	Service Account ID	[optional]

Return type

RegistrationGCPServiceAccountResponseExtV1

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_d4_cgcp_user_scripts_attachment

get_d4_cgcp_user_scripts_attachment(opts)

Return a script for customer to run in their cloud environment to grant us access to their GCP environment as a downloadable attachment

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::D4cRegistration.new
opts = {
  parent_type: 'Folder', # String | GCP Hierarchy Parent Type, organization/folder/project
  ids: ['inner_example'], # Array<String> | Hierarchical Resource IDs of accounts
  status: 'operational' # String | Account status to filter results by.
}

begin
  # Return a script for customer to run in their cloud environment to grant us access to their GCP environment as a downloadable attachment
  result = api_instance.get_d4_cgcp_user_scripts_attachment(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->get_d4_cgcp_user_scripts_attachment: #{e}"
end

Using the get_d4_cgcp_user_scripts_attachment_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_d4_cgcp_user_scripts_attachment_with_http_info(opts)

begin
  # Return a script for customer to run in their cloud environment to grant us access to their GCP environment as a downloadable attachment
  data, status_code, headers = api_instance.get_d4_cgcp_user_scripts_attachment_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RegistrationGCPProvisionGetUserScriptResponseV1>
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->get_d4_cgcp_user_scripts_attachment_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
parent_type	String	GCP Hierarchy Parent Type, organization/folder/project	[optional]
ids	Array<String>	Hierarchical Resource IDs of accounts	[optional]
status	String	Account status to filter results by.	[optional]

Return type

RegistrationGCPProvisionGetUserScriptResponseV1

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/octet-stream

get_discover_cloud_azure_account

get_discover_cloud_azure_account(opts)

Return information about Azure account registration

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::D4cRegistration.new
opts = {
  ids: ['inner_example'], # Array<String> | SubscriptionIDs of accounts to select for this status operation. If this is empty then all accounts are returned.
  tenant_ids: ['inner_example'], # Array<String> | Tenant ids to filter azure accounts
  scan_type: 'scan_type_example', # String | Type of scan, dry or full, to perform on selected accounts
  status: 'status_example', # String | Account status to filter results by.
  limit: 56, # Integer | The maximum records to return. Defaults to 100.
  offset: 56 # Integer | The offset to start retrieving records from
}

begin
  # Return information about Azure account registration
  result = api_instance.get_discover_cloud_azure_account(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->get_discover_cloud_azure_account: #{e}"
end

Using the get_discover_cloud_azure_account_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_discover_cloud_azure_account_with_http_info(opts)

begin
  # Return information about Azure account registration
  data, status_code, headers = api_instance.get_discover_cloud_azure_account_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RegistrationAzureAccountResponseV1>
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->get_discover_cloud_azure_account_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
ids	Array<String>	SubscriptionIDs of accounts to select for this status operation. If this is empty then all accounts are returned.	[optional]
tenant_ids	Array<String>	Tenant ids to filter azure accounts	[optional]
scan_type	String	Type of scan, dry or full, to perform on selected accounts	[optional]
status	String	Account status to filter results by.	[optional]
limit	Integer	The maximum records to return. Defaults to 100.	[optional][default to 100]
offset	Integer	The offset to start retrieving records from	[optional]

Return type

RegistrationAzureAccountResponseV1

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_discover_cloud_azure_tenant_ids

get_discover_cloud_azure_tenant_ids

Return available tenant ids for discover for cloud

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::D4cRegistration.new

begin
  # Return available tenant ids for discover for cloud
  result = api_instance.get_discover_cloud_azure_tenant_ids
  p result
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->get_discover_cloud_azure_tenant_ids: #{e}"
end

Using the get_discover_cloud_azure_tenant_ids_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_discover_cloud_azure_tenant_ids_with_http_info

begin
  # Return available tenant ids for discover for cloud
  data, status_code, headers = api_instance.get_discover_cloud_azure_tenant_ids_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RegistrationAzureTenantIDsResponseV1>
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->get_discover_cloud_azure_tenant_ids_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

RegistrationAzureTenantIDsResponseV1

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_discover_cloud_azure_user_scripts

get_discover_cloud_azure_user_scripts

Return a script for customer to run in their cloud environment to grant us access to their Azure environment

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::D4cRegistration.new

begin
  # Return a script for customer to run in their cloud environment to grant us access to their Azure environment
  result = api_instance.get_discover_cloud_azure_user_scripts
  p result
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->get_discover_cloud_azure_user_scripts: #{e}"
end

Using the get_discover_cloud_azure_user_scripts_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_discover_cloud_azure_user_scripts_with_http_info

begin
  # Return a script for customer to run in their cloud environment to grant us access to their Azure environment
  data, status_code, headers = api_instance.get_discover_cloud_azure_user_scripts_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RegistrationAzureProvisionGetUserScriptResponseV1>
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->get_discover_cloud_azure_user_scripts_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

RegistrationAzureProvisionGetUserScriptResponseV1

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_discover_cloud_azure_user_scripts_attachment

get_discover_cloud_azure_user_scripts_attachment(tenant_id, opts)

Return a script for customer to run in their cloud environment to grant us access to their Azure environment as a downloadable attachment

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::D4cRegistration.new
tenant_id = ['inner_example'] # Array<String> | Azure Tenant ID
opts = {
  subscription_ids: ['inner_example'], # Array<String> | Azure Subscription ID
  template: 'template_example', # String | Template to be rendered
  azure_management_group: true # Boolean | Use Azure Management Group
}

begin
  # Return a script for customer to run in their cloud environment to grant us access to their Azure environment as a downloadable attachment
  result = api_instance.get_discover_cloud_azure_user_scripts_attachment(tenant_id, opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->get_discover_cloud_azure_user_scripts_attachment: #{e}"
end

Using the get_discover_cloud_azure_user_scripts_attachment_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_discover_cloud_azure_user_scripts_attachment_with_http_info(tenant_id, opts)

begin
  # Return a script for customer to run in their cloud environment to grant us access to their Azure environment as a downloadable attachment
  data, status_code, headers = api_instance.get_discover_cloud_azure_user_scripts_attachment_with_http_info(tenant_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RegistrationAzureProvisionGetUserScriptResponseV1>
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->get_discover_cloud_azure_user_scripts_attachment_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
tenant_id	Array<String>	Azure Tenant ID
subscription_ids	Array<String>	Azure Subscription ID	[optional]
template	String	Template to be rendered	[optional]
azure_management_group	Boolean	Use Azure Management Group	[optional]

Return type

RegistrationAzureProvisionGetUserScriptResponseV1

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/octet-stream

get_horizon_d4_c_scripts

get_horizon_d4_c_scripts(opts)

Returns static install scripts for Horizon.

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::D4cRegistration.new
opts = {
  single_account: 'false', # String | Get static script for single account
  organization_id: 'organization_id_example', # String | AWS organization ID
  delete: 'false', # String | 
  account_type: 'commercial' # String | Account type (e.g.: commercial,gov) Only applicable when registering AWS commercial account in a Gov environment
}

begin
  # Returns static install scripts for Horizon.
  result = api_instance.get_horizon_d4_c_scripts(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->get_horizon_d4_c_scripts: #{e}"
end

Using the get_horizon_d4_c_scripts_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_horizon_d4_c_scripts_with_http_info(opts)

begin
  # Returns static install scripts for Horizon.
  data, status_code, headers = api_instance.get_horizon_d4_c_scripts_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RegistrationStaticScriptsResponse>
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->get_horizon_d4_c_scripts_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
single_account	String	Get static script for single account	[optional]
organization_id	String	AWS organization ID	[optional]
delete	String		[optional]
account_type	String	Account type (e.g.: commercial,gov) Only applicable when registering AWS commercial account in a Gov environment	[optional]

Return type

RegistrationStaticScriptsResponse

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

update_d4_cgcp_service_accounts_ext

update_d4_cgcp_service_accounts_ext(body)

Patches the service account key for external clients.

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::D4cRegistration.new
body = Falcon::RegistrationGCPServiceAccountPatchRequestV1.new({resources: [Falcon::RegistrationGCPServiceAccountPatchV1.new]}) # RegistrationGCPServiceAccountPatchRequestV1 | 

begin
  # Patches the service account key for external clients.
  result = api_instance.update_d4_cgcp_service_accounts_ext(body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->update_d4_cgcp_service_accounts_ext: #{e}"
end

Using the update_d4_cgcp_service_accounts_ext_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> update_d4_cgcp_service_accounts_ext_with_http_info(body)

begin
  # Patches the service account key for external clients.
  data, status_code, headers = api_instance.update_d4_cgcp_service_accounts_ext_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RegistrationGCPServiceAccountResponseExtV1>
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->update_d4_cgcp_service_accounts_ext_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
body	RegistrationGCPServiceAccountPatchRequestV1

Return type

RegistrationGCPServiceAccountResponseExtV1

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

update_discover_cloud_azure_account_client_id

update_discover_cloud_azure_account_client_id(id, opts)

Update an Azure service account in our system by with the user-created client_id created with the public key we've provided

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::D4cRegistration.new
id = 'id_example' # String | ClientID to use for the Service Principal associated with the customer's Azure account
opts = {
  object_id: 'object_id_example', # String | Object ID to use for the Service Principal associated with the customer's Azure account
  tenant_id: 'tenant_id_example' # String | Tenant ID to update client ID for. Required if multiple tenants are registered.
}

begin
  # Update an Azure service account in our system by with the user-created client_id created with the public key we've provided
  result = api_instance.update_discover_cloud_azure_account_client_id(id, opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->update_discover_cloud_azure_account_client_id: #{e}"
end

Using the update_discover_cloud_azure_account_client_id_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> update_discover_cloud_azure_account_client_id_with_http_info(id, opts)

begin
  # Update an Azure service account in our system by with the user-created client_id created with the public key we've provided
  data, status_code, headers = api_instance.update_discover_cloud_azure_account_client_id_with_http_info(id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RegistrationAzureTenantConfigurationResponseV1>
rescue Falcon::ApiError => e
  puts "Error when calling D4cRegistration->update_discover_cloud_azure_account_client_id_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	ClientID to use for the Service Principal associated with the customer's Azure account
object_id	String	Object ID to use for the Service Principal associated with the customer's Azure account	[optional]
tenant_id	String	Tenant ID to update client ID for. Required if multiple tenants are registered.	[optional]

Return type

RegistrationAzureTenantConfigurationResponseV1

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

Files

D4cRegistration.md

Latest commit

History

D4cRegistration.md

File metadata and controls

Falcon::D4cRegistration

connect_d4_cgcp_account

Examples

Using the connect_d4_cgcp_account_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

create_d4_c_aws_account

Examples

Using the create_d4_c_aws_account_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

create_d4_c_gcp_account

Examples

Using the create_d4_c_gcp_account_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

create_discover_cloud_azure_account

Examples

Using the create_discover_cloud_azure_account_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

delete_d4_c_aws_account

Examples

Using the delete_d4_c_aws_account_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

delete_d4_cgcp_account

Examples

Using the delete_d4_cgcp_account_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_d4_c_aws_account

Examples

Using the get_d4_c_aws_account_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_d4_c_aws_console_setup_urls

Examples

Using the get_d4_c_aws_console_setup_urls_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_d4_c_gcp_account

Examples

Using the get_d4_c_gcp_account_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_d4_c_gcp_user_scripts

Examples

Using the get_d4_c_gcp_user_scripts_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_d4_caws_account_scripts_attachment

Examples

Using the get_d4_caws_account_scripts_attachment_with_http_info variant