123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101 |
- /*! firebase-admin v12.1.1 */
- import { SmsRegionConfig, MultiFactorConfig, MultiFactorAuthServerConfig, RecaptchaConfig, PasswordPolicyAuthServerConfig, PasswordPolicyConfig, EmailPrivacyConfig } from './auth-config';
- /**
- * Interface representing the properties to update on the provided project config.
- */
- export interface UpdateProjectConfigRequest {
- /**
- * The SMS configuration to update on the project.
- */
- smsRegionConfig?: SmsRegionConfig;
- /**
- * The multi-factor auth configuration to update on the project.
- */
- multiFactorConfig?: MultiFactorConfig;
- /**
- * The reCAPTCHA configuration to update on the project.
- * By enabling reCAPTCHA Enterprise integration, you are
- * agreeing to the reCAPTCHA Enterprise
- * {@link https://cloud.google.com/terms/service-terms | Term of Service}.
- */
- recaptchaConfig?: RecaptchaConfig;
- /**
- * The password policy configuration to update on the project
- */
- passwordPolicyConfig?: PasswordPolicyConfig;
- /**
- * The email privacy configuration to update on the project
- */
- emailPrivacyConfig?: EmailPrivacyConfig;
- }
- /**
- * Response received when getting or updating the project config.
- */
- export interface ProjectConfigServerResponse {
- smsRegionConfig?: SmsRegionConfig;
- mfa?: MultiFactorAuthServerConfig;
- recaptchaConfig?: RecaptchaConfig;
- passwordPolicyConfig?: PasswordPolicyAuthServerConfig;
- emailPrivacyConfig?: EmailPrivacyConfig;
- }
- /**
- * Request to update the project config.
- */
- export interface ProjectConfigClientRequest {
- smsRegionConfig?: SmsRegionConfig;
- mfa?: MultiFactorAuthServerConfig;
- recaptchaConfig?: RecaptchaConfig;
- passwordPolicyConfig?: PasswordPolicyAuthServerConfig;
- emailPrivacyConfig?: EmailPrivacyConfig;
- }
- /**
- * Represents a project configuration.
- */
- export declare class ProjectConfig {
- /**
- * The SMS Regions Config for the project.
- * Configures the regions where users are allowed to send verification SMS.
- * This is based on the calling code of the destination phone number.
- */
- readonly smsRegionConfig?: SmsRegionConfig;
- /**
- * The project's multi-factor auth configuration.
- * Supports only phone and TOTP.
- */
- private readonly multiFactorConfig_?;
- /**
- * The multi-factor auth configuration.
- */
- get multiFactorConfig(): MultiFactorConfig | undefined;
- /**
- * The reCAPTCHA configuration to update on the project.
- * By enabling reCAPTCHA Enterprise integration, you are
- * agreeing to the reCAPTCHA Enterprise
- * {@link https://cloud.google.com/terms/service-terms | Term of Service}.
- */
- private readonly recaptchaConfig_?;
- /**
- * The password policy configuration for the project
- */
- readonly passwordPolicyConfig?: PasswordPolicyConfig;
- /**
- * The email privacy configuration for the project
- */
- readonly emailPrivacyConfig?: EmailPrivacyConfig;
- /**
- * Validates a project config options object. Throws an error on failure.
- *
- * @param request - The project config options object to validate.
- */
- private static validate;
- /**
- * The reCAPTCHA configuration.
- */
- get recaptchaConfig(): RecaptchaConfig | undefined;
- /**
- * Returns a JSON-serializable representation of this object.
- *
- * @returns A JSON-serializable representation of this object.
- */
- toJSON(): object;
- }
|