MSSP - CrowdStrike/falconpy GitHub Wiki

CrowdStrike Falcon CrowdStrike Subreddit

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 ID Description
getChildrenV2
PEP8 get_children_v2
Get link to child customer by child CID(s)
getChildren
PEP 8 get_children
Get link to child customer by child CID(s)
getCIDGroupMembersBy
PEP8 get_cid_group_members_by
Get CID group members by CID Group ID.
getCIDGroupMembersByV1
PEP 8 get_cid_group_members_by_v1
DEPRECATED
Get CID Group members by CID Group IDs.
addCIDGroupMembers
PEP 8 add_cid_group_members
Add new CID Group member.
deleteCIDGroupMembers
PEP 8 delete_cid_group_members
Delete CID Group members entry.
getCIDGroupById
PEP8 get_cid_group_by_id
Get CID Groups by ID.
getCIDGroupByIdV1
PEP 8 get_cid_group_by_id_v1
DEPRECATED
Get CID Group(s) by ID(s).
createCIDGroups
PEP 8 create_cid_groups
Create new CID Group(s). Maximum 500 CID Group(s) allowed.
deleteCIDGroups
PEP 8 delete_cid_groups
Delete CID Group(s) by ID(s).
updateCIDGroups
PEP 8 update_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 8 get_roles_by_id
Get MSSP Role assignment(s). MSSP Role assignment is of the format: <user_group_id>.<cid_group_id>.
addRole
PEP 8 add_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 8 delete_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 8 get_user_group_members_by_id
Get User Group members by User Group ID(s).
getUserGroupMembersByIDV1
PEP 8 get_user_group_members_by_id_v1
DEPRECATED
Get User Group members by User Group ID(s).
addUserGroupMembers
PEP 8 add_user_group_members
Add new User Group member. Maximum 500 members allowed per User Group.
deleteUserGroupMembers
PEP 8 delete_user_group_members
Delete User Group members entry.
getUserGroupsByID
PEP 8 get_user_groups_by_id
Get User Group by ID(s).
getUserGroupsByIDV1
PEP8 get_user_groups_by_id_v1
DEPRECATED
Get user groups by ID.
createUserGroups
PEP 8 create_user_groups
Create new User Group(s). Maximum 500 User Group(s) allowed per customer.
deleteUserGroups
PEP 8 delete_user_groups
Delete User Group(s) by ID(s).
updateUserGroups
PEP 8 update_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.
getUserGroupsByID
PEP8 get_user_groups_by_id
Get user groups by ID.
queryChildren
PEP 8 query_children
Query for customers linked as children
queryCIDGroupMembers
PEP 8 query_cid_group_members
Query a CID Groups members by associated CID.
queryCIDGroups
PEP 8 query_cid_groups
Query CID Groups.
queryRoles
PEP 8 query_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.
queryUserGroupMembers
PEP 8 query_user_group_members
Query User Group member by User UUID.
queryUserGroups
PEP 8 query_user_groups
Query User Groups.

Passing credentials

WARNING

client_id and client_secret are keyword arguments 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.

getChildrenV2

Get link to child customer by child CID(s)

PEP8 method name

get_children_v2

Endpoint

Method Route
POST /mssp/entities/children/GET/v2

Required Scope

flight-control:read

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
body
Service Class Support

Uber Class Support
body dictionary Full body payload in JSON format.
ids
Service Class Support

Uber Class Support
body string or list of strings CID of a child customer.

Usage

Service class example (PEP8 syntax)
from falconpy.mssp 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)
Service class example (Operation ID syntax)
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)
Uber class example
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("getChildrenV2", ids=id_list)

print(response)

Back to Table of Contents

getChildren

Get link to child customer by child CID(s)

PEP8 method name

get_children

Endpoint

Method Route
GET /mssp/entities/children/v1

Required Scope

flight-control:read

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
ids
Service Class Support

Uber Class Support
query string or list of strings CID of a child customer.
parameters
Service Class Support

Uber Class Support
query dictionary Full 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 APIHarnessV2

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

Back to Table of Contents

getCIDGroupMembersByV1

Get CID Group members by CID Group IDs. DEPRECATED

PEP8 method name

get_cid_group_members_by_v1

Endpoint

Method Route
GET /mssp/entities/cid-group-members/v1

Required Scope

flight-control:read

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
cid_group_ids
Service Class Support

Uber Class Support
query string or list of strings CID Group IDs to search for members of.
parameters
Service Class Support

