Mobile Enrollment - CrowdStrike/falconpy GitHub Wiki

CrowdStrike Falcon CrowdStrike Subreddit

Using the Mobile Enrollment service collection

Uber class support Service class support Documentation Version Page Updated

Table of Contents

Operation ID Description
RequestDeviceEnrollmentV3
PEP 8 device_enroll
Gets the registry credentials
RequestDeviceEnrollmentV4
PEP 8 device_enroll_v4
Gets the registry credentials

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.

RequestDeviceEnrollmentV3

Trigger on-boarding process for a mobile device.

PEP8 method name

device_enroll

Endpoint

Method Route
POST /enrollments/entities/details/v3

Required Scope

mobile-enrollment:write

Content-Type

  • Produces: application/json

Keyword Arguments

Name Service Uber Type Data type Description
action_name
Service Class Support
Uber Class Support
 query string Action to perform.
Allowed values: enroll, re-enroll.
body
Service Class Support
Uber Class Support
 body dictionary Full body payload as a dictionary, not required when using other keywords.
email_addresses
Service Class Support
Uber Class Support
 body string or list of strings User IDs to apply actions to. Supports comma-delimited strings. Must be provided as a keyword or as part of the body payload.
expires_at
Service Class Support
Uber Class Support
 body string Expiration date for the enrollment. UTC date format.
filter
Service Class Support
Uber Class Support
 query string FQL formatted filter.
parameters
Service Class Support
Uber Class Support
 query dictionary Full query parameters payload as a dictionary, not required when using other keywords.

Usage

Service class example (PEP8 syntax)
from falconpy import MobileEnrollment

# Do not hardcode API credentials!
falcon = MobileEnrollment(client_id=CLIENT_ID_HERE,
                          client_secret=CLIENT_SECRET
                          )

emails = "[email protected],[email protected]"

response = falcon.device_enroll(action_name="string",
                                email_addresses=emails,
                                expires_at="string",
                                filter="string"
                                )
print(response)
Service class example (Operation ID syntax)
from falconpy import MobileEnrollment

# Do not hardcode API credentials!
falcon = MobileEnrollment(client_id=CLIENT_ID_HERE,
                          client_secret=CLIENT_SECRET
                          )

emails = "[email protected],[email protected]"

response = falcon.RequestDeviceEnrollmentV3(action_name="string",
                                            email_addresses=emails,
                                            expires_at="string",
                                            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
                      )

emails = ["[email protected]", "[email protected]"]

body_payload = {
    "email_address": emails,
    "expires_at": "string"
}
response = falcon.command("RequestDeviceEnrollmentV3",
                          action_name="string",
                          filter="string",
                          body=body_payload
                          )
print(response)

RequestDeviceEnrollmentV4

Trigger on-boarding process for a mobile device.

PEP8 method name

device_enroll_v4

Endpoint

Method Route
POST /enrollments/entities/details/v3

Required Scope

mobile-enrollment:write

Content-Type

  • Produces: application/json

Keyword Arguments

Name Service Uber Type Data type Description
action_name
Service Class Support
Uber Class Support
 query string Action to perform.
Allowed values: enroll, re-enroll.
body
Service Class Support
Uber Class Support
 body dictionary Full body payload as a dictionary, not required when using other keywords.
email_addresses
Service Class Support
Uber Class Support
 body string or list of strings User IDs to apply actions to. Supports comma-delimited strings. Must be provided as a keyword or as part of the body payload.
enrollment_type
Service Class Support
Uber Class Support
 body string Type of mobile enrollment.
expires_at
Service Class Support
Uber Class Support
 body string Expiration date for the enrollment. UTC date format.
filter
Service Class Support
Uber Class Support
 query string FQL formatted filter.
parameters
Service Class Support
Uber Class Support
 query dictionary Full query parameters payload as a dictionary, not required when using other keywords.

Usage

Service class example (PEP8 syntax)
from falconpy import MobileEnrollment

# Do not hardcode API credentials!
falcon = MobileEnrollment(client_id=CLIENT_ID_HERE,
                          client_secret=CLIENT_SECRET
                          )

emails = "[email protected],[email protected]"

response = falcon.device_enroll(action_name="string",
                                email_addresses=emails,
                                enrollment_type="string",
                                expires_at="string",
                                filter="string"
                                )
print(response)
Service class example (Operation ID syntax)
from falconpy import MobileEnrollment

# Do not hardcode API credentials!
falcon = MobileEnrollment(client_id=CLIENT_ID_HERE,
                          client_secret=CLIENT_SECRET
                          )

emails = "[email protected],[email protected]"

response = falcon.RequestDeviceEnrollmentV3(action_name="string",
                                            email_addresses=emails,
                                            enrollment_type="string",
                                            expires_at="string",
                                            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
                      )

emails = ["[email protected]", "[email protected]"]

body_payload = {
    "email_address": emails,
    "enrollment_type": "string"
    "expires_at": "string"
}
response = falcon.command("RequestDeviceEnrollmentV3",
                          action_name="string",
                          filter="string",
                          body=body_payload
                          )
print(response)

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