Skip to content

Cloud OCI Registration

The Cloud OCI Registration service collection provides operations for registering and managing Oracle Cloud Infrastructure (OCI) tenancies in CrowdStrike Falcon CSPM. Create, update, delete, and validate OCI tenancy accounts, rotate keys, and retrieve setup scripts.

LanguageLast Update
Pythonv1.6.5
PowerShell
Gov0.22.0
TypeScriptv0.6.0
Rustv0.7.1
Rubyv1.4.0


OperationDescription
cloud-security-registration-oci-create-account
create_account
Create OCI tenancy account in CSPM
cloud-security-registration-oci-delete-account
delete_account
Delete an existing OCI tenancy in CSPM.
cloud-security-registration-oci-download-script
download_script
Retrieve script to create resources in tenancy OCID
cloud-security-registration-oci-get-account
get_account
Retrieve a list of OCI tenancies with support for FQL filtering, sorting, and pagination
cloud-security-registration-oci-rotate-key
rotate_key
Refresh key for the OCI Tenancy
cloud-security-registration-oci-update-account
update_account
Patch an existing OCI account in our system for a customer.
cloud-security-registration-oci-validate-tenancy
validate_tenancy
Validate the OCI account in CSPM for a provided CID.

cloud-security-registration-oci-create-account

Section titled “cloud-security-registration-oci-create-account”

Create OCI tenancy account in CSPM

