Config

Representa un proyecto de Identity Toolkit.

Representación JSON 
{
  "name": string,
  "signIn": {
    object (SignInConfig)
  },
  "notification": {
    object (NotificationConfig)
  },
  "quota": {
    object (QuotaConfig)
  },
  "monitoring": {
    object (MonitoringConfig)
  },
  "multiTenant": {
    object (MultiTenantConfig)
  },
  "authorizedDomains": [
    string
  ],
  "subtype": enum (Subtype),
  "client": {
    object (ClientConfig)
  },
  "mfa": {
    object (MultiFactorAuthConfig)
  },
  "blockingFunctions": {
    object (BlockingFunctionsConfig)
  },
  "recaptchaConfig": {
    object (RecaptchaConfig)
  },
  "smsRegionConfig": {
    object (SmsRegionConfig)
  },
  "autodeleteAnonymousUsers": boolean,
  "passwordPolicyConfig": {
    object (PasswordPolicyConfig)
  },
  "emailPrivacyConfig": {
    object (EmailPrivacyConfig)
  },
  "mobileLinksConfig": {
    object (MobileLinksConfig)
  },
  "defaultHostingSite": string
}
Campos
name

string

Solo salida. Es el nombre del recurso de configuración. Ejemplo: "projects/my-awesome-project/config"
signIn

object (SignInConfig)

Configuración relacionada con los métodos de acceso local
notification

object (NotificationConfig)

Configuración relacionada con el envío de notificaciones a los usuarios.
quota

object (QuotaConfig)

Configuración relacionada con las cuotas.
monitoring

object (MonitoringConfig)

Configuración relacionada con la supervisión de la actividad del proyecto.
multiTenant

object (MultiTenantConfig)

Configuración relacionada con la funcionalidad de varios usuarios.
authorizedDomains[]

string

Lista de dominios autorizados para redireccionamientos de OAuth
subtype

enum (Subtype)

Solo salida. Es el subtipo de esta configuración.
client

object (ClientConfig)

Son opciones relacionadas con la forma en que se deben configurar los clientes que realizan solicitudes en nombre de un proyecto.
mfa

object (MultiFactorAuthConfig)

Configuración de la autenticación de varios factores de este proyecto, incluido si está activa y qué factores se pueden usar para el segundo factor
blockingFunctions

object (BlockingFunctionsConfig)

Configuración relacionada con el bloqueo de funciones.
recaptchaConfig

object (RecaptchaConfig)

La configuración de reCAPTCHA a nivel del proyecto
smsRegionConfig

object (SmsRegionConfig)

Configura qué regiones están habilitadas para el envío de códigos de verificación por SMS.
autodeleteAnonymousUsers

boolean

Si los usuarios anónimos se borrarán automáticamente después de un período de 30 días.
passwordPolicyConfig

object (PasswordPolicyConfig)

La configuración de la política de contraseñas a nivel del proyecto.
emailPrivacyConfig

object (EmailPrivacyConfig)

Configuración relacionada con la privacidad del correo electrónico y la visibilidad pública.
defaultHostingSite

string

Solo salida. Nombre predeterminado del sitio de hosting de Firebase

SignInConfig

Configuración relacionada con los métodos de acceso local

Representación JSON 
{
  "email": {
    object (Email)
  },
  "phoneNumber": {
    object (PhoneNumber)
  },
  "anonymous": {
    object (Anonymous)
  },
  "allowDuplicateEmails": boolean,
  "hashConfig": {
    object (HashConfig)
  }
}
Campos
email

object (Email)

Son opciones de configuración relacionadas con la autenticación de un usuario por su dirección de correo electrónico.
phoneNumber

object (PhoneNumber)

Son opciones de configuración relacionadas con la autenticación de un usuario por su número de teléfono.
anonymous

object (Anonymous)

Son opciones de configuración relacionadas con la autenticación de un usuario anónimo.
allowDuplicateEmails

boolean

Indica si se permite que más de una cuenta tenga el mismo correo electrónico.
hashConfig

object (HashConfig)

Solo salida. Información de configuración de hash

Correo electrónico

Son opciones de configuración relacionadas con la autenticación de un usuario por su dirección de correo electrónico.

