weaviate.auth

Authentication class definitions.

class weaviate.auth.AuthClientCredentials(client_secret: str)

Bases: weaviate.auth.AuthCredentials

Using a client secret for authentication. In case of grant type client credentials.

Using a client secret for authentication. In case of grant type client credentials.

Parameters

client_secret (str) – The access token.

get_credentials() dict

Get decoded credentials.

Returns

Decoded credentials.

Return type

dict

class weaviate.auth.AuthClientPassword(username: str, password: str)

Bases: weaviate.auth.AuthCredentials

Using username and password for authentication. In case of grant type password.

Using username and password for authentication. In case of grant type password.

Parameters
  • username (str) – The username to login with.

  • password (str) – Password fot the given User.

get_credentials() dict

Get decoded credentials.

Returns

Decoded credentials.

Return type

dict

class weaviate.auth.AuthCredentials

Bases: abc.ABC

Base class for getting the grant type and credentials.

abstract get_credentials() dict

Get credentials.