CrowdStrike Falcon Twitter URL

Using the Mobile Enrollment service collection

Uber class support Service class support Documentation Version Page Updated

Table of Contents

Operation IDDescription
RequestDeviceEnrollmentV3
PEP 8device_enroll
Gets the registry credentials

Passing credentials

WARNING

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

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

RequestDeviceEnrollmentV3

Trigger on-boarding process for a mobile device.

PEP8 method name

device_enroll

Content-Type

  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
action_name
Service Class Support

Uber Class Support
querystringAction to perform.
Allowed values: enroll, re-enroll.
body
Service Class Support

Uber Class Support
bodydictionaryFull body payload in JSON format, not required when using other keywords.
email_addresses
Service Class Support

Uber Class Support
bodystring or list of stringsUser 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
bodystringExpiration date for the enrollment. UTC date format.
filter
Service Class Support

Uber Class Support
querystringFQL formatted filter.
parameters
Service Class Support

Uber Class Support
querydictionaryFull query parameters payload in JSON format, 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 = "address@somewhere.com,address2@somewhere.com"

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 = "address@somewhere.com,address2@somewhere.com"

response = falcon.RequestDeviceEnrollmentV3(action_name="string",
                                            email_addresses=emails,
                                            expires_at="string",
                                            filter="string"
                                            )
print(response)
Uber class example
from falconpy import APIHarness

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

emails = ["address@somewhere.com", "address2@somewhere.com"]

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