All pages
Powered by GitBook
1 of 10

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Templates

Classes for constructing an OAA JSON payload, one page per supported template.

Modules

  • application: Classes for constructing an OAA JSON payload for Custom Application

  • common: Shared base classes, enums and identity-mapping submission types used across the OAA templates.

  • enrichment: Classes for constructing an OAA JSON payload for Entity Enrichment

  • : Exception raised for OAA template schema violations.

  • : Classes for constructing an OAA JSON payload for the Host template

  • : Classes for constructing an OAA JSON payload for custom HRIS

  • : Classes for constructing an OAA JSON payload for Custom IDP

  • : Classes for constructing an OAA JSON payload for Custom Principal Submission

  • : Classes for constructing an OAA JSON payload for Secret Store

  • : Access Credential derived from Identity base class.

  • : Base class for CustomApplication.

  • : Model for defining custom properties for application and its entities (users, groups, roles, resources).

  • : Class for modeling application authorization using the OAA Application template.

  • : Veza supported IdP provider types.

  • : Identity mapping configuration submission.

  • : Identity mapping destination datasource.

  • : Enriched Entity

  • : Class for modeling Entity Enrichment using the OAA Entity Enrichment template.

  • : Model for defining custom properties for Entity Enrichment.

  • : General exception used for violations of the template schema.

  • : A credential that authenticates as an account on a Host.

  • : Environment for a Host fleet.

  • : Whether a HostGrant's principal is a user or a group.

  • : A group on a Host.

  • : HRIS Employee Entity

  • : HRIS Group

  • : Class for modeling Human Resource Information Systems (HRIS) Template

  • : App model for CustomIdPProvider

  • : Domain model for Custom IdP provider.

  • : Group model for CustomIdPProvider.

  • : CustomIdPProvider class for modeling Identity Providers (IdP) using OAA Custom Identity Provider Template.

  • : CustomPrincipal class for modeling Principal services using OAA Custom Principal Template.

  • : Group model for CustomPrincipal.

  • : Tenant model for Custom Principal submission.

  • : User model for CustomPrincipal

  • : Identity to Permission Mapping

  • : Permission Assignment

  • : Secret Store Entity

  • : Secret Store Permission Entity

  • : Helper function to simplify appending.

  • : Returns a list of unique strings from input list case insensitive