Representación JSON 
{
  "enabled": boolean,
  "passwordRequired": boolean
}
Campos
enabled

boolean

Indica si la autenticación por correo electrónico está habilitada para el proyecto o no.
passwordRequired

boolean

Indica si se requiere una contraseña para la autenticación por correo electrónico. Si es verdadero, se deben proporcionar un correo electrónico y una contraseña para acceder. Si es falso, el usuario puede acceder con un correo electrónico o una contraseña, o bien con un vínculo por correo electrónico.

PhoneNumber

Son opciones de configuración relacionadas con la autenticación de un usuario por su número de teléfono.

Representación JSON 
{
  "enabled": boolean,
  "testPhoneNumbers": {
    string: string,
    ...
  }
}
Campos
enabled

boolean

Indica si la autenticación con número de teléfono está habilitada para el proyecto.
testPhoneNumbers

map (key: string, value: string)

Un mapa de <número de teléfono de prueba, código falso> que se puede usar para pruebas de autenticación telefónica.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Anónimo

Son opciones de configuración relacionadas con la autenticación de un usuario anónimo.

Representación JSON 
{
  "enabled": boolean
}
Campos
enabled

boolean

Indica si la autenticación de usuarios anónimos está habilitada para el proyecto o no.

NotificationConfig

Configuración relacionada con el envío de notificaciones a los usuarios.

Representación JSON 
{
  "sendEmail": {
    object (SendEmail)
  },
  "sendSms": {
    object (SendSms)
  },
  "defaultLocale": string
}
Campos
sendEmail

object (SendEmail)

Opciones para enviar correos electrónicos.
sendSms

object (SendSms)

Opciones para el envío de SMS.
defaultLocale

string

Es la configuración regional predeterminada que se usa para el correo electrónico y los SMS en formato IETF BCP 47.

SendEmail

Opciones para enviar correos electrónicos.

Representación JSON 
{
  "method": enum (Method),
  "resetPasswordTemplate": {
    object (EmailTemplate)
  },
  "verifyEmailTemplate": {
    object (EmailTemplate)
  },
  "changeEmailTemplate": {
    object (EmailTemplate)
  },
  "legacyResetPasswordTemplate": {
    object (EmailTemplate)
  },
  "callbackUri": string,
  "dnsInfo": {
    object (DnsInfo)
  },
  "revertSecondFactorAdditionTemplate": {
    object (EmailTemplate)
  },

  // Union field email_provider_config can be only one of the following:
  "smtp": {
    object (Smtp)
  }
  // End of list of possible types for union field email_provider_config.
}
Campos
method

enum (Method)

Es el método que se usa para enviar un correo electrónico.
resetPasswordTemplate

object (EmailTemplate)

Plantilla de correo electrónico para restablecer la contraseña
verifyEmailTemplate

object (EmailTemplate)

Plantilla de correo electrónico para verificar el correo electrónico
changeEmailTemplate

object (EmailTemplate)

Plantilla de correo electrónico para cambiar el correo electrónico
legacyResetPasswordTemplate

object (EmailTemplate)

Plantilla de correo electrónico de restablecimiento de contraseña para la app heredada de Firebase V1.
callbackUri

string

URL de acción en la plantilla de correo electrónico.
dnsInfo

object (DnsInfo)

Información de la verificación de DNS del dominio personalizado
revertSecondFactorAdditionTemplate

object (EmailTemplate)

Plantilla de correo electrónico para revertir los correos electrónicos de adición de un segundo factor
Campo de unión email_provider_config. La configuración del proveedor de correo electrónico que se usa para enviar correos electrónicos email_provider_config solo puede ser una de las siguientes:
smtp

object (Smtp)

Usa un servidor de retransmisión de SMTP personalizado

Método

Es el método que se usa para enviar un correo electrónico.

Enums
METHOD_UNSPECIFIED No se especificó el método de correo electrónico.
DEFAULT Envía un correo electrónico en nombre del desarrollador.
CUSTOM_SMTP Envío de correos electrónicos con la configuración de SMTP que proporcionan los desarrolladores

Smtp

Configuración de la retransmisión de SMTP

Representación JSON 
{
  "senderEmail": string,
  "host": string,
  "port": integer,
  "username": string,
  "password": string,
  "securityMode": enum (SecurityMode)
}
Campos
senderEmail

