Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 2.74 KB

File metadata and controls

40 lines (31 loc) · 2.74 KB

AccessEntityFilters

Filters for matching entities by type, name, tag, IDs, connections, or access levels. Supports recursive logical composition via allOf/anyOf.

Properties

Name Type Description Notes
entity_types List[str] Filter by entity type. Only RESOURCE, GROUP, and USER are queryable via OpalQuery. [optional]
entity_item_types List[EntityItemTypeEnum] Filter by entity item types. [optional]
entity_name EntityNameFilter [optional]
entity_tag EntityTagFilter [optional]
entity_ids List[UUID] Filter by specific entity UUIDs. [optional]
imported_from_app List[UUID] Filter by app IDs from which returned nodes will be imported from. [optional]
role_remote_ids List[str] Filter by role remote IDs. Can only be applied within a hasAccessTo clause. [optional]
role_names List[str] Filter by role display names (e.g. "Admin", "Read"). Can only be applied within a hasAccessTo clause. [optional]
all_of List[AccessEntityFilters] A list of nested filters that must all match (logical AND). Each item has the same shape as this object — scalar fields like `entityTypes` or `entityTag`, and can further nest `allOf`, `anyOf`, or `not`. [optional]
any_of List[AccessEntityFilters] A list of nested filters where at least one must match (logical OR). Each item has the same shape as this object. [optional]
var_not object Excludes entities matching the embedded filter (logical NOT). Pass a filter object with the same shape as this one — typically a single scalar field, like `{not: {entityTypes: ["RESOURCE"]}}` to exclude resources. [optional]

Example

from opal_security.models.access_entity_filters import AccessEntityFilters

# TODO update the JSON string below
json = "{}"
# create an instance of AccessEntityFilters from a JSON string
access_entity_filters_instance = AccessEntityFilters.from_json(json)
# print the JSON string representation of the object
print(AccessEntityFilters.to_json())

# convert the object into a dict
access_entity_filters_dict = access_entity_filters_instance.to_dict()
# create an instance of AccessEntityFilters from a dict
access_entity_filters_from_dict = AccessEntityFilters.from_dict(access_entity_filters_dict)

[Back to Model list] [Back to API list] [Back to README]