Uber Class Support
query dictionary Full 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_v1(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.getCIDGroupMembersByV1(cid_group_ids=id_list)

print(response)
Uber class example
from falconpy import APIHarnessV2

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

Back to Table of Contents

addCIDGroupMembers

Add new CID Group member.

PEP8 method name

add_cid_group_members

Endpoint

Method Route
POST /mssp/entities/cid-group-members/v1

Required Scope

flight-control:write

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
body
Service Class Support

Uber Class Support
body dictionary Full body payload in JSON format.
cid_group_id
Service Class Support

Uber Class Support
body string ID of the CID group to update.
cids
Service Class Support

Uber Class Support
body string or list of strings CID(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 APIHarnessV2

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

Back to Table of Contents

deleteCIDGroupMembers

Delete CID Group members entry.

PEP8 method name

delete_cid_group_members

Endpoint

Method Route
DELETE /mssp/entities/cid-group-members/v1

Required Scope

flight-control:write

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
body
Service Class Support

Uber Class Support
body dictionary Full body payload in JSON format.
cid_group_id
Service Class Support

Uber Class Support
body string ID of the CID group to update.
cids
Service Class Support

Uber Class Support
body string or list of strings CID(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 APIHarnessV2

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

Back to Table of Contents

getCIDGroupMembersBy

Get CID group members by CID Group ID.

PEP8 method name

get_cid_group_members_by or get_cid_group_members_by_v2

Endpoint

Method Route
GET /mssp/entities/cid-group-members/v2

Required Scope

flight-control:read

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
ids
Service Class Support

Uber Class Support
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
Service Class Support

Uber Class Support
query dictionary Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy.mssp 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)
Service class example (Operation ID syntax)
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)
Uber class example
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", ids=id_list)

print(response)

Back to Table of Contents

getCIDGroupByIdV1

Get CID groups by ID(s). DEPRECATED

PEP8 method name

get_cid_group_by_id_v1

Endpoint

Method Route
GET /mssp/entities/cid-groups/v1

Required Scope

flight-control:read

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
cid_group_ids
Service Class Support

Uber Class Support
query string or list of strings CID Group IDs to search for.
parameters
Service Class Support

Uber Class Support
query dictionary Full 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_v1(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.getCIDGroupByIdV1(cid_group_ids=id_list)

print(response)
Uber class example
from falconpy import APIHarnessV2

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

Back to Table of Contents

createCIDGroups

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

PEP8 method name

create_cid_groups

Endpoint

Method Route
POST /mssp/entities/cid-groups/v1

Required Scope

flight-control:write

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
body
Service Class Support

Uber Class Support
body dictionary Full body payload in JSON format.
cid_group_id
Service Class Support

Uber Class Support
body string ID of the CID group.
cid
Service Class Support

Uber Class Support
body string Parent CID for the CID group.
description
Service Class Support

Uber Class Support
body string CID group description.
name
Service Class Support

Uber Class Support
body string CID 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 APIHarnessV2

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

Back to Table of Contents

deleteCIDGroups

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

PEP8 method name

delete_cid_groups

Endpoint

Method Route
DELETE /mssp/entities/cid-groups/v1

Required Scope

flight-control:write

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
cid_group_ids
Service Class Support

Uber Class Support
query string or list of strings CID Group IDs to be deleted.
parameters
Service Class Support

Uber Class Support
query dictionary Full 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 APIHarnessV2

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

Back to Table of Contents

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

Endpoint

Method Route
PATCH /mssp/entities/cid-groups/v1

Required Scope

flight-control:write

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
body
Service Class Support

Uber Class Support
body dictionary Full body payload in JSON format.
cid_group_id
Service Class Support

Uber Class Support
body string ID of the CID group.
cid
Service Class Support

Uber Class Support
body string Parent CID of the CID group.
description
Service Class Support

Uber Class Support
body string CID group description.
name
Service Class Support

Uber Class Support
body string CID 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 APIHarnessV2

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

Back to Table of Contents

getCIDGroupById

Get CID Groups by ID.

PEP8 method name

get_cid_group_by_id or get_cid_group_by_id_v2

Endpoint

Method Route
GET /mssp/entities/cid-groups/v2

Required Scope

flight-control:read

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
ids
Service Class Support

Uber Class Support
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
Service Class Support

Uber Class Support
query dictionary Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy.mssp 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)
Service class example (Operation ID syntax)
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)
Uber class example
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", ids=id_list)

print(response)

Back to Table of Contents

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

Endpoint

Method Route
GET /mssp/entities/mssp-roles/v1

Required Scope

flight-control:read

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
ids
Service Class Support

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

Uber Class Support
query dictionary Full 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 APIHarnessV2

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

Back to Table of Contents

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

Endpoint

Method Route
POST /mssp/entities/mssp-roles/v1

Required Scope

flight-control:write

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
body
Service Class Support

Uber Class Support
body dictionary Full body payload in JSON format.
cid_group_id
Service Class Support

Uber Class Support
body string CID Group ID to associate.
user_group_id
Service Class Support

Uber Class Support
body string User group ID to associate.
id
Service Class Support

