CrowdStrike Falcon Twitter URL

Using the MSSP (Flight Control) service collection

Uber class support Service class support Documentation Version Page Updated Samples Available

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

Operation IDDescription
getChildren
PEP 8get_children
Get link to child customer by child CID(s)
getCIDGroupMembersBy
PEP 8get_cid_group_members_by
Get CID Group members by CID Group IDs.
addCIDGroupMembers
PEP 8add_cid_group_members
Add new CID Group member.
deleteCIDGroupMembers
PEP 8delete_cid_group_members
Delete CID Group members entry.
getCIDGroupById
PEP 8get_cid_group_by_id
Get CID Group(s) by ID(s).
createCIDGroups
PEP 8create_cid_groups
Create new CID Group(s). Maximum 500 CID Group(s) allowed.
deleteCIDGroups
PEP 8delete_cid_groups
Delete CID Group(s) by ID(s).
updateCIDGroups
PEP 8update_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.
getRolesByID
PEP 8get_roles_by_id
Get MSSP Role assignment(s). MSSP Role assignment is of the format: <user_group_id>.<cid_group_id>.
addRole
PEP 8add_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.
deletedRoles
PEP 8delete_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).
getUserGroupMembersByID
PEP 8get_user_group_members_by_id
Get User Group members by User Group ID(s).
addUserGroupMembers
PEP 8add_user_group_members
Add new User Group member. Maximum 500 members allowed per User Group.
deleteUserGroupMembers
PEP 8delete_user_group_members
Delete User Group members entry.
getUserGroupsByID
PEP 8get_user_groups_by_id
Get User Group by ID(s).
createUserGroups
PEP 8create_user_groups
Create new User Group(s). Maximum 500 User Group(s) allowed per customer.
deleteUserGroups
PEP 8delete_user_groups
Delete User Group(s) by ID(s).
updateUserGroups
PEP 8update_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.
queryChildren
PEP 8query_children
Query for customers linked as children
queryCIDGroupMembers
PEP 8query_cid_group_members
Query a CID Groups members by associated CID.
queryCIDGroups
PEP 8query_cid_groups
Query CID Groups.
queryRoles
PEP 8query_roles
Query MSSP Role assignment. At least one of CID Group ID or User Group ID should also be provided. Role ID is optional.
queryUserGroupMembers
PEP 8query_user_group_members
Query User Group member by User UUID.
queryUserGroups
PEP 8query_user_groups
Query User Groups.

Passing credentials

WARNING

client_id and client_secret are input variables that contain your CrowdStrike API credentials. Please note that all examples below do not hard code these values. (These values are ingested as strings.)

CrowdStrike does not recommend hard coding API credentials or customer identifiers within source code.

getChildren

Get link to child customer by child CID(s)

PEP8 method name

get_children

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
ids
Service Class Support

Uber Class Support
querystring or list of stringsCID of a child customer.
parameters
Service Class Support

Uber Class Support
querydictionaryFull query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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)

Service class example (Operation ID syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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)

Uber class example
from falconpy import APIHarness

# Do not hardcode API credentials!
falcon = APIHarness(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)

getCIDGroupMembersBy

Get CID Group members by CID Group IDs.

PEP8 method name

get_cid_group_members_by

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
cid_group_ids
Service Class Support

Uber Class Support
querystring or list of stringsCID Group IDs to search for members of.
parameters
Service Class Support

Uber Class Support
querydictionaryFull query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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(cid_group_ids=id_list)
print(response)

