Federated Connections

Operations for the Federated Connections service collection.

Language	Last Update
Python	v1.6.1
PowerShell	v2.2.9
Go	v0.20.0
TypeScript	v0.6.0
Rust	v0.7.0
Ruby	v1.2.0

Table of Contents

Operation	Description
post_federated_connections_config	Create configuration for a federated connection
delete_federated_connections_config	Delete configuration for a federated connection
patch_federated_connections_config	Update configuration for a federated connection

---

post_federated_connections_config

Create configuration for a federated connection

POST /ngsiem/entities/federated-connections-config/v1

Scope Ngsiem Federated Connection: WRITE Consumes · Produces application/json

Parameters

Name	Type	Data type	Description
body	body	dictionary	Full body payload as JSON formatted dictionary.
cluster_url	body	string	URL of the external cluster
connection_id	body	string	ID of the federated connection
view_token	body	string	token for accessing external cluster

Code Examples

Python

Examples coming soon.

PowerShell

Examples coming soon.

Go

Examples coming soon.

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: process.env.FALCON_CLOUD!,
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.federatedConnections.postFederatedConnectionsConfig(
  {
    clusterUrl: "string",
    connectionId: "string",
    viewToken: "string"
}  // body
);

console.log(response);

Rust

Examples coming soon.

Ruby

require "crimson-falcon"

Falcon.configure do |config|
  config.client_id = ENV["FALCON_CLIENT_ID"]
  config.client_secret = ENV["FALCON_CLIENT_SECRET"]
  config.cloud = ENV["FALCON_CLOUD"]
end

api = Falcon::FederatedConnections.new

body = Falcon::ClientFederatedConnectionConfigRequestV1.new(
  cluster_url: 'string',
  connection_id: 'string',
  view_token: 'string'
)

response = api.post_federated_connections_config(body)

puts response

---

delete_federated_connections_config

Delete configuration for a federated connection

DELETE /ngsiem/entities/federated-connections-config/v1

Scope Ngsiem Federated Connection: WRITE Consumes · Produces application/json

Parameters

Name	Type	Data type	Description
connection_id	query	string	Connection ID to delete configuration for

Code Examples

Python

Examples coming soon.

PowerShell

Examples coming soon.

Go

Examples coming soon.

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: process.env.FALCON_CLOUD!,
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.federatedConnections.deleteFederatedConnectionsConfig("string");  // connectionId

console.log(response);

Rust

Examples coming soon.

Ruby

require "crimson-falcon"

Falcon.configure do |config|
  config.client_id = ENV["FALCON_CLIENT_ID"]
  config.client_secret = ENV["FALCON_CLIENT_SECRET"]
  config.cloud = ENV["FALCON_CLOUD"]
end

api = Falcon::FederatedConnections.new

response = api.delete_federated_connections_config('string')

puts response

---

patch_federated_connections_config

Update configuration for a federated connection

PATCH /ngsiem/entities/federated-connections-config/v1

Scope Ngsiem Federated Connection: WRITE Consumes · Produces application/json

Parameters

Name	Type	Data type	Description
body	body	dictionary	Full body payload as JSON formatted dictionary.
cluster_url	body	string	URL of the external cluster
view_token	body	string	token for accessing external cluster
connection_id	query	string	Connection ID to update configuration for

Code Examples

Python

Examples coming soon.

PowerShell

Examples coming soon.

Go

Examples coming soon.

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: process.env.FALCON_CLOUD!,
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.federatedConnections.patchFederatedConnectionsConfig(
  "string",  // connectionId
  {  // body
      clusterUrl: "string",
      viewToken: "string"
  }
);

console.log(response);

Rust

Examples coming soon.

Ruby

require "crimson-falcon"

Falcon.configure do |config|
  config.client_id = ENV["FALCON_CLIENT_ID"]
  config.client_secret = ENV["FALCON_CLIENT_SECRET"]
  config.cloud = ENV["FALCON_CLOUD"]
end

api = Falcon::FederatedConnections.new

body = Falcon::ClientFederatedConnectionConfigPatchRequestV1.new(
  cluster_url: 'string',
  view_token: 'string'
)

response = api.patch_federated_connections_config(body, 'string')

puts response