Uber Class Support
body string MSSP role ID.
role_ids
Service Class Support

Uber Class Support
body string or list of strings Additional 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 APIHarnessV2

# Do not hardcode API credentials!
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 = {
  "resources": [
    {
      "cid_group_id": "string",
      "id": "string",
      "role_ids": id_list,
      "user_group_id": "string"
    }
  ]
}

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

print(response)

Back to Table of Contents

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

Endpoint

Method Route
DELETE /mssp/entities/mssp-roles/v1

Required Scope

flight-control:write

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
body
Service Class Support

Uber Class Support
body dictionary Full body payload in JSON format.
cid_group_id
Service Class Support

Uber Class Support
body string CID Group ID to deassociate.
user_group_id
Service Class Support

Uber Class Support
body string User group ID to deassociate.
id
Service Class Support

Uber Class Support
body string MSSP role ID.
role_ids
Service Class Support

Uber Class Support
body string or list of strings Additional 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 APIHarnessV2

# Do not hardcode API credentials!
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 = {
  "resources": [
    {
      "cid_group_id": "string",
      "id": "string",
      "role_ids": id_list,
      "user_group_id": "string"
    }
  ]
}

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

print(response)

Back to Table of Contents

getUserGroupMembersByIDV1

Get user group members by user group ID(s). DEPRECATED

PEP8 method name

get_user_group_members_by_id_v1

Endpoint

Method Route
GET /mssp/entities/user-group-members/v1

Required Scope

flight-control:read

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
user_group_ids
Service Class Support

Uber Class Support
query string or list of strings User Group IDs to search for.
parameters
Service Class Support

Uber Class Support
query dictionary Full 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_v1(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.getUserGroupMembersByIDV1(user_group_ids=id_list)

print(response)
Uber class example
from falconpy import APIHarnessV2

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

Back to Table of Contents

addUserGroupMembers

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

PEP8 method name

add_user_group_members

Endpoint

Method Route
POST /mssp/entities/user-group-members/v1

Required Scope

flight-control:write

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
body
Service Class Support

Uber Class Support
body dictionary Full body payload in JSON format.
user_group_id
Service Class Support

Uber Class Support
body string User group ID to update.
user_uuids
Service Class Support

Uber Class Support
body string or list of strings User 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 APIHarnessV2

# Do not hardcode API credentials!
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 = {
  "resources": [
    {
      "user_group_id": "string",
      "user_uuids": id_list
    }
  ]
}

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

print(response)

Back to Table of Contents

deleteUserGroupMembers

Delete User Group members entry.

PEP8 method name

delete_user_group_members

Endpoint

Method Route
DELETE /mssp/entities/user-group-members/v1

Required Scope

flight-control:write

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
body
Service Class Support

Uber Class Support
body dictionary Full body payload in JSON format.
user_group_id
Service Class Support

Uber Class Support
body string User group ID to update.
user_uuids
Service Class Support

Uber Class Support
body string or list of strings User 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 APIHarnessV2

# Do not hardcode API credentials!
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 = {
  "resources": [
    {
      "user_group_id": "string",
      "user_uuids": id_list
    }
  ]
}

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

print(response)

Back to Table of Contents

getUserGroupMembersByID

Get user group members by user group ID.

PEP8 method name

get_user_group_members_by_id or get_user_group_members_by_id_v2

Endpoint

Method Route
GET /mssp/entities/user-group-members/v2

Required Scope

flight-control:read

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
ids
Service Class Support

Uber Class Support
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
Service Class Support

Uber Class Support
query dictionary Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy.mssp 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)
Service class example (Operation ID syntax)
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)
Uber class example
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", ids=id_list)

print(response)

Back to Table of Contents

getUserGroupsByIDV1

Get user groups by ID(s). DEPRECATED

PEP8 method name

get_user_groups_by_id_v1

Endpoint

Method Route
GET /mssp/entities/user-groups/v1

Required Scope

flight-control:read

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
user_group_ids
Service Class Support

Uber Class Support
query string or list of strings User Group IDs to search for.
parameters
Service Class Support

