14 KiB

title slug
Aut Provider /sdk/python/api-reference/auth-provider

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

module auth_provider

Interface definition for an Auth provider

Global Variables

  • ACCESS_TOKEN
  • EXPIRY

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

class AuthenticationException

Error trying to get the token from the provider


{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

class AuthenticationProvider

Interface definition for an Authentication provider


{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

method auth_token

auth_token()  str

Authentication token

Returns: str


{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

classmethod create

create(config: ConfigModel)  AuthenticationProvider

Create authentication

Arguments:

  • config (ConfigModel): configuration

Returns: AuthenticationProvider


{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

method get_access_token

get_access_token()

Authentication token

Returns: str


{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

class NoOpAuthenticationProvider

Extends AuthenticationProvider class

Args: config (MetadataServerConfig):

Attributes: config (MetadataServerConfig)

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

method __init__

__init__(config: OpenMetadataConnection)

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

method auth_token

auth_token()

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

classmethod create

create(config: OpenMetadataConnection)

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

method get_access_token

get_access_token()

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

class GoogleAuthenticationProvider

Google authentication implementation

Args: config (MetadataServerConfig):

Attributes: config (MetadataServerConfig)

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

method __init__

__init__(config: OpenMetadataConnection)

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

method auth_token

auth_token()  None

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

classmethod create

create(config: OpenMetadataConnection)

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

method get_access_token

get_access_token()

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

class OktaAuthenticationProvider

Prepare the Json Web Token for Okta auth

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

method __init__

__init__(config: OpenMetadataConnection)

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

method auth_token

auth_token()  None

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

classmethod create

create(config: OpenMetadataConnection)

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

method get_access_token

get_access_token()

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

class Auth0AuthenticationProvider

OAuth authentication implementation

Args: config (MetadataServerConfig):

Attributes: config (MetadataServerConfig)

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

method __init__

__init__(config: OpenMetadataConnection)

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

method auth_token

auth_token()  None

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

classmethod create

create(config: OpenMetadataConnection)

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

method get_access_token

get_access_token()

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

class AzureAuthenticationProvider

Prepare the Json Web Token for Azure auth

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

method __init__

__init__(config: OpenMetadataConnection)

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

method auth_token

auth_token()  None

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

classmethod create

create(config: OpenMetadataConnection)

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

method get_access_token

get_access_token()

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

class CustomOIDCAuthenticationProvider

Custom OIDC authentication implementation

Args: config (MetadataServerConfig):

Attributes: config (MetadataServerConfig)

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

method __init__

__init__(config: OpenMetadataConnection)  None

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

method auth_token

auth_token()  None

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

classmethod create

create(config: OpenMetadataConnection)  CustomOIDCAuthenticationProvider

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

method get_access_token

get_access_token()  Tuple[str, int]

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

class OpenMetadataAuthenticationProvider

OpenMetadata authentication implementation

Args: config (MetadataServerConfig):

Attributes: config (MetadataServerConfig)

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

method __init__

__init__(config: OpenMetadataConnection)

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

method auth_token

auth_token()  None

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

classmethod create

create(config: OpenMetadataConnection)

{% image align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /%}

method get_access_token

get_access_token()