Python SDK

Modules

• client: Classes for calling Veza APIs and managing OAA providers and data sources.
• templates: Classes for constructing an OAA JSON payload (Custom "Application" or "IdP").
• utils: oaaclient utility functions.

Classes

• client.OAAClient: OAA API Connection and Management.
• client.OAAClientError: Error raised by OAAClient.
• templates.Application: Base class for CustomApplication.
• templates.ApplicationPropertyDefinitions: Model for defining custom properties for application and its entities (users, groups, roles, resources).
• templates.CustomApplication: Class for modeling application authorization using the OAA Application template.
• templates.CustomIdPDomain: Domain model for Custom IdP provider.
• templates.CustomIdPGroup: Group model for CustomIdPProvider.
• templates.CustomIdPProvider: CustomIdPProvider class for modeling Identity Providers (IdP) using OAA Custom Identity Provider Template.
• templates.CustomIdPUser: User model for CustomIdPProvider.
• templates.CustomPermission: CustomPermission class for defining CustomApplication permissions.
• templates.CustomResource: Class for resources and sub-resources.
• templates.IdPEntityType: IdP entity types.
• templates.IdPIdentity: IdP identity derived from Identity base class.
• templates.IdPPropertyDefinitions: Model for defining custom properties for CustomIdPProvider and its entities (users, groups, domain).
• templates.IdPProviderType: Veza supported IdP provider types.
• templates.Identity: Base class for deriving all identity types (should not be used directly).
• templates.LocalGroup: LocalGroup identity.
• templates.LocalRole: Represent a Custom Application Local Role.
• templates.LocalUser: LocalUser identity, derived from Identity base class.
• templates.OAAIdentityType: Types of identities for permission mapping.
• templates.OAAPermission: Canonical permissions used by Veza Authorization Framework.
• templates.OAAPropertyType: Supported types for custom properties on OAA entities such as application, resource, and identity.
• templates.OAATemplateException: General exception used for violations of the template schema.
• templates.Provider: Base class for CustomProvider.
• templates.Tag: Veza tag data model.

Functions

• client.main
• templates.append_helper: Helper function to simplify appending.
• templates.unique_strs: Returns a list of unique strings from input list case insensitive
• utils.encode_icon_file: read an icon file to a base64 encoded string
• utils.load_json_from_file: Load JSON from file
• utils.log_arg_error: Helper function for logging errors when loading parameters