MSSP - CrowdStrike/falconpy GitHub Wiki
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.
Operation ID | Description | ||||
---|---|---|---|---|---|
|
Get link to child customer by child CID(s) | ||||
|
Get link to child customer by child CID(s) | ||||
|
Get CID group members by CID Group ID. | ||||
|
Get CID Group members by CID Group IDs. | ||||
|
Add new CID Group member. | ||||
|
Delete CID Group members entry. | ||||
|
Get CID Groups by ID. | ||||
|
Get CID Group(s) by ID(s). | ||||
|
Create new CID Group(s). Maximum 500 CID Group(s) allowed. | ||||
|
Delete CID Group(s) by ID(s). | ||||
|
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. | ||||
|
Get MSSP Role assignment(s). MSSP Role assignment is of the format: <user_group_id>.<cid_group_id>. | ||||
|
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. | ||||
|
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). | ||||
|
Get User Group members by User Group ID(s). | ||||
|
Get User Group members by User Group ID(s). | ||||
|
Add new User Group member. Maximum 500 members allowed per User Group. | ||||
|
Delete User Group members entry. | ||||
|
Get User Group by ID(s). | ||||
|
Get user groups by ID. | ||||
|
Create new User Group(s). Maximum 500 User Group(s) allowed per customer. | ||||
|
Delete User Group(s) by ID(s). | ||||
|
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. | ||||
|
Get user groups by ID. | ||||
|
Query for customers linked as children | ||||
|
Query a CID Groups members by associated CID. | ||||
|
Query CID Groups. | ||||
|
Query links between user groups and CID groups. At least one of CID Group ID or User Group ID should also be provided. Role ID is optional. | ||||
|
Query User Group member by User UUID. | ||||
|
Query User Groups. |
WARNING
client_id
andclient_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.
Get link to child customer by child CID(s)
get_children_v2
Method | Route |
---|---|
/mssp/entities/children/GET/v2 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
body |
|
|
body | dictionary | Full body payload in JSON format. |
ids |
|
|
body | string or list of strings | CID of a child customer. |
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)
from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.getChildrenV2(ids=id_list)
print(response)
from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.command("getChildrenV2", ids=id_list)
print(response)
Back to Table of Contents
Get link to child customer by child CID(s)
get_children
Method | Route |
---|---|
/mssp/entities/children/v1 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
ids |
|
|
query | string or list of strings | CID of a child customer. |
parameters |
|
|
query | dictionary | Full query string parameters payload in JSON format. |
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)
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)
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
Get CID Group members by CID Group IDs.
get_cid_group_members_by_v1
Method | Route |
---|---|
/mssp/entities/cid-group-members/v1 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
cid_group_ids |
|
|
query | string or list of strings | CID Group IDs to search for members of. |
parameters |
|
|
query | dictionary | Full query string parameters payload in JSON format. |
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)
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)
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
Add new CID Group member.
add_cid_group_members
Method | Route |
---|---|
/mssp/entities/cid-group-members/v1 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
body |
|
|
body | dictionary | Full body payload in JSON format. |
cid_group_id |
|
|
body | string | ID of the CID group to update. |
cids |
|
|
body | string or list of strings | CID(s) to add to the CID group. |
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)
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)
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
Delete CID Group members entry.
delete_cid_group_members
Method | Route |
---|---|
/mssp/entities/cid-group-members/v1 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
body |
|
|
body | dictionary | Full body payload in JSON format. |
cid_group_id |
|
|
body | string | ID of the CID group to update. |
cids |
|
|
body | string or list of strings | CID(s) to remove to the CID group. |
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)
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)
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
Get CID group members by CID Group ID.
get_cid_group_members_by or get_cid_group_members_by_v2
Method | Route |
---|---|
/mssp/entities/cid-group-members/v2 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
ids |
|
|
query | string or list of strings | CID Group IDs to search for members of. The keyword cid_group_ids will also be accepted for this argument. |
parameters |
|
|
query | dictionary | Full query string parameters payload in JSON format. |
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)
from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.getCIDGroupMembersBy(ids=id_list)
print(response)
from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.command("getCIDGroupMembersBy", ids=id_list)
print(response)
Back to Table of Contents
Get CID groups by ID(s).
get_cid_group_by_id_v1
Method | Route |
---|---|
/mssp/entities/cid-groups/v1 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
cid_group_ids |
|
|
query | string or list of strings | CID Group IDs to search for. |
parameters |
|
|
query | dictionary | Full query string parameters payload in JSON format. |
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)
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)
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
Create new CID Group(s). Maximum 500 CID Group(s) allowed.
create_cid_groups
Method | Route |
---|---|
/mssp/entities/cid-groups/v1 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
body |
|
|
body | dictionary | Full body payload in JSON format. |
cid_group_id |
|
|
body | string | ID of the CID group. |
cid |
|
|
body | string | Parent CID for the CID group. |
description |
|
|
body | string | CID group description. |
name |
|
|
body | string | CID group name. |
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)
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)
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
Delete CID Group(s) by ID(s).
delete_cid_groups
Method | Route |
---|---|
/mssp/entities/cid-groups/v1 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
cid_group_ids |
|
|
query | string or list of strings | CID Group IDs to be deleted. |
parameters |
|
|
query | dictionary | Full query string parameters payload in JSON format. |
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)
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)
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
Update existing CID Group(s). CID Group ID is expected for each CID Group definition provided in request body. CID Group member(s) remain unaffected.
update_cid_groups
Method | Route |
---|---|
/mssp/entities/cid-groups/v1 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
body |
|
|
body | dictionary | Full body payload in JSON format. |
cid_group_id |
|
|
body | string | ID of the CID group. |
cid |
|
|
body | string | Parent CID of the CID group. |
description |
|
|
body | string | CID group description. |
name |
|
|
body | string | CID group name. |
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)
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)
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
Get CID Groups by ID.
get_cid_group_by_id or get_cid_group_by_id_v2
Method | Route |
---|---|
/mssp/entities/cid-groups/v2 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
ids |
|
|
query | string or list of strings | CID Group IDs to search for. The keyword cid_group_ids will also be accepted for this argument. |
parameters |
|
|
query | dictionary | Full query string parameters payload in JSON format. |
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)
from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.getCIDGroupById(ids=id_list)
print(response)
from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.command("getCIDGroupById", ids=id_list)
print(response)
Back to Table of Contents
Get MSSP Role assignment(s). MSSP Role assignment is of the format: <user_group_id>.<cid_group_id>.
get_roles_by_id
Method | Route |
---|---|
/mssp/entities/mssp-roles/v1 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
ids |
|
|
query | string or list of strings | Role IDs to retrieve. MSSP Role assignment is of the format <user_group_id>:<cid_group_id>. |
parameters |
|
|
query | dictionary | Full query string parameters payload in JSON format. |
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)
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)
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
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.
add_role
Method | Route |
---|---|
/mssp/entities/mssp-roles/v1 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
body |
|
|
body | dictionary | Full body payload in JSON format. |
cid_group_id |
|
|
body | string | CID Group ID to associate. |
user_group_id |
|
|
body | string | User group ID to associate. |
id |
|
|
body | string | MSSP role ID. |
role_ids |
|
|
body | string or list of strings | Additional role ID(s) to associate. |
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)
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)
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
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).
delete_roles
Method | Route |
---|---|
/mssp/entities/mssp-roles/v1 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
body |
|
|
body | dictionary | Full body payload in JSON format. |
cid_group_id |
|
|
body | string | CID Group ID to deassociate. |
user_group_id |
|
|
body | string | User group ID to deassociate. |
id |
|
|
body | string | MSSP role ID. |
role_ids |
|
|
body | string or list of strings | Additional role ID(s) to deassociate. |
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)
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)
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
Get user group members by user group ID(s).
get_user_group_members_by_id_v1
Method | Route |
---|---|
/mssp/entities/user-group-members/v1 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
user_group_ids |
|
|
query | string or list of strings | User Group IDs to search for. |
parameters |
|
|
query | dictionary | Full query string parameters payload in JSON format. |
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)
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)
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
Add new User Group member. Maximum 500 members allowed per User Group.
add_user_group_members
Method | Route |
---|---|
/mssp/entities/user-group-members/v1 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
body |
|
|
body | dictionary | Full body payload in JSON format. |
user_group_id |
|
|
body | string | User group ID to update. |
user_uuids |
|
|
body | string or list of strings | User ID(s) to add to the group. |
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)
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)
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
Delete User Group members entry.
delete_user_group_members
Method | Route |
---|---|
/mssp/entities/user-group-members/v1 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
body |
|
|
body | dictionary | Full body payload in JSON format. |
user_group_id |
|
|
body | string | User group ID to update. |
user_uuids |
|
|
body | string or list of strings | User ID(s) to remove to the group. |
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)
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)
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
Get user group members by user group ID.
get_user_group_members_by_id or get_user_group_members_by_id_v2
Method | Route |
---|---|
/mssp/entities/user-group-members/v2 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
ids |
|
|
query | string or list of strings | User Group IDs to search for. The keyword user_group_ids will also be accepted for this argument. |
parameters |
|
|
query | dictionary | Full query string parameters payload in JSON format. |
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)
from falconpy import FlightControl
falcon = FlightControl(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.getUserGroupMembersByID(ids=id_list)
print(response)
from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.command("getUserGroupMembersByID", ids=id_list)
print(response)
Back to Table of Contents
Get user groups by ID(s).
get_user_groups_by_id_v1
Method | Route |
---|---|
/mssp/entities/user-groups/v1 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
user_group_ids |
|
|
query | string or list of strings | User Group IDs to search for. |
parameters |
|
|
query | dictionary | Full query string parameters payload in JSON format. |
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)
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)
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
Create new User Group(s). Maximum 500 User Group(s) allowed per customer.
create_user_groups
Method | Route |
---|---|
/mssp/entities/user-groups/v1 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
body |
|
|
body | dictionary | Full body payload in JSON format. |
user_group_id |
|
|
body | string | ID of the User group. |
cid |
|
|
body | string | CID of the User group. |
description |
|
|
body | string | User group description. |
name |
|
|
body | string | User group name. |
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)
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)
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
Delete User Group(s) by ID(s).
delete_user_groups
Method | Route |
---|---|
/mssp/entities/user-groups/v1 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
user_group_ids |
|
|
query | string or list of strings | User Group IDs to delete. |
parameters |
|
|
query | dictionary | Full query string parameters payload in JSON format. |
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)
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)
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
Update existing User Group(s). User Group ID is expected for each User Group definition provided in request body. User Group member(s) remain unaffected.
update_user_groups
Method | Route |
---|---|
/mssp/entities/user-groups/v1 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
body |
|
|
body | dictionary | Full body payload in JSON format. |
user_group_id |
|
|
body | string | ID of the User group. |
cid |
|
|
body | string | CID of the User group. |
description |
|
|
body | string | User group description. |
name |
|
|
body | string | User group name. |
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)
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)
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
Get user groups by ID.
get_user_groups_by_id or get_user_groups_by_id_v2
Method | Route |
---|---|
/mssp/entities/user-groups/v2 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
ids |
|
|
query | string or list of strings | User Group IDs to search for. The keyword user_group_ids will also be accepted for this argument. |
parameters |
|
|
query | dictionary | Full query string parameters payload in JSON format. |
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)
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)
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
Query for customers linked as children
query_children
Method | Route |
---|---|
/mssp/queries/children/v1 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
limit |
|
|
query | integer | Maximum number of records to return. (Max: 1000, Default: 10) |
filter |
|
|
query | string |
FQL filter used to limit the results returned. Supported filters: cid . |
offset |
|
|
query | integer | Starting index of overall result set from which to return ids. |
sort |
|
|
query | string | The property to sort by. (Ex: last_modified_timestamp|desc) |
parameters |
|
|
query | dictionary | Full query string parameters payload in JSON format. |
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)
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)
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
Query a CID Groups members by associated CID.
query_cid_group_members
Method | Route |
---|---|
/mssp/queries/cid-group-members/v1 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
cid |
|
|
query | string | CID to lookup associated CID group for. |
limit |
|
|
query | integer | Maximum number of records to return. (Max: 1000, Default: 10) |
offset |
|
|
query | integer | Starting index of overall result set from which to return ids. |
sort |
|
|
query | string | The property to sort by. (Ex: last_modified_timestamp|desc) |
parameters |
|
|
query | dictionary | Full query string parameters payload in JSON format. |
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)
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)
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
Query CID Groups.
query_cid_groups
Method | Route |
---|---|
/mssp/queries/cid-groups/v1 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
name |
|
|
query | string | Name to lookup groups for. |
limit |
|
|
query | integer | Maximum number of records to return. (Max: 1000, Default: 10) |
offset |
|
|
query | integer | Starting index of overall result set from which to return ids. |
sort |
|
|
query | string | The property to sort by. (Ex: last_modified_timestamp|desc) |
parameters |
|
|
query | dictionary | Full query string parameters payload in JSON format. |
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)
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)
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
Query MSSP Role assignment. At least one of CID Group ID or User Group ID should also be provided. Role ID is optional.
query_roles
Method | Route |
---|---|
/mssp/queries/mssp-roles/v1 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
user_uuid |
|
|
query | string | User Group ID to fetch MSSP role for. |
cid_group_id |
|
|
query | string | CID Group ID to fetch MSSP role for. |
role_id |
|
|
query | string | Role ID to fetch MSSP role for. |
limit |
|
|
query | integer | Maximum number of records to return. (Max: 1000, Default: 10) |
offset |
|
|
query | integer | Starting index of overall result set from which to return ids. |
sort |
|
|
query | string | The property to sort by. (Ex: last_modified_timestamp|desc) |
parameters |
|
|
query | dictionary | Full query string parameters payload in JSON format. |
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)
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)
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
Query User Group member by User UUID.
query_user_group_members
Method | Route |
---|---|
/mssp/queries/user-group-members/v1 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
user_uuid |
|
|
query | string | User UUID to lookup associated User Group ID. |
limit |
|
|
query | integer | Maximum number of records to return. (Max: 1000, Default: 10) |
offset |
|
|
query | integer | Starting index of overall result set from which to return ids. |
sort |
|
|
query | string | The property to sort by. (Ex: last_modified_timestamp|desc) |
parameters |
|
|
query | dictionary | Full query string parameters payload in JSON format. |
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)
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)
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
Query User Groups.
query_user_groups
Method | Route |
---|---|
/mssp/queries/user-groups/v1 |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
name |
|
|
query | string | Name to lookup groups for. |
limit |
|
|
query | integer | Maximum number of records to return. (Max: 1000, Default: 10) |
offset |
|
|
query | integer | Starting index of overall result set from which to return ids. |
sort |
|
|
query | string | The property to sort by. (Ex: last_modified_timestamp|desc) |
parameters |
|
|
query | dictionary | Full query string parameters payload in JSON format. |
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)
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)
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