Uber Class Support
query dictionary Full 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_v1(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.getUserGroupsByIDV1(user_group_ids=id_list)

print(response)
Uber class example
from falconpy import APIHarnessV2

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

Back to Table of Contents

createUserGroups

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

PEP8 method name

create_user_groups

Endpoint

Method Route
POST /mssp/entities/user-groups/v1

Required Scope

flight-control:write

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
body
Service Class Support

Uber Class Support
body dictionary Full body payload in JSON format.
user_group_id
Service Class Support

Uber Class Support
body string ID of the User group.
cid
Service Class Support

Uber Class Support
body string CID of the User group.
description
Service Class Support

Uber Class Support
body string User group description.
name
Service Class Support

Uber Class Support
body string User 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 APIHarnessV2

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

Back to Table of Contents

deleteUserGroups

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

PEP8 method name

delete_user_groups

Endpoint

Method Route
DELETE /mssp/entities/user-groups/v1

Required Scope

flight-control:write

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
user_group_ids
Service Class Support

Uber Class Support
query string or list of strings User Group IDs to delete.
parameters
Service Class Support

Uber Class Support
query dictionary Full 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 APIHarnessV2

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

Back to Table of Contents

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

Endpoint

Method Route
PATCH /mssp/entities/user-groups/v1

Required Scope

flight-control:write

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
body
Service Class Support

Uber Class Support
body dictionary Full body payload in JSON format.
user_group_id
Service Class Support

Uber Class Support
body string ID of the User group.
cid
Service Class Support

Uber Class Support
body string CID of the User group.
description
Service Class Support

Uber Class Support
body string User group description.
name
Service Class Support

Uber Class Support
body string User 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 APIHarnessV2

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

Back to Table of Contents

getUserGroupsByID

Get user groups by ID.

PEP8 method name

get_user_groups_by_id or get_user_groups_by_id_v2

Endpoint

Method Route
GET /mssp/entities/user-groups/v2

Required Scope

flight-control:read

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
ids
Service Class Support

Uber Class Support
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
Service Class Support

Uber Class Support
query dictionary Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy.mssp 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)
Service class example (Operation ID syntax)
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.getUserGroupsByIDV2(ids=id_list)

print(response)
Uber class example
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("getUserGroupsByIDV2", ids=id_list)

print(response)

Back to Table of Contents

queryChildren

Query for customers linked as children

PEP8 method name

query_children

Endpoint

Method Route
GET /mssp/queries/children/v1

Required Scope

flight-control:read

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
limit
Service Class Support

Uber Class Support
query integer Maximum number of records to return.

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

Uber Class Support
query string FQL filter used to limit the results returned. Supported filters: cid.
offset
Service Class Support

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

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

Uber Class Support
query dictionary Full 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,
                                 filter="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.queryChildren(sort="string",
                                offset=integer,
                                limit=integer,
                                filter="string"
                                )

print(response)
Uber class example
from falconpy import APIHarnessV2

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

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

print(response)

Back to Table of Contents

queryCIDGroupMembers

Query a CID Groups members by associated CID.

PEP8 method name

query_cid_group_members

Endpoint

Method Route
GET /mssp/queries/cid-group-members/v1

Required Scope

flight-control:read

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
cid
Service Class Support

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

Uber Class Support
query integer Maximum number of records to return.

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

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

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

Uber Class Support
query dictionary Full 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 APIHarnessV2

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

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

print(response)

Back to Table of Contents

queryCIDGroups

Query CID Groups.

PEP8 method name

query_cid_groups

Endpoint

Method Route
GET /mssp/queries/cid-groups/v1

Required Scope

flight-control:read

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
name
Service Class Support

Uber Class Support
query string Name to lookup groups for.
limit
Service Class Support

Uber Class Support
query integer Maximum number of records to return.

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

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

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

Uber Class Support
query dictionary Full 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 APIHarnessV2

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

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

print(response)

Back to Table of Contents

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

Endpoint

Method Route
GET /mssp/queries/mssp-roles/v1

Required Scope

flight-control:read

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
user_uuid
Service Class Support

Uber Class Support
query string User Group ID to fetch MSSP role for.
cid_group_id
Service Class Support

Uber Class Support
query string CID Group ID to fetch MSSP role for.
role_id
Service Class Support

Uber Class Support
query string Role ID to fetch MSSP role for.
limit
Service Class Support

Uber Class Support
query integer Maximum number of records to return.

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

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

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

Uber Class Support
query dictionary Full 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 APIHarnessV2

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

Back to Table of Contents

queryUserGroupMembers

Query User Group member by User UUID.

PEP8 method name

query_user_group_members

Endpoint

Method Route
GET /mssp/queries/user-group-members/v1

Required Scope

flight-control:read

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
user_uuid
Service Class Support

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

Uber Class Support
query integer Maximum number of records to return.

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

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

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

Uber Class Support
query dictionary Full 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 APIHarnessV2

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

Back to Table of Contents

queryUserGroups

Query User Groups.

PEP8 method name

query_user_groups

Endpoint

Method Route
GET /mssp/queries/user-groups/v1

Required Scope

flight-control:read

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
name
Service Class Support

Uber Class Support
query string Name to lookup groups for.
limit
Service Class Support

Uber Class Support
query integer Maximum number of records to return.

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

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

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

Uber Class Support
query dictionary Full 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 APIHarnessV2

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

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

print(response)

Back to Table of Contents

⚠️ **GitHub.com Fallback** ⚠️