[client] Add administrative entities and functionality by peritz · Pull Request #816 · OpenCTI-Platform/client-python

peritz · 2025-01-27T16:48:31Z

Proposed changes

Addition of administrative entities such as:
- Settings
- User
- Group
- Role
- Capability
Updating documentation to autodoc class members for entity classes
Perform cleanup of test entities in the event that tests fail (important when testing User, since you cannot create a user that already exists)

Related issues

None that I'm aware of

Checklist

I consider the submitted work as finished
I tested the code for its functionality
I wrote test cases for the relevant uses case
I added/update the relevant documentation (either on github or on notion)
Where necessary I refactored code to improve the overall quality

Further comments

The rationale behind adding administrative functionality is to allow scripts to be more easily created which manage the platform in a programatic fashion, such as to create users for connectors as part of a Terraform module, or automatic rotation of user API tokens for service accounts.

This can be achieved through the GraphQL queries, but by including these in the library we reduce the code overhead and can take advantage of existing session management code in the API client. It also reduces the barrier to entry for those looking to create administrative tooling.

Addition of all administrative functionality is not complete. Currently, only user, group, role, and settings management has been included.

In the future I'd also like to include entities for managing vocabularies, entity settings, etc.

…form#457)

… #6835)

marieflorescontact

Hi @peritz,
I've started to review your code. I've made some comments. I'll go further next week 🙂
thank you for your submission!!!

marieflorescontact · 2025-01-30T15:10:19Z

pycti/entities/opencti_group.py

+        orderMode = kwargs.get("orderMode", None)
+        search = kwargs.get("search", None)
+        filters = kwargs.get("filters", None)
+        customAttributes = kwargs.get("customAttributes", None)


Suggested change

customAttributes = kwargs.get("customAttributes", None)

custom_attributes = kwargs.get("customAttributes", None)

we prefer to use snake_case for variable name

Fixed this in all new entities

marieflorescontact · 2025-01-30T15:43:21Z

pycti/entities/opencti_group.py

+        )
+        query = (
+            """
+            mutation MarkingForbid($groupId: ID!, $markingId: StixRef!) {


Suggested change

mutation MarkingForbid($groupId: ID!, $markingId: StixRef!) {

mutation GroupEditMarkingRemove($groupId: ID!, $markingId: StixRef!) {

or GroupEditRemoveRelation=> something staring w/ GroupEdit

Updated query names to include Edit for each relevant query

pycti/entities/opencti_capability.py

pycti/entities/opencti_group.py

marieflorescontact · 2025-01-30T18:26:33Z

tests/02-integration/entities/test_entity_crud.py


-    entity_class.base_class().delete(id=test_indicator["id"])
+    finally:
+        entity_class.base_class().delete(id=test_indicator["id"])


Using finally can be a problem:
The finally block is always executed, whether or not the assertion fails.
The solution would be to add a check before accessing test_indicator[‘id’] in finally :

finally: if test_indicator and "id" in test_indicator: entity_class.base_class().delete(id=test_indicator["id"])

Updated to check existence of entities before deletions in entity crud tests

peritz · 2025-01-31T11:08:41Z

@marieflorescontact I've updated the PR with changes you suggested, looking forward to the rest of the review :)

marieflorescontact

last "snake_case" comments :)

functionnaly tested ok User / Group / Role APIs
I will test the Setting part during the next days 🙂

marieflorescontact · 2025-02-03T14:25:02Z

pycti/entities/opencti_user.py

+            entity_type
+            parent_types
+            created_at
+            updated_at


created_at and updated_at should be removed (there are User properties but not on Me type)

marieflorescontact · 2025-02-03T17:26:29Z

pycti/entities/opencti_role.py

+        first = kwargs.get("first", 500)
+        after = kwargs.get("after", None)
+        orderBy = kwargs.get("orderBy", None)
+        orderMode = kwargs.get("orderMode", None)


Suggested change

orderMode = kwargs.get("orderMode", None)

order_mode = kwargs.get("orderMode", None)

marieflorescontact · 2025-02-03T17:26:57Z

pycti/entities/opencti_role.py

+        search = kwargs.get("search", None)
+        first = kwargs.get("first", 500)
+        after = kwargs.get("after", None)
+        orderBy = kwargs.get("orderBy", None)


Suggested change

orderBy = kwargs.get("orderBy", None)

order_by = kwargs.get("orderBy", None)

marieflorescontact · 2025-02-03T17:27:37Z

pycti/entities/opencti_group.py

+        """
+        first = kwargs.get("first", 500)
+        after = kwargs.get("after", None)
+        orderBy = kwargs.get("orderBy", None)


Suggested change

orderBy = kwargs.get("orderBy", None)

order_by = kwargs.get("orderBy", None)

marieflorescontact · 2025-02-03T17:28:07Z

pycti/entities/opencti_group.py

+        first = kwargs.get("first", 500)
+        after = kwargs.get("after", None)
+        orderBy = kwargs.get("orderBy", None)
+        orderMode = kwargs.get("orderMode", None)


Suggested change

orderMode = kwargs.get("orderMode", None)

order_mode = kwargs.get("orderMode", None)

marieflorescontact · 2025-02-03T17:28:57Z

pycti/entities/opencti_group.py

+        filters = kwargs.get("filters", None)
+        custom_attributes = kwargs.get("customAttributes", None)
+        getAll = kwargs.get("getAll", False)
+        withPagination = kwargs.get("withPagination", False)


Suggested change

withPagination = kwargs.get("withPagination", False)

with_pagination = kwargs.get("withPagination", False)

marieflorescontact · 2025-02-03T17:29:33Z

pycti/entities/opencti_role.py

+        orderBy = kwargs.get("orderBy", None)
+        orderMode = kwargs.get("orderMode", None)
+        custom_attributes = kwargs.get("customAttributes", None)
+        getAll = kwargs.get("getAll", False)


Suggested change

getAll = kwargs.get("getAll", False)

get_all = kwargs.get("getAll", False)

marieflorescontact · 2025-02-03T17:31:06Z

pycti/entities/opencti_user.py

+        """
+        first = kwargs.get("first", 500)
+        after = kwargs.get("after", None)
+        orderBy = kwargs.get("orderBy", "name")


Suggested change

orderBy = kwargs.get("orderBy", "name")

order_by = kwargs.get("orderBy", "name")

marieflorescontact · 2025-02-03T17:31:16Z

pycti/entities/opencti_user.py

+        first = kwargs.get("first", 500)
+        after = kwargs.get("after", None)
+        orderBy = kwargs.get("orderBy", "name")
+        orderMode = kwargs.get("orderMode", "asc")


Suggested change

orderMode = kwargs.get("orderMode", "asc")

order_mode = kwargs.get("orderMode", "asc")

marieflorescontact · 2025-02-03T17:31:28Z

pycti/entities/opencti_user.py

+        search = kwargs.get("search", None)
+        include_sessions = kwargs.get("include_sessions", False)
+        custom_attributes = kwargs.get("customAttributes", None)
+        getAll = kwargs.get("getAll", False)


Suggested change

getAll = kwargs.get("getAll", False)

get_all = kwargs.get("getAll", False)

marieflorescontact · 2025-02-07T09:32:42Z

pycti/entities/opencti_capability.py

+        self.opencti = opencti
+        self.properties = """
+            id
+            entity_type


missing standard_id

marieflorescontact · 2025-02-07T09:36:43Z

pycti/entities/opencti_group.py

+            standard_id
+            name
+            description
+


Not a big deal but for queries prefer to group all properties without empty line

marieflorescontact · 2025-02-07T10:05:36Z

pycti/entities/opencti_group.py

+                    }
+                }
+
+                fragment GroupEditionMarkings_group on Group {


we can remove the fragment and use same thing that in add_member API

marieflorescontact · 2025-02-07T10:31:31Z

pycti/entities/opencti_settings.py

+
+            created_at
+            updated_at
+            enterprise_edition


enterprise_edition has been removed in OpenCTI 6.5 freshly released, replaced by platform_enterprise_edition

richard-julien · 2025-02-11T11:19:26Z

Will merge that in a branch and fix the latest comments.
Thanks for your PR @peritz

peritz · 2025-02-13T10:10:49Z

Apologies I was out of office there for a time, thanks @richard-julien for the fixes and @marieflorescontact for the review

marieflorescontact · 2025-02-13T10:12:43Z

Thanks for your contribution @peritz !!!! 🙂👌

peritz and others added 25 commits January 16, 2025 17:56

Add Role and Capability entity

bf721e9

Add Group entity to the library

2ba0aa4

Add capability test to Role object

4533f79

Add User entity

c0281c6

Add membership tests for Group entity

62200af

Add capabilities test for Role entity

3f8868b

Add tests for Settings entity

0c7fa48

Add Settings entity stub to fail tests

3defc31

Add Settings entity

f88ebd9

Standardise admin entities to use kwargs approach

ed445ca

Remove unused import from entities test cases

ebc0102

Add cleanup code to CRUD tests

a2b0d1b

Update documentation for new administrative entities

917459f

Remove harcoded first value when getting all indicators (OpenCTI-Plat…

d5f67b1

…form#457)

[client] Reverse the marking definition ID generation arguments

1137009

[client] Release 6.4.8

3682d60

[client] Fix marking definition ID generation

d7c79c3

[client] remove default confidence value of 15 for sightings (opencti…

92167ff

… #6835)

[client] Hide Authorization header (opencti/9693)

0c2c466

Allow customAttributes for listing capabilities

5b472db

Remove ambiguous first parameter to capabilities query

901bd7b

Move test stubs for Settings to entities test file

fa1d099

Correct minor issues around typing and args convention

7bf2aca

Merge branch 'OpenCTI-Platform:master' into feature/admin

7227004

Sort imports using isort

1b90773

peritz force-pushed the feature/admin branch from 6ad48a7 to 1b90773 Compare January 27, 2025 16:54

Format files with black

901905e

marieflorescontact self-requested a review January 29, 2025 11:19

marieflorescontact self-assigned this Jan 29, 2025

marieflorescontact reviewed Jan 30, 2025

View reviewed changes

peritz added 2 commits January 31, 2025 11:02

Update variable names for admin entities

0a77c8a

Cleanup test entities only if they exist

3ed3a1e

marieflorescontact reviewed Feb 3, 2025

View reviewed changes

marieflorescontact reviewed Feb 7, 2025

View reviewed changes

richard-julien changed the base branch from master to issue/827 February 11, 2025 11:18

richard-julien merged commit a9a0ed1 into OpenCTI-Platform:issue/827 Feb 11, 2025
5 checks passed

richard-julien mentioned this pull request Feb 11, 2025

[client] Add administrative entities and functionality #828

Merged

	customAttributes = kwargs.get("customAttributes", None)
	custom_attributes = kwargs.get("customAttributes", None)

	mutation MarkingForbid($groupId: ID!, $markingId: StixRef!) {
	mutation GroupEditMarkingRemove($groupId: ID!, $markingId: StixRef!) {

	orderMode = kwargs.get("orderMode", None)
	order_mode = kwargs.get("orderMode", None)

	orderBy = kwargs.get("orderBy", None)
	order_by = kwargs.get("orderBy", None)

	withPagination = kwargs.get("withPagination", False)
	with_pagination = kwargs.get("withPagination", False)

	getAll = kwargs.get("getAll", False)
	get_all = kwargs.get("getAll", False)

	orderBy = kwargs.get("orderBy", "name")
	order_by = kwargs.get("orderBy", "name")

	orderMode = kwargs.get("orderMode", "asc")
	order_mode = kwargs.get("orderMode", "asc")

Conversation

peritz commented Jan 27, 2025

Proposed changes

Related issues

Checklist

Further comments

Uh oh!

marieflorescontact left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

peritz commented Jan 31, 2025

Uh oh!

marieflorescontact left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

richard-julien commented Feb 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

peritz commented Feb 13, 2025

Uh oh!

marieflorescontact commented Feb 13, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

richard-julien commented Feb 11, 2025 •

edited

Loading