OpenMetadata/openmetadata-docs/content/v1.8.x/sdk/python/api-reference/index.md

title	slug
Overview	/sdk/python/api-reference

API Overview

Modules

• auth_provider: Interface definition for an Auth provider
• client: Python API REST wrapper and helpers
• client_utils: OMeta client create helpers
• credentials: Helper methods to handle creds retrieval
• models: Pydantic models for ometa client API
• ometa_api: OpenMetadata is the high level Python API that serves as a wrapper
• provider_registry: Register auth provider init functions here
• routes: OMeta API endpoints
• utils: Helper functions to handle OpenMetadata Entities' properties
• dashboard_mixin: Mixin class containing Table specific methods
• data_insight_mixin: Mixin class containing data specific methods
• es_mixin: Mixin class containing Lineage specific methods
• ingestion_pipeline_mixin: Mixin class containing ingestion pipeline specific methods
• lineage_mixin: Mixin class containing Lineage specific methods
• mlmodel_mixin: Mixin class containing Lineage specific methods
• patch_mixin: Mixin class containing PATCH specific methods
• patch_mixin_utils: Utilities and a super class containing common utility methods for mixins performing JSON PATCHes
• pipeline_mixin: Mixin class containing Pipeline specific methods
• query_mixin: Mixin class containing Query specific methods
• role_policy_mixin: Mixin class containing Role and Policy specific methods
• search_index_mixin: Mixin class containing Search Index specific methods
• server_mixin: Mixin class containing Server and client specific methods
• service_mixin: Helper mixin to handle services
• table_mixin: Mixin class containing Table specific methods
• tests_mixin: Mixin class containing Tests specific methods
• topic_mixin: Mixin class containing Topic specific methods
• user_mixin: Mixin class containing User specific methods
• version_mixin: Mixin class containing entity versioning specific methods

Classes

• auth_provider.Auth0AuthenticationProvider: OAuth authentication implementation
• auth_provider.AuthenticationException: Error trying to get the token from the provider
• auth_provider.AuthenticationProvider: Interface definition for an Authentication provider
• auth_provider.AzureAuthenticationProvider: Prepare the Json Web Token for Azure auth
• auth_provider.CustomOIDCAuthenticationProvider: Custom OIDC authentication implementation
• auth_provider.GoogleAuthenticationProvider: Google authentication implementation
• auth_provider.NoOpAuthenticationProvider: Extends AuthenticationProvider class
• auth_provider.OktaAuthenticationProvider: Prepare the Json Web Token for Okta auth
• auth_provider.OpenMetadataAuthenticationProvider: OpenMetadata authentication implementation
• client.APIError: Represent API related error.
• client.ClientConfig: :param raw_data: should we return api response raw or wrap it with
• client.REST: REST client wrapper to manage requests with
• client.RetryException: API Client retry exception
• credentials.DATE: date string in the format YYYY-MM-DD
• credentials.FLOAT: api allows passing floats or float as strings.
• credentials.URL: Handle URL for creds retrieval
• models.EntityList: Pydantic Entity list model
• ometa_api.EmptyPayloadException: Raise when receiving no data, even if no exception
• ometa_api.InvalidEntityException: We receive an entity not supported in an operation
• ometa_api.MissingEntityTypeException: We are receiving an Entity Type[T] not covered
• ometa_api.OpenMetadata: Generic interface to the OpenMetadata API
• provider_registry.InvalidAuthProviderException: Raised when we cannot find a valid auth provider
• dashboard_mixin.OMetaDashboardMixin: OpenMetadata API methods related to Dashboards and Charts.
• data_insight_mixin.DataInsightMixin: data insight mixin used to write results
• es_mixin.ESMixin: OpenMetadata API methods related to Elasticsearch.
• ingestion_pipeline_mixin.OMetaIngestionPipelineMixin: OpenMetadata API methods related to ingestion pipeline.
• lineage_mixin.OMetaLineageMixin: OpenMetadata API methods related to Lineage.
• mlmodel_mixin.OMetaMlModelMixin: OpenMetadata API methods related to MlModel.
• patch_mixin.OMetaPatchMixin: OpenMetadata API methods related to Tables.
• patch_mixin_utils.OMetaPatchMixinBase: OpenMetadata API methods related to Glossaries.
• patch_mixin_utils.PatchField: JSON PATCH field names
• patch_mixin_utils.PatchOperation: JSON PATCH operation strings
• patch_mixin_utils.PatchPath: JSON PATCH path strings
• patch_mixin_utils.PatchValue: JSON PATCH value field names
• pipeline_mixin.OMetaPipelineMixin: OpenMetadata API methods related to the Pipeline Entity
• query_mixin.OMetaQueryMixin: OpenMetadata API methods related to Queries.
• role_policy_mixin.OMetaRolePolicyMixin: OpenMetadata API methods related to Roles and Policies.
• search_index_mixin.OMetaSearchIndexMixin: OpenMetadata API methods related to search index.
• server_mixin.OMetaServerMixin: OpenMetadata API methods related to the Pipeline Entity
• server_mixin.VersionMismatchException: Used when server and client versions do not match
• server_mixin.VersionNotFoundException: Used when server doesn't return a version
• service_mixin.OMetaServiceMixin: OpenMetadata API methods related to service.
• table_mixin.OMetaTableMixin: OpenMetadata API methods related to Tables.
• tests_mixin.OMetaTestsMixin: OpenMetadata API methods related to Tests.
• topic_mixin.OMetaTopicMixin: OpenMetadata API methods related to Topics.
• user_mixin.OMetaUserMixin: OpenMetadata API methods related to user.
• version_mixin.OMetaVersionMixin: OpenMetadata API methods related to entity versioning.

Functions

• client_utils.create_ometa_client: Create an OpenMetadata client
• client_utils.get_chart_entities_from_id: Method to get the chart entity using get_by_name api
• credentials.get_api_version: Get version API
• credentials.get_credentials: Get credentials
• provider_registry.auth0_auth_init
• provider_registry.azure_auth_init
• provider_registry.basic_auth_init
• provider_registry.custom_oidc_auth_init
• provider_registry.google_auth_init
• provider_registry.ldap_auth_init
• provider_registry.no_auth_init
• provider_registry.okta_auth_init
• provider_registry.om_auth_init
• provider_registry.saml_auth_init
• provider_registry.warn_auth_deprecation
• provider_registry.warn_not_supported
• utils.format_name: Given a name, replace all special characters by _
• utils.get_entity_type: Given an Entity T, return its type.
• utils.model_str: Default model stringifying method.
• patch_mixin.update_column_description: Inplace update for the incoming column list
• patch_mixin.update_column_tags: Inplace update for the incoming column list