Service class example (Operation ID syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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(cid_group_ids=id_list)
print(response)

Uber class example
from falconpy import APIHarness

# Do not hardcode API credentials!
falcon = APIHarness(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)

addCIDGroupMembers

Add new CID Group member.

PEP8 method name

add_cid_group_members

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
body
Service Class Support

Uber Class Support
bodydictionaryFull body payload in JSON format.
cid_group_id
Service Class Support

Uber Class Support
bodystringID of the CID group to update.
cids
Service Class Support

Uber Class Support
bodystring or list of stringsCID(s) to add to the CID group.

Usage

Service class example (PEP8 syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
falcon = FlightControl(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )

id_list = 'CID1,CID2,CID3'  # Can also pass a list here: ['CID1', 'CID2', 'CID3']

response = falcon.add_cid_group_members(cid_group_id="string", cids=id_list)
print(response)

Service class example (Operation ID syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
falcon = FlightControl(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )

id_list = 'CID1,CID2,CID3'  # Can also pass a list here: ['CID1', 'CID2', 'CID3']

response = falcon.addCIDGroupMembers(cid_group_id="string", cids=id_list)
print(response)

Uber class example
from falconpy import APIHarness

# Do not hardcode API credentials!
falcon = APIHarness(client_id=CLIENT_ID,
                    client_secret=CLIENT_SECRET
                    )

id_list = ['CID1', 'CID2', 'CID3']

BODY = {
  "resources": [
    {
      "cid_group_id": "string",
      "cids": id_list
    }
  ]
}

response = falcon.command("addCIDGroupMembers", body=BODY)
print(response)

deleteCIDGroupMembers

Delete CID Group members entry.

PEP8 method name

delete_cid_group_members

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
body
Service Class Support

Uber Class Support
bodydictionaryFull body payload in JSON format.
cid_group_id
Service Class Support

Uber Class Support
bodystringID of the CID group to update.
cids
Service Class Support

Uber Class Support
bodystring or list of stringsCID(s) to remove to the CID group.

Usage

Service class example (PEP8 syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
falcon = FlightControl(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )

id_list = 'CID1,CID2,CID3'  # Can also pass a list here: ['CID1', 'CID2', 'CID3']

response = falcon.delete_cid_group_members(cid_group_id="string", cids=id_list)
print(response)

Service class example (Operation ID syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
falcon = FlightControl(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )
id_list = 'CID1,CID2,CID3'  # Can also pass a list here: ['CID1', 'CID2', 'CID3']

response = falcon.deleteCIDGroupMembers(body=BODY)
print(response)

Uber class example
from falconpy import APIHarness

# Do not hardcode API credentials!
falcon = APIHarness(client_id=CLIENT_ID,
                    client_secret=CLIENT_SECRET
                    )

id_list = 'CID1,CID2,CID3'  # Can also pass a list here: ['CID1', 'CID2', 'CID3']

BODY = {
  "resources": [
    {
      "cid_group_id": "string",
      "cids": id_list
    }
  ]
}

response = falcon.command("deleteCIDGroupMembers", cid_group_id="string", cids=id_list)
print(response)

getCIDGroupById

Get CID Group(s) by ID(s).

PEP8 method name

get_cid_group_by_id

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
cid_group_ids
Service Class Support

Uber Class Support
querystring or list of stringsCID Group IDs to search for.
parameters
Service Class Support

Uber Class Support
querydictionaryFull query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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(cid_group_ids=id_list)
print(response)

Service class example (Operation ID syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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(cid_group_ids=id_list)
print(response)

Uber class example
from falconpy import APIHarness

# Do not hardcode API credentials!
falcon = APIHarness(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)

createCIDGroups

Create new CID Group(s). Maximum 500 CID Group(s) allowed.

PEP8 method name

create_cid_groups

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
body
Service Class Support

Uber Class Support
bodydictionaryFull body payload in JSON format.
cid_group_id
Service Class Support

Uber Class Support
bodystringID of the CID group.
cid
Service Class Support

Uber Class Support
bodystringParent CID for the CID group.
description
Service Class Support

Uber Class Support
bodystringCID group description.
name
Service Class Support

Uber Class Support
bodystringCID group name.

Usage

Service class example (PEP8 syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
falcon = FlightControl(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )

response = falcon.create_cid_groups(cid_group_id="string",
                                    cid="string",
                                    description="string",
                                    name="string"
                                    )
print(response)

Service class example (Operation ID syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
falcon = FlightControl(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )

response = falcon.createCIDGroups(cid_group_id="string",
                                  cid="string",
                                  description="string",
                                  name="string"
                                  )
print(response)

Uber class example
from falconpy import APIHarness

# Do not hardcode API credentials!
falcon = APIHarness(client_id=CLIENT_ID,
                    client_secret=CLIENT_SECRET
                    )

BODY = {
    "resources": [
        {
            "cid": "string",
            "cid_group_id": "string",
            "description": "string",
            "name": "string"
        }
    ]
}

response = falcon.command("createCIDGroups", body=BODY)
print(response)

deleteCIDGroups

Delete CID Group(s) by ID(s).

PEP8 method name

delete_cid_groups

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
cid_group_ids
Service Class Support

Uber Class Support
querystring or list of stringsCID Group IDs to be deleted.
parameters
Service Class Support

Uber Class Support
querydictionaryFull query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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)

Service class example (Operation ID syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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)

Uber class example
from falconpy import APIHarness

# Do not hardcode API credentials!
falcon = APIHarness(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)

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.

PEP8 method name

update_cid_groups

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
body
Service Class Support

Uber Class Support
bodydictionaryFull body payload in JSON format.
cid_group_id
Service Class Support

Uber Class Support
bodystringID of the CID group.
cid
Service Class Support

Uber Class Support
bodystringParent CID of the CID group.
description
Service Class Support

Uber Class Support
bodystringCID group description.
name
Service Class Support

Uber Class Support
bodystringCID group name.

Usage

Service class example (PEP8 syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
falcon = FlightControl(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )

response = falcon.update_cid_groups(cid_group_id="string",
                                    cid="string",
                                    description="string",
                                    name="string"
                                    )
print(response)

Service class example (Operation ID syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
falcon = FlightControl(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )

response = falcon.updateCIDGroups(cid_group_id="string",
                                  cid="string",
                                  description="string",
                                  name="string"
                                  )
print(response)

Uber class example
from falconpy import APIHarness

# Do not hardcode API credentials!
falcon = APIHarness(client_id=CLIENT_ID,
                    client_secret=CLIENT_SECRET
                    )

BODY = {
  "resources": [
    {
      "cid": "string",
      "cid_group_id": "string",
      "description": "string",
      "name": "string"
    }
  ]
}

response = falcon.command("updateCIDGroups", body=BODY)
print(response)

getRolesByID

Get MSSP Role assignment(s). MSSP Role assignment is of the format: <user_group_id>.<cid_group_id>.

PEP8 method name

get_roles_by_id

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
ids
Service Class Support

Uber Class Support
querystring or list of stringsRole IDs to retrieve. MSSP Role assignment is of the format <user_group_id>:<cid_group_id>.
parameters
Service Class Support

Uber Class Support
querydictionaryFull query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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)

Service class example (Operation ID syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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)

Uber class example
from falconpy import APIHarness

# Do not hardcode API credentials!
falcon = APIHarness(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)

addRole

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.

PEP8 method name

add_role

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
body
Service Class Support

Uber Class Support
bodydictionaryFull body payload in JSON format.
cid_group_id
Service Class Support

Uber Class Support
bodystringCID Group ID to associate.
user_group_id
Service Class Support

Uber Class Support
bodystringUser group ID to associate.
id
Service Class Support

Uber Class Support
bodystringMSSP role ID.
role_ids
Service Class Support

Uber Class Support
bodystring or list of stringsAdditional role ID(s) to associate.

Usage

Service class example (PEP8 syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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",
                           user_group_id="string",
                           id="string",
                           role_ids=id_list
                           )
print(response)

Service class example (Operation ID syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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",
                          user_group_id="string",
                          id="string",
                          role_ids=id_list
                          )
print(response)

Uber class example
from falconpy import APIHarness

# Do not hardcode API credentials!
falcon = APIHarness(client_id=CLIENT_ID,
                    client_secret=CLIENT_SECRET
                    )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

BODY = {
  "resources": [
    {
      "cid_group_id": "string",
      "id": "string",
      "role_ids": id_list,
      "user_group_id": "string"
    }
  ]
}

response = falcon.command("addRole", body=BODY)
print(response)

deletedRoles

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).

PEP8 method name

delete_roles

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
body
Service Class Support

Uber Class Support
bodydictionaryFull body payload in JSON format.
cid_group_id
Service Class Support

Uber Class Support
bodystringCID Group ID to deassociate.
user_group_id
Service Class Support

Uber Class Support
bodystringUser group ID to deassociate.
id
Service Class Support

Uber Class Support
bodystringMSSP role ID.
role_ids
Service Class Support

Uber Class Support
bodystring or list of stringsAdditional role ID(s) to deassociate.

Usage

Service class example (PEP8 syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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",
                               user_group_id="string",
                               id="string",
                               role_ids=id_list
                               )
print(response)

Service class example (Operation ID syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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",
                               user_group_id="string",
                               id="string",
                               role_ids=id_list
                               )
print(response)

Uber class example
from falconpy import APIHarness

# Do not hardcode API credentials!
falcon = APIHarness(client_id=CLIENT_ID,
                    client_secret=CLIENT_SECRET
                    )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

BODY = {
  "resources": [
    {
      "cid_group_id": "string",
      "id": "string",
      "role_ids": id_list,
      "user_group_id": "string"
    }
  ]
}

response = falcon.command("deletedRoles", body=BODY)
print(response)

getUserGroupMembersByID

Get User Group members by User Group ID(s).

PEP8 method name

get_user_group_members_by_id

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
user_group_ids
Service Class Support

Uber Class Support
querystring or list of stringsUser Group IDs to search for.
parameters
Service Class Support

Uber Class Support
querydictionaryFull query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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(user_group_ids=id_list)
print(response)

Service class example (Operation ID syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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(user_group_ids=id_list)
print(response)

Uber class example
from falconpy import APIHarness

# Do not hardcode API credentials!
falcon = APIHarness(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)

addUserGroupMembers

Add new User Group member. Maximum 500 members allowed per User Group.

PEP8 method name

add_user_group_members

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
body
Service Class Support

Uber Class Support
bodydictionaryFull body payload in JSON format.
user_group_id
Service Class Support

Uber Class Support
bodystringUser group ID to update.
user_uuids
Service Class Support

Uber Class Support
bodystring or list of stringsUser ID(s) to add to the group.

Usage

Service class example (PEP8 syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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_id="string", user_uuids=id_list)
print(response)

Service class example (Operation ID syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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_id="string", user_uuids=id_list)
print(response)

Uber class example
from falconpy import APIHarness

# Do not hardcode API credentials!
falcon = APIHarness(client_id=CLIENT_ID,
                    client_secret=CLIENT_SECRET
                    )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

BODY = {
  "resources": [
    {
      "user_group_id": "string",
      "user_uuids": id_list
    }
  ]
}

response = falcon.command("addUserGroupMembers", body=BODY)
print(response)

deleteUserGroupMembers

Delete User Group members entry.

PEP8 method name

delete_user_group_members

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
body
Service Class Support

Uber Class Support
bodydictionaryFull body payload in JSON format.
user_group_id
Service Class Support

Uber Class Support
bodystringUser group ID to update.
user_uuids
Service Class Support

Uber Class Support
bodystring or list of stringsUser ID(s) to remove to the group.

Usage

Service class example (PEP8 syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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_id="string", user_uuids=id_list)
print(response)

Service class example (Operation ID syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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_id="string", user_uuids=id_list)
print(response)

Uber class example
from falconpy import APIHarness

# Do not hardcode API credentials!
falcon = APIHarness(client_id=CLIENT_ID,
                    client_secret=CLIENT_SECRET
                    )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

BODY = {
  "resources": [
    {
      "user_group_id": "string",
      "user_uuids": id_list
    }
  ]
}

response = falcon.command("deleteUserGroupMembers", body=BODY)
print(response)

getUserGroupsByID

Get User Group by ID(s).

PEP8 method name

get_user_groups_by_id

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
user_group_ids
Service Class Support

Uber Class Support
querystring or list of stringsUser Group IDs to search for.
parameters
Service Class Support

Uber Class Support
querydictionaryFull query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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(user_group_ids=id_list)
print(response)

Service class example (Operation ID syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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(user_group_ids=id_list)
print(response)

Uber class example
from falconpy import APIHarness

# Do not hardcode API credentials!
falcon = APIHarness(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)

createUserGroups

Create new User Group(s). Maximum 500 User Group(s) allowed per customer.

PEP8 method name

create_user_groups

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
body
Service Class Support

Uber Class Support
bodydictionaryFull body payload in JSON format.
user_group_id
Service Class Support

Uber Class Support
bodystringID of the User group.
cid
Service Class Support

Uber Class Support
bodystringCID of the User group.
description
Service Class Support

Uber Class Support
bodystringUser group description.
name
Service Class Support

Uber Class Support
bodystringUser group name.

Usage

Service class example (PEP8 syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
falcon = FlightControl(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )

response = falcon.create_user_groups(user_group_id="string",
                                     cid="string",
                                     description="string",
                                     name="string"
                                     )
print(response)

Service class example (Operation ID syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
falcon = FlightControl(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )

response = falcon.createUserGroups(user_group_id="string",
                                   cid="string",
                                   description="string",
                                   name="string"
                                   )
print(response)

Uber class example
from falconpy import APIHarness

# Do not hardcode API credentials!
falcon = APIHarness(client_id=CLIENT_ID,
                    client_secret=CLIENT_SECRET
                    )

BODY = {
  "resources": [
    {
      "cid": "string",
      "description": "string",
      "name": "string",
      "user_group_id": "string"
    }
  ]
}

response = falcon.command("createUserGroups", body=BODY)
print(response)

deleteUserGroups

Delete User Group(s) by ID(s).

PEP8 method name

delete_user_groups

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
user_group_ids
Service Class Support

Uber Class Support
querystring or list of stringsUser Group IDs to delete.
parameters
Service Class Support

Uber Class Support
querydictionaryFull query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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)

Service class example (Operation ID syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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)

Uber class example
from falconpy import APIHarness

# Do not hardcode API credentials!
falcon = APIHarness(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)

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.

PEP8 method name

update_user_groups

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
body
Service Class Support

Uber Class Support
bodydictionaryFull body payload in JSON format.
user_group_id
Service Class Support

Uber Class Support
bodystringID of the User group.
cid
Service Class Support

Uber Class Support
bodystringCID of the User group.
description
Service Class Support

Uber Class Support
bodystringUser group description.
name
Service Class Support

Uber Class Support
bodystringUser group name.

Usage

Service class example (PEP8 syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
falcon = FlightControl(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )

response = falcon.update_user_groups(user_group_id="string",
                                     cid="string",
                                     description="string",
                                     name="string"
                                     )
print(response)

Service class example (Operation ID syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
falcon = FlightControl(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )

response = falcon.updateUserGroups(user_group_id="string",
                                   cid="string",
                                   description="string",
                                   name="string"
                                   )
print(response)

Uber class example
from falconpy import APIHarness

# Do not hardcode API credentials!
falcon = APIHarness(client_id=CLIENT_ID,
                    client_secret=CLIENT_SECRET
                    )

BODY = {
  "resources": [
    {
      "cid": "string",
      "description": "string",
      "name": "string",
      "user_group_id": "string"
    }
  ]
}

response = falcon.command("updateUserGroups", body=BODY)
print(response)

queryChildren

Query for customers linked as children

PEP8 method name

query_children

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
limit
Service Class Support

Uber Class Support
queryintegerMaximum number of records to return.

(Max: 1000, Default: 10)
offset
Service Class Support

Uber Class Support
queryintegerStarting index of overall result set from which to return ids.
sort
Service Class Support

Uber Class Support
querystringThe property to sort by. (Ex: last_modified_timestamp|desc)
parameters
Service Class Support

Uber Class Support
querydictionaryFull query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
falcon = FlightControl(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )

response = falcon.query_children(sort="string",
                                 offset=integer,
                                 limit=integer
                                 )
print(response)

Service class example (Operation ID syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
falcon = FlightControl(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )

response = falcon.queryChildren(sort="string",
                                offset=integer,
                                limit=integer
                                )
print(response)

Uber class example
from falconpy import APIHarness

# Do not hardcode API credentials!
falcon = APIHarness(client_id=CLIENT_ID,
                    client_secret=CLIENT_SECRET
                    )

response = falcon.command("queryChildren",
                          sort="string",
                          offset=integer,
                          limit=integer
                          )
print(response)

queryCIDGroupMembers

Query a CID Groups members by associated CID.

PEP8 method name

query_cid_group_members

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
cid
Service Class Support

Uber Class Support
querystringCID to lookup associated CID group for.
limit
Service Class Support

Uber Class Support
queryintegerMaximum number of records to return.

(Max: 1000, Default: 10)
offset
Service Class Support

Uber Class Support
queryintegerStarting index of overall result set from which to return ids.
sort
Service Class Support

Uber Class Support
querystringThe property to sort by. (Ex: last_modified_timestamp|desc)
parameters
Service Class Support

Uber Class Support
querydictionaryFull query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
falcon = FlightControl(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )

response = falcon.query_cid_group_members(cid="string",
                                          sort="string",
                                          offset=integer,
                                          limit=integer
                                          )
print(response)

Service class example (Operation ID syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
falcon = FlightControl(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )

response = falcon.queryCIDGroupMembers(cid="string",
                                       sort="string",
                                       offset=integer,
                                       limit=integer
                                       )
print(response)

Uber class example
from falconpy import APIHarness

# Do not hardcode API credentials!
falcon = APIHarness(client_id=CLIENT_ID,
                    client_secret=CLIENT_SECRET
                    )

response = falcon.command("queryCIDGroupMembers",
                          cid="string",
                          sort="string",
                          offset=integer,
                          limit=integer
                          )
print(response)

queryCIDGroups

Query CID Groups.

PEP8 method name

query_cid_groups

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
name
Service Class Support

Uber Class Support
querystringName to lookup groups for.
limit
Service Class Support

Uber Class Support
queryintegerMaximum number of records to return.

(Max: 1000, Default: 10)
offset
Service Class Support

Uber Class Support
queryintegerStarting index of overall result set from which to return ids.
sort
Service Class Support

Uber Class Support
querystringThe property to sort by. (Ex: last_modified_timestamp|desc)
parameters
Service Class Support

Uber Class Support
querydictionaryFull query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
falcon = FlightControl(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )

response = falcon.query_cid_groups(name="string",
                                   sort="string",
                                   offset=integer,
                                   limit=integer
                                   )
print(response)

Service class example (Operation ID syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
falcon = FlightControl(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )

response = falcon.queryCIDGroups(name="string",
                                 sort="string",
                                 offset=integer,
                                 limit=integer
                                 )
print(response)

Uber class example
from falconpy import APIHarness

# Do not hardcode API credentials!
falcon = APIHarness(client_id=CLIENT_ID,
                    client_secret=CLIENT_SECRET
                    )

response = falcon.command("queryCIDGroups",
                          name="string",
                          sort="string",
                          offset=integer,
                          limit=integer
                          )
print(response)

queryRoles

Query MSSP Role assignment. At least one of CID Group ID or User Group ID should also be provided. Role ID is optional.

PEP8 method name

query_roles

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
user_uuid
Service Class Support

Uber Class Support
querystringUser Group ID to fetch MSSP role for.
cid_group_id
Service Class Support

Uber Class Support
querystringCID Group ID to fetch MSSP role for.
role_id
Service Class Support

Uber Class Support
querystringRole ID to fetch MSSP role for.
limit
Service Class Support

Uber Class Support
queryintegerMaximum number of records to return.

(Max: 1000, Default: 10)
offset
Service Class Support

Uber Class Support
queryintegerStarting index of overall result set from which to return ids.
sort
Service Class Support

Uber Class Support
querystringThe property to sort by. (Ex: last_modified_timestamp|desc)
parameters
Service Class Support

Uber Class Support
querydictionaryFull query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
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",
                              sort="string",
                              offset=integer,
                              limit=integer
                              )
print(response)

Service class example (Operation ID syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
falcon = FlightControl(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )

response = falcon.queryRoles(user_group_id="string",
                             cid_group_id="string",
                             role_id="string",
                             sort="string",
                             offset=integer,
                             limit=integer
                             )
print(response)

Uber class example
from falconpy import APIHarness

# Do not hardcode API credentials!
falcon = APIHarness(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)

queryUserGroupMembers

Query User Group member by User UUID.

PEP8 method name

query_user_group_members

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
user_uuid
Service Class Support

Uber Class Support
querystringUser UUID to lookup associated User Group ID.
limit
Service Class Support

Uber Class Support
queryintegerMaximum number of records to return.

(Max: 1000, Default: 10)
offset
Service Class Support

Uber Class Support
queryintegerStarting index of overall result set from which to return ids.
sort
Service Class Support

Uber Class Support
querystringThe property to sort by. (Ex: last_modified_timestamp|desc)
parameters
Service Class Support

Uber Class Support
querydictionaryFull query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
falcon = FlightControl(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )

response = falcon.query_user_group_members(user_uuid="string",
                                           sort="string",
                                           offset=integer,
                                           limit=integer
                                           )
print(response)

Service class example (Operation ID syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
falcon = FlightControl(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )

response = falcon.queryUserGroupMembers(user_uuid="string",
                                        sort="string",
                                        offset=integer,
                                        limit=integer
                                        )
print(response)

Uber class example
from falconpy import APIHarness

# Do not hardcode API credentials!
falcon = APIHarness(client_id=CLIENT_ID,
                    client_secret=CLIENT_SECRET
                    )

response = falcon.command("queryUserGroupMembers",
                          user_uuid="string",
                          sort="string",
                          offset=integer,
                          limit=integer
                          )
print(response)

queryUserGroups

Query User Groups.

PEP8 method name

query_user_groups

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
name
Service Class Support

Uber Class Support
querystringName to lookup groups for.
limit
Service Class Support

Uber Class Support
queryintegerMaximum number of records to return.

(Max: 1000, Default: 10)
offset
Service Class Support

Uber Class Support
queryintegerStarting index of overall result set from which to return ids.
sort
Service Class Support

Uber Class Support
querystringThe property to sort by. (Ex: last_modified_timestamp|desc)
parameters
Service Class Support

Uber Class Support
querydictionaryFull query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
falcon = FlightControl(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )

response = falcon.query_user_groups(name="string",
                                    sort="string",
                                    offset=integer,
                                    limit=integer
                                    )
print(response)

Service class example (Operation ID syntax)
from falconpy import FlightControl

# Do not hardcode API credentials!
falcon = FlightControl(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )

response = falcon.queryUserGroups(name="string",
                                  sort="string",
                                  offset=integer,
                                  limit=integer
                                  )
print(response)

Uber class example
from falconpy import APIHarness

# Do not hardcode API credentials!
falcon = APIHarness(client_id=CLIENT_ID,
                    client_secret=CLIENT_SECRET
                    )

response = falcon.command("queryUserGroups",
                          name="string",
                          sort="string",
                          offset=integer,
                          limit=integer
                          )
print(response)