pycti.entities.opencti_grouping

Classes

Grouping

Main Grouping class for OpenCTI

Module Contents

class pycti.entities.opencti_grouping.Grouping(opencti)[source]

Main Grouping class for OpenCTI

Manages STIX grouping objects in the OpenCTI platform.

Parameters:: opencti (OpenCTIApiClient) – instance of OpenCTIApiClient

Initialize the Grouping instance.

Parameters:: opencti (OpenCTIApiClient) – OpenCTI API client instance

opencti[source]

properties = Multiline-String[source]

Show Value

"""
            id
            standard_id
            entity_type
            parent_types
            spec_version
            created_at
            updated_at
            status {
                id
                template {
                  id
                  name
                  color
                }
            }
            createdBy {
                ... on Identity {
                    id
                    standard_id
                    entity_type
                    parent_types
                    spec_version
                    identity_class
                    name
                    description
                    roles
                    contact_information
                    x_opencti_aliases
                    created
                    modified
                    objectLabel {
                        id
                        value
                        color
                    }
                }
                ... on Organization {
                    x_opencti_organization_type
                    x_opencti_reliability
                }
                ... on Individual {
                    x_opencti_firstname
                    x_opencti_lastname
                }
            }
            objectOrganization {
                id
                standard_id
                name
            }
            objectMarking {
                id
                standard_id
                entity_type
                definition_type
                definition
                created
                modified
                x_opencti_order
                x_opencti_color
            }
            objectLabel {
                id
                value
                color
            }
            externalReferences {
                edges {
                    node {
                        id
                        standard_id
                        entity_type
                        source_name
                        description
                        url
                        hash
                        external_id
                        created
                        modified
                    }
                }
            }
            revoked
            confidence
            created
            modified
            name
            description
            context
            x_opencti_aliases
            objects(all: true) {
                edges {
                    node {
                        ... on BasicObject {
                            id
                            entity_type
                            parent_types
                        }
                        ... on BasicRelationship {
                            id
                            entity_type
                            parent_types
                        }
                        ... on StixObject {
                            standard_id
                            spec_version
                            created_at
                            updated_at
                        }
                        ... on AttackPattern {
                            name
                        }
                        ... on Campaign {
                            name
                        }
                        ... on CourseOfAction {
                            name
                        }
                        ... on Individual {
                            name
                        }
                        ... on Organization {
                            name
                        }
                        ... on Sector {
                            name
                        }
                        ... on System {
                            name
                        }
                        ... on Indicator {
                            name
                        }
                        ... on Infrastructure {
                            name
                        }
                        ... on IntrusionSet {
                            name
                        }
                        ... on Position {
                            name
                        }
                        ... on City {
                            name
                        }
                        ... on Country {
                            name
                        }
                        ... on Region {
                            name
                        }
                        ... on Malware {
                            name
                        }
                        ... on ThreatActor {
                            name
                        }
                        ... on Tool {
                            name
                        }
                        ... on Vulnerability {
                            name
                        }
                        ... on Incident {
                            name
                        }
                        ... on StixCyberObservable {
                            observable_value
                        }
                        ... on StixCoreRelationship {
                            standard_id
                            spec_version
                            created_at
                            updated_at
                            relationship_type
                        }
                       ... on StixSightingRelationship {
                            standard_id
                            spec_version
                            created_at
                            updated_at
                        }
                    }
                }
            }
        """

properties_with_files = Multiline-String[source]

Show Value

"""
            id
            standard_id
            entity_type
            parent_types
            spec_version
            created_at
            updated_at
            status {
                id
                template {
                  id
                  name
                  color
                }
            }
            createdBy {
                ... on Identity {
                    id
                    standard_id
                    entity_type
                    parent_types
                    spec_version
                    identity_class
                    name
                    description
                    roles
                    contact_information
                    x_opencti_aliases
                    created
                    modified
                    objectLabel {
                        id
                        value
                        color
                    }
                }
                ... on Organization {
                    x_opencti_organization_type
                    x_opencti_reliability
                }
                ... on Individual {
                    x_opencti_firstname
                    x_opencti_lastname
                }
            }
            objectOrganization {
                id
                standard_id
                name
            }
            objectMarking {
                id
                standard_id
                entity_type
                definition_type
                definition
                created
                modified
                x_opencti_order
                x_opencti_color
            }
            objectLabel {
                id
                value
                color
            }
            externalReferences {
                edges {
                    node {
                        id
                        standard_id
                        entity_type
                        source_name
                        description
                        url
                        hash
                        external_id
                        created
                        modified
                        importFiles {
                            edges {
                                node {
                                    id
                                    name
                                    size
                                    metaData {
                                        mimetype
                                        version
                                    }
                                }
                            }
                        }
                    }
                }
            }
            revoked
            confidence
            created
            modified
            name
            description
            context
            x_opencti_aliases
            objects(all: true) {
                edges {
                    node {
                        ... on BasicObject {
                            id
                            entity_type
                            parent_types
                        }
                        ... on BasicRelationship {
                            id
                            entity_type
                            parent_types
                        }
                        ... on StixObject {
                            standard_id
                            spec_version
                            created_at
                            updated_at
                        }
                        ... on AttackPattern {
                            name
                        }
                        ... on Campaign {
                            name
                        }
                        ... on CourseOfAction {
                            name
                        }
                        ... on Individual {
                            name
                        }
                        ... on Organization {
                            name
                        }
                        ... on Sector {
                            name
                        }
                        ... on System {
                            name
                        }
                        ... on Indicator {
                            name
                        }
                        ... on Infrastructure {
                            name
                        }
                        ... on IntrusionSet {
                            name
                        }
                        ... on Position {
                            name
                        }
                        ... on City {
                            name
                        }
                        ... on Country {
                            name
                        }
                        ... on Region {
                            name
                        }
                        ... on Malware {
                            name
                        }
                        ... on ThreatActor {
                            name
                        }
                        ... on Tool {
                            name
                        }
                        ... on Vulnerability {
                            name
                        }
                        ... on Incident {
                            name
                        }
                        ... on StixCyberObservable {
                            observable_value
                        }
                        ... on StixCoreRelationship {
                            standard_id
                            spec_version
                            created_at
                            updated_at
                            relationship_type
                        }
                       ... on StixSightingRelationship {
                            standard_id
                            spec_version
                            created_at
                            updated_at
                        }
                    }
                }
            }
            importFiles {
                edges {
                    node {
                        id
                        name
                        size
                        metaData {
                            mimetype
                            version
                        }
                        objectMarking {
                            id
                            standard_id
                            entity_type
                            definition_type
                            definition
                            created
                            modified
                            x_opencti_order
                            x_opencti_color
                        }
                    }
                }
            }
        """

