Federated Connections

Operations for the Federated Connections service collection.

Language	Last Update
Python	v1.6.5
PowerShell
Go	v0.22.0
TypeScript	v0.6.0
Rust
Ruby	v1.4.0

---

---

Table of Contents

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

---

DeleteFederatedConnectionsConfig

Delete configuration for a federated connection

Method DELETE

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

Scope NGSIEM Data Connections API: WRITE

PEP 8 delete_federated_connections_config

Parameters

connection_id query · string

Connection ID to delete configuration for

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import FederatedConnections

falcon = FederatedConnections(client_id=CLIENT_ID,
                              client_secret=CLIENT_SECRET
                              )

response = falcon.delete_federated_connections_config(connection_id="string")
print(response)

Operation ID

from falconpy import FederatedConnections

falcon = FederatedConnections(client_id=CLIENT_ID,
                              client_secret=CLIENT_SECRET
                              )

response = falcon.DeleteFederatedConnectionsConfig(connection_id="string")
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("DeleteFederatedConnectionsConfig",
                          connection_id="string")
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/federated_connections"
)

func main() {
  client, err := falcon.NewClient(&falcon.ApiConfig{
    ClientId:     os.Getenv("FALCON_CLIENT_ID"),
    ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"),
    Context:      context.Background(),
  })
  if err != nil {
    panic(err)
  }

  response, err := client.FederatedConnections.DeleteFederatedConnectionsConfig(
    &federated_connections.DeleteFederatedConnectionsConfigParams{
      ConnectionID: "string",
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

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

Responses

400 Bad Request

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

404 Not Found

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

---

---

PatchFederatedConnectionsConfig

Update configuration for a federated connection

Method PATCH

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

Scope NGSIEM Data Connections API: WRITE

PEP 8 patch_federated_connections_config

Parameters

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

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import FederatedConnections

falcon = FederatedConnections(client_id=CLIENT_ID,
                              client_secret=CLIENT_SECRET
                              )

response = falcon.patch_federated_connections_config(connection_id="string",
                                                     cluster_url="string",
                                                     view_token="string")
print(response)

Operation ID

from falconpy import FederatedConnections

falcon = FederatedConnections(client_id=CLIENT_ID,
                              client_secret=CLIENT_SECRET
                              )

response = falcon.PatchFederatedConnectionsConfig(connection_id="string",
                                                  cluster_url="string",
                                                  view_token="string")
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

body_payload = {
    "cluster_url": "string",
    "view_token": "string"
}

response = falcon.command("PatchFederatedConnectionsConfig",
                          connection_id="string",
                          body=body_payload)
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/federated_connections"
  "github.com/crowdstrike/gofalcon/falcon/models"
)

func main() {
  client, err := falcon.NewClient(&falcon.ApiConfig{
    ClientId:     os.Getenv("FALCON_CLIENT_ID"),
    ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"),
    Context:      context.Background(),
  })
  if err != nil {
    panic(err)
  }

  cluster_url := "string"
  view_token := "string"

  response, err := client.FederatedConnections.PatchFederatedConnectionsConfig(
    &federated_connections.PatchFederatedConnectionsConfigParams{
      Body: &models.ClientFederatedConnectionConfigPatchRequestV1{
        ClusterUrl: &cluster_url,
        ViewToken: &view_token,
      },
      ConnectionID: "string",
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

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

Responses

200 OK

[
  {
    "cluster_url": "string",
    "connection_id": "string"
  }
]

400 Bad Request

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

404 Not Found

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

---

---

PostFederatedConnectionsConfig

Create configuration for a federated connection

Method POST

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

Scope NGSIEM Data Connections API: WRITE

PEP 8 post_federated_connections_config

Parameters

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

PEP 8

from falconpy import FederatedConnections

falcon = FederatedConnections(client_id=CLIENT_ID,
                              client_secret=CLIENT_SECRET
                              )

response = falcon.post_federated_connections_config(cluster_url="string",
                                                    connection_id="string",
                                                    view_token="string")
print(response)

Operation ID

from falconpy import FederatedConnections

falcon = FederatedConnections(client_id=CLIENT_ID,
                              client_secret=CLIENT_SECRET
                              )

response = falcon.PostFederatedConnectionsConfig(cluster_url="string",
                                                 connection_id="string",
                                                 view_token="string")
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

body_payload = {
    "cluster_url": "string",
    "connection_id": "string",
    "view_token": "string"
}

response = falcon.command("PostFederatedConnectionsConfig", body=body_payload)
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/federated_connections"
  "github.com/crowdstrike/gofalcon/falcon/models"
)

func main() {
  client, err := falcon.NewClient(&falcon.ApiConfig{
    ClientId:     os.Getenv("FALCON_CLIENT_ID"),
    ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"),
    Context:      context.Background(),
  })
  if err != nil {
    panic(err)
  }

  cluster_url := "string"
  connection_id := "string"
  view_token := "string"

  response, err := client.FederatedConnections.PostFederatedConnectionsConfig(
    &federated_connections.PostFederatedConnectionsConfigParams{
      Body: &models.ClientFederatedConnectionConfigRequestV1{
        ClusterUrl: &cluster_url,
        ConnectionID: &connection_id,
        ViewToken: &view_token,
      },
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

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

Responses

200 OK

[
  {
    "cluster_url": "string",
    "connection_id": "string"
  }
]

400 Bad Request

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}