grid.auth

Package Contents

class grid.auth.UserAuthentication(username, password)

Bases: grid.auth.authentication.BaseAuthentication

FILENAME = auth.user
USERNAME_FIELD = username
PASSWORD_FIELD = password
static parse(path)

Static method used to create new user authentication instances parsing a json file.

Parameters:path (str) – json file path.
Returns:List of user authentication objects.
Return type:List
json(self)

Convert user instances into a JSON/Dictionary structure.

grid.auth.BASE_DIR
grid.auth.BASE_FOLDER = .openmined
grid.auth.AUTH_MODELS
grid.auth.auth_credentials = []
grid.auth.read_authentication_configs(directory=None, folder=None) → list

Search for a path and folder used to store user credentials

Parameters:
  • directory (str) – System path (can usually be /home/<user>).
  • folder (str) – folder name used to store PyGrid credentials.
Returns:

List of credentials instances.

Return type:

List

grid.auth.search_credential(user: str)

Search for a specific credential instance.

Parameters:user (str) – Key used to identify the credential.
Returns:Credential’s instance.
Return type:BaseAuthentication