: CustomPermission class for defining CustomApplication permissions.

  • : Class for resources and sub-resources.

  • : IdP identity derived from Identity base class.

  • : Base class for deriving all identity types (should not be used directly).

  • : Local Agent identity, derived from Identity base class.

  • : LocalGroup identity.

  • : Represents an AI model entity within an application.

  • : Represent a Custom Application Local Role.

  • : LocalUser identity, derived from Identity base class.

  • : Types of local user account, human or service account.

  • : Types of identities for permission mapping.

  • : Canonical permissions used by Veza Authorization Framework.

  • : Identity mapping mode.
  • : Identity property used as source or destination in a property matcher.

  • : Identity mapping property matcher.

  • : Identity mapping submission.

  • : Identity mapping transformation applied to identity values before matching.

  • : Identity mapping match type.

  • : Node types for entity owners

  • : Supported types for custom properties on OAA entities such as application, resource, and identity.

  • : Base class for CustomProvider.

  • : Veza Tag data model.

  • : Whether a HostUser stands for a person or not.
  • : A single host machine.

  • : A privilege defined once on the fleet and referenced by name wherever it is granted.

  • : Model for defining custom properties for a Host fleet's hosts, users, groups and resources.

  • : Class for modeling host machine authorization using the OAA Host template.

  • : Something inside a host that a privilege can apply to.

  • : A user account on a Host.

  • : HRISSystem information

    : User model for CustomIdPProvider.

  • : IdP entity types.

  • : Model for defining custom properties for CustomIdPProvider and its entities (users, groups, domain).

  • : Types of identities for permission mapping.

  • : Principal entity types.

  • : Model for defining custom properties for CustomPrincipal and its entities (tenant, users, groups).

  • : Property Definitions for Secret Store entities
  • : Class for modeling Secret Store Template

  • : Secret Store Vault Entity

  • : Secret Store Vault Entry Entity

  • : Vault Entry Identity

  • Classes

    Application

    Common

    Enrichment

    Exceptions

    Host

    HRIS

    IdP

    Principal

    Secret Store

    Functions

    exceptions
    host
    hris
    idp
    principal
    secret_store
    application.AccessCred
    application.Application
    application.ApplicationPropertyDefinitions
    application.CustomApplication
    common.EntityOwner
    common.IdPProviderType
    common.IdentityMappingConfigurationSubmission
    common.IdentityMappingDestinationDatasourceSubmission
    enrichment.EnrichedEntity
    enrichment.EntityEnrichment
    enrichment.EntityEnrichmentPropertyDefinitions
    exceptions.OAATemplateException
    host.HostCredential
    host.HostEnvironment
    host.HostGranteeType
    host.HostGroup
    hris.HRISEmployee
    hris.HRISGroup
    hris.HRISPropertyDefinitions
    hris.HRISProvider
    idp.CustomIdPApp
    idp.CustomIdPDomain
    idp.CustomIdPGroup
    idp.CustomIdPProvider
    principal.CustomPrincipal
    principal.CustomPrincipalGroup
    principal.CustomPrincipalTenant
    principal.CustomPrincipalUser
    secret_store.IdentityToPermission
    secret_store.PermissionAssignment
    secret_store.SecretStore
    secret_store.SecretStorePermission
    common.append_helper
    common.unique_strs
    application.CustomPermission
    application.CustomResource
    application.IdPIdentity
    application.Identity
    application.LocalAgent
    application.LocalGroup
    application.LocalModel
    application.LocalRole
    application.LocalUser
    application.LocalUserType
    application.OAAIdentityType
    application.OAAPermission
    common.IdentityMappingMode
    common.IdentityMappingProperty
    common.IdentityMappingPropertyMatchersSubmission
    common.IdentityMappingSubmission
    common.IdentityMappingTransformation
    common.IdentityMappingType
    common.OAAOwnerType
    common.OAAPropertyType
    common.Provider
    common.Tag
    host.HostIdentityType
    host.HostNode
    host.HostPrivilegeDefinition
    host.HostPropertyDefinitions
    host.HostProvider
    host.HostResource
    host.HostUser
    hris.HRISSystem
    idp.CustomIdPUser
    idp.IdPEntityType
    idp.IdPPropertyDefinitions
    idp.IdPUserIdentityType
    principal.PrincipalEntityType
    principal.PrincipalPropertyDefinitions
    secret_store.SecretStorePropertyDefinitions
    secret_store.SecretStoreSubmission
    secret_store.SecretStoreVault
    secret_store.SecretStoreVaultEntry
    secret_store.VaultEntryIdentity

    Exceptions

    Exception raised for OAA template schema violations.

    Copyright 2026 Veza Technologies Inc.

    Use of this source code is governed by the MIT license that can be found in the LICENSE file or at https://opensource.org/licenses/MIT.


    General exception used for violations of the template schema.

    __init__(message)

    class OAATemplateException

    method __init__

    HRIS

    Classes for constructing an OAA JSON payload for custom HRIS

    Copyright 2026 Veza Technologies Inc.

    Use of this source code is governed by the MIT license that can be found in the LICENSE file or at https://opensource.org/licenses/MIT.

    Global Variables


    • PROPERTY_NAME_REGEX


    class HRISProvider

    Class for modeling Human Resource Information Systems (HRIS) Template

    HRIS template consists of base information about the HRIS instance, Employees and Groups.

    Employees and Groups are tracked in case insensitive dictionaries that can be used to reference entities after creation.

    Args:

    • name (str): Name for HRIS Instance

    • hris_type (str): Type for HRIS. Typically the vendor or product name.

    • url (str): Instance URL for HRIS.

    Attributes:

    • employees (dict[string]): Dictionary of HRISEmployee instances keyed by Employee ID

    • groups (dict[string]): Dictionary of HRISGroup instances keyed by Group ID


    Add a new Employee

    Function creates a new HRISEmployee instance and adds it to the HRISProvider.employees keyed by the unique_id

    Args:

    • unique_id (str): Unique Identifier for Employee

    • name (str): Display name for employee

    • employee_number (str): The employee's number that appears in the third-party integration.

    Raises:

    • OAATemplateException: Employee with ID already exists

    Returns:

    • HRISEmployee: Entity for new employee


    Add a new Group

    Used to represent any subset of employees, such as PayGroup or Team. Employees can be in multiple Groups. Groups can also be members of other groups to create hierarchy.

    Some properties of HRISEmployee such as department must reference an existing HRISGroup by its ID.

    Args:

    • unique_id (str): Unique ID for group

    • name (str): Display name

    • group_type (str): Type for group such as "Team", "Department", "Cost Center"

    Returns:

    • HRISGroup: Entity for new group


    Get the OAA payload.

    Returns the complete OAA template payload for HRIS as serializable dictionary

    Returns:

    • dict: OAA payload as dictionary


    HRISSystem information

    Representation for HRISSystem information. The system information is used to represent additional details for the HRIS Instance.

    Args:

    • name (str): Name for system Instance

    • url (str, optional): URL for instance . Defaults to "". TODO: Is this right?

    Attributes:

    • identity_mapping_configuration (IdentityMappingConfigurationSubmission): Identity mapping configuration, set via set_identity_mapping_configuration().


    Link HRIS to External IdP of given type

    Sets the IdP types (Okta, AzureAD, etc.) for Veza to link employee identities to.

    Args:

    • provider_type (IdPProviderType): Type of IdP for source identities

    Raises:

    • ValueError: provider_type must be IdPProviderType enum

    Returns:

    • list[IdPProviderType]: List of configured IdP types


    Create and set the identity mapping configuration.

    Initializes the identity_mapping_configuration attribute with a new IdentityMappingConfigurationSubmission instance and returns it for further configuration.

    Returns:

    • IdentityMappingConfigurationSubmission: The identity mapping configuration.



    HRIS Employee Entity

    Represents an employee record in the HRIS system. Each employee must have a unique ID to identify it in the payload. This ID is also used to reference one employee to the other for manager hierarchy.

    Init variables are all required and must not be empty such as ""

    Args:

    • unique_id (str): Unique Identifier for Employee

    • name (str): Name for employee record.

    • employee_number (str): The employee's number that appears in the third-party integration.

    Parameters:

    • company (str): The company (or subsidiary) the employee works for.

    • preferred_name (str): The employee's preferred first name.

    • display_full_name (str): The employee's full name, to use for display purposes.

    Raises:

    • ValueError: Any of the required arguments are empty.


    Add employee to group

    Adds employee to a group by the group ID. Group must also be defined for HRISInstance with HRISProvider.add_group()

    Args:

    • group_id (str): Unique ID of HRISGroup to add employee too


    Add manager to Employee

    Adds a manager to the employee by the manager's HRISEmployee instance unique ID. Manger employee record must also exist.

    Args:

    • manager_id (str): Unique ID for manager HRISEmployee instance


    Set Employee custom property value

    Property name must be defined for employee before calling set_property

    Args:

    • property_name (str): Name of property

    • property_value (any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.. Defaults to False.

    Raises:

    • OAATemplateException: If property with property_name is not defined.


    Output employee to dictionary for payload.


    HRIS Group

    Represents any group of employees in the HRIS system. HRISGroups can be used to represent teams, departments, cost centers or any organizational unit. Each group has a type to make searching and grouping easier.

    Group's Unique ID must be unique across all group types.

    Args:

    • unique_id (str): Unique ID for group

    • name (str): Display name

    • group_type (str): Type for group such as "Team", "Department", "Cost Center"


    Set HRIS Group custom property value

    Property name must be defined for group before calling set_property

    Args:

    • property_name (str): Name of property

    • property_value (any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.. Defaults to False.

    Raises:

    • OAATemplateException: If property with property_name is not defined.


    Dictionary output for inclusion in payload







    Check property name for valid characters

    Raises an exception if the name string does not match required pattern. Name must start with a character and can only contain letters and _ character.

    Args:

    • name (str): name of property to validate

    Raises:

    • OAATemplateException: Name is not a string

    • OAATemplateException: Name contains invalid characters or does not start with a letter

    first_name (str): Employee first name
  • last_name (str): Employee last name (family name)

  • is_active (bool): Boolean for employee active status

  • employment_status (str): String representation of employee status, e.g. "ACTIVE", "TERMINATE", "PENDING"

  • first_name (str): Employee first name
  • last_name (str): Employee last name (family name)

  • is_active (bool): Boolean for employee active status

  • employment_status (str): String representation of employee status, e.g. "ACTIVE", "TERMINATE", "PENDING"

  • canonical_name (str): The employee's canonical name.
  • username (str): The employee's username that appears in the integration UI.

  • email (str): The employee's work email.

  • idpid (str): The ID for this employee on the destination IDP provider used to automatically connect to it, if not supplied email is used.

  • personal_email (str): The employee's personal email.

  • home_location (str): The employee's home location.

  • work_location (str): The employee's work location.

  • cost_center (str): The cost center ID (Group ID) that the employee is in.

  • department (str): The department ID (Group ID) that the employee is in.

  • managers (str): The employee IDs of the employee's managers.

  • groups (str): The IDs of groups this user is in

  • start_date (str): The date that the employee started working. RFC3339 timestamp.

  • termination_date (str): The employee's termination date. RFC3339 timestamp.

  • job_title (str): The title of the employee.

  • employment_typ (str): The employee's type of employment. For example: FULL_TIME, PART_TIME, INTERN, CONTRACTOR, FREELANCE.

  • primary_time_zone (str): The time zone which the employee primarily lives.

  • method __init__

    method add_employee

    method add_group

    method get_payload

    class HRISSystem

    method __init__

    method add_idp_type

    method set_identity_mapping_configuration

    method to_dict

    class HRISEmployee

    method __init__

    method add_group

    method add_manager

    method set_property

    method to_dict

    class HRISGroup

    method __init__

    method set_property

    method to_dict

    class HRISPropertyDefinitions

    method __init__

    method define_employee_property

    method define_group_property

    method define_system_property

    method to_dict

    method validate_name

    __init__(name: 'str', hris_type: 'str', url: 'str')
    add_employee(
        unique_id: 'str',
        name: 'str',
        employee_number: 'str',
        first_name: 'str',
        last_name: 'str',
        is_active: 'bool',
        employment_status: 'str'
    ) β†’ HRISEmployee
    add_group(unique_id: 'str', name: 'str', group_type: 'str') β†’ HRISGroup
    get_payload() β†’ dict
    __init__(name: 'str', url: 'str' = '')
    add_idp_type(provider_type: 'IdPProviderType') β†’ list[IdPProviderType]
    set_identity_mapping_configuration() β†’ IdentityMappingConfigurationSubmission
    to_dict() β†’ dict
    __init__(
        unique_id: 'str',
        name: 'str',
        employee_number: 'str',
        first_name: 'str',
        last_name: 'str',
        is_active: 'bool',
        employment_status: 'str'
    )
    add_group(group_id: 'str') β†’ None
    add_manager(manager_id: 'str') β†’ None
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    to_dict() β†’ dict
    __init__(unique_id: 'str', name: 'str', group_type: 'str')
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    to_dict() β†’ dict
    __init__()
    define_employee_property(name: 'str', property_type: 'OAAPropertyType') β†’ None
    define_group_property(name: 'str', property_type: 'OAAPropertyType') β†’ None
    define_system_property(name: 'str', property_type: 'OAAPropertyType') β†’ None
    to_dict() β†’ dict
    validate_name(name: 'str') β†’ None

    Secret Store

    Classes for constructing an OAA JSON payload for Secret Store

    Copyright 2026 Veza Technologies Inc.

    Use of this source code is governed by the MIT license that can be found in the LICENSE file or at https://opensource.org/licenses/MIT.

    Global Variables


    • PROPERTY_NAME_REGEX


    class SecretStoreSubmission

    Class for modeling Secret Store Template

    SecretStore template consists of base information about the secret store instance, permissions, vaults, entries, and identity mappings.

    Args:

    • name (str): Name for Secret Store Instance

    • secret_store_type (str): Type for Secret Store. Typically the vendor or product name.

    • unique_id (str): Unique identify for secret store instance. Optional, defaults to name.

    • skip_local_users_creation (bool, optional): Skip creation of local user identities for this secret store. Defaults to None.

    Attributes:

    • secret_store (SecretStore): The secret store entity

    • property_definitions (SecretStorePropertyDefinitions): Custom property definitions

    • identity_mapping_configuration (IdentityMappingConfigurationSubmission): Identity mapping configuration, set via set_identity_mapping_configuration().


    Get the OAA payload.

    Returns the complete OAA template payload for Secret Store as serializable dictionary

    Returns:

    • dict: OAA payload as dictionary

    Raises:

    • OAATemplateException: If secret_store is not set


    Create and set the identity mapping configuration.

    Initializes the identity_mapping_configuration attribute with a new IdentityMappingConfigurationSubmission instance and returns it for further configuration.

    Returns:

    • IdentityMappingConfigurationSubmission: The identity mapping configuration.


    Secret Store Entity

    Represents a secret store application with permissions, vaults, and identity mappings.

    Args:

    • name (str): Display name for secret store

    • unique_id (str, optional): Unique identifier for secret store

    • description (str, optional): Description of the secret store


    Add identity to permission mapping

    Args:

    • identity (str): The identity ID

    • identity_type (str): The type of identity (e.g., "local_user")

    • permission_assignments (list[PermissionAssignment], optional): Permission assignments for this identity

    Returns:

    • IdentityToPermission: The identity to permission mapping

    Raises:

    • OAATemplateException: Identity to permission mapping for identity and identity_type already exists


    Add a new Permission

    Args:

    • name (str): Display name for permission

    • unique_id (str, optional): Unique identifier for permission. Defaults to name if not provided.

    • resource (str, optional): Resource this permission applies to

    Returns:

    • SecretStorePermission: Entity for new permission

    Raises:

    • OAATemplateException: Permission with ID already exists


    Add a new tag to secret store.

    Args:

    • key (str): Tag key/name

    • value (str, optional): Tag value. Defaults to "".


    Add a new Vault

    Args:

    • name (str): Display name for vault

    • vault_type (str): Type of vault (user-defined)

    • unique_id (str, optional): Unique identifier for vault. Defaults to name if not provided.

    Returns:

    • SecretStoreVault: Entity for new vault

    Raises:

    • OAATemplateException: Vault with ID already exists


    Set secret store custom property value

    Property name must be defined before calling set_property

    Args:

    • property_name (str): Name of property

    • property_value (any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property with property_name is not defined.


    Return the dictionary representation of secret store.


    Secret Store Permission Entity

    Represents a permission in a secret store.

    Args:

    • name (str): Display name for permission

    • unique_id (str, optional): Unique identifier for permission

    • resource (str, optional): Resource this permission applies to

    Attributes:

    • permission_type (list[OAAPermission]): List of OAAPermission enums that represent the canonical permissions


    Add a permission type to the permission_type list.

    Extends the list of canonical OAAPermission types this permission grants.

    Args:

    • permission_type (OAAPermission): The OAAPermission enum value to add

    Raises:

    • OAATemplateException: If permission_type is not an OAAPermission enum


    Add a new tag to permission.

    Args:

    • key (str): Tag key/name

    • value (str, optional): Tag value. Defaults to "".


    Set permission custom property value

    Property name must be defined before calling set_property

    Args:

    • property_name (str): Name of property

    • property_value (any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property with property_name is not defined.


    Return the dictionary representation of permission.


    Secret Store Vault Entity

    Represents a vault in a secret store.

    Args:

    • name (str): Display name for vault

    • vault_type (str): Type of vault (user-defined)

    • unique_id (str, optional): Unique identifier for vault


    Add a new Entry to vault

    Args:

    • name (str): Display name for entry

    • unique_id (str, optional): Unique identifier for entry. Defaults to name if not provided.

    • description (str, optional): Description of the entry

    Returns:

    • SecretStoreVaultEntry: Entity for new entry

    Raises:

    • OAATemplateException: Entry with ID already exists


    Add a new tag to vault.

    Args:

    • key (str): Tag key/name

    • value (str, optional): Tag value. Defaults to "".


    Set vault custom property value

    Property name must be defined before calling set_property

    Args:

    • property_name (str): Name of property

    • property_value (any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property with property_name is not defined.


    Return the dictionary representation of vault.


    Secret Store Vault Entry Entity

    Represents an entry (credential) in a vault.

    Args:

    • name (str): Display name for entry

    • unique_id (str, optional): Unique identifier for entry

    • description (str, optional): Description of the entry


    Add an identity to this vault entry

    Args:

    • identity_type (str): The type of identity (e.g., "OktaUser", "AzureADUser")

    • external_id (str): The external ID of the identity

    Returns:

    • VaultEntryIdentity: The identity entity


    Add a new tag to entry.

    Args:

    • key (str): Tag key/name

    • value (str, optional): Tag value. Defaults to "".


    Set entry custom property value

    Property name must be defined before calling set_property

    Args:

    • property_name (str): Name of property

    • property_value (any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property with property_name is not defined.


    Return the dictionary representation of entry.


    Vault Entry Identity

    Represents identity information for a vault entry.

    Args:

    • identity_type (str): The type of identity (e.g., "OktaUser", "AzureADUser")

    • external_id (str): The external ID of the identity


    Return the dictionary representation of identity.


    Identity to Permission Mapping

    Maps an identity to permissions on vaults.

    Args:

    • identity (str): The identity ID

    • identity_type (str): The type of identity (e.g., "local_user")

    • permission_assignments (list[PermissionAssignment], optional): Permission assignments for this identity


    Add a permission assignment

    Args:

    • vault (list[str]): List of vault IDs or names

    • permissions (list[str]): List of permission names

    Returns:

    • PermissionAssignment: The permission assignment


    Return the dictionary representation of identity to permission.


    Permission Assignment

    Assigns permissions to vaults.

    Args:

    • vault (list[str]): List of vault IDs or names

    • permissions (list[str]): List of permission names


    Return the dictionary representation of permission assignment.


    Property Definitions for Secret Store entities


    Define a custom property for entries

    Args:

    • name (str): Property name

    • property_type (OAAPropertyType): Property type


    Define a custom property for permissions

    Args:

    • name (str): Property name

    • property_type (OAAPropertyType): Property type


    Define a custom property for secret store

    Args:

    • name (str): Property name

    • property_type (OAAPropertyType): Property type


    Define a custom property for vaults

    Args:

    • name (str): Property name

    • property_type (OAAPropertyType): Property type


    Convert property definitions to dictionary


    Check property name for valid characters

    Raises an exception if the name string does not match required pattern. Name must start with a character and can only contain letters and _ character.

    Args:

    • name (str): name of property to validate

    Raises:

    • OAATemplateException: Name is not a string

    • OAATemplateException: Name contains invalid characters or does not start with a letter

    skip_local_users_creation (bool, optional): Skip creation of local user identities for this secret store.

    allow_identity_assume (bool, optional): Whether this permission allows identity assumption
  • permission_type (list[OAAPermission], optional): List of OAAPermission enums that represent the canonical permissions

  • description (str, optional): Description of the vault
    allow_identity_assume (bool, optional): Whether this permission allows identity assumption
  • permission_type (list[OAAPermission], optional): List of OAAPermission enums that represent the canonical permissions

  • description
    (str, optional): Description of the vault

    method __init__

    method get_payload

    method set_identity_mapping_configuration

    class SecretStore

    method __init__

    method add_identity_to_permission

    method add_permission

    method add_tag

    method add_vault

    method set_property

    method to_dict

    class SecretStorePermission

    method __init__

    method add_permission_type

    method add_tag

    method set_property

    method to_dict

    class SecretStoreVault

    method __init__

    method add_entry

    method add_tag

    method set_property

    method to_dict

    class SecretStoreVaultEntry

    method __init__

    method add_identity

    method add_tag

    method set_property

    method to_dict

    class VaultEntryIdentity

    method __init__

    method to_dict

    class IdentityToPermission

    method __init__

    method add_permission_assignment

    method to_dict

    class PermissionAssignment

    method __init__

    method to_dict

    class SecretStorePropertyDefinitions

    method __init__

    method define_entry_property

    method define_permission_property

    method define_secret_store_property

    method define_vault_property

    method to_dict

    method validate_name

    __init__(
        name: 'str',
        secret_store_type: 'str',
        unique_id: 'str' = None,
        skip_local_users_creation: 'Optional[bool]' = None
    )
    get_payload() β†’ dict
    set_identity_mapping_configuration() β†’ IdentityMappingConfigurationSubmission
    __init__(name: 'str', unique_id: 'str' = None, description: 'str' = None)
    add_identity_to_permission(
        identity: 'str',
        identity_type: 'str',
        permission_assignments: 'List[PermissionAssignment]' = None
    ) β†’ IdentityToPermission
    add_permission(
        name: 'str',
        unique_id: 'str' = None,
        resource: 'str' = None,
        allow_identity_assume: 'bool' = None,
        permission_type: 'List[OAAPermission]' = None
    ) β†’ SecretStorePermission
    add_tag(key: 'str', value: 'str' = '') β†’ None
    add_vault(
        name: 'str',
        vault_type: 'str',
        unique_id: 'str' = None,
        description: 'str' = None
    ) β†’ SecretStoreVault
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    to_dict() β†’ dict
    __init__(
        name: 'str',
        unique_id: 'str' = None,
        resource: 'str' = None,
        allow_identity_assume: 'bool' = None,
        permission_type: 'List[OAAPermission]' = None
    )
    add_permission_type(permission_type: 'OAAPermission') β†’ None
    add_tag(key: 'str', value: 'str' = '') β†’ None
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    to_dict() β†’ dict
    __init__(
        name: 'str',
        vault_type: 'str',
        unique_id: 'str' = None,
        description: 'str' = None
    )
    add_entry(
        name: 'str',
        unique_id: 'str' = None,
        description: 'str' = None
    ) β†’ SecretStoreVaultEntry
    add_tag(key: 'str', value: 'str' = '') β†’ None
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    to_dict() β†’ dict
    __init__(name: 'str', unique_id: 'str' = None, description: 'str' = None)
    add_identity(identity_type: 'str', external_id: 'str') β†’ VaultEntryIdentity
    add_tag(key: 'str', value: 'str' = '') β†’ None
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    to_dict() β†’ dict
    __init__(identity_type: 'str', external_id: 'str')
    to_dict() β†’ dict
    __init__(
        identity: 'str',
        identity_type: 'str',
        permission_assignments: 'List[PermissionAssignment]' = None
    )
    add_permission_assignment(
        vault: 'List[str]',
        permissions: 'List[str]'
    ) β†’ PermissionAssignment
    to_dict() β†’ dict
    __init__(vault: 'List[str]', permissions: 'List[str]')
    to_dict() β†’ dict
    __init__()
    define_entry_property(name: 'str', property_type: 'OAAPropertyType') β†’ None
    define_permission_property(name: 'str', property_type: 'OAAPropertyType') β†’ None
    define_secret_store_property(
        name: 'str',
        property_type: 'OAAPropertyType'
    ) β†’ None
    define_vault_property(name: 'str', property_type: 'OAAPropertyType') β†’ None
    to_dict() β†’ dict
    validate_name(name: 'str') β†’ None

    Common

    Shared base classes, enums and identity-mapping submission types used across the OAA templates.

    Copyright 2026 Veza Technologies Inc.

    Use of this source code is governed by the MIT license that can be found in the LICENSE file or at https://opensource.org/licenses/MIT.

    Global Variables


    • PROPERTY_NAME_REGEX


    function append_helper

    append_helper(base, addition)

    Helper function to simplify appending.

    Handles multiple cases:

    • base is None: starts a list

    • addition is list: extends base with list

    • addition is anything else: append element to list

    Args:

    • base (List or None): base list to append to, can be None

    • addition (*): What to append to the list

    Returns:

    • list: will always return a list


    Returns a list of unique strings from input list case insensitive

    Returns the unique list of strings from input list in a case insensitive manner. For duplicate strings with different cast (e.g. "STRING" and "string") the case of the first occurrence is returned.

    Args:

    • input (list): list of strings

    Returns:

    • list: list of unique strings


    Veza supported IdP provider types.


    Node types for entity owners


    Supported types for custom properties on OAA entities such as application, resource, and identity.


    Identity mapping match type.

    Corresponds to IdentityMapping.Type in identitymapping.proto.


    Identity mapping mode.

    Corresponds to IdentityMapping.Mode in identitymapping.proto.


    Identity mapping transformation applied to identity values before matching.

    Corresponds to IdentityMapping.Transformations in identitymapping.proto.


    Identity property used as source or destination in a property matcher.

    Corresponds to IdentityMapping.Property in identitymapping.proto.


    Base class for CustomProvider.



    Veza Tag data model.

    Args:

    • key (str): key for tag, aka name. Must be present and must be letters, numbers or _ (underscore) only.

    • value (str, optional): Value for tag, will appear in Veza as key:value. Must be letters, numbers, whitespace and the special characters @,._- only.

    Attributes:

    • key (str): key for tag, aka name. Must be present and must be letters, numbers or _ (underscore) only.

    • value (str): Value for tag, will appear in Veza as key:value. Must be letters, numbers and the special characters @,._ only.



    Identity mapping configuration submission.

    Top-level container for identity mapping configuration in an OAA payload.

    Args:

    • use_email (bool): Whether to use email for identity mapping. Defaults to False.

    • operation (str, optional): Operation type for this configuration.

    Attributes:

    • use_email (bool): Whether to use email for identity mapping. Default False.

    • mappings (list[IdentityMappingSubmission]): List of identity mappings.

    • operation (str): Operation type. Default None.


    Add an identity mapping.

    Args:

    • destination_datasource_type (str): Destination datasource type.

    • destination_datasource_oaa_type (str): Destination datasource OAA app type.

    • mapping_type (str): Mapping type. Use IdentityMappingType for valid values.

    Returns:

    • IdentityMappingSubmission: The new mapping.


    Return the dictionary representation.


    Identity mapping submission.

    Represents a single identity mapping configuration entry.

    Args:

    • destination_datasource_type (str): Destination datasource type.

    • destination_datasource_oaa_type (str): Destination datasource OAA app type.

    • mapping_type (str): Mapping type (serialized as type). Use IdentityMappingType for valid values.

    Attributes:

    • destination_datasource_type (str): Destination datasource type.

    • destination_datasource_oaa_type (str): Destination datasource OAA app type.

    • mapping_type (IdentityMappingType): Mapping type.


    Add a destination datasource.

    Args:

    • datasource_type (str): Datasource type.

    • oaa_type (str): OAA app type.

    Returns:

    • IdentityMappingDestinationDatasourceSubmission: The new destination datasource.


    Add a property matcher.

    Args:

    • source_property (str): Source property to match on. Use IdentityMappingProperty for valid values.

    • destination_property (str): Destination property to match against. Use IdentityMappingProperty for valid values.

    • custom_source_property (str, optional): Custom source property name, used when

    Returns:

    • IdentityMappingPropertyMatchersSubmission: The new property matcher.


    Return the dictionary representation.


    Identity mapping property matcher.

    Defines how source and destination properties are matched.

    Args:

    • source_property (str): Source property to match on. Use IdentityMappingProperty for valid values.

    • destination_property (str): Destination property to match against. Use IdentityMappingProperty for valid values.

    • custom_source_property (str, optional): Custom source property name, used when


    Return the dictionary representation.


    Identity mapping destination datasource.

    Specifies a destination datasource for an identity mapping.

    Args:

    • datasource_type (str): Datasource type (serialized as type).

    • oaa_type (str): OAA app type (serialized as oaa_app_type).


    Return the dictionary representation.

    mapping_mode (str, optional): Mapping mode. Use IdentityMappingMode for valid values. Defaults to "".

  • transformations (list[str], optional): List of transformations. Use IdentityMappingTransformation for valid values. Defaults to None.

  • custom_value (str, optional): Custom value. Defaults to "".

  • mapping_mode (str, optional): Mapping mode (serialized as mode). Use IdentityMappingMode for valid values. Defaults to "".

  • transformations (list[str], optional): List of transformations. Use IdentityMappingTransformation for valid values. Defaults to None.

  • custom_value (str, optional): Custom value. Defaults to "".

  • mapping_mode (IdentityMappingMode): Mapping mode.
  • transformations (list[IdentityMappingTransformation]): List of transformations.

  • custom_value (str): Custom value.

  • property_matchers (list[IdentityMappingPropertyMatchersSubmission]): Property matchers.

  • destination_datasources (list[IdentityMappingDestinationDatasourceSubmission]): Destination datasources.

  • source_property
    is
    IdentityMappingProperty.CUSTOM_PROPERTY
    . Defaults to "".
  • custom_destination_property (str, optional): Custom destination property name, used when destination_property is IdentityMappingProperty.CUSTOM_PROPERTY. Defaults to "".

  • source_property
    is
    IdentityMappingProperty.CUSTOM_PROPERTY
    . Defaults to "".
  • custom_destination_property (str, optional): Custom destination property name, used when destination_property is IdentityMappingProperty.CUSTOM_PROPERTY. Defaults to "".

  • function unique_strs

    class IdPProviderType

    class OAAOwnerType

    class OAAPropertyType

    class IdentityMappingType

    class IdentityMappingMode

    class IdentityMappingTransformation

    class IdentityMappingProperty

    class Provider

    method __init__

    method serialize

    class Tag

    method __init__

    class EntityOwner

    method __init__

    class IdentityMappingConfigurationSubmission

    method __init__

    method add_mapping

    method to_dict

    class IdentityMappingSubmission

    method __init__

    method add_destination_datasource

    method add_property_matcher

    method to_dict

    class IdentityMappingPropertyMatchersSubmission

    method __init__

    method to_dict

    class IdentityMappingDestinationDatasourceSubmission

    method __init__

    method to_dict

    unique_strs(input: 'list') β†’ list
    __init__(name, custom_template)
    serialize()
    __init__(key: 'str', value: 'str' = '') β†’ None
    __init__(
        external_id: 'str',
        owner_type: 'str',
        is_primary: 'bool' = False
    ) β†’ None
    __init__() β†’ None
    add_mapping(
        destination_datasource_type: 'str',
        destination_datasource_oaa_type: 'str',
        mapping_type: 'str',
        mapping_mode: 'str' = '',
        transformations: 'List[str]' = None,
        custom_value: 'str' = ''
    ) β†’ IdentityMappingSubmission
    to_dict() β†’ dict
    __init__(
        destination_datasource_type: 'str',
        destination_datasource_oaa_type: 'str',
        mapping_type: 'str',
        mapping_mode: 'str' = '',
        transformations: 'List[str]' = None,
        custom_value: 'str' = ''
    ) β†’ None
    add_destination_datasource(
        datasource_type: 'str',
        oaa_type: 'str'
    ) β†’ IdentityMappingDestinationDatasourceSubmission
    add_property_matcher(
        source_property: 'str',
        destination_property: 'str',
        custom_source_property: 'str' = '',
        custom_destination_property: 'str' = ''
    ) β†’ IdentityMappingPropertyMatchersSubmission
    to_dict() β†’ dict
    __init__(
        source_property: 'str',
        destination_property: 'str',
        custom_source_property: 'str' = '',
        custom_destination_property: 'str' = ''
    ) β†’ None
    to_dict() β†’ dict
    __init__(datasource_type: 'str', oaa_type: 'str') β†’ None
    to_dict() β†’ dict

    Host

    Classes for constructing an OAA JSON payload for the Host template

    Copyright 2026 Veza Technologies Inc.

    Use of this source code is governed by the MIT license that can be found in the LICENSE file or at https://opensource.org/licenses/MIT.

    Global Variables


    • PROPERTY_NAME_REGEX


    class HostGranteeType

    Whether a HostGrant's principal is a user or a group.


    class HostIdentityType

    Whether a HostUser stands for a person or not.


    class HostProvider

    Class for modeling host machine authorization using the OAA Host template.

    A Host provider supports two collection models, distinguished by shape rather than a mode flag. A central collector with visibility of the whole fleet calls add_environment() once and add_host() for every host in the fleet. An agent running on one host has no view of the fleet, so it calls add_host(environment_id=...) for its own host alone and does not call add_environment().

    What distinguishes the two is where the environment comes from, not how many hosts are submitted. A submission that carries an environment of its own and also sets environment_id on a host, or that does neither, is rejected by the server as ambiguous.

    Args:

    • host_type (str): Type descriptor for the fleet, typically the platform or vendor name

    Attributes:

    • host_type (str): Type for the fleet

    • environment (HostEnvironment): The fleet's environment, set by add_environment(). None for a per-host agent submission.

    • hosts (dict[HostNode]): Dictionary of HostNode instances


    Add the fleet's environment.

    Only used by a central collector that has visibility of the whole fleet. A per-host agent submission names its environment with add_host(environment_id=...) instead and must not call this method.

    Args:

    • unique_id (str): Unique ID for the environment. Required.

    • name (str): Display name for the environment. Required.

    • description (str, optional): Description for the environment. Defaults to None.

    Raises:

    • OAATemplateException: If an environment has already been added to this submission.

    Returns: HostEnvironment


    Add a new Host.

    Hosts can be referenced after creation using the .hosts dictionary attribute, keyed case insensitively by unique_id.

    Args:

    • name (str): Display name for host. Required.

    • unique_id (str): Unique identifier for host for reference by ID. Required.

    • environment_id (str, optional): ID of the Environment this host belongs to. Required when this submission carries no environment of its own (a per-host agent submission); must be absent when add_environment() has been called on this provider. Defaults to None.

    Raises:

    • OAATemplateException: name or unique_id is empty, or host is already defined.

    Returns: HostNode


    Add a new privilege definition.

    Privileges are defined once on the fleet and referenced by name wherever they are granted via HostNode.add_grant().

    Args:

    • name (str): Name grants refer to

    • privilege_type (list[OAAPermission]): Canonical access types this privilege confers

    • description (str, optional): Description for privilege. Defaults to None.

    Raises:

    • OAATemplateException: name is empty, or privilege with name already exists.

    Returns: HostPrivilegeDefinition


    Get the OAA payload.

    Returns the complete OAA template payload for the host fleet as serializable dictionary

    Returns:

    • dict: OAA payload as dictionary


    Environment for a Host fleet.

    Represents the fleet-wide information for a Host submission. Created by HostProvider.add_environment().

    Args:

    • unique_id (str): Unique ID for the environment. Required.

    • name (str): Display name for the environment. Required.

    • description (str, optional): Description for the environment. Defaults to None.

    Raises:

    • ValueError: unique_id or name is empty.

    • OAATemplateException: An identity_provider_types value is not a known IdP kind.


    Output function for payload.


    A single host machine.

    Contains the host's own users, groups, credentials, resources and grants. Created by HostProvider.add_host().

    Args:

    • name (str): Display name for host. Required.

    • unique_id (str): Unique identifier for host. Required.

    • environment_id (str, optional): ID of the Environment this host belongs to. Required for a per-host agent submission, which carries no environment of its own; must be absent when the submission carries an environment. Defaults to None.

    Attributes:

    • platform (str): Host platform, e.g. "linux". None until set.

    • version (str): Host platform version, e.g. "Ubuntu 22.04.4 LTS". None until set.

    • ip_address (str): Host IP address. None until set.

    Raises:

    • ValueError: name or unique_id is empty.


    Add a new credential to this host.

    A credential is a way of authenticating as an account, such as an SSH key. It carries no privileges of its own; it identifies which account its holder becomes.

    Args:

    • name (str): Display name for credential. Required.

    • unique_id (str): Unique identifier for credential. Required.

    • credential_type (str, optional): Type for credential. Defaults to None.

    Raises:

    • OAATemplateException: name or unique_id is empty, or credential already defined.

    Returns: HostCredential


    Grant privileges to a principal on this host.

    Records which privileges a user or group holds, on the host itself, on resources inside it, or both.

    Calling this again for the same principal_id and grantee_type adds to the existing grant where the call applies to the same things, and creates a second grant where it does not. A principal holding sudo on one command and login on the host holds two differently scoped sets of privileges, and they stay apart; a second call naming the same command adds to the first. The same id used for both a user and a group grant likewise produces two separate grants.

    Args:

    • principal_id (str): ID of the user or group holding the privileges. Must be declared among this host's users or groups when is_local is True.

    • grantee_type (HostGranteeType): Whether principal_id names a user or a group.

    • is_local (bool, optional): Whether the principal is declared on this host. False for a directory-backed principal, whose identity provider's connector draws the edge from it. Defaults to True.

    Raises:

    • OAATemplateException: principal_id is empty, grantee_type is not a HostGranteeType, a privileges entry is not a name or an object carrying one, or a resources entry is empty or not the expected type.


    Add a new group to this host.

    Args:

    • name (str): Display name for group. Required.

    • unique_id (str): Unique identifier for group. Required.

    • group_type (str, optional): Type for group. Defaults to None.

    Raises:

    • OAATemplateException: name or unique_id is empty, or group already defined.

    Returns: HostGroup


    Add a new resource to this host.

    A resource is something inside the host that a privilege can apply to, such as a service or a command, rather than the host as a whole.

    A unique_id is unique within a resource_type rather than across the host, so a service and a container may both be called postgres.

    Args:

    • name (str): Display name for resource. Required.

    • unique_id (str): Unique identifier for resource within the resource_type. Required.

    • resource_type (str): The kind of thing this is, e.g. "service" or "command". Must not contain a "." or ":" character. Required.

    Raises:

    • OAATemplateException: name, unique_id or resource_type is empty, a resource of the same type and unique_id is already defined, or resource_type contains a "." or ":" character.

    Returns: HostResource


    Add a new user account to this host.

    A user belongs to exactly one host: root on two hosts is two accounts, each added separately.

    Args:

    • name (str): Display name for user. Required.

    • unique_id (str): Unique identifier for user. Required.

    • identities (list[str], optional): The identities in an identity provider this account belongs to. Required when is_local is False. Defaults to None.

    Raises:

    • OAATemplateException: name or unique_id is empty, user already defined, or identity_type is not a HostIdentityType.

    Returns: HostUser


    Set a custom property value for the host.

    Property name must be defined for the fleet before calling set_property. See HostPropertyDefinitions.define_host_property for more information.

    Args:

    • property_name (str): Name of property to set value for

    • property_value (Any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property name is not defined.


    Output function for payload.


    A user account on a Host.

    A user belongs to exactly one host: root on two hosts is two accounts, each with its own last_login_at and is_active. Created by HostNode.add_user().

    Args:

    • name (str): Display name for user. Required.

    • unique_id (str): Unique identifier for user. Required.

    • identities (list[str], optional): The identities in an identity provider this account belongs to. Defaults to None.

    Raises:

    • ValueError: name or unique_id is empty.

    • OAATemplateException: identity_type is not a HostIdentityType.


    Add this user to a group.

    Group must also be defined on the host with HostNode.add_group().

    Args:

    • group_id (str): ID of the group to add user to.

    Raises:

    • OAATemplateException: group_id is empty.


    Set a custom property value for the user.

    Property name must be defined for the fleet's users before calling set_property.

    Args:

    • property_name (str): Name of property to set value for

    • property_value (Any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property name is not defined.


    Output function for payload.


    A group on a Host.

    Created by HostNode.add_group().

    Args:

    • name (str): Display name for group. Required.

    • unique_id (str): Unique identifier for group. Required.

    • group_type (str, optional): Type for group. Defaults to None.

    Raises:

    • ValueError: name or unique_id is empty.


    Add a member group.

    A member may be another group on the same host, or a directory-backed group with no local definition.

    Args:

    • group_id (str): ID of the member group.

    • is_local (bool, optional): Whether the member group is declared on this host. Defaults to True.

    Raises:

    • OAATemplateException: group_id is empty.


    Set a custom property value for the group.

    Property name must be defined for the fleet's groups before calling set_property.

    Args:

    • property_name (str): Name of property to set value for

    • property_value (Any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property name is not defined.


    Output function for payload.


    A credential that authenticates as an account on a Host.

    A credential is a way of authenticating as an account, such as an SSH key. It carries no privileges of its own; it identifies which account its holder becomes. Created by HostNode.add_credential().

    Credentials have no custom properties.

    Args:

    • name (str): Display name for credential. Required.

    • unique_id (str): Unique identifier for credential. Required.

    • credential_type (str, optional): Type for credential. Defaults to None.

    Raises:

    • ValueError: name or unique_id is empty.


    Add a holder to this credential.

    Holders are the identities known to hold the credential, so several people holding keys to one shared account can be distinguished. A holder is often not an account on this host at all.

    Args:

    • identity_id (str): ID of the identity that holds the credential.

    • is_local (bool, optional): Whether the holder is an account declared on this host. Defaults to True.

    Raises:

    • OAATemplateException: identity_id is empty.


    Output function for payload.


    Something inside a host that a privilege can apply to.

    A resource is something inside a host that a privilege can apply to, such as a service or a command, rather than the host as a whole. Referred to from a grant as resource_type.id via resource_key. Created by HostNode.add_resource().

    Args:

    • name (str): Display name for resource. Required.

    • unique_id (str): Unique identifier for resource within the resource_type. Required.

    • resource_type (str): The kind of thing this is, e.g. "service" or "command". Must not contain a "." or ":" character. Required.

    Attributes:

    • resource_key (str): The resource_type.id identifier a grant uses to refer to this resource.

    Raises:

    • ValueError: name, unique_id or resource_type is empty.

    • OAATemplateException: resource_type contains a "." or ":" character.


    The resource_type.id identifier a grant uses to refer to this resource.


    Set a custom property value for the resource.

    Property name must be defined for the fleet's resources before calling set_property.

    Args:

    • property_name (str): Name of property to set value for

    • property_value (Any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property name is not defined.


    Output function for payload.


    A privilege defined once on the fleet and referenced by name wherever it is granted.

    Names are supplied by the connector rather than fixed by Veza. Created by HostProvider.add_privilege().

    Args:

    • name (str): Name grants refer to

    • privilege_type (list[OAAPermission]): Canonical access types this privilege confers

    • description (str, optional): Description for privilege. Defaults to None.

    Raises:

    • ValueError: name is empty.

    • OAATemplateException: A privilege_type entry is not an OAAPermission.


    Output function for payload.


    Model for defining custom properties for a Host fleet's hosts, users, groups and resources.

    Property definitions define the names for additional entity properties and the expected type. Credentials have no custom properties.

    Attributes:

    • host_properties (dict): property definitions for hosts

    • user_properties (dict): property definitions for users

    • group_properties (dict): property definitions for groups







    Check property name for valid characters

    Raises an exception if the name string does not match required pattern. Name must start with a character and can only contain letters and _ character.

    Args:

    • name (str): name of property to validate

    Raises:

    • OAATemplateException: Name is not a string

    • OAATemplateException: Name contains invalid characters or does not start with a letter

    privileges (dict[HostPrivilegeDefinition]): Dictionary of privilege definitions, referenced by name from grants

  • property_definitions (HostPropertyDefinitions): Custom property names and types for the fleet

  • identity_provider_types (list[str], optional): Which kinds of identity provider may be searched when resolving the identities this submission refers to. Values must be one of IdPProviderType. Absent or empty means all of them. Defaults to None.
    identity_provider_types (list[str], optional): Which kinds of identity provider may be searched when resolving identities this submission refers to. Values must be one of IdPProviderType. Defaults to None.

    property_definitions (HostPropertyDefinitions, optional): Property definitions structure for the fleet. Defaults to None.

    users (dict[HostUser]): Dictionary of HostUser instances
  • groups (dict[HostGroup]): Dictionary of HostGroup instances

  • credentials (dict[HostCredential]): Dictionary of HostCredential instances

  • resources (dict[HostResource]): Dictionary of HostResource instances, keyed by resource_type.id

  • identity_to_privileges (dict): Dictionary of grants, one per principal per set of things the privileges apply to

  • assumes_user (str, optional): ID of the account on this host this credential authenticates as. Defaults to None.
  • created_at (str, optional): RFC3339 timestamp. Defaults to None.

  • last_used_at (str, optional): RFC3339 timestamp. Defaults to None.

  • is_active (bool, optional): Defaults to None.

  • can_expire (bool, optional): Defaults to None.

  • expires_at (str, optional): RFC3339 timestamp. Defaults to None.

  • privileges (list, optional): Privilege names granted, each of which must have been defined on the provider with HostProvider.add_privilege(). An entry may be a bare name (str), or a dict carrying a name key where something needs to be said about how the privilege is held, such as {"name": "sudo", "no_password": True}. Defaults to None.

  • apply_to_host (bool, optional): Whether these privileges apply to the host itself. Defaults to None, in which case they apply to the host when no resources are given, and to the resources alone when some are.

  • resources (list, optional): Resources inside the host these privileges also apply to. Accepts HostResource instances or "resource_type.id" strings. Defaults to None.

  • is_local (bool, optional): True for a group defined on the host itself. False for a directory group granted access without a local definition. Defaults to True.
  • identities (list[str], optional): The identities in an identity provider this group corresponds to. Required when is_local is False. Defaults to None.

  • is_local (bool, optional): True for an account configured on the host itself. False for a network user granted access without a local account. Defaults to True.

  • identity_type (HostIdentityType, optional): Whether this account stands for a person. Absent means human. Defaults to None.

  • is_active (bool, optional): Defaults to None.

  • last_login_at (str, optional): RFC3339 timestamp of the account's last login to this host. Defaults to None.

  • is_local (bool, optional): Defaults to True.
  • identity_type (HostIdentityType, optional): Defaults to None.

  • is_active (bool, optional): Defaults to None.

  • last_login_at (str, optional): RFC3339 timestamp. Defaults to None.

  • property_definitions (CaseInsensitiveDict, optional): Property definitions for the host's users. Defaults to None.

  • is_local (bool, optional): Defaults to True.
  • identities (list[str], optional): The identities in an identity provider this group corresponds to. Defaults to None.

  • property_definitions (CaseInsensitiveDict, optional): Property definitions for the host's groups. Defaults to None.

  • assumes_user (str, optional): ID of the account on this host this credential authenticates as. Defaults to None.
  • created_at (str, optional): RFC3339 timestamp. Defaults to None.

  • last_used_at (str, optional): RFC3339 timestamp. Defaults to None.

  • is_active (bool, optional): Defaults to None.

  • can_expire (bool, optional): Defaults to None.

  • expires_at (str, optional): RFC3339 timestamp. Defaults to None.

  • property_definitions (CaseInsensitiveDict, optional): Property definitions for the host's resources. Defaults to None.
    resource_properties (dict): property definitions for resources

    method __init__

    method add_environment

    method add_host

    method add_privilege

    method get_payload

    class HostEnvironment

    method __init__

    method to_dict

    class HostNode

    method __init__

    method add_credential

    method add_grant

    method add_group

    method add_resource

    method add_user

    method set_property

    method to_dict

    class HostUser

    method __init__

    method add_group

    method set_property

    method to_dict

    class HostGroup

    method __init__

    method add_member_group

    method set_property

    method to_dict

    class HostCredential

    method __init__

    method add_holder

    method to_dict

    class HostResource

    method __init__

    property resource_key

    method set_property

    method to_dict

    class HostPrivilegeDefinition

    method __init__

    method to_dict

    class HostPropertyDefinitions

    method __init__

    method define_group_property

    method define_host_property

    method define_resource_property

    method define_user_property

    method to_dict

    method validate_name

    __init__(host_type: 'str') β†’ None
    add_environment(
        unique_id: 'str',
        name: 'str',
        description: 'str' = None,
        identity_provider_types: 'List[str]' = None
    ) β†’ HostEnvironment
    add_host(name: 'str', unique_id: 'str', environment_id: 'str' = None) β†’ HostNode
    add_privilege(
        name: 'str',
        privilege_type: 'List[OAAPermission]',
        description: 'str' = None
    ) β†’ HostPrivilegeDefinition
    get_payload() β†’ dict
    __init__(
        unique_id: 'str',
        name: 'str',
        description: 'str' = None,
        identity_provider_types: 'List[str]' = None
    ) β†’ None
    to_dict() β†’ dict
    __init__(
        name: 'str',
        unique_id: 'str',
        environment_id: 'str' = None,
        property_definitions: 'HostPropertyDefinitions' = None
    ) β†’ None
    add_credential(
        name: 'str',
        unique_id: 'str',
        credential_type: 'str' = None,
        assumes_user: 'str' = None,
        created_at: 'str' = None,
        last_used_at: 'str' = None,
        is_active: 'bool' = None,
        can_expire: 'bool' = None,
        expires_at: 'str' = None
    ) β†’ HostCredential
    add_grant(
        principal_id: 'str',
        grantee_type: 'HostGranteeType',
        is_local: 'bool' = True,
        privileges: 'list' = None,
        apply_to_host: 'bool' = None,
        resources: 'list' = None
    ) β†’ None
    add_group(
        name: 'str',
        unique_id: 'str',
        group_type: 'str' = None,
        is_local: 'bool' = True,
        identities: 'List[str]' = None
    ) β†’ HostGroup
    add_resource(name: 'str', unique_id: 'str', resource_type: 'str') β†’ HostResource
    add_user(
        name: 'str',
        unique_id: 'str',
        identities: 'List[str]' = None,
        is_local: 'bool' = True,
        identity_type: 'HostIdentityType' = None,
        is_active: 'bool' = None,
        last_login_at: 'str' = None
    ) β†’ HostUser
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    to_dict() β†’ dict
    __init__(
        name: 'str',
        unique_id: 'str',
        identities: 'List[str]' = None,
        is_local: 'bool' = True,
        identity_type: 'HostIdentityType' = None,
        is_active: 'bool' = None,
        last_login_at: 'str' = None,
        property_definitions=None
    ) β†’ None
    add_group(group_id: 'str') β†’ None
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    to_dict() β†’ dict
    __init__(
        name: 'str',
        unique_id: 'str',
        group_type: 'str' = None,
        is_local: 'bool' = True,
        identities: 'List[str]' = None,
        property_definitions=None
    ) β†’ None
    add_member_group(group_id: 'str', is_local: 'bool' = True) β†’ None
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    to_dict() β†’ dict
    __init__(
        name: 'str',
        unique_id: 'str',
        credential_type: 'str' = None,
        assumes_user: 'str' = None,
        created_at: 'str' = None,
        last_used_at: 'str' = None,
        is_active: 'bool' = None,
        can_expire: 'bool' = None,
        expires_at: 'str' = None
    ) β†’ None
    add_holder(identity_id: 'str', is_local: 'bool' = True) β†’ None
    to_dict() β†’ dict
    __init__(
        name: 'str',
        unique_id: 'str',
        resource_type: 'str',
        property_definitions=None
    ) β†’ None
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    to_dict() β†’ dict
    __init__(
        name: 'str',
        privilege_type: 'List[OAAPermission]',
        description: 'str' = None
    ) β†’ None
    to_dict() β†’ dict
    __init__() β†’ None
    define_group_property(name: 'str', property_type: 'OAAPropertyType') β†’ None
    define_host_property(name: 'str', property_type: 'OAAPropertyType') β†’ None
    define_resource_property(name: 'str', property_type: 'OAAPropertyType') β†’ None
    define_user_property(name: 'str', property_type: 'OAAPropertyType') β†’ None
    to_dict() β†’ dict
    validate_name(name: 'str') β†’ None

    Enrichment

    Classes for constructing an OAA JSON payload for Entity Enrichment

    Copyright 2026 Veza Technologies Inc.

    Use of this source code is governed by the MIT license that can be found in the LICENSE file or at https://opensource.org/licenses/MIT.

    Global Variables


    • PROPERTY_NAME_REGEX


    class EntityEnrichment

    Class for modeling Entity Enrichment using the OAA Entity Enrichment template.

    The Entity Enrichment template attaches custom properties to existing Veza entities (such as AwsIamRole, AwsIamUser or OktaUser) discovered by other integrations. Unlike other OAA templates it does not create new entities; it only enriches existing ones with additional searchable metadata.

    Enriched entities are tracked internally in a case insensitive dictionary keyed by the composite of entity type, data source id, and id so the same entity id can be enriched across multiple data sources or types. The index is private; use add_entity to add entities and get_entity to retrieve them.

    Args:

    • name (str): Name for the Entity Enrichment instance. Used when creating the provider but not included in the payload itself.

    Attributes:

    • name (str): Name for the Entity Enrichment instance

    • property_definitions (EntityEnrichmentPropertyDefinitions): Custom property definitions grouped by Veza entity type


    Add an entity to enrich

    Creates a new EnrichedEntity for an existing Veza entity. The entity is tracked internally keyed by the composite of entity type, data source id, and id so each entity may appear only once within the payload.

    Args:

    • entity_type (str): Veza entity type (e.g. "AwsIamRole", "OktaUser")

    • id (str): Veza unique ID for the entity. For AWS entities this is the ARN.

    • data_source_id (str): ID of the Veza data source that owns the entity. For AWS this is the account

    Raises:

    • OAATemplateException: Entity with the same type, id, and data_source_id already exists

    Returns:

    • EnrichedEntity: Entity for the new enrichment record


    Get a previously added entity to enrich.

    Looks up an entity added with add_entity by its type, id, and data source id.

    Args:

    • entity_type (str): Veza entity type (e.g. "AwsIamRole", "OktaUser")

    • id (str): Veza unique ID for the entity. For AWS entities this is the ARN.

    • data_source_id (str): ID of the Veza data source that owns the entity.

    Raises:

    • OAATemplateException: No entity with the given type, id, and data_source_id has been added

    Returns:

    • EnrichedEntity: The matching enrichment record


    Get the OAA payload.

    Returns the complete OAA template payload for entity enrichment as serializable dictionary

    Returns:

    • dict: OAA payload as dictionary


    Enriched Entity

    Represents a single Veza entity to enrich with custom property values. The entity is identified by the combination of entity_type, id and data_source_id. Init variables are all required and must not be empty such as "".

    Args:

    • entity_type (str): Veza entity type, e.g. "AwsIamRole", "OktaUser"

    • id (str): Veza unique ID for the entity. For AWS entities this is the ARN.

    • data_source_id (str): ID of the Veza data source that owns the entity.

    Raises:

    • ValueError: Any of the required arguments are empty.


    Set Enriched Entity custom property value

    Property name must be defined for the entity's type before calling set_property

    Args:

    • property_name (str): Name of property

    • property_value (any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property with property_name is not defined for the entity type.


    Output enriched entity to dictionary for payload.


    Model for defining custom properties for Entity Enrichment.

    Property definitions are grouped by Veza entity type. Each entity type maintains its own set of property names and types that may be set on enriched entities of that type.

    Attributes:

    • entity_properties (dict): Property definitions keyed by entity type. Each value is a dictionary mapping property name to its OAAPropertyType.


    Define a property for an entity type.

    Args:

    • entity_type (str): Veza entity type the property applies to (e.g. "AwsIamRole")

    • name (str): name for property

    • property_type (OAAPropertyType): type for property

    Raises:

    • OAATemplateException: entity_type is not a non-empty string

    • OAATemplateException: name contains invalid characters or is not a string

    • OAATemplateException: property_type


    Return property definitions as list ready for OAA payload


    Check property name for valid characters

    Raises an exception if the name string does not match required pattern. Name must start with a character and can only contain letters and _ character.

    Args:

    • name (str): name of property to validate

    Raises:

    • OAATemplateException: Name is not a string

    • OAATemplateException: Name contains invalid characters or does not start with a letter

    ID combined with the data source type (e.g. "339083562601: awsiam").
    is not an OAAPropertyType enum

    method __init__

    method add_entity

    method get_entity

    method get_payload

    class EnrichedEntity

    method __init__

    method set_property

    method to_dict

    class EntityEnrichmentPropertyDefinitions

    method __init__

    method define_property

    method to_dict

    method validate_name

    __init__(name: 'str')
    add_entity(
        entity_type: 'str',
        id: 'str',
        data_source_id: 'str'
    ) β†’ EnrichedEntity
    get_entity(
        entity_type: 'str',
        id: 'str',
        data_source_id: 'str'
    ) β†’ EnrichedEntity
    get_payload() β†’ dict
    __init__(entity_type: 'str', id: 'str', data_source_id: 'str')
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    to_dict() β†’ dict
    __init__()
    define_property(
        entity_type: 'str',
        name: 'str',
        property_type: 'OAAPropertyType'
    ) β†’ None
    to_dict() β†’ list
    validate_name(name: 'str') β†’ None

    Principal

    Classes for constructing an OAA JSON payload for Custom Principal Submission

    Copyright 2026 Veza Technologies Inc.

    Use of this source code is governed by the MIT license that can be found in the LICENSE file or at https://opensource.org/licenses/MIT.


    class PrincipalEntityType

    Principal entity types.


    class CustomPrincipal

    CustomPrincipal class for modeling Principal services using OAA Custom Principal Template.

    Principals represent a source of identities (users and groups) to other OAA template types on the same provider.

    Class uses dictionaries to track most components, dictionaries are all keyed by case insensitive string of the entity name

    Args:

    • name (str): Name of Principal Provider

    • principal_type (str): Type descriptor for Principal Provider

    • tenant_id (str): Unique identifier for the tenant

    Attributes:

    • name (str): Name of custom Principal Provider

    • principal_type (str): Type for Principal Provider

    • property_definitions (PrincipalPropertyDefinitions): Custom Property definitions for Principal instance


    Add group to Principal submission

    Arguments:

    • name (str): name for group

    • unique_id (str, optional): unique ID for group

    • group_unique_id (str, optional): unique identifier for group. Used in identity correlation.

    Returns: CustomPrincipalGroup


    Add user to Principal submission

    Arguments:

    • name (str): name for user

    • unique_id (str, optional): unique ID for user

    • email (str, optional): email address for user

    Returns: CustomPrincipalUser


    Return formatted payload as dictionary for JSON conversion and upload


    Tenant model for Custom Principal submission.

    Args:

    • name (str): tenant name

    • unique_id (str): unique ID for tenant

    • tenant_unique_id (str, optional): unique identifier for tenant, usually a URL

    Attributes:

    • name (str): tenant name

    • id (str): unique ID for tenant

    • tenant_unique_id (str): unique identifier for tenant


    Add a new tag to Principal Tenant.

    Args:

    • key (str): Key for tag, aka name. Must be present and must be letters, numbers or _ (underscore) only.

    • value (str, optional): Value for Tag, will appear in Veza as key:value. Must be letters, numbers, whitespace and the special characters @,._- only. Defaults to "".


    Set custom property value for tenant.

    Property name must be defined for tenant before calling set_property().

    Args:

    • property_name (str): Name of property

    • property_value (Any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property with property_name is not defined.


    Output function for payload.


    User model for CustomPrincipal

    Args:

    • name (str): name for user

    • unique_id (str): unique ID for user

    • email (str, optional): email address for user

    Attributes:

    • name (str): name for user

    • unique_id (str): unique ID for user

    • email (str): email address for user

    • user_unique_id


    Add user to group by group ID.

    Args:

    • group_id (str): ID of group to add user to


    Add an identity to user.

    Args:

    • identity (str): Identity string for user


    Add a new tag to Principal User.

    Args:

    • key (str): Key for tag, aka name. Must be present and must be letters, numbers or _ (underscore) only.

    • value (str, optional): Value for Tag, will appear in Veza as key:value. Must be letters, numbers, whitespace and the special characters @,._- only. Defaults to "".


    Set custom property value for user.

    Property name must be defined for users before calling set_property().

    Args:

    • property_name (str): Name of property

    • property_value (Any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property with property_name is not defined.


    Function to prepare user entity for payload


    Group model for CustomPrincipal.

    Args:

    • name (str): name of group

    • unique_id (str): unique ID for group

    • property_definitions (PrincipalPropertyDefinitions, optional): Property definitions for custom properties

    Attributes:

    • name (str): name of group

    • id (str): unique ID for group

    • group_unique_id (str): Optional unique identifier for group. Used for identity_unique_id


    Add an identity to group.

    Args:

    • identity (str): Identity string for group


    Add a new tag to Principal Group.

    Args:

    • key (str): Key for tag, aka name. Must be present and must be letters, numbers or _ (underscore) only.

    • value (str, optional): Value for Tag, will appear in Veza as key:value. Must be letters, numbers, whitespace and the special characters @,._- only. Defaults to "".


    Set parent group for hierarchical group structure.

    Args:

    • parent_group_id (str): ID of parent group

    Raises:

    • OAATemplateException: If parent_group_id matches the group's own id


    Set custom property value for group.

    Property name must be defined for groups before calling set_property().

    Args:

    • property_name (str): Name of property

    • property_value (Any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property with property_name is not defined.


    Function to prepare group entity for payload.


    Model for defining custom properties for CustomPrincipal and its entities (tenant, users, groups).

    Property definitions define the names for additional entity properties and the expected type.

    Attributes:

    • tenant_properties (dict): property definitions for Principal Tenant

    • user_properties (dict): property definitions for Principal users

    • group_properties (dict): property definitions for Principal groups


    Define a group custom property.

    Args:

    • name (str): name of property

    • property_type (OAAPropertyType): type for property


    Define a tenant custom property.

    Args:

    • name (str): name of property

    • property_type (OAAPropertyType): type for property


    Define a user custom property.

    Args:

    • name (str): name of property

    • property_type (OAAPropertyType): type for property


    Returns custom Principal property definitions.


    Validate that a property name has been defined for a given Principal entity.

    Raises exception if property name has not been previously defined for entity

    Args:

    • property_name (str): name of property to validate

    • entity_type (PrincipalEntityType): type of entity custom property is for (TENANT, USER, or GROUP)

    Raises:

    • OAATemplateException: If property name is not defined

    tenant (CustomPrincipalTenant): Tenant model
  • users (dict[CustomPrincipalUser]): Dictionary of CustomPrincipalUser class instances

  • groups (dict[CustomPrincipalGroup]): Dictionary of CustomPrincipalGroup class instances

  • user_unique_id
    (str, optional): unique identifier for user if different than email
    property_definitions
    (PrincipalPropertyDefinitions, optional): Property definitions for custom properties
    property_definitions
    (PrincipalPropertyDefinitions, optional): Property definitions for custom properties
    (str): Optional unique identifier for user. Used for identity_unique_id if set.
  • display_name (str): display name for user

  • is_active (bool): whether user is active

  • created_at (str): date user was created (RFC3339 format)

  • deactivated_at (str): date user was deactivated (RFC3339 format)

  • last_login_at (str): date user last logged in (RFC3339 format)

  • group_type
    (str): type of group
  • parent_group_id (str): ID of parent group for hierarchical groups

  • method __init__

    method add_group

    method add_user

    method get_payload

    class CustomPrincipalTenant

    method __init__

    method add_tag

    method set_property

    method to_dict

    class CustomPrincipalUser

    method __init__

    method add_group

    method add_identity

    method add_tag

    method set_property

    method to_dict

    class CustomPrincipalGroup

    method __init__

    method add_identity

    method add_tag

    method set_parent_group

    method set_property

    method to_dict

    class PrincipalPropertyDefinitions

    method __init__

    method define_group_property

    method define_tenant_property

    method define_user_property

    method to_dict

    method validate_property_name

    __init__(name: 'str', principal_type: 'str', tenant_id: 'str') β†’ None
    add_group(
        name: 'str',
        unique_id: 'str' = None,
        group_unique_id: 'str' = None
    ) β†’ CustomPrincipalGroup
    add_user(
        name: 'str',
        unique_id: 'str' = None,
        email: 'str' = None,
        user_unique_id: 'str' = None
    ) β†’ CustomPrincipalUser
    get_payload() β†’ dict
    __init__(
        name: 'str',
        unique_id: 'str',
        tenant_unique_id: 'str' = None,
        property_definitions: 'PrincipalPropertyDefinitions' = None
    ) β†’ None
    add_tag(key: 'str', value: 'str' = '') β†’ None
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    to_dict() β†’ dict
    __init__(
        name: 'str',
        unique_id: 'str',
        email: 'str' = None,
        property_definitions: 'PrincipalPropertyDefinitions' = None
    ) β†’ None
    add_group(group_id: 'str') β†’ None
    add_identity(identity: 'str') β†’ None
    add_tag(key: 'str', value: 'str' = '') β†’ None
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    to_dict() β†’ dict
    __init__(
        name: 'str',
        unique_id: 'str',
        property_definitions: 'PrincipalPropertyDefinitions' = None
    ) β†’ None
    add_identity(identity: 'str') β†’ None
    add_tag(key: 'str', value: 'str' = '') β†’ None
    set_parent_group(parent_group_id: 'str') β†’ None
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    to_dict() β†’ dict
    __init__() β†’ None
    define_group_property(name: 'str', property_type: 'OAAPropertyType') β†’ None
    define_tenant_property(name: 'str', property_type: 'OAAPropertyType') β†’ None
    define_user_property(name: 'str', property_type: 'OAAPropertyType') β†’ None
    to_dict() β†’ dict
    validate_property_name(
        property_name: 'str',
        entity_type: 'PrincipalEntityType'
    ) β†’ None

    IdP

    Classes for constructing an OAA JSON payload for Custom IDP

    Copyright 2026 Veza Technologies Inc.

    Use of this source code is governed by the MIT license that can be found in the LICENSE file or at https://opensource.org/licenses/MIT.

    Global Variables


    • PROPERTY_NAME_REGEX


    class IdPEntityType

    IdP entity types.


    class CustomIdPProvider

    CustomIdPProvider class for modeling Identity Providers (IdP) using OAA Custom Identity Provider Template.

    CustomIdPProvider class consists of IdP domain information, user, group and external associations for identities like AWS Roles.

    Classes uses dictionaries to track most components, dictionaries are all keyed by string of the entity name

    Args:

    • name (str): Name of IdP

    • idp_type (str): Type descriptor for IdP, can be unique or share across multiple IdP e.g. ldap, IPA

    • domain (str): IdP domain name

    Attributes:

    • name (str): Name of custom IdP

    • idp_type (str): Type for IdP

    • description (str): Description for IdP

    • domain


    summary

    Args:

    • id (str): description

    • name (str): description

    Raises:

    Returns:

    • CustomIdPApp: description


    Add group to IdP.

    Arguments:

    • name (str): primary ID for group

    • full_name (str): optional display name for group

    • identity (str): optional unique identifier for group, if None name is used as identity


    Add user to IdP

    if no identity is set name will be used as identity

    Arguments:

    • name (str): primary ID for user

    • full_name (str): optional full name for display

    • email (str): optional email for user

    Returns: CustomIdPUser


    Return formatted payload as dictionary for JSON conversion and upload


    Create and set the identity mapping configuration.

    Initializes the identity_mapping_configuration attribute with a new IdentityMappingConfigurationSubmission instance and returns it for further configuration.

    Returns:

    • IdentityMappingConfigurationSubmission: The identity mapping configuration.


    Domain model for Custom IdP provider.

    Args:

    • name (str): domain name

    Attributes:

    • name (str): domain name


    Add a new tag to IdP Domain.

    Args:

    • key (str): Key for tag, aka name. Must be present and must be letters, numbers or _ (underscore) only.

    • value (str, optional): Value for Tag, will appear in Veza as key:value. Must be letters, numbers, whitespace and the special characters @,._- only. Defaults to "".


    Set custom property value for domain.

    Property name must be defined for domain before calling set_property(). See example below and IdPPropertyDefinitions.define_domain_property for more information.

    Args:

    • property_name (str): Name of property

    • property_value (Any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property with property_name is not defined.

    Example: idp = CustomIdPProvider(name="Example IdP", idp_type="example", domain="example.com") >>> idp.property_definitions.define_domain_property(name="my_property", property_type=OAAPropertyType.STRING) >>> idp.domain.set_property(property_name="my_property", property_value="domain property value")


    Output function for payload.


    Types of identities for permission mapping.


    User model for CustomIdPProvider.

    Args:

    • name (str): username for identity

    • email (str): primary email for user

    • full_name (str): Display name for user

    Attributes:

    • name (str): username for identity

    • email (str): primary email for user

    • full_name (str): display name for user


    Create App assignment for user

    Args:

    • id (str): ID of App assignment, must be unique for user

    • name (str): Name of assignment

    • app_id (str): App ID, must exist in list of Apps for IDP

    Raises:

    • OAATemplateException: Duplicate assignment ID

    • OAATemplateException: Unknown assignment property name


    Add AWS Roles to list of roles user can assume by ARN.

    Args:

    • arns (list): list of role ARNs as strings that the user is allowed to assume


    Add user to group(s) by group name

    Args:

    • group_identities (list): list of strings for group identities to add user to


    Add a new tag to IdP User.

    Args:

    • key (str): Key for tag, aka name. Must be present and must be letters, numbers or _ (underscore) only.

    • value (str, optional): Value for Tag, will appear in Veza as key:value. Must be letters, numbers, whitespace and the special characters @,._- only. Defaults to "".


    Set custom property value for user.

    Property name must be defined for users before calling set_property(). See example below and IdPPropertyDefinitions.define_user_property for more information.

    Args:

    • property_name (str): Name of property

    • property_value (Any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property with property_name is not defined.

    Example: idp = CustomIdPProvider(name="Example IdP", idp_type="example", domain="example.com") >>> idp.property_definitions.define_user_property(name="my_property", property_type=OAAPropertyType.STRING) >>> user1 = idp.add_user(name="User 1") >>> user1.set_property("my_property", "user1 value")


    Set an source external identity for user.

    • source_identity will connect CustomIdP user to a Veza graph IdP user.

    • provider_type limits scope for finding matching IdP identities

    • search all providers with IdPProviderType.ANY.

    Args:

    • identity (str): Unique Identity of the source identity

    • provider_type (IdPProviderType): Type for provider to match source identity from


    Function to prepare user entity for payload


    Group model for CustomIdPProvider.

    Args:

    • name (str): name of group

    • full_name (str): optional full name for group

    • identity (str): optional identifier for group if name is not reference identifier

    Parameters:

    • name (str): name of group

    • full_name (str): optional full name for group

    • identity (str): optional identifier for group, if None name is used as identity


    Create App assignment for group

    Args:

    • id (str): ID of App assignment, must be unique for group

    • name (str): Name of assignment

    • app_id (str): App ID, must exist in list of Apps for IDP

    Raises:

    • OAATemplateException: Duplicate assignment ID

    • OAATemplateException: Unknown assignment property name


    Add AWS Roles to list of roles group members can assume by ARN.

    Args:

    • arns (list): list of role ARNs as strings that the group members are allowed to assume


    Add group to group(s) by group name

    Adds current group to another parent group by the group identifier

    Args:

    • group_identities (list): list of strings for group identities to add group to


    Add a new tag to IdP Group.

    Args:

    • key (str): Key for tag, aka name. Must be present and must be letters, numbers or _ (underscore) only.

    • value (str, optional): Value for Tag, will appear in Veza as key:value. Must be letters, numbers, whitespace and the special characters @,._- only. Defaults to "".


    Set custom property value for group.

    Property name must be defined for groups before calling set_property(). See example below and IdPPropertyDefinitions.define_group_property for more information.

    Args:

    • property_name (str): Name of property

    • property_value (Any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property with property_name is not defined.

    Example: idp = CustomIdPProvider(name="Example IdP", idp_type="example", domain="example.com") >>> idp.property_definitions.define_group_property(name="my_property", property_type=OAAPropertyType.STRING) >>> group1 = idp.add_group(name="Group 1") >>> group1.set_property("my_property", "group1 value")


    Set an source external identity for group.

    • source_identity will connect CustomIDP group to a Veza graph IdP group.

    • provider_type limits scope for finding matching IdP group identities

    • search all providers with IdPProviderType.ANY.

    Args:

    • identity (str): Unique Identity of the source group

    • provider_type (IdPProviderType): Type for provider to match source identity from


    Function to prepare user entity for payload.


    App model for CustomIdPProvider

    Args:

    • id (str): ID for App, must be unique

    • name (str): Name for App

    • property_definitions (IdPPropertyDefinitions, optional): Custom property definitions, required to set custom properties. Defaults to None.

    Attributes:

    • id (str): ID for App, must be unique

    • name (str): Name for App

    • description (str): Description property for App


    Add AWS Roles to list of roles App can assume by ARN. Any Users or Groups assigned to the App are represented as being able to assume the roles.

    Args:

    • arns (list): list of role ARNs as strings that the user is allowed to assume


    Add a new tag to IdP User.

    Args:

    • key (str): Key for tag, aka name. Must be present and must be letters, numbers or _ (underscore) only.

    • value (str, optional): Value for Tag, will appear in Veza as key:value. Must be letters, numbers, whitespace and the special characters @,._- only. Defaults to "".


    Set custom property value for app.

    Property name must be defined for app before calling set_property(). See example below and IdPPropertyDefinitions.define_app_property for more information.

    Args:

    • property_name (str): Name of property

    • property_value (Any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property with property_name is not defined.

    Example: idp = CustomIdPProvider(name="Example IdP", idp_type="example", domain="example.com") >>> idp.property_definitions.define_app_property(name="my_property", property_type=OAAPropertyType.STRING) >>> app1 = idp.add_app(id="app1", ="App 1") >>> app1.set_property("my_property", "app1 value")



    Model for defining custom properties for CustomIdPProvider and its entities (users, groups, domain).

    Property definitions define the names for additional entity properties and the expected type.

    Attributes:

    • domain_properties (dict): property definitions for IdP Domain

    • user_properties (dict): property definitions for IdP users

    • group_properties (dict): property definitions for IdP groups


    Define an app assignment custom property

    Args:

    • name (str): name of property

    • property_type (OAAPropertyType): type for property


    Define an app custom property

    Args:

    • name (str): name of property

    • property_type (OAAPropertyType): type for property


    Define a domain custom property.

    Args:

    • name (str): name of property

    • property_type (OAAPropertyType): type for property


    Define a group custom property.

    Args:

    • name (str): name of property

    • property_type (OAAPropertyType): type for property


    Define a user custom property.

    Args:

    • name (str): name of property

    • property_type (OAAPropertyType): type for property


    Returns custom IdP property definitions.


    Validate that a property name has been defined for a given IdP entity.

    Raises exception if property name has not been previously defined for entity

    Args:

    • property_name (str): name of property to validate

    • entity_type (str): type of entity custom property is for (domain, users, groups)

    Raises:

    • OAATemplateException: If property name is not defined

    description (str, optional): Description for IdP. Defaults to None.
    (CustomIdPDomain): Domain model, created with domain name at init
  • users (dict[CustomIdPUser]): Dictionary of CustomIdPUser class instances

  • groups (dict[CustomIdPGroup]): Dictionary of CustomIdPGroup class instances

  • property_definitions (IdPPropertyDefinitions): Custom Property definitions for IdP instance

  • identity_mapping_configuration (IdentityMappingConfigurationSubmission): Identity mapping configuration, set via set_identity_mapping_configuration().

  • identity
    (str): optional unique identifier for user, if None name is used as identity
    identity
    (str): unique identifier for user (may be same as username or email, or another unique ID like employee number)
    identity
    (str): unique identifier for user (may be same as username or email, or another unique ID like employee number)
  • department (str): department name for user

  • is_active (bool): if user is active, defaults to None

  • is_guest (bool): if user is a guest type user, defaults to None

  • manager_id (str, optional): CustomIdPUser.identity of manager, defaults to None

  • identity_type (IdPUserIdentityType, optional): Identity type for user (HUMAN, NONHUMAN), defaults to HUMAN if not set.

  • assignment_properties
    (Optional[dict], optional): Optional custom properties to set. Property names must be defined first. Defaults to None.
    is_security_group (bool): Property for group, defaults to None (unset)
    assignment_properties
    (Optional[dict], optional): Optional custom properties to set. Property names must be defined first. Defaults to None.

    method __init__

    method add_app

    method add_group

    method add_user

    method get_payload

    method set_identity_mapping_configuration

    class CustomIdPDomain

    method __init__

    method add_tag

    method set_property

    method to_dict

    class IdPUserIdentityType

    class CustomIdPUser

    method __init__

    method add_app_assignment

    method add_assumed_role_arns

    method add_groups

    method add_tag

    method set_property

    method set_source_identity

    method to_dict

    class CustomIdPGroup

    method __init__

    method add_app_assignment

    method add_assumed_role_arns

    method add_groups

    method add_tag

    method set_property

    method set_source_identity

    method to_dict

    class CustomIdPApp

    method __init__

    method add_assumed_role_arns

    method add_tag

    method set_property

    method to_dict

    class IdPPropertyDefinitions

    method __init__

    method define_app_assignment_property

    method define_app_property

    method define_domain_property

    method define_group_property

    method define_user_property

    method to_dict

    method validate_property_name

    __init__(
        name: 'str',
        idp_type: 'str',
        domain: 'str',
        description: 'str' = None
    ) β†’ None
    add_app(id: 'str', name: 'str') β†’ CustomIdPApp
    add_group(
        name: 'str',
        full_name: 'str' = None,
        identity: 'str' = None
    ) β†’ CustomIdPGroup
    add_user(
        name: 'str',
        full_name: 'str' = None,
        email: 'str' = None,
        identity: 'str' = None
    ) β†’ CustomIdPUser
    get_payload() β†’ dict
    set_identity_mapping_configuration() β†’ IdentityMappingConfigurationSubmission
    __init__(
        name: 'str',
        property_definitions: 'IdPPropertyDefinitions' = None
    ) β†’ None
    add_tag(key: 'str', value: 'str' = '') β†’ None
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    to_dict() β†’ dict
    __init__(
        name: 'str',
        email: 'str' = None,
        full_name: 'str' = None,
        identity: 'str' = None,
        property_definitions: 'IdPPropertyDefinitions' = None
    ) β†’ None
    add_app_assignment(
        id: 'str',
        name: 'str',
        app_id: 'str',
        assignment_properties: 'Optional[dict]' = None
    ) β†’ None
    add_assumed_role_arns(arns: 'List[str]') β†’ None
    add_groups(group_identities: 'List[str]') β†’ None
    add_tag(key: 'str', value: 'str' = '') β†’ None
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    set_source_identity(identity: 'str', provider_type: 'IdPProviderType') β†’ None
    to_dict() β†’ dict
    __init__(
        name: 'str',
        full_name: 'str' = None,
        identity: 'str' = None,
        property_definitions: 'IdPPropertyDefinitions' = None
    ) β†’ None
    add_app_assignment(
        id: 'str',
        name: 'str',
        app_id: 'str',
        assignment_properties: 'Optional[dict]' = None
    ) β†’ None
    add_assumed_role_arns(arns: 'List[str]') β†’ None
    add_groups(group_identities: 'List[str]') β†’ None
    add_tag(key: 'str', value: 'str' = '') β†’ None
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    set_source_identity(identity: 'str', provider_type: 'IdPProviderType') β†’ None
    to_dict() β†’ None
    __init__(
        id: 'str',
        name: 'str',
        property_definitions: 'IdPPropertyDefinitions' = None
    ) β†’ None
    add_assumed_role_arns(arns: 'List[str]') β†’ None
    add_tag(key: 'str', value: 'str' = '') β†’ None
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    to_dict() β†’ dict
    __init__() β†’ None
    define_app_assignment_property(
        name: 'str',
        property_type: 'OAAPropertyType'
    ) β†’ None
    define_app_property(name: 'str', property_type: 'OAAPropertyType') β†’ None
    define_domain_property(name: 'str', property_type: 'OAAPropertyType') β†’ None
    define_group_property(name: 'str', property_type: 'OAAPropertyType') β†’ None
    define_user_property(name: 'str', property_type: 'OAAPropertyType') β†’ None
    to_dict() β†’ dict
    validate_property_name(property_name: 'str', entity_type: 'str') β†’ None

    Application

    Classes for constructing an OAA JSON payload for Custom Application

    Copyright 2026 Veza Technologies Inc.

    Use of this source code is governed by the MIT license that can be found in the LICENSE file or at https://opensource.org/licenses/MIT.

    Global Variables


    • PROPERTY_NAME_REGEX


    class OAAPermission

    Canonical permissions used by Veza Authorization Framework.

    Used to describe the raw data or metadata permissions granted by CustomPermission


    class OAAIdentityType

    Types of identities for permission mapping.


    Base class for CustomApplication.


    Class for modeling application authorization using the OAA Application template.

    CustomApplication class consists of identities, resources and permissions and produces the OAA JSON payload for the custom application template.

    Class uses dictionaries to track most entities that can be referenced after creation. Dictionaries keys are case insensitive of the entity identifier (name or id). This applies to local_users, local_groups, local_roles, idp_identities, resources and custom_permissions.

    Args:

    • name (str): Name of custom application

    • application_type (str): Searchable property, can be unique or shared across multiple applications

    • description (str, optional): Description for application. Defaults to None.

    Attributes:

    • application_type (str): Searchable application type

    • custom_permissions (dict[OAAPermission]): Dictionary of class instances

    • description (str): Description for application


    Legacy method for backwards compatibility.

    Deprecated: Access should be added through identity (local_role, local_group, idp)


    Create an Access Credential

    Access creds can be used to represent alternative access methods such as API keys or application integrations.

    Access creds can be assigned roles and permissions similar to local users. Access credentials can exist independently for use cases such as administratively created integrations or can be assigned to a local user for use cases like personal access tokens.

    Args:

    • unique_id (str): unique identifier for access cred

    • name (str): name for access cred

    Raises:

    • OAATemplateException: Access credential with unique ID already exists

    Returns:

    • AccessCred: New access cred


    Create a new local agent for the application.

    Agents represent AI agent entities. They can be assigned to groups, have access credentials, reference models, and be authorized via permissions or roles similar to local users.

    Args:

    • name (str): Display name for agent

    • unique_id (str, optional): Unique identifier for agent for reference by ID

    • ai_platform (str, optional): AI platform the agent runs on. Defaults to "".

    Raises:

    • OAATemplateException: Agent with identifier already exists

    Returns: LocalAgent


    Create a new custom permission.

    Creates a new CustomPermission object for the application that can be used to authorize identities to the application, resources/sub-resource or as part of a role.

    Args:

    • name (str): Name of the permission

    • permissions (list[OAAPermission]): Canonical permissions the custom permission represents

    • apply_to_sub_resources (bool, optional): If true, when permission is applied to the application or resource, identity also has permission to all children of application/resource. Defaults to False.

    Returns: CustomPermission


    Create an IdP principal identity.

    IdP users and groups can be authorized directly to applications and resources by associating custom application permissions and roles with an IdP identity's name or email.

    Args:

    • name (str): IdP unique identifier for user or group.

    Returns: IdPIdentity


    Create a new local group.

    Groups can be associated to resources via permissions or roles. All users in the local group are granted the group's authorization.

    Local groups will be identified by name by default, if unique_id is provided it will be used as the identifier instead

    Local groups can be referenced after creation using .local_groups dictionary attribute. Dictionary is case insensitive keyed by unique_id or name if not using unique_id.

    Args:

    • name (str): Display name for group

    • identities (list): List of IdP identities to associate group with.

    • unique_id (str, optional): Unique identifier for group for reference by ID

    Returns: LocalGroup


    Create a new local role.

    • A local role represents a collection of permissions.

    • Identities (local user, group, idp user) can be assigned a role to the application or resource, granting the role's permissions.

    • Local roles will be identified by name by default, if unique_id is provided it will be used as the identifier instead.

    • Local roles can be referenced after creation if needed through

    Args:

    • name (str): Display name for role

    • permissions (list): List of Custom Permission names to include in role. CustomPermission must be created separately.

    • unique_id (str, optional): Unique identifier for role for reference by ID

    Returns: LocalRole


    Create a new local user for application.

    Local users can be assigned to groups and associated with resources via permissions or roles. Groups and identities can be provided at creation or added later. See Identity and LocalUser class for operations.

    Local users will be identified by name by default, if unique_id is provided it will be used as the identifier instead.

    Local users can be referenced after creation using the .local_users dictionary attribute. Dictionary is case insensitivekeyed by unique_id or name if not using unique_id.

    Use unique_id when name is not guaranteed to be unique. All permission, group and role assignments will be referenced by unique_id.

    Args:

    • name (str): Display name for user

    • identities (list): List of identities as strings (usually email) for local user. Used to map local user to discovered IdP identities.

    • groups (list[LocalGroup]): List of group names (as string) to add user to

    Returns: LocalUser


    Create a new local model for the application.

    Models represent AI model entities. They can be referenced by agents.

    Args:

    • name (str): Display name for model

    • unique_id (str, optional): Unique identifier for model for reference by ID

    • ai_platform (str, optional): AI platform the model runs on. Defaults to "".

    Raises:

    • OAATemplateException: Model with identifier already exists

    Returns: LocalModel


    Add Entity Owner

    Add an entity owner to the application.

    Args:

    • external_id (str): IDP identity of the owner

    • owner_type (str): IDP Node type of the entity, OAAOwnerType enum. For Custom IDP owner_type should be OAA.<IDPType>.IDPUser

    • is_primary (bool, optional): Is Primary Owner. Defaults to False.


    Create a new resource under the application.

    Resource type is used to group and filter application resources. It should be consistent for all common resources of an application.

    Returns new resource object.

    Resource is identified by name by default unless unique_id is provided. name must be unique if not using unique_id.

    Resources can be referenced after creation using the .resources dictionary attribute. Dictionary is keyed by unique_id or name if not using unique_id. Use unique_id when name is not guaranteed to be unique.

    Args:

    • name (str): Name of resources

    • resource_type (str): Type for resource

    • description (str, optional): Description of resources. Defaults to None.

    Returns: CustomResource


    Add a tag to the Application

    Args:

    • key (str): Key for tag, aka name. Must be present and must be letters, numbers or _ (underscore) only.

    • value (str, optional): Value for Tag, will appear in Veza as key:value. Must be letters, numbers, whitespace and the special characters @,._- only. Defaults to "".


    Return the 'applications' section of the payload as serializable dictionary.


    Add a custom permission to the application.

    Deprecated: See CustomApplication.add_custom_permission()

    Args:

    • custom_permission (CustomPermission): CustomPermission class

    Raises:

    • Exception: Duplicate Keys

    Returns:

    • CustomPermission: The defined custom Permission


    Collect authorizations for all identities into a single list.


    Get the OAA payload.

    Returns the complete OAA template payload for application as serializable dictionary

    Returns:

    • dict: OAA payload as dictionary


    Return the 'permissions' section of the payload as serializable dictionary.


    Set a custom property value for the application.

    Property name must be defined for CustomApplication before calling set_property. See example below and ApplicationPropertyDefinitions.define_application_property for more information on defining properties.

    Args:

    • property_name (str): Name of property to set value for, property names must be defined as part of the application property_definitions

    • property_value (Any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property name is not defined

    Example: app = CustomApplication("App", application_type="example") >>> app.property_definitions.define_application_property(name="my_property", property_type=OAAPropertyType.STRING) >>> app.set_property("my_property", "property value")


    Class for resources and sub-resources.

    Should be used for representing components of the application to which authorization is granted. Each resource has a name and a type. The type can be used for grouping and filtering.

    Arguments:

    • name (str): display name for resource, must be unique to parent application or resource unless using unique_id

    • resource_type (str): type for resource

    • description (str): description for resource

    Attributes:

    • name (str): display name for resource, must be unique to parent application or resource

    • unique_id (str): resource's unique identifier if provided.

    • resource_type (str): type for resource


    No longer supported, access should be added through identity (local_user, local_group, idp)


    Add Entity Owner

    Add an entity owner to the resource.

    Args:

    • external_id (str): IDP identity of the owner

    • owner_type (str): IDP Node type of the entity, OAAOwnerType enum. For Custom IDP owner_type should be OAA.<IDPType>.IDPUser

    • is_primary (bool, optional): Is Primary Owner. Defaults to False.


    Add an external connection to the resource.

    Used to add a relationship to another entity discovered by Veza such as a service account or AWS IAM role.

    Args:

    • id (str): Unique identifier for connection entity

    • node_type (str): Veza type for connecting node


    Create a new sub-resource under current resource

    Args:

    • name (str): display name for resource

    • resource_type (str): type for resource

    • description (str, optional): String description. Defaults to None.

    Returns: CustomResource


    Add a new tag to resource.

    Args:

    • key (str): Key for tag, aka name. Must be present and must be letters, numbers or _ (underscore) only.

    • value (str, optional): Value for Tag, will appear in Veza as key:value. Must be letters, numbers, whitespace and the special characters @,._- only. Defaults to "".


    Set the value for a custom property on a resource or sub-resource.

    Property name must be defined for resource type before calling set_property(). See example below and ApplicationPropertyDefinitions.define_resource_property for more information on defining properties.

    Args:

    • property_name (str): Name of property to set value for

    • property_value (Any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property_name is not defined

    Example: app = CustomApplication("App", application_type="example") >>> app.property_definitions.define_resource_property(resource_type="cog", name="my_property", property_type=OAAPropertyType.STRING) >>> cog1 = app.add_resource(name="cog1", resource_type="cog") >>> cog1.set_property("my_property", "this value")


    Return the dictionary representation of resource.


    Base class for deriving all identity types (should not be used directly).

    Args:

    • name (str): name of identity

    • identity_type (OAAIdentityType): Veza Identity Type (local_user, local_group, idp)

    • unique_id (str, optional): ID of entity for reference by ID

    Attributes:

    • name (str): name of identity

    • identity_type (OAAIdentityType): Veza Identity Type (local_user, local_group, idp)

    • application_permissions (list[CustomPermission]): List of permissions identity has directly to custom application


    Add Entity Owner

    Add an entity owner for user or group.

    Args:

    • external_id (str): IDP identity of the owner

    • owner_type (str): IDP Node type of the entity, OAAOwnerType enum. For Custom IDP owner_type should be OAA.<IDPType>.IDPUser

    • is_primary (bool, optional): Is Primary Owner. Defaults to False.


    Add a permission to an identity.

    Permission can apply to either the application or application resource/sub-resources

    Args:

    • permissions ([str]): List of strings representing the permission names

    • resource (CustomResource, optional): Custom resource, if None permission is applied to application. Defaults to None.

    • apply_to_application (bool): Apply permission to application when True, defaults to False


    Add a role to an identity.

    Role to authorize identity to either the application or application resource/sub-resource based on role's permissions.

    Role assignment properties can be set with the assignment_properties dictionary parameter with property names as the keys. Role assignment properties types must be defined on the application prior to setting.

    Args:

    • role (str): Name of role as string

    • resources (List[CustomResource], optional): Custom resource, if None role is applied to application. Defaults to None.

    • apply_to_application (bool, optional): Apply permission to application when True, False will replace existing value, None will leave previous setting if any


    Add a new tag to identity.

    Args:

    • key (str): Key for tag, aka name. Must be present and must be letters, numbers or _ (underscore) only.

    • value (str, optional): Value for Tag, will appear in Veza as key:value. Must be letters, numbers, whitespace and the special characters @,._- only. Defaults to "".


    Get a JSON serializable dictionary of all the identity's permissions and roles.

    Formats the identity's permissions and roles for the Custom Application template payload

    Returns:

    • dict: JSON serializable dictionary of all the identity's permissions and roles


    Set a custom defined property to a specific value on an identity.

    Property name must be defined for identity type before calling set_property(). See example below for LocalUser and ApplicationPropertyDefinitions.define_local_user_property for more information on defining properties. Property must be defined for the correct Identity type (LocalUser or LocalGroup, IdPIdentity does not support custom properties).

    Args:

    • property_name (str): Name of property to set value for

    • property_value (Any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property with property_name is not defined.

    Example:

    app = CustomApplication("App", application_type="example") >>> app.property_definitions.define_local_user_property(name="my_property", property_type=OAAPropertyType.STRING) >>> user1 = app.add_local_user(name="user1") >>> user1.set_property("my_property", "value for user1")


    Types of local user account, human or service account.


    LocalUser identity, derived from Identity base class.

    Used to model an application user. Can be associated with an external IdP user, or represent a local account.

    Args:

    • name (str): name of identity

    • identities (list): list of strings for IdP identity association

    • groups (list[LocalGroup]): list of group names as strings to add user too

    Attributes:

    • name (str): name of identity

    • id (str): ID of entity for ID based reference

    • email (string): Users email address


    Add access cred to user (access cred must be created separately)

    Args:

    • access_cred (str): unique identifier of access cred


    Add user to local group (group must be created separately).

    Args:

    • group (str): identifier of local group


    Add multiple identities to a local user from a list.

    Args:

    • identities (list[str]): list of identities to add to user


    Add an identity to user.

    Identity should match the email address or another principal identifier for an IdP user (Okta, Azure, etc.). Veza will create a connection from the application local user to IdP identity.

    Args:

    • identity (str): email or identifier for IdP user


    Add Entity Owner

    Add an entity owner for user or group.

    Args:

    • external_id (str): IDP identity of the owner

    • owner_type (str): IDP Node type of the entity, OAAOwnerType enum. For Custom IDP owner_type should be OAA.<IDPType>.IDPUser

    • is_primary (bool, optional): Is Primary Owner. Defaults to False.


    Add a permission to an identity.

    Permission can apply to either the application or application resource/sub-resources

    Args:

    • permissions ([str]): List of strings representing the permission names

    • resource (CustomResource, optional): Custom resource, if None permission is applied to application. Defaults to None.

    • apply_to_application (bool): Apply permission to application when True, defaults to False


    Add a role to an identity.

    Role to authorize identity to either the application or application resource/sub-resource based on role's permissions.

    Role assignment properties can be set with the assignment_properties dictionary parameter with property names as the keys. Role assignment properties types must be defined on the application prior to setting.

    Args:

    • role (str): Name of role as string

    • resources (List[CustomResource], optional): Custom resource, if None role is applied to application. Defaults to None.

    • apply_to_application (bool, optional): Apply permission to application when True, False will replace existing value, None will leave previous setting if any


    Add a new tag to identity.

    Args:

    • key (str): Key for tag, aka name. Must be present and must be letters, numbers or _ (underscore) only.

    • value (str, optional): Value for Tag, will appear in Veza as key:value. Must be letters, numbers, whitespace and the special characters @,._- only. Defaults to "".


    Get a JSON serializable dictionary of all the identity's permissions and roles.

    Formats the identity's permissions and roles for the Custom Application template payload

    Returns:

    • dict: JSON serializable dictionary of all the identity's permissions and roles


    Set a custom defined property to a specific value on an identity.

    Property name must be defined for identity type before calling set_property(). See example below for LocalUser and ApplicationPropertyDefinitions.define_local_user_property for more information on defining properties. Property must be defined for the correct Identity type (LocalUser or LocalGroup, IdPIdentity does not support custom properties).

    Args:

    • property_name (str): Name of property to set value for

    • property_value (Any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property with property_name is not defined.

    Example:

    app = CustomApplication("App", application_type="example") >>> app.property_definitions.define_local_user_property(name="my_property", property_type=OAAPropertyType.STRING) >>> user1 = app.add_local_user(name="user1") >>> user1.set_property("my_property", "value for user1")


    Output user to dictionary for payload.


    LocalGroup identity.

    Derived from Identity base class. Used to represent groups of local users for application.

    Args:

    • name (str): name of group

    • identities (list): list of strings for IdP identity association

    • unique_id (string, optional): Unique identifier for group

    Attributes:

    • name (str): name of identity

    • identities (list): list of strings for IdP identity association

    • groups (list[LocalGroup]): list of group names as strings that group is member of for nested groups


    Add a nested group to local group (group must be created separately).

    Args:

    • group (str): identifier of local group


    Add an identity to group.

    The email address or another valid identifier should match that of an IdP principal (Okta, Azure, etc.). Veza will create a connection from the application local group to IdP identity.

    Args:

    • identity (str): primary IdP identifier for group to associate


    Add Entity Owner

    Add an entity owner for user or group.

    Args:

    • external_id (str): IDP identity of the owner

    • owner_type (str): IDP Node type of the entity, OAAOwnerType enum. For Custom IDP owner_type should be OAA.<IDPType>.IDPUser

    • is_primary (bool, optional): Is Primary Owner. Defaults to False.


    Add a permission to an identity.

    Permission can apply to either the application or application resource/sub-resources

    Args:

    • permissions ([str]): List of strings representing the permission names

    • resource (CustomResource, optional): Custom resource, if None permission is applied to application. Defaults to None.

    • apply_to_application (bool): Apply permission to application when True, defaults to False


    Add a role to an identity.

    Role to authorize identity to either the application or application resource/sub-resource based on role's permissions.

    Role assignment properties can be set with the assignment_properties dictionary parameter with property names as the keys. Role assignment properties types must be defined on the application prior to setting.

    Args:

    • role (str): Name of role as string

    • resources (List[CustomResource], optional): Custom resource, if None role is applied to application. Defaults to None.

    • apply_to_application (bool, optional): Apply permission to application when True, False will replace existing value, None will leave previous setting if any


    Add a new tag to identity.

    Args:

    • key (str): Key for tag, aka name. Must be present and must be letters, numbers or _ (underscore) only.

    • value (str, optional): Value for Tag, will appear in Veza as key:value. Must be letters, numbers, whitespace and the special characters @,._- only. Defaults to "".


    Get a JSON serializable dictionary of all the identity's permissions and roles.

    Formats the identity's permissions and roles for the Custom Application template payload

    Returns:

    • dict: JSON serializable dictionary of all the identity's permissions and roles


    Set a custom defined property to a specific value on an identity.

    Property name must be defined for identity type before calling set_property(). See example below for LocalUser and ApplicationPropertyDefinitions.define_local_user_property for more information on defining properties. Property must be defined for the correct Identity type (LocalUser or LocalGroup, IdPIdentity does not support custom properties).

    Args:

    • property_name (str): Name of property to set value for

    • property_value (Any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property with property_name is not defined.

    Example:

    app = CustomApplication("App", application_type="example") >>> app.property_definitions.define_local_user_property(name="my_property", property_type=OAAPropertyType.STRING) >>> user1 = app.add_local_user(name="user1") >>> user1.set_property("my_property", "value for user1")


    Output group to dictionary for payload.


    IdP identity derived from Identity base class.

    Used to associate IdP identities (users or groups) directly to resource where concept of local users/groups doesn't apply to application.

    Args:

    • name (str): Primary IdP identifier for identity (email, group name, etc)

    • property_definitions (ApplicationPropertyDefinitions, optional): Property definitions for role assignment validation

    Attributes:

    • name (str): name of identity

    • identity_type (OAAIdentityType): Veza Identity Type, (idp)

    • application_permissions (list[CustomPermission]): permissions identity has directly to custom application


    Add Entity Owner

    Add an entity owner for user or group.

    Args:

    • external_id (str): IDP identity of the owner

    • owner_type (str): IDP Node type of the entity, OAAOwnerType enum. For Custom IDP owner_type should be OAA.<IDPType>.IDPUser

    • is_primary (bool, optional): Is Primary Owner. Defaults to False.


    Add a permission to an identity.

    Permission can apply to either the application or application resource/sub-resources

    Args:

    • permissions ([str]): List of strings representing the permission names

    • resource (CustomResource, optional): Custom resource, if None permission is applied to application. Defaults to None.

    • apply_to_application (bool): Apply permission to application when True, defaults to False


    Add a role to an identity.

    Role to authorize identity to either the application or application resource/sub-resource based on role's permissions.

    Role assignment properties can be set with the assignment_properties dictionary parameter with property names as the keys. Role assignment properties types must be defined on the application prior to setting.

    Args:

    • role (str): Name of role as string

    • resources (List[CustomResource], optional): Custom resource, if None role is applied to application. Defaults to None.

    • apply_to_application (bool, optional): Apply permission to application when True, False will replace existing value, None will leave previous setting if any


    Add a new tag to identity.

    Args:

    • key (str): Key for tag, aka name. Must be present and must be letters, numbers or _ (underscore) only.

    • value (str, optional): Value for Tag, will appear in Veza as key:value. Must be letters, numbers, whitespace and the special characters @,._- only. Defaults to "".


    Get a JSON serializable dictionary of all the identity's permissions and roles.

    Formats the identity's permissions and roles for the Custom Application template payload

    Returns:

    • dict: JSON serializable dictionary of all the identity's permissions and roles


    Set custom IdP property (no functionality).

    IdP identities do not support custom properties since the identity is discovered through the provider (Okta, Azure, etc)


    Access Credential derived from Identity base class.

    Access Creds can be used to represent non-user based methods that grant access such as API keys or integrations.

    AccessCreds can be assigned roles or permissions to an application or resource. An AccessCred can stand-alone or be associated to a local user.

    Args:

    • unique_id (str): Unique identifier for access cred

    • name (str): Name for access cred, does not need to be unique

    Attributes:

    • unique_id (str): Unique identifier for access cred

    • name (str): Name for access cred, does not need to be unique

    • is_active (bool): Indicate if credential is active, defaults to True


    Add Entity Owner

    Add an entity owner to the access credential.

    Args:

    • external_id (str): IDP identity of the owner

    • owner_type (str): IDP Node type of the entity, OAAOwnerType enum. For Custom IDP owner_type should be OAA.<IDPType>.IDPUser

    • is_primary (bool, optional): Is Primary Owner. Defaults to False.


    Add a permission to an identity.

    Permission can apply to either the application or application resource/sub-resources

    Args:

    • permissions ([str]): List of strings representing the permission names

    • resource (CustomResource, optional): Custom resource, if None permission is applied to application. Defaults to None.

    • apply_to_application (bool): Apply permission to application when True, defaults to False


    Add a role to an identity.

    Role to authorize identity to either the application or application resource/sub-resource based on role's permissions.

    Role assignment properties can be set with the assignment_properties dictionary parameter with property names as the keys. Role assignment properties types must be defined on the application prior to setting.

    Args:

    • role (str): Name of role as string

    • resources (List[CustomResource], optional): Custom resource, if None role is applied to application. Defaults to None.

    • apply_to_application (bool, optional): Apply permission to application when True, False will replace existing value, None will leave previous setting if any


    Add a new tag to identity.

    Args:

    • key (str): Key for tag, aka name. Must be present and must be letters, numbers or _ (underscore) only.

    • value (str, optional): Value for Tag, will appear in Veza as key:value. Must be letters, numbers, whitespace and the special characters @,._- only. Defaults to "".


    Get a JSON serializable dictionary of all the identity's permissions and roles.

    Formats the identity's permissions and roles for the Custom Application template payload

    Returns:

    • dict: JSON serializable dictionary of all the identity's permissions and roles


    Set a custom defined property to a specific value on an access credential.

    Property name must be defined for access credentials before calling set_property(). See example below and ApplicationPropertyDefinitions.define_access_cred_property for more information on defining properties.

    Args:

    • property_name (str): Name of property to set value for

    • property_value (Any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property with property_name is not defined.

    Example:

    app = CustomApplication("App", application_type="example") >>> app.property_definitions.define_access_cred_property(name="my_property", property_type=OAAPropertyType.STRING) >>> cred1 = app.add_access_cred(unique_id="cred001", name="Cred 001") >>> cred1.set_property("my_property", "value for cred001")


    Output Access credential dictionary for payload


    Local Agent identity, derived from Identity base class.

    Represents an AI agent entity within an application. Agents can be assigned to groups, have access credentials, reference models, and be authorized via permissions or roles.

    Args:

    • name (str): Display name for agent

    • unique_id (str, optional): Unique identifier for agent for reference by ID

    • ai_platform (str, optional): AI platform the agent runs on

    Attributes:

    • name (str): Display name

    • unique_id (str): Unique identifier if provided

    • ai_platform (str): AI platform

    • ai_agent_publisher


    Add access cred to agent (access cred must be created separately).

    Args:

    • access_cred (str): unique identifier of access cred


    Add agent to local group (group must be created separately).

    Args:

    • group (str): identifier of local group


    Add a model reference to agent (model must be created separately).

    Args:

    • model (str): identifier of local model


    Add Entity Owner

    Add an entity owner for user or group.

    Args:

    • external_id (str): IDP identity of the owner

    • owner_type (str): IDP Node type of the entity, OAAOwnerType enum. For Custom IDP owner_type should be OAA.<IDPType>.IDPUser

    • is_primary (bool, optional): Is Primary Owner. Defaults to False.


    Add a permission to an identity.

    Permission can apply to either the application or application resource/sub-resources

    Args:

    • permissions ([str]): List of strings representing the permission names

    • resource (CustomResource, optional): Custom resource, if None permission is applied to application. Defaults to None.

    • apply_to_application (bool): Apply permission to application when True, defaults to False


    Add a role to an identity.

    Role to authorize identity to either the application or application resource/sub-resource based on role's permissions.

    Role assignment properties can be set with the assignment_properties dictionary parameter with property names as the keys. Role assignment properties types must be defined on the application prior to setting.

    Args:

    • role (str): Name of role as string

    • resources (List[CustomResource], optional): Custom resource, if None role is applied to application. Defaults to None.

    • apply_to_application (bool, optional): Apply permission to application when True, False will replace existing value, None will leave previous setting if any


    Add a new tag to identity.

    Args:

    • key (str): Key for tag, aka name. Must be present and must be letters, numbers or _ (underscore) only.

    • value (str, optional): Value for Tag, will appear in Veza as key:value. Must be letters, numbers, whitespace and the special characters @,._- only. Defaults to "".


    Get a JSON serializable dictionary of all the identity's permissions and roles.

    Formats the identity's permissions and roles for the Custom Application template payload

    Returns:

    • dict: JSON serializable dictionary of all the identity's permissions and roles


    Set a custom defined property on an agent.

    Property name must be defined for agents before calling set_property().

    Args:

    • property_name (str): Name of property to set value for

    • property_value (Any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property with property_name is not defined.


    Output agent to dictionary for payload.


    Represents an AI model entity within an application.

    Models can be referenced by agents and have custom properties, tags, and owners.

    Args:

    • name (str): Display name for model

    • unique_id (str, optional): Unique identifier for model for reference by ID

    • ai_platform (str, optional): AI platform the model runs on

    Attributes:

    • name (str): Display name

    • unique_id (str): Unique identifier if provided

    • ai_platform (str): AI platform

    • ai_model_publisher


    Add Entity Owner

    Add an entity owner to the model.

    Args:

    • external_id (str): IDP identity of the owner

    • owner_type (str): IDP Node type of the entity, OAAOwnerType enum. For Custom IDP owner_type should be OAA.<IDPType>.IDPUser

    • is_primary (bool, optional): Is Primary Owner. Defaults to False.


    Add a new tag to model.

    Args:

    • key (str): Key for tag, aka name. Must be present and must be letters, numbers or _ (underscore) only.

    • value (str, optional): Value for Tag, will appear in Veza as key:value. Defaults to "".


    Set a custom defined property on a model.

    Property name must be defined for models before calling set_property().

    Args:

    • property_name (str): Name of property to set value for

    • property_value (Any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property with property_name is not defined.


    Output model to dictionary for payload.


    Represent a Custom Application Local Role.

    Local Roles are a collection of permissions (as CustomPermission). Roles can be used to associate a local user, group or IdP identity to an application, resource or sub-resource.

    Permissions can either be assigned at creation and/or added later.

    If the CustomPermission definition includes resource types in the resource_types list, the permission will only be assigned to resources/sub-resources that match that type as part of an assignment.

    Args:

    • name (str): name of local role

    • permissions (list[CustomPermission], optional): List of custom permission names (strings) to associate with the role. Defaults to empty list.

    • unique_id (string, optional): Unique identifier for role for identification by ID

    Attributes:

    • name (str): name of local role

    • unique_id (str): Unique identifier for role for identification by ID

    • permissions (list[CustomPermission]): list of custom permission names (strings) to associate with the role


    Add Entity Owner

    Add an entity owner to the local role.

    Args:

    • external_id (str): IDP identity of the owner

    • owner_type (str): IDP Node type of the entity, OAAOwnerType enum. For Custom IDP owner_type should be OAA.<IDPType>.IDPUser

    • is_primary (bool, optional): Is Primary Owner. Defaults to False.


    Add a permission to the role.

    Args:

    • permissions (list): List of permission names (strings) to add to role


    Add a nested sub-role to the role (nested role must be created separately)

    Args:

    • role (str): identifier of the local role to nest inside this role


    Add a new tag to role.

    Args:

    • key (str): Key for tag, aka name. Must be present and must be letters, numbers or _ (underscore) only.

    • value (str, optional): Value for Tag, will appear in Veza as key:value. Must be letters, numbers, whitespace and the special characters @,._- only. Defaults to "".


    Set the value for custom property on a local role.

    Property name must be defined for local roles before calling set_property(). See example below and ApplicationPropertyDefinitions.define_local_role_property for more information on defining properties.

    Args:

    • property_name (str): Name of property to set value for

    • property_value (Any): Value for property, type should match OAAPropertyType for property definition

    • ignore_none (bool, optional): Do not set property if value is None. Defaults to False.

    Raises:

    • OAATemplateException: If property name is not defined.

    Example: app = CustomApplication("App", application_type="example") >>> app.property_definitions.define_local_role_property(name="my_property", property_type=OAAPropertyType.STRING) >>> role1 = app.add_local_role(name="role1") >>> role1.set_property(property_name="my_property", property_value="role1s value")


    Convert role to dictionary for inclusion in JSON payload.

    Returns:

    • dict: serializable dictionary of role


    CustomPermission class for defining CustomApplication permissions.

    • Custom permissions represent the named permissions for the application in its terms (e.g. "Admin" or "PUSH") and define the Veza canonical mapping (e.g. DataRead, MetadataRead, DataWrite).

    • A permission can either be applied directly to an application or resource or assigned as part of a role.

    • Optionally, when permissions are used as part of a role, if the resource_types list is populated the permission will only be applied to resources who's type is in the resource_types list when the role is applied to a resource.

    Args:

    • name (str): Display name for permission

    • permissions (list): List of OAAPermission enums that represent the canonical permissions

    • apply_to_sub_resources (bool, optional): If true, when permission is applied to the application or resource, identity also has permission to all children of application/resource. Defaults to False.

    Attributes:

    • name (str): Display name for permission

    • permissions (list[OAAPermission]): List of OAAPermission enums that represent the canonical permissions

    • apply_to_sub_resources (bool): If true, when permission is applied to the application or resource, identity also has permission to all children of application/resource.


    Add a resource type to the resource_types list.

    Extends the list of resource types permission applies to when used in role assignment.

    Args:

    • resource_type (str): The resource type string value


    Returns dictionary representation for payload.


    Model for defining custom properties for application and its entities (users, groups, roles, resources).

    Property definitions define the names for additional entity properties and the expected type.

    Args:

    • application_type (str): type of custom application property definitions apply to

    Attributes:

    • application_properties (dict): property definitions for application

    • local_user_properties (dict): property definitions for local users

    • local_group_properties (dict): property definitions for local groups


    Define an access cred property.

    Args:

    • name (str): name for property

    • property_type (OAAPropertyType): type for property


    Define an application property.

    Args:

    • name (str): name for property

    • property_type (OAAPropertyType): type for property


    Define a local agent property.

    Args:

    • name (str): name for property

    • property_type (OAAPropertyType): type for property


    Define a local group property.

    Args:

    • name (str): name for property

    • property_type (OAAPropertyType): type for property


    Define a local model property.

    Args:

    • name (str): name for property

    • property_type (OAAPropertyType): type for property


    Define a local role property.

    Args:

    • name (str): name for property

    • property_type (OAAPropertyType): type for property


    Define a local user property.

    Args:

    • name (str): name for property

    • property_type (OAAPropertyType): type for property


    Define a property for a resource by type of resource.

    Args:

    • resource_type (str): type of resource property definition is for

    • name (str): property name

    • property_type (OAAPropertyType): type for property



    Return property definitions as dictionary ready for OAA payload


    Check property name for valid characters

    Raises an exception if the name string does not match required pattern. Name must start with a character and can only contain letters and _ character.

    Args:

    • name (str): name of property to validate

    Raises:

    • OAATemplateException: Name is not a string

    • OAATemplateException: Name contains invalid characters or does not start with a letter


    Validate that a property name has been defined for given resource type.

    Args:

    • property_name (str): name of property to validate

    • entity_type (str): type of entity custom property is for (application, local_user, local_group, local_role, resource)

    • resource_type (str): (optional) type for validating resource property names, only applicable to entity_type resource

    Raises:

    • OAATemplateException: If property name has not been previously defined for entity

    identity_to_permissions (dict): Mapping of authorizations for identities to resources
  • idp_identities (dict[IdPIdentity]): Contains federated identities without a corresponding local account

  • local_groups (dict[LocalGroup]): Contains application groups (collections of users)

  • local_roles (dict[LocalRole]): Contains application roles (collections of permissions)

  • local_users (dict[LocalUser]): Contains users local to the application and their properties

  • name (str): Name of custom application

  • properties (dict): key value pairs of property values, property keys must be defined as part of the property_definitions

  • property_definitions (ApplicationPropertyDefinitions): Custom property names and types for the application

  • resources (dict[CustomResource]): Contains data resources and subresources within the application

  • ai_agent_publisher (str, optional): Publisher of the AI agent. Defaults to "".

    resource_types (list, optional): List of resource types as strings that the permission relates to. Defaults to empty list.

    .local_roles
    case insensitive dictionary attribute.
  • When a permission that has resource_types is added to a role, it will only apply to resources with a matching resource_type

  • unique_id (str, optional): Unique identifier for user for reference by ID
    ai_model_publisher (str, optional): Publisher of the AI model. Defaults to "".
  • ai_model_family (str, optional): Model family. Defaults to "".

  • ai_model_series (str, optional): Model series. Defaults to "".

  • unique_id
    (str, optional): Unique identifier for resource. defaults to None.
    application_name (str): name of parent application
  • resource_key (str, optional): for sub-resources the full unique identifier required for identity_to_permissions section. Defaults to name or unique_id if not provided.

  • property_definitions (ApplicationPropertyDefinitions, optional): Property definitions structure for the resource

  • unique_id (str, optional): Optional unique identifier for the resource. Defaults to None.

  • application_name (str): name of parent application
  • resource_key (str): for sub-resources represents the sub-resource's parent path

  • sub_resources (dict): dictionary of sub-resources keyed by name

  • properties (dict): dictionary of properties set for resource

  • tags (list[Tag]): list of tags

  • unique_id
    (str, optional): Unique identifier for new subresource, Defaults to
    name
    .
    resource_permissions (dict): Dictionary of custom permissions associated with resources and sub-resources. Key is permission, value is list of resource keys
  • application_roles (LocalRole): List of roles identity has directly to custom application

  • resource_roles (dict): Dictionary of local_roles for resources and sub-resources. Key is roles, value is list of resource keys

  • properties (dict): Dictionary of properties for identity, allowed values will vary by identity type

  • tags (list[Tag]): List of tags

  • assignment_properties (dict, optional): Custom properties for the role assignment. Defaults to no properties.

    unique_id (string, optional): For reference by ID
    identities
    (list): list of strings for IdP identity association
  • groups (list[LocalGroup]): list of group names as strings to add user too

  • identity_type (OAAIdentityType): Veza Identity Type (local_user)

  • application_permissions (list[CustomPermission]): Permissions identity has directly to custom application

  • resource_permissions (dict): Dictionary of custom permissions associated with resources and sub-resources. Key is permission, value is list of resource keys

  • application_roles (list[LocalRole]): Custom application roles assigned directly to the identity

  • resource_roles (dict): Dictionary of local_roles for resources and sub-resources. Key is roles, value is list of resource keys

  • properties (dict): Dictionary of properties for identity, allowed values will vary by identity type

  • tags (list[Tag]): List of tags

  • is_active (bool): Defaults to None for unset

  • created_at (str): RFC3339 time stamp for user creation

  • last_login_at (str): RFC3339 time stamp for last login

  • deactivated_at (str): RFC3339 for user deactivate time

  • password_last_changed_at (str): RFC3339 time stamp for last password change

  • user_type (LocalUserType): Set the local user account type

  • assignment_properties (dict, optional): Custom properties for the role assignment. Defaults to no properties.

    identity_type (OAAIdentityType): Veza Identity Type, local_group
  • application_permissions (list[CustomPermission]): permissions identity has directly to custom application

  • resource_permissions (dict): Dictionary of custom permissions associated with resources and sub-resources. Key is permission, value is list of resource keys

  • application_roles (list[LocalRole]): list of roles identity has directly to custom application

  • resource_roles (dict): Dictionary of local_roles for resources and sub-resources. Key is roles, value is list of resource keys

  • properties (dict): Dictionary of properties for identity, allowed values will vary by identity type

  • tags (list[Tag]): List of tags

  • created_at (str): RFC3339 time stamp for group creation time

  • assignment_properties (dict, optional): Custom properties for the role assignment. Defaults to no properties.

    resource_permissions (dict): Dictionary of custom permissions associated with resources and sub-resources. Key is permission, value is list of resource keys
  • application_roles (list[LocalRole]): roles identity has directly to custom application

  • resource_roles (dict): Dictionary of local_roles for resources and sub-resources. Key is roles, value is list of resource keys

  • properties (dict): Dictionary of properties for identity, allowed values will vary by identity type

  • tags (list[Tag]): List of tags

  • assignment_properties (dict, optional): Custom properties for the role assignment. Defaults to no properties.

    created_at (str): Time access cred was created at as RFC3339 timestampe, defaults to empty
  • expires_at (str): Time access cred was created at as RFC3339 timestampe, defaults to empty

  • last_used_at (str): Time access cred was created at as RFC3339 timestampe, defaults to empty

  • can_expire (bool): Boolean to indicate if credential type can exipre, defaults to unset

  • assignment_properties (dict, optional): Custom properties for the role assignment. Defaults to no properties.

    ai_agent_publisher (str, optional): Publisher of the AI agent
  • property_definitions (ApplicationPropertyDefinitions, optional): Property definitions for the application

  • (str): AI agent publisher
  • is_active (bool): Whether agent is active, defaults to None for unset

  • created_at (str): RFC3339 timestamp for agent creation

  • groups (list): List of group names the agent belongs to

  • access_creds (list): List of access credential IDs associated with the agent

  • models (list): List of model names/IDs the agent uses

  • tags (list[Tag]): List of tags

  • owners (list[EntityOwner]): List of entity owners

  • properties (dict): Custom properties

  • assignment_properties (dict, optional): Custom properties for the role assignment. Defaults to no properties.

    ai_model_publisher (str, optional): Publisher of the AI model
  • ai_model_family (str, optional): Model family

  • ai_model_series (str, optional): Model series

  • property_definitions (ApplicationPropertyDefinitions, optional): Property definitions for the application

  • (str): AI model publisher
  • ai_model_family (str): AI model family

  • ai_model_series (str): AI model series

  • created_at (str): RFC3339 timestamp for model creation

  • tags (list[Tag]): List of tags

  • owners (list[EntityOwner]): List of entity owners

  • properties (dict): Custom properties

  • roles (list[LocalRole]): list of roles nested inside the role
  • tags (list[Tag]): list of Tags instances

  • resource_types (list, optional): List of resource types as strings that the permission relates to. Defaults to empty list.

    resource_types (list): List of resource types as strings that the permission relates to.

    local_role_properties (dict): property definitions for local roles
  • resources (dict): property definitions for resources keyed by resource type

  • class Application

    method __init__

    class CustomApplication

    method __init__

    method add_access

    method add_access_cred

    method add_agent

    method add_custom_permission

    method add_idp_identity

    method add_local_group

    method add_local_role

    method add_local_user

    method add_model

    method add_owner

    method add_resource

    method add_tag

    method app_dict

    method define_custom_permission

    method get_identity_to_permissions

    method get_payload

    method permissions_dict

    method set_property

    class CustomResource

    method __init__

    method add_access

    method add_owner

    method add_resource_connection

    method add_sub_resource

    method add_tag

    method set_property

    method to_dict

    class Identity

    method __init__

    method add_owner

    method add_permission

    method add_role

    method add_tag

    method get_identity_to_permissions

    method set_property

    class LocalUserType

    class LocalUser

    method __init__

    method add_access_cred

    method add_group

    method add_identities

    method add_identity

    method add_owner

    method add_permission

    method add_role

    method add_tag

    method get_identity_to_permissions

    method set_property

    method to_dict

    class LocalGroup

    method __init__

    method add_group

    method add_identity

    method add_owner

    method add_permission

    method add_role

    method add_tag

    method get_identity_to_permissions

    method set_property

    method to_dict

    class IdPIdentity

    method __init__

    method add_owner

    method add_permission

    method add_role

    method add_tag

    method get_identity_to_permissions

    method set_property

    class AccessCred

    method __init__

    method add_owner

    method add_permission

    method add_role

    method add_tag

    method get_identity_to_permissions

    method set_property

    method to_dict

    class LocalAgent

    method __init__

    method add_access_cred

    method add_group

    method add_model

    method add_owner

    method add_permission

    method add_role

    method add_tag

    method get_identity_to_permissions

    method set_property

    method to_dict

    class LocalModel

    method __init__

    method add_owner

    method add_tag

    method set_property

    method to_dict

    class LocalRole

    method __init__

    method add_owner

    method add_permissions

    method add_role

    method add_tag

    method set_property

    method to_dict

    class CustomPermission

    method __init__

    method add_resource_type

    method to_dict

    class ApplicationPropertyDefinitions

    method __init__

    method define_access_cred_property

    method define_application_property

    method define_local_agent_property

    method define_local_group_property

    method define_local_model_property

    method define_local_role_property

    method define_local_user_property

    method define_resource_property

    method define_role_assignment_property

    method to_dict

    method validate_name

    method validate_property_name

    __init__(name, application_type, description=None)
    __init__(name: 'str', application_type: 'str', description: 'str' = None) β†’ None
    add_access(identity, identity_type, permission, resource=None)
    add_access_cred(unique_id: 'str', name: 'str') β†’ AccessCred
    add_agent(
        name: 'str',
        unique_id: 'str' = None,
        ai_platform: 'str' = '',
        ai_agent_publisher: 'str' = ''
    ) β†’ LocalAgent
    add_custom_permission(
        name: 'str',
        permissions: 'List[OAAPermission]',
        apply_to_sub_resources: 'bool' = False,
        resource_types: 'List[str]' = None
    ) β†’ CustomPermission
    add_idp_identity(name: 'str') β†’ IdPIdentity
    add_local_group(
        name: 'str',
        identities: 'List[str]' = None,
        unique_id: 'str' = None
    ) β†’ LocalGroup
    add_local_role(
        name: 'str',
        permissions: 'List[str]' = None,
        unique_id: 'str' = None
    ) β†’ LocalRole
    add_local_user(
        name: 'str',
        identities: 'List[str]' = None,
        groups: 'List[str]' = None,
        unique_id: 'str' = None
    ) β†’ LocalUser
    add_model(
        name: 'str',
        unique_id: 'str' = None,
        ai_platform: 'str' = '',
        ai_model_publisher: 'str' = '',
        ai_model_family: 'str' = '',
        ai_model_series: 'str' = ''
    ) β†’ LocalModel
    add_owner(
        external_id: 'str',
        owner_type: 'str',
        is_primary: 'bool' = False
    ) β†’ None
    add_resource(
        name: 'str',
        resource_type: 'str',
        description: 'str' = None,
        unique_id: 'str' = None
    ) β†’ CustomResource
    add_tag(key: 'str', value: 'str' = '') β†’ None
    app_dict() β†’ dict
    define_custom_permission(
        custom_permission: 'CustomPermission'
    ) β†’ CustomPermission
    get_identity_to_permissions() β†’ list
    get_payload() β†’ dict
    permissions_dict() β†’ dict
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    __init__(
        name: 'str',
        resource_type: 'str',
        description: 'str',
        application_name: 'str',
        resource_key: 'str' = None,
        property_definitions: 'ApplicationPropertyDefinitions' = None,
        unique_id: 'str' = None
    ) β†’ None
    add_access(identity, identity_type, permission)
    add_owner(
        external_id: 'str',
        owner_type: 'str',
        is_primary: 'bool' = False
    ) β†’ None
    add_resource_connection(id: 'str', node_type: 'str') β†’ None
    add_sub_resource(
        name: 'str',
        resource_type: 'str',
        description: 'str' = None,
        unique_id: 'str' = None
    ) β†’ CustomResource
    add_tag(key: 'str', value: 'str' = '') β†’ None
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    to_dict() β†’ dict
    __init__(
        name: 'str',
        identity_type: 'OAAIdentityType',
        unique_id: 'str' = None,
        property_definitions: 'ApplicationPropertyDefinitions' = None
    ) β†’ None
    add_owner(
        external_id: 'str',
        owner_type: 'str',
        is_primary: 'bool' = False
    ) β†’ None
    add_permission(
        permission: 'str',
        resources: 'List[CustomResource]' = None,
        apply_to_application: 'bool' = False
    ) β†’ None
    add_role(
        role: 'str',
        resources: 'List[CustomResource]' = None,
        apply_to_application: 'Optional[bool]' = None,
        assignment_properties: 'Optional[dict]' = None
    ) β†’ None
    add_tag(key: 'str', value: 'str' = '') β†’ None
    get_identity_to_permissions(application_name: 'str') β†’ dict
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    __init__(
        name: 'str',
        identities: 'List[str]' = None,
        groups: 'List[str]' = None,
        unique_id: 'str' = None,
        property_definitions: 'ApplicationPropertyDefinitions' = None
    ) β†’ None
    add_access_cred(access_cred: 'str') β†’ None
    add_group(group: 'str') β†’ None
    add_identities(identities: 'List[str]') β†’ None
    add_identity(identity: 'str') β†’ None
    add_owner(
        external_id: 'str',
        owner_type: 'str',
        is_primary: 'bool' = False
    ) β†’ None
    add_permission(
        permission: 'str',
        resources: 'List[CustomResource]' = None,
        apply_to_application: 'bool' = False
    ) β†’ None
    add_role(
        role: 'str',
        resources: 'List[CustomResource]' = None,
        apply_to_application: 'Optional[bool]' = None,
        assignment_properties: 'Optional[dict]' = None
    ) β†’ None
    add_tag(key: 'str', value: 'str' = '') β†’ None
    get_identity_to_permissions(application_name: 'str') β†’ dict
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    to_dict() β†’ dict
    __init__(
        name,
        identities=None,
        unique_id: 'str' = None,
        property_definitions: 'ApplicationPropertyDefinitions' = None
    )
    add_group(group: 'str') β†’ None
    add_identity(identity: 'str') β†’ None
    add_owner(
        external_id: 'str',
        owner_type: 'str',
        is_primary: 'bool' = False
    ) β†’ None
    add_permission(
        permission: 'str',
        resources: 'List[CustomResource]' = None,
        apply_to_application: 'bool' = False
    ) β†’ None
    add_role(
        role: 'str',
        resources: 'List[CustomResource]' = None,
        apply_to_application: 'Optional[bool]' = None,
        assignment_properties: 'Optional[dict]' = None
    ) β†’ None
    add_tag(key: 'str', value: 'str' = '') β†’ None
    get_identity_to_permissions(application_name: 'str') β†’ dict
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    to_dict() β†’ dict
    __init__(
        name: 'str',
        property_definitions: 'ApplicationPropertyDefinitions' = None
    ) β†’ None
    add_owner(
        external_id: 'str',
        owner_type: 'str',
        is_primary: 'bool' = False
    ) β†’ None
    add_permission(
        permission: 'str',
        resources: 'List[CustomResource]' = None,
        apply_to_application: 'bool' = False
    ) β†’ None
    add_role(
        role: 'str',
        resources: 'List[CustomResource]' = None,
        apply_to_application: 'Optional[bool]' = None,
        assignment_properties: 'Optional[dict]' = None
    ) β†’ None
    add_tag(key: 'str', value: 'str' = '') β†’ None
    get_identity_to_permissions(application_name: 'str') β†’ dict
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    __init__(
        unique_id: 'str',
        name: 'str',
        property_definitions: 'ApplicationPropertyDefinitions' = None
    ) β†’ None
    add_owner(
        external_id: 'str',
        owner_type: 'str',
        is_primary: 'bool' = False
    ) β†’ None
    add_permission(
        permission: 'str',
        resources: 'List[CustomResource]' = None,
        apply_to_application: 'bool' = False
    ) β†’ None
    add_role(
        role: 'str',
        resources: 'List[CustomResource]' = None,
        apply_to_application: 'Optional[bool]' = None,
        assignment_properties: 'Optional[dict]' = None
    ) β†’ None
    add_tag(key: 'str', value: 'str' = '') β†’ None
    get_identity_to_permissions(application_name: 'str') β†’ dict
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    to_dict() β†’ dict
    __init__(
        name: 'str',
        unique_id: 'str' = None,
        ai_platform: 'str' = '',
        ai_agent_publisher: 'str' = '',
        property_definitions: 'ApplicationPropertyDefinitions' = None
    ) β†’ None
    add_access_cred(access_cred: 'str') β†’ None
    add_group(group: 'str') β†’ None
    add_model(model: 'str') β†’ None
    add_owner(
        external_id: 'str',
        owner_type: 'str',
        is_primary: 'bool' = False
    ) β†’ None
    add_permission(
        permission: 'str',
        resources: 'List[CustomResource]' = None,
        apply_to_application: 'bool' = False
    ) β†’ None
    add_role(
        role: 'str',
        resources: 'List[CustomResource]' = None,
        apply_to_application: 'Optional[bool]' = None,
        assignment_properties: 'Optional[dict]' = None
    ) β†’ None
    add_tag(key: 'str', value: 'str' = '') β†’ None
    get_identity_to_permissions(application_name: 'str') β†’ dict
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    to_dict() β†’ dict
    __init__(
        name: 'str',
        unique_id: 'str' = None,
        ai_platform: 'str' = '',
        ai_model_publisher: 'str' = '',
        ai_model_family: 'str' = '',
        ai_model_series: 'str' = '',
        property_definitions: 'ApplicationPropertyDefinitions' = None
    ) β†’ None
    add_owner(
        external_id: 'str',
        owner_type: 'str',
        is_primary: 'bool' = False
    ) β†’ None
    add_tag(key: 'str', value: 'str' = '') β†’ None
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    to_dict() β†’ dict
    __init__(
        name: 'str',
        permissions: 'List[str]' = None,
        unique_id: 'str' = None,
        property_definitions: 'ApplicationPropertyDefinitions' = None
    ) β†’ None
    add_owner(
        external_id: 'str',
        owner_type: 'str',
        is_primary: 'bool' = False
    ) β†’ None
    add_permissions(permissions: 'List[str]') β†’ None
    add_role(role: 'str') β†’ None
    add_tag(key: 'str', value: 'str' = '') β†’ None
    set_property(
        property_name: 'str',
        property_value: 'any',
        ignore_none: 'bool' = False
    ) β†’ None
    to_dict() β†’ dict
    __init__(
        name: 'str',
        permissions: 'List[OAAPermission]',
        apply_to_sub_resources: 'bool' = False,
        resource_types: 'list' = None
    ) β†’ None
    add_resource_type(resource_type: 'str') β†’ None
    to_dict() β†’ dict
    __init__(application_type: 'str') β†’ None
    define_access_cred_property(
        name: 'str',
        property_type: 'OAAPropertyType'
    ) β†’ None
    define_application_property(
        name: 'str',
        property_type: 'OAAPropertyType'
    ) β†’ None
    define_local_agent_property(
        name: 'str',
        property_type: 'OAAPropertyType'
    ) β†’ None
    define_local_group_property(
        name: 'str',
        property_type: 'OAAPropertyType'
    ) β†’ None
    define_local_model_property(
        name: 'str',
        property_type: 'OAAPropertyType'
    ) β†’ None
    define_local_role_property(name: 'str', property_type: 'OAAPropertyType') β†’ None
    define_local_user_property(name: 'str', property_type: 'OAAPropertyType') β†’ None
    define_resource_property(
        resource_type: 'str',
        name: 'str',
        property_type: 'OAAPropertyType'
    ) β†’ None
    define_role_assignment_property(
        name: 'str',
        property_type: 'OAAPropertyType'
    ) β†’ None
    to_dict() β†’ dict
    validate_name(name: 'str') β†’ None
    validate_property_name(
        property_name: 'str',
        entity_type: 'str',
        resource_type: 'str' = None
    ) β†’ bool