string

Correo electrónico del remitente para la retransmisión de SMTP
host

string

Host de retransmisión de SMTP
port

integer

Puerto de retransmisión de SMTP
username

string

Nombre de usuario de la retransmisión de SMTP
password

string

Contraseña de la retransmisión de SMTP
securityMode

enum (SecurityMode)

Modo de seguridad SMTP

SecurityMode

Modo de seguridad SMTP

Enums
SECURITY_MODE_UNSPECIFIED Valor predeterminado No se debe usar.
SSL Modo SSL
START_TLS Modo START_TLS

EmailTemplate

Plantilla de correo electrónico Los campos Asunto y Cuerpo pueden contener los siguientes marcadores de posición, que se reemplazarán por los valores adecuados: %LINK%: Es el vínculo que se debe usar para canjear el código de envío fuera del servicio. %EMAIL%: Es el correo electrónico al que se envía el mensaje. %NEW_EMAIL%: Es el correo electrónico nuevo que se configura para la cuenta (si corresponde). %APP_NAME%: Es el nombre visible del proyecto de Google Cloud. %DISPLAY_NAME%: Es el nombre visible del usuario.

Representación JSON 
{
  "senderLocalPart": string,
  "subject": string,
  "senderDisplayName": string,
  "body": string,
  "bodyFormat": enum (BodyFormat),
  "replyTo": string,
  "customized": boolean
}
Campos
senderLocalPart

string

Parte local de la dirección de origen
subject

string

Asunto del correo electrónico
senderDisplayName

string

Nombre visible del remitente
body

string

Cuerpo del correo electrónico
bodyFormat

enum (BodyFormat)

Formato del cuerpo del correo electrónico
replyTo

string

Dirección de respuesta
customized

boolean

Solo salida. Indica si el cuerpo o el asunto del correo electrónico están personalizados.

BodyFormat

Formato del cuerpo del correo electrónico

Enums
BODY_FORMAT_UNSPECIFIED Valor predeterminado No se debe usar.
PLAIN_TEXT Texto sin formato
HTML HTML

DnsInfo

Información de la verificación de DNS del dominio personalizado De forma predeterminada, se usará default_domain. Se puede configurar un dominio personalizado con VerifyCustomDomain.

Representación JSON 
{
  "customDomain": string,
  "useCustomDomain": boolean,
  "pendingCustomDomain": string,
  "customDomainState": enum (VerificationState),
  "domainVerificationRequestTime": string
}
Campos
customDomain

string

Solo salida. El dominio personalizado verificado aplicado.
useCustomDomain

boolean

Indica si se debe usar un dominio personalizado.
pendingCustomDomain

string

Solo salida. El dominio personalizado que se verificará.
customDomainState

enum (VerificationState)

Solo salida. Es el estado de verificación actual del dominio personalizado. El dominio personalizado solo se usará una vez que la verificación del dominio se realice correctamente.
domainVerificationRequestTime

string (Timestamp format)

Solo salida. Es la marca de tiempo de la solicitud inicial para la verificación de dominio actual.

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

SendSms

Opciones para el envío de SMS.

Representación JSON 
{
  "useDeviceLocale": boolean,
  "smsTemplate": {
    object (SmsTemplate)
  }
}
Campos
useDeviceLocale

boolean

Indica si se debe usar el encabezado accept_language para los SMS.
smsTemplate

object (SmsTemplate)

Solo salida. Es la plantilla que se debe usar cuando se envía un SMS.

SmsTemplate

Es la plantilla que se debe usar cuando se envía un SMS.

Representación JSON 
{
  "content": string
}
Campos
content

string

Solo salida. El contenido del SMS Puede contener los siguientes marcadores de posición, que se reemplazarán por los valores adecuados: %APP_NAME%: En el caso de las apps para Android o iOS, es el nombre visible de la app. Para las aplicaciones web, es el dominio que aloja la aplicación. %LOGIN_CODE%: Es el código fuera del dispositivo que se envía en el SMS.

QuotaConfig

Configuración relacionada con las cuotas.

Representación JSON 
{
  "signUpQuotaConfig": {
    object (TemporaryQuota)
  }
}
Campos
signUpQuotaConfig

