pycti.entities.opencti_user
===========================
.. py:module:: pycti.entities.opencti_user
Classes
-------
.. autoapisummary::
pycti.entities.opencti_user.User
Module Contents
---------------
.. py:class:: User(opencti)
Representation of a user on the OpenCTI platform
Users can be member of multiple groups, from which its permissions
(capabilities) are derived. Additionally, users are part of organisations,
and sometimes administrating them (Enterprise edition).
They have configured confidence, and an effective confidence (which might
be set by the group).
You can view the properties, session_properties, and
me_properties attributes of a User object to view what attributes will be
present in a User or MeUser object.
:param opencti: instance of :py:class:`~pycti.api.opencti_api_client.OpenCTIApiClient`
:type opencti: OpenCTIApiClient
Initialize the User instance.
:param opencti: OpenCTI API client instance
:type opencti: OpenCTIApiClient
.. py:attribute:: opencti
.. py:attribute:: properties
:value: Multiline-String
.. raw:: html
Show Value
.. code-block:: python
"""
id
standard_id
individual_id
user_email
firstname
lastname
name
description
language
theme
unit_system
external
restrict_delete
account_status
account_lock_after_date
entity_type
parent_types
created_at
updated_at
unit_system
submenu_show_icons
submenu_auto_collapse
monochrome_labels
roles {
id, name, description
capabilities {
id, name
}
capabilitiesInDraft {
id, name
}
}
groups {
edges {
node {
id, name, description
}
}
}
objectOrganization {
edges {
node {
id, is_inferred, name, description
}
}
}
administrated_organizations {
id, name, description
}
user_confidence_level {
max_confidence
overrides {
entity_type, max_confidence
}
}
effective_confidence_level {
max_confidence
source {
type
object {
... on Group {
id, name
}
}
}
overrides {
entity_type, max_confidence
source {
type
object {
... on Group {
id, name
}
}
}
}
}
"""
.. raw:: html
Show Value
.. code-block:: python
"""
api_tokens {
id
name
}
"""
.. raw:: html
Show Value
.. code-block:: python
"""
sessions {
id, created, ttl, originalMaxAge
}
"""
.. raw:: html
Show Value
.. code-block:: python
"""
id
individual_id
user_email
firstname
lastname
name
description
theme
language
unit_system
submenu_show_icons
submenu_auto_collapse
entity_type
parent_types
created_at
updated_at
objectOrganization {
edges {
node {
id, name
}
}
}
administrated_organizations {
id, name
}
capabilities {
id, name, description
}
capabilitiesInDraft {
id, name, description
}
groups {
edges {
node {
id, name, description
}
}
}
effective_confidence_level {
max_confidence
source {
type
object {
... on Group {
id, name
}
}
}
overrides {
entity_type, max_confidence
source {
type
object {
... on Group {
id, name
}
}
}
}
}
"""
.. raw:: html