static generate_id(name, context, created=None)[source]

Generate a STIX ID for a Grouping.

Parameters:

name (str) – The name of the grouping
context (str) – The grouping context
created (datetime or str or None) – Optional creation date

Returns:

STIX ID for the grouping

Return type:

str

static generate_id_from_data(data)[source]

Generate a STIX ID from grouping data.

Parameters:: data (dict) – Dictionary containing ‘name’, ‘context’, and ‘created’ keys
Returns:: STIX ID for the grouping
Return type:: str

list(**kwargs)[source]

List Grouping objects.

Parameters:

filters (dict) – the filters to apply
search (str) – the search keyword
first (int) – return the first n rows from the after ID (or the beginning if not set)
after (str) – ID of the first row for pagination
orderBy (str) – field to order results by
orderMode (str) – ordering mode (asc/desc)
customAttributes (list) – custom attributes to return
getAll (bool) – whether to retrieve all results
withPagination (bool) – whether to include pagination info
withFiles (bool) – whether to include files

Returns:

List of Grouping objects

Return type:

list

read(**kwargs)[source]

Read a Grouping object.

Parameters:

id (str) – the id of the Grouping
filters (dict) – the filters to apply if no id provided
customAttributes (list) – custom attributes to return
withFiles (bool) – whether to include files

Returns:

Grouping object

Return type:

dict or None

get_by_stix_id_or_name(**kwargs)[source]

Read a Grouping object by stix_id or name.

Parameters:

stix_id (str) – the STIX ID of the Grouping
name (str) – the name of the Grouping
context (str) – the context of the Grouping
customAttributes (list) – custom attributes to return

Returns:

Grouping object

Return type:

dict or None

contains_stix_object_or_stix_relationship(**kwargs)[source]

Check if a grouping already contains a thing (Stix Object or Stix Relationship).

Parameters:

id (str) – the id of the Grouping
stixObjectOrStixRelationshipId (str) – the id of the Stix-Entity

Returns:

Boolean

Return type:

bool

create(**kwargs)[source]

Create a Grouping object.

Parameters:

stix_id (str) – (optional) the STIX ID
createdBy (str) – (optional) the author ID
objects (list) – (optional) list of STIX object IDs
objectMarking (list) – (optional) list of marking definition IDs
objectLabel (list) – (optional) list of label IDs
externalReferences (list) – (optional) list of external reference IDs
revoked (bool) – (optional) whether the grouping is revoked
confidence (int) – (optional) confidence level (0-100)
lang (str) – (optional) language
created (datetime) – (optional) creation date
modified (datetime) – (optional) modification date
name (str) – the name of the Grouping (required)
context (str) – the grouping context (required)
content (str) – (optional) content
description (str) – (optional) description
x_opencti_aliases (list) – (optional) list of aliases
x_opencti_stix_ids (list) – (optional) list of additional STIX IDs
objectOrganization (list) – (optional) list of organization IDs
x_opencti_workflow_id (str) – (optional) workflow ID
x_opencti_modified_at (datetime) – (optional) custom modification date
update (bool) – (optional) whether to update if exists (default: False)
files (list) – (optional) list of File objects to attach
filesMarkings (list) – (optional) list of lists of marking definition IDs for each file

Returns:

Grouping object

Return type:

dict or None

add_stix_object_or_stix_relationship(**kwargs)[source]

Add a Stix-Entity object to Grouping object (object_refs).

Parameters:

id (str) – the id of the Grouping
stixObjectOrStixRelationshipId (str) – the id of the Stix-Entity

Returns:

Boolean

Return type:

bool

remove_stix_object_or_stix_relationship(**kwargs)[source]

Remove a Stix-Entity object from Grouping object (object_refs).

Parameters:

id (str) – the id of the Grouping
stixObjectOrStixRelationshipId (str) – the id of the Stix-Entity

Returns:

Boolean

Return type:

bool

import_from_stix2(**kwargs)[source]

Import a Grouping object from a STIX2 object.

Parameters:

stixObject (dict) – the Stix-Object Grouping
extras (dict) – extra dict
update (bool) – set the update flag on import

Returns:

Grouping object

Return type:

dict or None