object (TemporaryQuota)

Cuota para el extremo de registro, si se reemplaza. La cuota de registros se mide en registros por proyecto por hora por IP.

TemporaryQuota

Aumento o disminución temporal de la cuota

Representación JSON 
{
  "quota": string,
  "startTime": string,
  "quotaDuration": string
}
Campos
quota

string (int64 format)

Corresponde al campo "refill_token_count" en la configuración de QuotaServer.
startTime

string (Timestamp format)

Cuándo entrará en vigencia esta cuota

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
quotaDuration

string (Duration format)

Cuánto tiempo estará activa esta cuota

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".

MultiTenantConfig

Configuración relacionada con la funcionalidad de varios usuarios.

Representación JSON 
{
  "allowTenants": boolean,
  "defaultTenantLocation": string
}
Campos
allowTenants

boolean

Indica si este proyecto puede tener inquilinos o no.
defaultTenantLocation

string

La organización o carpeta superior de Cloud predeterminada en la que se debe crear el proyecto del inquilino. El nombre del recurso superior debe tener el formato "/", como "folders/123" o "organizations/456". Si no se establece el valor, el inquilino se creará en la misma organización o carpeta que el proyecto del agente.

Subtipo

Es el subtipo de esta configuración.

Enums
SUBTYPE_UNSPECIFIED Valor predeterminado No se debe usar.
IDENTITY_PLATFORM Un proyecto de Identity Platform
FIREBASE_AUTH Un proyecto de Firebase Authentication

ClientConfig

Son opciones relacionadas con la forma en que se deben configurar los clientes que realizan solicitudes en nombre de un proyecto.

Representación JSON 
{
  "apiKey": string,
  "permissions": {
    object (Permissions)
  },
  "firebaseSubdomain": string
}
Campos
apiKey

string

Solo salida. Clave de API que se puede usar cuando se realizan solicitudes para este proyecto.
permissions

object (Permissions)

Configuración relacionada con la restricción de la capacidad de un usuario para afectar su cuenta.
firebaseSubdomain

string

Solo salida. Subdominio de Firebase

Permisos

Configuración relacionada con la restricción de la capacidad de un usuario para afectar su cuenta.

Representación JSON 
{
  "disabledUserSignup": boolean,
  "disabledUserDeletion": boolean
}
Campos
disabledUserSignup

boolean

Si es verdadero, los usuarios finales no pueden registrarse para obtener una cuenta nueva en el proyecto asociado a través de ninguno de nuestros métodos de API.
disabledUserDeletion

boolean

Si es verdadero, los usuarios finales no pueden borrar su cuenta en el proyecto asociado a través de ninguno de nuestros métodos de API.

BlockingFunctionsConfig

Configuración relacionada con el bloqueo de funciones.

Representación JSON 
{
  "triggers": {
    string: {
      object (Trigger)
    },
    ...
  },
  "forwardInboundCredentials": {
    object (ForwardInboundCredentials)
  }
}
Campos
triggers

map (key: string, value: object (Trigger))

Mapa del activador al tipo de evento. La clave debe ser uno de los tipos de eventos admitidos: "beforeCreate", "beforeSignIn".

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
forwardInboundCredentials

object (ForwardInboundCredentials)

Las credenciales del usuario que se incluirán en la carga útil de JWT que se envía a las funciones de bloqueo registradas.

Activador

Función de Cloud Functions síncrona con activador HTTP

Representación JSON 
{
  "functionUri": string,
  "updateTime": string
}
Campos
functionUri

string

Activador de URI HTTP para la función de Cloud
updateTime

string (Timestamp format)

Cuándo se cambió el activador.

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

ForwardInboundCredentials

Indica qué credenciales se pasarán a las funciones de bloqueo registradas.

Representación JSON 
{
  "idToken": boolean,
  "accessToken": boolean,
  "refreshToken": boolean
}
Campos
idToken

boolean

Indica si se debe pasar el token de ID del proveedor de identidad de OIDC del usuario.
accessToken

boolean

Indica si se debe pasar el token de acceso del proveedor de identidad de OAuth del usuario.
refreshToken

boolean

Indica si se debe pasar el token de actualización del proveedor de identidad de OAuth del usuario.