MSSP (Flight Control)
The MSSP (Flight Control) service collection provides operations for managing multi-tenant CrowdStrike environments. Manage child customer relationships, CID groups, user groups, role assignments, and query across your fleet.
| Language | Last Update |
|---|---|
| Python | v1.4.6 |
| PowerShell | v2.2.9 |
| Go | v0.20.0 |
| TypeScript | v0.6.0 |
| Rust | v0.7.0 |
| Ruby | v1.2.0 |
This service collection has code examples posted to the repository.
For examples on how to authenticate to a child tenant as a MSSP, please review the MSSP authentication examples.
Table of Contents
Section titled “Table of Contents”| Operation | Description |
|---|---|
getChildrenV2get_children_v2 | Get link to child customer by child CID(s) |
getChildrenget_children | Get link to child customer by child CID(s) |
getCIDGroupMembersByget_cid_group_members_by | Get CID group members by CID Group ID. |
getCIDGroupMembersByV1get_cid_group_members_by_v1 | Get CID Group members by CID Group IDs. deprecated |
addCIDGroupMembersadd_cid_group_members | Add new CID Group member. |
deleteCIDGroupMembersdelete_cid_group_members | Delete CID Group members entry. |
getCIDGroupByIdget_cid_group_by_id | Get CID Groups by ID. |
getCIDGroupByIdV1get_cid_group_by_id_v1 | Get CID Group(s) by ID(s). deprecated |
createCIDGroupscreate_cid_groups | Create new CID Group(s). Maximum 500 CID Group(s) allowed. |
deleteCIDGroupsdelete_cid_groups | Delete CID Group(s) by ID(s). |
updateCIDGroupsupdate_cid_groups | Update existing CID Group(s). CID Group ID is expected for each CID Group definition provided in request body. CID Group member(s) remain unaffected. |
getRolesByIDget_roles_by_id | Get MSSP Role assignment(s). MSSP Role assignment is of the format: <user_group_id>.<cid_group_id>. |
addRoleadd_role | Assign new MSSP Role(s) between User Group and CID Group. It does not revoke existing role(s) between User Group and CID Group. User Group ID and CID Group ID have to be specified in request. |
deletedRolesdelete_roles | Delete MSSP Role assignment(s) between User Group and CID Group. User Group ID and CID Group ID have to be specified in request. Only specified roles are removed if specified in request payload, else association between User Group and CID Group is dissolved completely (if no roles specified). |
getUserGroupMembersByIDget_user_group_members_by_id | Get User Group members by User Group ID(s). |
getUserGroupMembersByIDV1get_user_group_members_by_id_v1 | Get User Group members by User Group ID(s). deprecated |
addUserGroupMembersadd_user_group_members | Add new User Group member. Maximum 500 members allowed per User Group. |
deleteUserGroupMembersdelete_user_group_members | Delete User Group members entry. |
getUserGroupsByIDget_user_groups_by_id | Get User Group by ID(s). |
getUserGroupsByIDV1get_user_groups_by_id_v1 | Get user groups by ID. deprecated |
createUserGroupscreate_user_groups | Create new User Group(s). Maximum 500 User Group(s) allowed per customer. |
deleteUserGroupsdelete_user_groups | Delete User Group(s) by ID(s). |
updateUserGroupsupdate_user_groups | Update existing User Group(s). User Group ID is expected for each User Group definition provided in request body. User Group member(s) remain unaffected. |
getUserGroupsByIDV2get_user_groups_by_id_v2 | Get user groups by ID. |
queryChildrenquery_children | Query for customers linked as children |
queryCIDGroupMembersquery_cid_group_members | Query a CID Groups members by associated CID. |
queryCIDGroupsquery_cid_groups | Query CID Groups. |
queryRolesquery_roles | Query links between user groups and CID groups. At least one of CID Group ID or User Group ID should also be provided. Role ID is optional. |
queryUserGroupMembersquery_user_group_members | Query User Group member by User UUID. |
queryUserGroupsquery_user_groups | Query User Groups. |
deleteCIDGroupMembersV1delete_cid_group_members_v1 | Deprecated: Please use deleteCIDGroupMembersV2. |
getChildrenV2
Section titled “getChildrenV2”Get link to child customer by child CID(s)
get_children_v2Parameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| body | body | dictionary | Full body payload in JSON format. |
| ids | body | string or list of strings | CID of a child customer. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.get_children_v2(ids=id_list)print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.getChildrenV2(ids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
body_payload = { "ids": ["string"]}
response = falcon.command("getChildrenV2", body=body_payload)print(response)Get-FalconMemberCid -Id @("ID1", "ID2")package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp" "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) }
response, err := client.Mssp.GetChildrenV2( &mssp.GetChildrenV2Params{ Body: &models.MsaspecIdsRequest{ Ids: []string{"string"}, }, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.getChildrenV2( { ids: []} // body);
console.log(response);use rusty_falcon::apis::mssp_api::get_children_v2;use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::models::MsaspecIdsRequest;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let body = MsaspecIdsRequest { ids: vec!["string".to_string()], ..Default::default() };
let response = get_children_v2( &falcon.cfg, // configuration body, // body ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
body = Falcon::MsaspecIdsRequest.new( ids: [])
response = api.get_children_v2(body)
puts responsegetChildren
Section titled “getChildren”Get link to child customer by child CID(s)
get_childrenParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| ids | query | string or list of strings | CID of a child customer. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.get_children(ids=id_list)print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.getChildren(ids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.command("getChildren", ids=id_list)print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp")
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.Mssp.GetChildren( &mssp.GetChildrenParams{ Ids: []string{"ID1", "ID2", "ID3"}, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.getChildren(["ID1", "ID2", "ID3"]); // ids
console.log(response);use rusty_falcon::apis::mssp_api::get_children;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = get_children( &falcon.cfg, // configuration vec!["string".to_string()], // ids ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
response = api.get_children(['ID1', 'ID2', 'ID3'])
puts responsegetCIDGroupMembersBy
Section titled “getCIDGroupMembersBy”Get CID group members by CID Group ID.
get_cid_group_members_by or get_cid_group_members_by_v2Parameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| ids | query | string or list of strings | CID Group IDs to search for members of. The keyword cid_group_ids will also be accepted for this argument. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.get_cid_group_members_by(ids=id_list)print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.getCIDGroupMembersBy(ids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.command("getCIDGroupMembersBy", cid_group_ids=id_list)print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp")
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.Mssp.GetCIDGroupMembersBy( &mssp.GetCIDGroupMembersByParams{ CidGroupIds: []string{"ID1", "ID2", "ID3"}, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.getCIDGroupMembersBy(["ID1", "ID2", "ID3"]); // cidGroupIds
console.log(response);use rusty_falcon::apis::mssp_api::get_cid_group_members_by;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = get_cid_group_members_by( &falcon.cfg, // configuration vec!["string".to_string()], // cid_group_ids ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
response = api.get_cid_group_members_by(['ID1', 'ID2', 'ID3'])
puts responsegetCIDGroupMembersByV1
Section titled “getCIDGroupMembersByV1”Get CID Group members by CID Group IDs.
Deprecated operation
Section titled “Deprecated operation”get_cid_group_members_by_v1Parameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| cid_group_ids | query | string or list of strings | CID Group IDs to search for members of. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.get_cid_group_members_by_v1(cid_group_ids=id_list)print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.getCIDGroupMembersByV1(cid_group_ids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.command("getCIDGroupMembersByV1", cid_group_ids=id_list)print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp")
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.Mssp.GetCIDGroupMembersBy( &mssp.GetCIDGroupMembersByParams{ CidGroupIds: []string{"ID1", "ID2", "ID3"}, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.getCIDGroupMembersBy(["ID1", "ID2", "ID3"]); // cidGroupIds
console.log(response);use rusty_falcon::apis::mssp_api::get_cid_group_members_by;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = get_cid_group_members_by( &falcon.cfg, // configuration vec!["string".to_string()], // cid_group_ids ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
response = api.get_cid_group_members_by(['ID1', 'ID2', 'ID3'])
puts responseaddCIDGroupMembers
Section titled “addCIDGroupMembers”Add new CID Group member.
add_cid_group_membersParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| body | body | dictionary | Full body payload in JSON format. |
| cid_group_id | body | string | ID of the CID group to update. |
| cids | body | string or list of strings | CID(s) to add to the CID group. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.add_cid_group_members(cid_group_id="string", cids=id_list)print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.addCIDGroupMembers(cid_group_id="string", cids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
body_payload = { "resources": [ { "cid_group_id": "string", "cids": ["string"] } ]}
response = falcon.command("addCIDGroupMembers", body=body_payload)print(response)Add-FalconCidGroupMember -Id "string" -Cid @("ID1", "ID2")package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp" "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) }
cid_group_id := "string"
response, err := client.Mssp.AddCIDGroupMembers( &mssp.AddCIDGroupMembersParams{ Body: &models.DomainCIDGroupMembersRequestV1{ Resources: []interface{}{ { CIDGroupID: &cid_group_id, Cids: []string{"string"}, }, }, }, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.addCIDGroupMembers( { resources: [{ cidGroupId: "string", cids: [] }]} // body);
console.log(response);use rusty_falcon::apis::mssp_api::add_cid_group_members;use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::models::DomainCidGroupMembersRequestV1;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let body = DomainCidGroupMembersRequestV1 { resources: vec![CIDGroupMembers { cid_group_id: Some("string".to_string()), cids: vec!["string".to_string()], ..Default::default() }], ..Default::default() };
let response = add_cid_group_members( &falcon.cfg, // configuration body, // body ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
body = Falcon::DomainCIDGroupMembersRequestV1.new( resources: [{ cid_group_id: 'string', cids: [] }])
response = api.add_cid_group_members(body)
puts responsedeleteCIDGroupMembers
Section titled “deleteCIDGroupMembers”Delete CID Group members entry.
delete_cid_group_membersParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| body | body | dictionary | Full body payload in JSON format. |
| cid_group_id | body | string | ID of the CID group to update. |
| cids | body | string or list of strings | CID(s) to remove to the CID group. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.delete_cid_group_members(cid_group_id="string", cids=id_list)print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.deleteCIDGroupMembers(cid_group_id="string", cids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
body_payload = { "resources": [ { "cid_group_id": "string", "cids": ["string"] } ]}
response = falcon.command("deleteCIDGroupMembers", body=body_payload)print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp" "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) }
cid_group_id := "string"
response, err := client.Mssp.DeleteCIDGroupMembers( &mssp.DeleteCIDGroupMembersParams{ Body: &models.DomainCIDGroupMembersRequestV1{ Resources: []interface{}{ { CIDGroupID: &cid_group_id, Cids: []string{"string"}, }, }, }, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.deleteCIDGroupMembers( { resources: [{ cidGroupId: "string", cids: [] }]} // body);
console.log(response);use rusty_falcon::apis::mssp_api::delete_cid_group_members;use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::models::DomainCidGroupMembersRequestV1;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let body = DomainCidGroupMembersRequestV1 { resources: vec![CIDGroupMembers { cid_group_id: Some("string".to_string()), cids: vec!["string".to_string()], ..Default::default() }], ..Default::default() };
let response = delete_cid_group_members( &falcon.cfg, // configuration body, // body ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
body = Falcon::DomainCIDGroupMembersRequestV1.new( resources: [{ cid_group_id: 'string', cids: [] }])
response = api.delete_cid_group_members(body)
puts responsegetCIDGroupByIdV1
Section titled “getCIDGroupByIdV1”Get CID Group(s) by ID(s).
Deprecated operation
Section titled “Deprecated operation”get_cid_group_by_id_v1Parameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| cid_group_ids | query | string or list of strings | CID Group IDs to search for. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.get_cid_group_by_id_v1(cid_group_ids=id_list)print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.getCIDGroupByIdV1(cid_group_ids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.command("getCIDGroupByIdV1", cid_group_ids=id_list)print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp")
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.Mssp.GetCIDGroupByID( &mssp.GetCIDGroupByIDParams{ CidGroupIds: []string{"ID1", "ID2", "ID3"}, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.getCIDGroupById(["ID1", "ID2", "ID3"]); // cidGroupIds
console.log(response);use rusty_falcon::apis::mssp_api::get_cid_group_by_id;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = get_cid_group_by_id( &falcon.cfg, // configuration vec!["string".to_string()], // cid_group_ids ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
response = api.get_cid_group_by_id(['ID1', 'ID2', 'ID3'])
puts responsegetCIDGroupById
Section titled “getCIDGroupById”Get CID Groups by ID.
get_cid_group_by_id or get_cid_group_by_id_v2Parameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| ids | query | string or list of strings | CID Group IDs to search for. The keyword cid_group_ids will also be accepted for this argument. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.get_cid_group_by_id(ids=id_list)print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.getCIDGroupById(ids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.command("getCIDGroupById", cid_group_ids=id_list)print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp")
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.Mssp.GetCIDGroupByID( &mssp.GetCIDGroupByIDParams{ CidGroupIds: []string{"ID1", "ID2", "ID3"}, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.getCIDGroupById(["ID1", "ID2", "ID3"]); // cidGroupIds
console.log(response);use rusty_falcon::apis::mssp_api::get_cid_group_by_id;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = get_cid_group_by_id( &falcon.cfg, // configuration vec!["string".to_string()], // cid_group_ids ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
response = api.get_cid_group_by_id(['ID1', 'ID2', 'ID3'])
puts responsecreateCIDGroups
Section titled “createCIDGroups”Create new CID Group(s). Maximum 500 CID Group(s) allowed.
create_cid_groupsParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| body | body | dictionary | Full body payload in JSON format. |
| cid_group_id | body | string | ID of the CID group. |
| cid | body | string | Parent CID for the CID group. |
| description | body | string | CID group description. |
| name | body | string | CID group name. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.create_cid_groups(cid="string", cid_group_id="string", description="string", name="string")print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.createCIDGroups(cid="string", cid_group_id="string", description="string", name="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
body_payload = { "resources": [ { "cid": "string", "cid_group_id": "string", "description": "string", "is_default": boolean, "name": "string" } ]}
response = falcon.command("createCIDGroups", body=body_payload)print(response)New-FalconCidGroup -Name "string" -Description "string"package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp" "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) }
cid := "string" cid_group_id := "string" description := "string" is_default := boolean name := "string"
response, err := client.Mssp.CreateCIDGroups( &mssp.CreateCIDGroupsParams{ Body: &models.DomainCIDGroupsRequestV1{ Resources: []interface{}{ { CID: &cid, CIDGroupID: &cid_group_id, Description: &description, IsDefault: &is_default, Name: &name, }, }, }, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.createCIDGroups( { resources: [{ cid: "string", cidGroupId: "string", description: "string", isDefault: boolean, name: "string" }]} // body);
console.log(response);use rusty_falcon::apis::mssp_api::create_cid_groups;use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::models::DomainCidGroupsRequestV1;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let body = DomainCidGroupsRequestV1 { resources: vec![CIDGroup { cid_group_id: Some("string".to_string()), name: Some("string".to_string()), ..Default::default() }], ..Default::default() };
let response = create_cid_groups( &falcon.cfg, // configuration body, // body ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
body = Falcon::DomainCIDGroupsRequestV1.new( resources: [{ cid: 'string', cid_group_id: 'string', description: 'string', is_default: boolean, name: 'string' }])
response = api.create_cid_groups(body)
puts responsedeleteCIDGroups
Section titled “deleteCIDGroups”Delete CID Group(s) by ID(s).
delete_cid_groupsParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| cid_group_ids | query | string or list of strings | CID Group IDs to be deleted. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.delete_cid_groups(cid_group_ids=id_list)print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.deleteCIDGroups(cid_group_ids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.command("deleteCIDGroups", cid_group_ids=id_list)print(response)Remove-FalconCidGroup -Id @("ID1", "ID2")package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp")
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.Mssp.DeleteCIDGroups( &mssp.DeleteCIDGroupsParams{ CidGroupIds: []string{"ID1", "ID2", "ID3"}, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.deleteCIDGroups(["ID1", "ID2", "ID3"]); // cidGroupIds
console.log(response);use rusty_falcon::apis::mssp_api::delete_cid_groups;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = delete_cid_groups( &falcon.cfg, // configuration vec!["string".to_string()], // cid_group_ids ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
response = api.delete_cid_groups(['ID1', 'ID2', 'ID3'])
puts responseupdateCIDGroups
Section titled “updateCIDGroups”Update existing CID Group(s). CID Group ID is expected for each CID Group definition provided in request body. CID Group member(s) remain unaffected.
update_cid_groupsParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| body | body | dictionary | Full body payload in JSON format. |
| cid_group_id | body | string | ID of the CID group. |
| cid | body | string | Parent CID of the CID group. |
| description | body | string | CID group description. |
| name | body | string | CID group name. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.update_cid_groups(cid="string", cid_group_id="string", description="string", name="string")print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.updateCIDGroups(cid="string", cid_group_id="string", description="string", name="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
body_payload = { "resources": [ { "cid": "string", "cid_group_id": "string", "description": "string", "is_default": boolean, "name": "string" } ]}
response = falcon.command("updateCIDGroups", body=body_payload)print(response)Edit-FalconCidGroup -Id "string"package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp" "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) }
cid := "string" cid_group_id := "string" description := "string" is_default := boolean name := "string"
response, err := client.Mssp.UpdateCIDGroups( &mssp.UpdateCIDGroupsParams{ Body: &models.DomainCIDGroupsRequestV1{ Resources: []interface{}{ { CID: &cid, CIDGroupID: &cid_group_id, Description: &description, IsDefault: &is_default, Name: &name, }, }, }, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.updateCIDGroups( { resources: [{ cid: "string", cidGroupId: "string", description: "string", isDefault: boolean, name: "string" }]} // body);
console.log(response);use rusty_falcon::apis::mssp_api::update_cid_groups;use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::models::DomainCidGroupsRequestV1;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let body = DomainCidGroupsRequestV1 { resources: vec![CIDGroup { cid_group_id: Some("string".to_string()), name: Some("string".to_string()), ..Default::default() }], ..Default::default() };
let response = update_cid_groups( &falcon.cfg, // configuration body, // body ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
body = Falcon::DomainCIDGroupsRequestV1.new( resources: [{ cid: 'string', cid_group_id: 'string', description: 'string', is_default: boolean, name: 'string' }])
response = api.update_cid_groups(body)
puts responsegetRolesByID
Section titled “getRolesByID”Get MSSP Role assignment(s).
get_roles_by_idParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| ids | query | string or list of strings | Role IDs to retrieve. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.get_roles_by_id(ids=id_list)print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.getRolesByID(ids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.command("getRolesByID", ids=id_list)print(response)Get-FalconGroupRole -Id @("ID1", "ID2")package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp")
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.Mssp.GetRolesByID( &mssp.GetRolesByIDParams{ Ids: []string{"ID1", "ID2", "ID3"}, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.getRolesByID(["ID1", "ID2", "ID3"]); // ids
console.log(response);use rusty_falcon::apis::mssp_api::get_roles_by_id;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = get_roles_by_id( &falcon.cfg, // configuration vec!["string".to_string()], // ids ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
response = api.get_roles_by_id(['ID1', 'ID2', 'ID3'])
puts responseaddRole
Section titled “addRole”Assign new MSSP Role(s) between User Group and CID Group.
add_roleParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| body | body | dictionary | Full body payload in JSON format. |
| cid_group_id | body | string | CID Group ID to associate. |
| user_group_id | body | string | User group ID to associate. |
| id | body | string | MSSP role ID. |
| role_ids | body | string or list of strings | Additional role ID(s) to associate. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.add_role(cid_group_id="string", id="string", role_ids=id_list, user_group_ids="string")print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.addRole(cid_group_id="string", id="string", role_ids=id_list, user_group_ids="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
body_payload = { "resources": [ { "cid_group_id": "string", "id": "string", "role_ids": ["string"], "user_group_id": "string" } ]}
response = falcon.command("addRole", body=body_payload)print(response)Add-FalconGroupRole -CidGroupId "string" ` -UserGroupId "string" ` -RoleId @("ID1", "ID2")package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp" "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) }
cid_group_id := "string" id := "string" user_group_id := "string"
response, err := client.Mssp.AddRole( &mssp.AddRoleParams{ Body: &models.DomainMSSPRoleRequestV1{ Resources: []interface{}{ { CIDGroupID: &cid_group_id, ID: &id, RoleIds: []string{"string"}, UserGroupID: &user_group_id, }, }, }, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.addRole( { resources: [{ cidGroupId: "string", id: "string", roleIds: [], userGroupId: "string" }]} // body);
console.log(response);use rusty_falcon::apis::mssp_api::add_role;use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::models::DomainMsspRoleRequestV1;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let body = DomainMsspRoleRequestV1 { resources: vec![MSSPRoles { cid_group_id: Some("string".to_string()), id: Some("string".to_string()), role_ids: vec!["string".to_string()], user_group_id: Some("string".to_string()), ..Default::default() }], ..Default::default() };
let response = add_role( &falcon.cfg, // configuration body, // body ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
body = Falcon::DomainMSSPRoleRequestV1.new( resources: [{ cid_group_id: 'string', id: 'string', role_ids: [], user_group_id: 'string' }])
response = api.add_role(body)
puts responsedeletedRoles
Section titled “deletedRoles”Delete MSSP Role assignment(s) between User Group and CID Group.
delete_rolesParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| body | body | dictionary | Full body payload in JSON format. |
| cid_group_id | body | string | CID Group ID to deassociate. |
| user_group_id | body | string | User group ID to deassociate. |
| id | body | string | MSSP role ID. |
| role_ids | body | string or list of strings | Additional role ID(s) to deassociate. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.delete_roles(cid_group_id="string", id="string", role_ids=id_list, user_group_ids="string")print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.deletedRoles(cid_group_id="string", id="string", role_ids=id_list, user_group_ids="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
body_payload = { "resources": [ { "cid_group_id": "string", "id": "string", "role_ids": ["string"], "user_group_id": "string" } ]}
response = falcon.command("deletedRoles", body=body_payload)print(response)Remove-FalconGroupRole -CidGroupId "string" -UserGroupId "string"package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp" "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) }
cid_group_id := "string" id := "string" user_group_id := "string"
response, err := client.Mssp.DeletedRoles( &mssp.DeletedRolesParams{ Body: &models.DomainMSSPRoleRequestV1{ Resources: []interface{}{ { CIDGroupID: &cid_group_id, ID: &id, RoleIds: []string{"string"}, UserGroupID: &user_group_id, }, }, }, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.deletedRoles( { resources: [{ cidGroupId: "string", id: "string", roleIds: [], userGroupId: "string" }]} // body);
console.log(response);use rusty_falcon::apis::mssp_api::deleted_roles;use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::models::DomainMsspRoleRequestV1;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let body = DomainMsspRoleRequestV1 { resources: vec![MSSPRoles { cid_group_id: Some("string".to_string()), id: Some("string".to_string()), role_ids: vec!["string".to_string()], user_group_id: Some("string".to_string()), ..Default::default() }], ..Default::default() };
let response = deleted_roles( &falcon.cfg, // configuration body, // body ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
body = Falcon::DomainMSSPRoleRequestV1.new( resources: [{ cid_group_id: 'string', id: 'string', role_ids: [], user_group_id: 'string' }])
response = api.deleted_roles(body)
puts responsegetUserGroupMembersByID
Section titled “getUserGroupMembersByID”Get User Group members by User Group ID(s).
get_user_group_members_by_id or get_user_group_members_by_id_v2Parameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| ids | query | string or list of strings | User Group IDs to search for. The keyword user_group_ids will also be accepted for this argument. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.get_user_group_members_by_id(ids=id_list)print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.getUserGroupMembersByID(ids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.command("getUserGroupMembersByID", user_group_ids=id_list)print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp")
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.Mssp.GetUserGroupMembersByID( &mssp.GetUserGroupMembersByIDParams{ UserGroupIds: []string{"ID1", "ID2", "ID3"}, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.getUserGroupMembersByID(["ID1", "ID2", "ID3"]); // userGroupIds
console.log(response);use rusty_falcon::apis::mssp_api::get_user_group_members_by_id;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = get_user_group_members_by_id( &falcon.cfg, // configuration vec!["string".to_string()], // user_group_ids ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
response = api.get_user_group_members_by_id(['ID1', 'ID2', 'ID3'])
puts responsegetUserGroupMembersByIDV1
Section titled “getUserGroupMembersByIDV1”Get User Group members by User Group ID(s). deprecated
get_user_group_members_by_id_v1Parameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| user_group_ids | query | string or list of strings | User Group IDs to search for. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.get_user_group_members_by_id_v1(user_group_ids=id_list)print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.getUserGroupMembersByIDV1(user_group_ids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.command("getUserGroupMembersByIDV1", user_group_ids=id_list)print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp")
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.Mssp.GetUserGroupMembersByID( &mssp.GetUserGroupMembersByIDParams{ UserGroupIds: []string{"ID1", "ID2", "ID3"}, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.getUserGroupMembersByID(["ID1", "ID2", "ID3"]); // userGroupIds
console.log(response);use rusty_falcon::apis::mssp_api::get_user_group_members_by_id;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = get_user_group_members_by_id( &falcon.cfg, // configuration vec!["string".to_string()], // user_group_ids ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
response = api.get_user_group_members_by_id(['ID1', 'ID2', 'ID3'])
puts responseaddUserGroupMembers
Section titled “addUserGroupMembers”Add new User Group member. Maximum 500 members allowed per User Group.
add_user_group_membersParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| body | body | dictionary | Full body payload in JSON format. |
| user_group_id | body | string | User group ID to update. |
| user_uuids | body | string or list of strings | User ID(s) to add to the group. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.add_user_group_members(user_group_ids="string", user_uuids=id_list)print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.addUserGroupMembers(user_group_ids="string", user_uuids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
body_payload = { "resources": [ { "user_group_id": "string", "user_uuids": ["string"] } ]}
response = falcon.command("addUserGroupMembers", body=body_payload)print(response)Add-FalconUserGroupMember -Id "string" -UserId @("ID1", "ID2")package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp" "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) }
user_group_id := "string"
response, err := client.Mssp.AddUserGroupMembers( &mssp.AddUserGroupMembersParams{ Body: &models.DomainUserGroupMembersRequestV1{ Resources: []interface{}{ { UserGroupID: &user_group_id, UserUuids: []string{"string"}, }, }, }, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.addUserGroupMembers( { resources: [{ userGroupId: "string", userUuids: [] }]} // body);
console.log(response);use rusty_falcon::apis::mssp_api::add_user_group_members;use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::models::DomainUserGroupMembersRequestV1;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let body = DomainUserGroupMembersRequestV1 { resources: vec![UserGroupMembers { user_group_id: Some("string".to_string()), user_uuids: vec!["string".to_string()], ..Default::default() }], ..Default::default() };
let response = add_user_group_members( &falcon.cfg, // configuration body, // body ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
body = Falcon::DomainUserGroupMembersRequestV1.new( resources: [{ user_group_id: 'string', user_uuids: [] }])
response = api.add_user_group_members(body)
puts responsedeleteUserGroupMembers
Section titled “deleteUserGroupMembers”Delete User Group members entry.
delete_user_group_membersParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| body | body | dictionary | Full body payload in JSON format. |
| user_group_id | body | string | User group ID to update. |
| user_uuids | body | string or list of strings | User ID(s) to remove to the group. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.delete_user_group_members(user_group_ids="string", user_uuids=id_list)print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.deleteUserGroupMembers(user_group_ids="string", user_uuids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
body_payload = { "resources": [ { "user_group_id": "string", "user_uuids": ["string"] } ]}
response = falcon.command("deleteUserGroupMembers", body=body_payload)print(response)Remove-FalconUserGroupMember -Id "string" -UserId @("ID1", "ID2")package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp" "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) }
user_group_id := "string"
response, err := client.Mssp.DeleteUserGroupMembers( &mssp.DeleteUserGroupMembersParams{ Body: &models.DomainUserGroupMembersRequestV1{ Resources: []interface{}{ { UserGroupID: &user_group_id, UserUuids: []string{"string"}, }, }, }, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.deleteUserGroupMembers( { resources: [{ userGroupId: "string", userUuids: [] }]} // body);
console.log(response);use rusty_falcon::apis::mssp_api::delete_user_group_members;use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::models::DomainUserGroupMembersRequestV1;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let body = DomainUserGroupMembersRequestV1 { resources: vec![UserGroupMembers { user_group_id: Some("string".to_string()), user_uuids: vec!["string".to_string()], ..Default::default() }], ..Default::default() };
let response = delete_user_group_members( &falcon.cfg, // configuration body, // body ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
body = Falcon::DomainUserGroupMembersRequestV1.new( resources: [{ user_group_id: 'string', user_uuids: [] }])
response = api.delete_user_group_members(body)
puts responsegetUserGroupsByID
Section titled “getUserGroupsByID”Get User Group by ID(s).
get_user_groups_by_idParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| ids | query | string or list of strings | User Group IDs to search for. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.get_user_groups_by_id(ids=id_list)print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.getUserGroupsByID(ids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.command("getUserGroupsByID", user_group_ids=id_list)print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp")
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.Mssp.GetUserGroupsByID( &mssp.GetUserGroupsByIDParams{ UserGroupIds: []string{"ID1", "ID2", "ID3"}, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.getUserGroupsByID(["ID1", "ID2", "ID3"]); // userGroupIds
console.log(response);use rusty_falcon::apis::mssp_api::get_user_groups_by_id;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = get_user_groups_by_id( &falcon.cfg, // configuration vec!["string".to_string()], // user_group_ids ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
response = api.get_user_groups_by_id(['ID1', 'ID2', 'ID3'])
puts responsegetUserGroupsByIDV1
Section titled “getUserGroupsByIDV1”Get user groups by ID. deprecated
get_user_groups_by_id_v1Parameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| user_group_ids | query | string or list of strings | User Group IDs to search for. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.get_user_groups_by_id_v1(user_group_ids=id_list)print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.getUserGroupsByIDV1(user_group_ids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.command("getUserGroupsByIDV1", user_group_ids=id_list)print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp")
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.Mssp.GetUserGroupsByID( &mssp.GetUserGroupsByIDParams{ UserGroupIds: []string{"ID1", "ID2", "ID3"}, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.getUserGroupsByID(["ID1", "ID2", "ID3"]); // userGroupIds
console.log(response);use rusty_falcon::apis::mssp_api::get_user_groups_by_id;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = get_user_groups_by_id( &falcon.cfg, // configuration vec!["string".to_string()], // user_group_ids ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
response = api.get_user_groups_by_id(['ID1', 'ID2', 'ID3'])
puts responsecreateUserGroups
Section titled “createUserGroups”Create new User Group(s). Maximum 500 User Group(s) allowed per customer.
create_user_groupsParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| body | body | dictionary | Full body payload in JSON format. |
| user_group_id | body | string | ID of the User group. |
| cid | body | string | CID of the User group. |
| description | body | string | User group description. |
| name | body | string | User group name. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.create_user_groups(cid="string", description="string", name="string", user_group_id="string")print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.createUserGroups(cid="string", description="string", name="string", user_group_id="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
body_payload = { "resources": [ { "cid": "string", "description": "string", "name": "string", "user_group_id": "string" } ]}
response = falcon.command("createUserGroups", body=body_payload)print(response)New-FalconUserGroup -Name "string" -Description "string"package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp" "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) }
cid := "string" description := "string" name := "string" user_group_id := "string"
response, err := client.Mssp.CreateUserGroups( &mssp.CreateUserGroupsParams{ Body: &models.DomainUserGroupsRequestV1{ Resources: []interface{}{ { CID: &cid, Description: &description, Name: &name, UserGroupID: &user_group_id, }, }, }, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.createUserGroups( { resources: [{ cid: "string", description: "string", name: "string", userGroupId: "string" }]} // body);
console.log(response);use rusty_falcon::apis::mssp_api::create_user_groups;use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::models::DomainUserGroupsRequestV1;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let body = DomainUserGroupsRequestV1 { resources: vec![UserGroup { description: Some("string".to_string()), name: Some("string".to_string()), ..Default::default() }], ..Default::default() };
let response = create_user_groups( &falcon.cfg, // configuration body, // body ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
body = Falcon::DomainUserGroupsRequestV1.new( resources: [{ cid: 'string', description: 'string', name: 'string', user_group_id: 'string' }])
response = api.create_user_groups(body)
puts responsedeleteUserGroups
Section titled “deleteUserGroups”Delete User Group(s) by ID(s).
delete_user_groupsParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| user_group_ids | query | string or list of strings | User Group IDs to delete. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.delete_user_groups(user_group_ids=id_list)print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.deleteUserGroups(user_group_ids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.command("deleteUserGroups", user_group_ids=id_list)print(response)Remove-FalconUserGroup -Id @("ID1", "ID2")package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp")
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.Mssp.DeleteUserGroups( &mssp.DeleteUserGroupsParams{ UserGroupIds: []string{"ID1", "ID2", "ID3"}, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.deleteUserGroups(["ID1", "ID2", "ID3"]); // userGroupIds
console.log(response);use rusty_falcon::apis::mssp_api::delete_user_groups;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = delete_user_groups( &falcon.cfg, // configuration vec!["string".to_string()], // user_group_ids ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
response = api.delete_user_groups(['ID1', 'ID2', 'ID3'])
puts responseupdateUserGroups
Section titled “updateUserGroups”Update existing User Group(s). User Group ID is expected for each User Group definition provided in request body. User Group member(s) remain unaffected.
update_user_groupsParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| body | body | dictionary | Full body payload in JSON format. |
| user_group_id | body | string | ID of the User group. |
| cid | body | string | CID of the User group. |
| description | body | string | User group description. |
| name | body | string | User group name. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.update_user_groups(cid="string", description="string", name="string", user_group_id="string")print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.updateUserGroups(cid="string", description="string", name="string", user_group_id="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
body_payload = { "resources": [ { "cid": "string", "description": "string", "name": "string", "user_group_id": "string" } ]}
response = falcon.command("updateUserGroups", body=body_payload)print(response)Edit-FalconUserGroup -Id "string"package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp" "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) }
cid := "string" description := "string" name := "string" user_group_id := "string"
response, err := client.Mssp.UpdateUserGroups( &mssp.UpdateUserGroupsParams{ Body: &models.DomainUserGroupsRequestV1{ Resources: []interface{}{ { CID: &cid, Description: &description, Name: &name, UserGroupID: &user_group_id, }, }, }, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.updateUserGroups( { resources: [{ cid: "string", description: "string", name: "string", userGroupId: "string" }]} // body);
console.log(response);use rusty_falcon::apis::mssp_api::update_user_groups;use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::models::DomainUserGroupsRequestV1;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let body = DomainUserGroupsRequestV1 { resources: vec![UserGroup { description: Some("string".to_string()), name: Some("string".to_string()), ..Default::default() }], ..Default::default() };
let response = update_user_groups( &falcon.cfg, // configuration body, // body ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
body = Falcon::DomainUserGroupsRequestV1.new( resources: [{ cid: 'string', description: 'string', name: 'string', user_group_id: 'string' }])
response = api.update_user_groups(body)
puts responsegetUserGroupsByID
Section titled “getUserGroupsByID”Get user groups by ID.
get_user_groups_by_id or get_user_groups_by_id_v2Parameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| ids | query | string or list of strings | User Group IDs to search for. The keyword user_group_ids will also be accepted for this argument. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.get_user_groups_by_id(ids=id_list)print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.getUserGroupsByID(ids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.command("getUserGroupsByID", user_group_ids=id_list)print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp")
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.Mssp.GetUserGroupsByID( &mssp.GetUserGroupsByIDParams{ UserGroupIds: []string{"ID1", "ID2", "ID3"}, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.getUserGroupsByID(["ID1", "ID2", "ID3"]); // userGroupIds
console.log(response);use rusty_falcon::apis::mssp_api::get_user_groups_by_id;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = get_user_groups_by_id( &falcon.cfg, // configuration vec!["string".to_string()], // user_group_ids ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
response = api.get_user_groups_by_id(['ID1', 'ID2', 'ID3'])
puts responsequeryChildren
Section titled “queryChildren”Query for customers linked as children
query_childrenParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| filter | query | string | FQL filter expression. |
| offset | query | integer | Starting index of result set from which to return IDs. |
| limit | query | integer | The maximum records to return. |
| sort | query | string | The property to sort by. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.query_children(filter="string", limit=integer, offset="string", sort="string")print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.queryChildren(filter="string", limit=integer, offset="string", sort="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("queryChildren", filter="string", sort="string", offset=integer, limit=integer)print(response)Get-FalconMemberCid -Filter "string" ` -Sort "string" ` -Limit integer ` -Offset integerpackage main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp")
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) }
filter := "string" sort := "string" offset := int64(0) limit := int64(0)
response, err := client.Mssp.QueryChildren( &mssp.QueryChildrenParams{ Filter: &filter, Sort: &sort, Offset: &offset, Limit: &limit, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.queryChildren( "string", // filter "string", // sort integer, // offset integer // limit);
console.log(response);use rusty_falcon::apis::mssp_api::query_children;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = query_children( &falcon.cfg, // configuration Some("string"), // filter Some("string"), // sort Some(integer), // offset Some(integer), // limit ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
response = api.query_children(filter: 'string', sort: 'string', offset: integer, limit: integer)
puts responsequeryCIDGroupMembers
Section titled “queryCIDGroupMembers”Query a CID Groups members by associated CID.
query_cid_group_membersParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| cid | query | string | CID to search for. |
| sort | query | string | The property to sort by. |
| offset | query | integer | Starting index of result set. |
| limit | query | integer | The maximum records to return. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.query_cid_group_members(cid="string", limit=integer, offset="string", sort="string")print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.queryCIDGroupMembers(cid="string", limit=integer, offset="string", sort="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("queryCIDGroupMembers", cid="string", sort="string", offset=integer, limit=integer)print(response)Get-FalconCidGroupMember -Cid "string" ` -Sort "string" ` -Limit integer ` -Offset integerpackage main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp")
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) }
sort := "string" offset := int64(0) limit := int64(0)
response, err := client.Mssp.QueryCIDGroupMembers( &mssp.QueryCIDGroupMembersParams{ Cid: "string", Sort: &sort, Offset: &offset, Limit: &limit, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.queryCIDGroupMembers( "string", // cid "string", // sort integer, // offset integer // limit);
console.log(response);use rusty_falcon::apis::mssp_api::query_cid_group_members;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = query_cid_group_members( &falcon.cfg, // configuration "string", // cid Some("string"), // sort Some(integer), // offset Some(integer), // limit ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
response = api.query_cid_group_members('string')
puts responsequeryCIDGroups
Section titled “queryCIDGroups”Query CID Groups.
query_cid_groupsParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| name | query | string | Name to search for. |
| sort | query | string | The property to sort by. |
| offset | query | integer | Starting index of result set. |
| limit | query | integer | The maximum records to return. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.query_cid_groups(name="string", limit=integer, offset="string", sort="string")print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.queryCIDGroups(name="string", limit=integer, offset="string", sort="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("queryCIDGroups", name="string", sort="string", offset=integer, limit=integer)print(response)Get-FalconCidGroup -Sort "string" ` -Limit integer ` -Offset integerpackage main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp")
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) }
name := "string" sort := "string" offset := int64(0) limit := int64(0)
response, err := client.Mssp.QueryCIDGroups( &mssp.QueryCIDGroupsParams{ Name: &name, Sort: &sort, Offset: &offset, Limit: &limit, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.queryCIDGroups( "string", // name "string", // sort integer, // offset integer // limit);
console.log(response);use rusty_falcon::apis::mssp_api::query_cid_groups;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = query_cid_groups( &falcon.cfg, // configuration Some("string"), // name Some("string"), // sort Some(integer), // offset Some(integer), // limit ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
response = api.query_cid_groups(name: 'string', sort: 'string', offset: integer, limit: integer)
puts responsequeryRoles
Section titled “queryRoles”Query links between user groups and CID groups. At least one of CID Group ID or User Group ID should also be provided. Role ID is optional.
query_rolesParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| user_group_id | query | string | User Group ID to filter the results. |
| cid_group_id | query | string | CID Group ID to filter the results. |
| role_id | query | string | Role ID to filter the results. |
| sort | query | string | The property to sort by. |
| offset | query | integer | Starting index of result set. |
| limit | query | integer | The maximum records to return. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.query_roles(user_group_id="string", cid_group_id="string", role_id="string", limit=integer, offset="string", sort="string")print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.queryRoles(user_group_id="string", cid_group_id="string", role_id="string", limit=integer, offset="string", sort="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("queryRoles", user_group_id="string", cid_group_id="string", role_id="string", sort="string", offset=integer, limit=integer)print(response)Get-FalconGroupRole -Sort "string" ` -Limit integer ` -Offset integerpackage main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp")
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) }
userGroupID := "string" cidGroupID := "string" roleID := "string" sort := "string" offset := int64(0) limit := int64(0)
response, err := client.Mssp.QueryRoles( &mssp.QueryRolesParams{ UserGroupID: &userGroupID, CidGroupID: &cidGroupID, RoleID: &roleID, Sort: &sort, Offset: &offset, Limit: &limit, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.queryRoles( "string", // userGroupId "string", // cidGroupId "string", // roleId "string", // sort integer, // offset integer // limit);
console.log(response);use rusty_falcon::apis::mssp_api::query_roles;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = query_roles( &falcon.cfg, // configuration Some("string"), // user_group_id Some("string"), // cid_group_id Some("string"), // role_id Some("string"), // sort Some(integer), // offset Some(integer), // limit ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
response = api.query_roles(user_group_id: 'string', cid_group_id: 'string', role_id: 'string', sort: 'string', offset: integer, limit: integer)
puts responsequeryUserGroupMembers
Section titled “queryUserGroupMembers”Query User Group member by User UUID.
query_user_group_membersParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| user_uuid | query | string | User UUID to search for. |
| sort | query | string | The property to sort by. |
| offset | query | integer | Starting index of result set. |
| limit | query | integer | The maximum records to return. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.query_user_group_members(user_uuid="string", limit=integer, offset="string", sort="string")print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.queryUserGroupMembers(user_uuid="string", limit=integer, offset="string", sort="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("queryUserGroupMembers", user_uuid="string", sort="string", offset=integer, limit=integer)print(response)Get-FalconUserGroupMember -UserId "string" ` -Sort "string" ` -Limit integer ` -Offset integerpackage main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp")
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) }
sort := "string" offset := int64(0) limit := int64(0)
response, err := client.Mssp.QueryUserGroupMembers( &mssp.QueryUserGroupMembersParams{ UserUUID: "string", Sort: &sort, Offset: &offset, Limit: &limit, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.queryUserGroupMembers( "string", // userUuid "string", // sort integer, // offset integer // limit);
console.log(response);use rusty_falcon::apis::mssp_api::query_user_group_members;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = query_user_group_members( &falcon.cfg, // configuration "string", // user_uuid Some("string"), // sort Some(integer), // offset Some(integer), // limit ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
response = api.query_user_group_members('string')
puts responsequeryUserGroups
Section titled “queryUserGroups”Query User Groups.
query_user_groupsParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| name | query | string | Name to search for. |
| sort | query | string | The property to sort by. |
| offset | query | integer | Starting index of result set. |
| limit | query | integer | The maximum records to return. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.query_user_groups(name="string", limit=integer, offset="string", sort="string")print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.queryUserGroups(name="string", limit=integer, offset="string", sort="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("queryUserGroups", name="string", sort="string", offset=integer, limit=integer)print(response)Get-FalconUserGroup -Sort "string" ` -Limit integer ` -Offset integerpackage main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp")
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) }
name := "string" sort := "string" offset := int64(0) limit := int64(0)
response, err := client.Mssp.QueryUserGroups( &mssp.QueryUserGroupsParams{ Name: &name, Sort: &sort, Offset: &offset, Limit: &limit, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.queryUserGroups( "string", // name "string", // sort integer, // offset integer // limit);
console.log(response);use rusty_falcon::apis::mssp_api::query_user_groups;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = query_user_groups( &falcon.cfg, // configuration Some("string"), // name Some("string"), // sort Some(integer), // offset Some(integer), // limit ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
response = api.query_user_groups(name: 'string', sort: 'string', offset: integer, limit: integer)
puts responsedeleteCIDGroupMembersV1
Section titled “deleteCIDGroupMembersV1”Deprecated: Please use deleteCIDGroupMembersV2.
delete_cid_group_members_v1Parameters
Section titled “Parameters”Same parameters as deleteCIDGroupMembers.
Code Examples
Section titled “Code Examples”from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.delete_cid_group_members_v1(cid_group_id="string", cids=id_list)print(response)from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.deleteCIDGroupMembersV1(cid_group_id="string", cids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
body_payload = { "resources": [ { "cid_group_id": "string", "cids": ["string"] } ]}
response = falcon.command("deleteCIDGroupMembersV1", body=body_payload)print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/mssp" "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) }
cid_group_id := "string"
response, err := client.Mssp.DeleteCIDGroupMembers( &mssp.DeleteCIDGroupMembersParams{ Body: &models.DomainCIDGroupMembersRequestV1{ Resources: []interface{}{ { CIDGroupID: &cid_group_id, Cids: []string{"string"}, }, }, }, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}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.mssp.deleteCIDGroupMembers( { resources: [{ cidGroupId: "string", cids: [] }]} // body);
console.log(response);use rusty_falcon::apis::mssp_api::delete_cid_group_members;use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::models::DomainCidGroupMembersRequestV1;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let body = DomainCidGroupMembersRequestV1 { resources: vec![CIDGroupMembers { cid_group_id: Some("string".to_string()), cids: vec!["string".to_string()], ..Default::default() }], ..Default::default() };
let response = delete_cid_group_members( &falcon.cfg, // configuration body, // body ).await.expect("API call failed");
println!("{:?}", response);}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::Mssp.new
body = Falcon::DomainCIDGroupMembersRequestV1.new( resources: [{ cid_group_id: 'string', cids: [] }])
response = api.delete_cid_group_members(body)
puts response