diff --git a/openmetadata-docs/content/v1.0.x/sdk/python/index.md b/openmetadata-docs/content/v1.0.x/sdk/python/index.md index 77462b35de68..909f7137183a 100644 --- a/openmetadata-docs/content/v1.0.x/sdk/python/index.md +++ b/openmetadata-docs/content/v1.0.x/sdk/python/index.md @@ -164,14 +164,21 @@ OpenMetadata is the class holding the connection to the API and handling the req ```python from metadata.ingestion.ometa.ometa_api import OpenMetadata from metadata.generated.schema.entity.services.connections.metadata.openMetadataConnection import ( - OpenMetadataConnection, + OpenMetadataConnection, AuthProvider, ) +from metadata.generated.schema.security.client.openMetadataJWTClientConfig import OpenMetadataJWTClientConfig -server_config = OpenMetadataConnection(hostPort="http://localhost:8585/api") +server_config = OpenMetadataConnection( + hostPort="http://localhost:8585/api", + authProvider=AuthProvider.openmetadata, + securityConfig=OpenMetadataJWTClientConfig( + jwtToken="", + ), +) metadata = OpenMetadata(server_config) ``` -As this is just using a local development, the `OpenMetadataConnection` is rather simple. However, in there we would prepare settings such as `authProvider` or `securityConfig`. +For local development, we can get a JWT token for the ingestion bot as described [here](/deployment/security/enable-jwt-tokens#generate-token) and use that when we specify the `jwtToken`. For a real-world deployment, we can also use [different authentication methods](/deployment/security) and specify other settings of the connection (such as `sslConfig`). {% note %} diff --git a/openmetadata-docs/content/v1.1.x/sdk/python/index.md b/openmetadata-docs/content/v1.1.x/sdk/python/index.md index 3ae1fb96a8f1..5593dd4b33ff 100644 --- a/openmetadata-docs/content/v1.1.x/sdk/python/index.md +++ b/openmetadata-docs/content/v1.1.x/sdk/python/index.md @@ -164,14 +164,21 @@ OpenMetadata is the class holding the connection to the API and handling the req ```python from metadata.ingestion.ometa.ometa_api import OpenMetadata from metadata.generated.schema.entity.services.connections.metadata.openMetadataConnection import ( - OpenMetadataConnection, + OpenMetadataConnection, AuthProvider, ) +from metadata.generated.schema.security.client.openMetadataJWTClientConfig import OpenMetadataJWTClientConfig -server_config = OpenMetadataConnection(hostPort="http://localhost:8585/api") +server_config = OpenMetadataConnection( + hostPort="http://localhost:8585/api", + authProvider=AuthProvider.openmetadata, + securityConfig=OpenMetadataJWTClientConfig( + jwtToken="", + ), +) metadata = OpenMetadata(server_config) ``` -As this is just using a local development, the `OpenMetadataConnection` is rather simple. However, in there we would prepare settings such as `authProvider` or `securityConfig`. +For local development, we can get a JWT token for the ingestion bot as described [here](/deployment/security/enable-jwt-tokens#generate-token) and use that when we specify the `jwtToken`. For a real-world deployment, we can also use [different authentication methods](/deployment/security) and specify other settings of the connection (such as `sslConfig`). {% note %} diff --git a/openmetadata-docs/content/v1.2.x/sdk/python/index.md b/openmetadata-docs/content/v1.2.x/sdk/python/index.md index 91c5d3e0f778..169d4fbdcb75 100644 --- a/openmetadata-docs/content/v1.2.x/sdk/python/index.md +++ b/openmetadata-docs/content/v1.2.x/sdk/python/index.md @@ -164,14 +164,21 @@ OpenMetadata is the class holding the connection to the API and handling the req ```python from metadata.ingestion.ometa.ometa_api import OpenMetadata from metadata.generated.schema.entity.services.connections.metadata.openMetadataConnection import ( - OpenMetadataConnection, + OpenMetadataConnection, AuthProvider, ) +from metadata.generated.schema.security.client.openMetadataJWTClientConfig import OpenMetadataJWTClientConfig -server_config = OpenMetadataConnection(hostPort="http://localhost:8585/api") +server_config = OpenMetadataConnection( + hostPort="http://localhost:8585/api", + authProvider=AuthProvider.openmetadata, + securityConfig=OpenMetadataJWTClientConfig( + jwtToken="", + ), +) metadata = OpenMetadata(server_config) ``` -As this is just using a local development, the `OpenMetadataConnection` is rather simple. However, in there we would prepare settings such as `authProvider` or `securityConfig`. +For local development, we can get a JWT token for the ingestion bot as described [here](/deployment/security/enable-jwt-tokens#generate-token) and use that when we specify the `jwtToken`. For a real-world deployment, we can also use [different authentication methods](/deployment/security) and specify other settings of the connection (such as `sslConfig`). {% note %}