Method POST
Route /cloud-security-registration-oci/entities/accounts/v1
Scope Cloud Security OCI Registration: WRITE
PEP 8 create_account
body body · dictionary
Full body payload as JSON formatted dictionary.
resources body · array
group_name body · string
OCI group name.
home_region body · string
OCI home region.
policy_name body · string
Policy name.
products body · list of dictionaries
OCI products.
tenancy_ocid body · string
OCI tenancy ID.
user_email body · string
User email address.
user_name body · string
OCI user name.
from falconpy import CloudOCIRegistration
falcon = CloudOCIRegistration(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
products = [
{
"features": [
{
"deployment_method": "string",
"feature": "string",
"is_enabled": True,
"persona": "string",
"registration_detailed_status": "string"
}
],
"product": "string"
}
]
response = falcon.create_account(group_name="string",
home_region="string",
policy_name="string",
products=products,
tenancy_ocid="string",
user_email="string",
user_name="string")
print(response)
[
{
"cid": "string",
"tenancy_ocid": "string"
}
]


cloud-security-registration-oci-delete-account

Section titled “cloud-security-registration-oci-delete-account”

Delete an existing OCI tenancy in CSPM.

Method DELETE
Route /cloud-security-registration-oci/entities/accounts/v1
Scope Cloud Security OCI Registration: WRITE
PEP 8 delete_account
ids query · string or list of strings
OCI tenancy ocids to remove
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CloudOCIRegistration
falcon = CloudOCIRegistration(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_account(ids=id_list)
print(response)
{
"errors": [
{
"code": 0,
"id": "string",
"message": "string"
}
],
"meta": {
"pagination": {
"limit": 0,
"offset": 0,
"total": 0
},
"powered_by": "string",
"query_time": 0.0,
"trace_id": "string",
"writes": {
"resources_affected": 0
}
}
}


cloud-security-registration-oci-download-script

Section titled “cloud-security-registration-oci-download-script”

Retrieve script to create resources in tenancy OCID

Method POST
Route /cloud-security-registration-oci/entities/scripts/v1
Scope Cloud Security OCI Registration: READ
PEP 8 download_script
body body · dictionary
Full body payload as JSON formatted dictionary.
resources body · array
deployment_method body · string
Deployment method.
is_download body · boolean
Flag indicating if the script is intended for download.
tenancy_ocid body · string
OCI tenancy ID.
from falconpy import CloudOCIRegistration
falcon = CloudOCIRegistration(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.download_script(deployment_method="string",
is_download=boolean,
tenancy_ocid="string")
print(response)
[
{
"cid": "string",
"stack_url": "string",
"tenancy_ocid": "string",
"version": "string",
"zip_url": "string"
}
]


cloud-security-registration-oci-get-account

Section titled “cloud-security-registration-oci-get-account”

Retrieve a list of OCI tenancies with support for FQL filtering, sorting, and pagination

Method GET
Route /cloud-security-registration-oci/combined/accounts/v1
Scope Cloud Security OCI Registration: READ
PEP 8 get_account
filter query · string
FQL (Falcon Query Language) string for filtering results. Allowed filters are:
Available values (8)
tenancy_namehome_regionkey_age
overall_statuscreated_atupdated_at
registration_nametenancy_ocid
sort query · string
Field and direction for sorting results - allowed sort fields are Set{created_at, updated_at, registration_name, tenancy_ocid, tenancy_name, home_region, key_age, overall_status}
Available values (7)
home_regionkey_ageoverall_status
created_atupdated_attenancy_ocid
tenancy_name
next_token query · string
Token for cursor-based pagination. Currently unsupported.
limit query · integer
Maximum number of records to return (default: 100, max: 10000)
offset query · integer
Starting index of result
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CloudOCIRegistration
falcon = CloudOCIRegistration(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.get_account(filter="string",
sort="string",
next_token="string",
limit=integer,
offset=integer)
print(response)
[
{
"cid": "string",
"cloud_registration_enabled": false,
"conditions": [],
"created_at": "string",
"cspm_enabled": false,
"finger_print": "string",
"group_name": "string",
"group_ocid": "string",
"home_region": "string",
"is_connected": false,
"key_age": 0,
"overall_status": "string",
"policy_name": "string",
"policy_ocid": "string",
"private_key": "string",
"products": {},
"public_key": "string",
"registration_description": "string",
"registration_id": "string",
"registration_name": "string",
"stack_name": "string",
"stack_ocid": "string",
"tenancy_name": "string",
"tenancy_ocid": "string",
"updated_at": "string",
"user_email": "string",
"user_name": "string",
"user_ocid": "string"
}
]


cloud-security-registration-oci-rotate-key

Section titled “cloud-security-registration-oci-rotate-key”

Refresh key for the OCI Tenancy

Method POST
Route /cloud-security-registration-oci/entities/account-rotate-keys/v1
Scope Cloud Security OCI Registration: WRITE
PEP 8 rotate_key
body body · dictionary
Full body payload as JSON formatted dictionary.
resources body · array
tenancy_ocid body · string
OCI tenancy ID.
from falconpy import CloudOCIRegistration
falcon = CloudOCIRegistration(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.rotate_key(tenancy_ocid="string")
print(response)
[
{
"cid": "string",
"finger_print": "string",
"public_key": "string",
"tenancy_ocid": "string"
}
]


cloud-security-registration-oci-update-account

Section titled “cloud-security-registration-oci-update-account”

Patch an existing OCI account in our system for a customer.

Method PATCH
Route /cloud-security-registration-oci/entities/accounts/v1
Scope Cloud Security OCI Registration: WRITE
PEP 8 update_account
body body · dictionary
Full body payload as JSON formatted dictionary.
resources body · array
group_name body · string
OCI group name.
home_region body · string
OCI home region.
policy_name body · string
Policy name.
products body · list of dictionaries
OCI products.
stack_ocid body · string
OCI stack ID.
tenancy_ocid body · string
OCI tenancy ID.
user_email body · string
User email address.
user_name body · string
OCI user name.
user_ocid body · string
OCI user ID.
from falconpy import CloudOCIRegistration
falcon = CloudOCIRegistration(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
products = [
{
"features": [
{
"deployment_method": "string",
"feature": "string",
"is_enabled": True,
"persona": "string",
"registration_detailed_status": "string"
}
],
"product": "string"
}
]
response = falcon.update_account(group_name="string",
home_region="string",
policy_name="string",
products=products,
stack_ocid="string",
tenancy_ocid="string",
user_email="string",
user_name="string",
user_ocid="string")
print(response)
[
{
"cid": "string",
"cloud_registration_enabled": false,
"conditions": [],
"created_at": "string",
"cspm_enabled": false,
"finger_print": "string",
"group_name": "string",
"group_ocid": "string",
"home_region": "string",
"is_connected": false,
"key_age": 0,
"overall_status": "string",
"policy_name": "string",
"policy_ocid": "string",
"private_key": "string",
"products": {},
"public_key": "string",
"registration_description": "string",
"registration_id": "string",
"registration_name": "string",
"stack_name": "string",
"stack_ocid": "string",
"tenancy_name": "string",
"tenancy_ocid": "string",
"updated_at": "string",
"user_email": "string",
"user_name": "string",
"user_ocid": "string"
}
]


cloud-security-registration-oci-validate-tenancy

Section titled “cloud-security-registration-oci-validate-tenancy”

Validate the OCI account in CSPM for a provided CID.

Method POST
Route /cloud-security-registration-oci/entities/account-validate/v1
Scope Cloud Security OCI Registration: WRITE
PEP 8 validate_tenancy
body body · dictionary
Full body payload as JSON formatted dictionary.
resources body · array
products body · list of dictionaries
OCI products to validate.
tenancy_ocid body · string
OCI tenancy ID.
from falconpy import CloudOCIRegistration
falcon = CloudOCIRegistration(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
products = [
{
"features": [
"string"
],
"product": "string"
}
]
response = falcon.validate_tenancy(products=products, tenancy_ocid="string")
print(response)
[
{
"cid": "string",
"home_region": "string",
"overall_status": "string",
"products": {},
"tenancy_ocid": "string"
}
]