Merge branch 'mfa-totp' of https://github.com/firebase/firebase-admin-python into mfa-totp

Author: pragatimodi

firebase_admin/multi_factor_config_mgt.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 """Firebase multifactor configuration management module.
 
-This module contains functions for managing various multifactor configurations at
+This module contains functions for managing multifactor auth configuration at
 the project and tenant level.
 """
 from enum import Enum
@@ -94,7 +94,7 @@ def adjacent_intervals(self):
 
 
 class TOTPProviderConfig:
- """Represents a TOTP Provider Configuration to be specified for a tenant or project."""
+ """A tenant or project's TOTP provider configuration."""
 
  def __init__(self, adjacent_intervals: int = None):
  self.adjacent_intervals: int = adjacent_intervals
@@ -106,7 +106,7 @@ def to_dict(self) -> dict:
  return data
 
  def validate(self):
- """Validates a given totp_provider_config object.
+ """Validates the configuration.
 
  Raises:
  ValueError: In case of an unsuccessful validation.
@@ -133,8 +133,8 @@ def build_server_request(self):
 
 
 class ProviderConfig:
- """Represents a provider configuration for tenant or project.
- Currently only TOTP can be configured"""
+ """A tenant or project's multifactor provider configuration.
+ Currently, only TOTP can be configured."""
 
  class State(Enum):
  ENABLED = 'ENABLED'
@@ -155,7 +155,7 @@ def to_dict(self) -> dict:
  return data
 
  def validate(self):
- """Validates a provider_config object.
+ """Validates the provider configuration.
 
  Raises:
  ValueError: In case of an unsuccessful validation.
@@ -184,8 +184,7 @@ def build_server_request(self):
 
 
 class MultiFactorConfig:
- """Represents a multi factor configuration for tenant or project
- """
+ """A tenant or project's multi factor configuration."""
 
  def __init__(self,
  provider_configs: List[ProviderConfig] = None):
@@ -199,7 +198,7 @@ def to_dict(self) -> dict:
  return data
 
  def validate(self):
- """Validates a given multi_factor_config object.
+ """Validates the configuration.
 
  Raises:
  ValueError: In case of an unsuccessful validation.

firebase_admin/project_config_mgt.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 """Firebase project configuration management module.
 
-This module contains functions for managing various project operations like update and create
+This module contains functions for managing projects.
 """
 
 import requests
@@ -52,9 +52,10 @@ def get_project_config(app=None):
  return project_config_mgt_service.get_project_config()
 
 def update_project_config(multi_factor_config: MultiFactorConfig = None, app=None):
- """Update the Project Config with the given options.
+ """Update the project config with the given options.
+
  Args:
- multi_factor_config: Updated Multi Factor Authentication configuration
+ multi_factor_config: Updated multi-factor authentication configuration
  (optional)
  app: An App instance (optional).
  Returns: