Índice
ProjectConfigService(interfaz)TenantManagementService(interfaz)BlockingFunctionsConfig(mensaje)BlockingFunctionsConfig.Trigger(mensaje)ClientConfig(mensaje)ClientConfig.Permissions(mensaje)Config(mensaje)Config.Subtype(enum)CreateDefaultSupportedIdpConfigRequest(mensaje)CreateInboundSamlConfigRequest(mensaje)CreateOAuthIdpConfigRequest(mensaje)CreateTenantRequest(mensaje)DefaultSupportedIdp(mensaje)DefaultSupportedIdpConfig(mensaje)DeleteDefaultSupportedIdpConfigRequest(mensaje)DeleteInboundSamlConfigRequest(mensaje)DeleteOAuthIdpConfigRequest(mensaje)DeleteTenantRequest(mensaje)EnableCicpRequest(mensaje)EnableCicpResponse(mensaje)GetConfigRequest(mensaje)GetDefaultSupportedIdpConfigRequest(mensaje)GetInboundSamlConfigRequest(mensaje)GetOAuthIdpConfigRequest(mensaje)GetTenantRequest(mensaje)HashConfig(mensaje)HashConfig.HashAlgorithm(enum)IdpCertificate(mensaje)InboundSamlConfig(mensaje)InboundSamlConfig.IdpConfig(mensaje)InboundSamlConfig.SpConfig(mensaje)ListDefaultSupportedIdpConfigsRequest(mensaje)ListDefaultSupportedIdpConfigsResponse(mensaje)ListDefaultSupportedIdpsRequest(mensaje)ListDefaultSupportedIdpsResponse(mensaje)ListInboundSamlConfigsRequest(mensaje)ListInboundSamlConfigsResponse(mensaje)ListOAuthIdpConfigsRequest(mensaje)ListOAuthIdpConfigsResponse(mensaje)ListTenantsRequest(mensaje)ListTenantsResponse(mensaje)MonitoringConfig(mensaje)MonitoringConfig.RequestLogging(mensaje)MultiFactorAuthConfig(mensaje)MultiFactorAuthConfig.Provider(enum)MultiFactorAuthConfig.State(enum)NotificationConfig(mensaje)NotificationConfig.SendEmail(mensaje)NotificationConfig.SendEmail.DnsInfo(mensaje)NotificationConfig.SendEmail.DnsInfo.VerificationState(enum)NotificationConfig.SendEmail.EmailTemplate(mensaje)NotificationConfig.SendEmail.EmailTemplate.BodyFormat(enum)NotificationConfig.SendEmail.Method(enum)NotificationConfig.SendEmail.Smtp(mensaje)NotificationConfig.SendEmail.Smtp.SecurityMode(enum)NotificationConfig.SendSms(mensaje)NotificationConfig.SendSms.SmsTemplate(mensaje)OAuthIdpConfig(mensaje)OAuthIdpConfig.OAuthResponseType(mensaje)QuotaConfig(mensaje)QuotaConfig.TemporaryQuota(mensaje)SignInConfig(mensaje)SignInConfig.Anonymous(mensaje)SignInConfig.Email(mensaje)SignInConfig.PhoneNumber(mensaje)SpCertificate(mensaje)Tenant(mensaje)UpdateConfigRequest(mensaje)UpdateDefaultSupportedIdpConfigRequest(mensaje)UpdateInboundSamlConfigRequest(mensaje)UpdateOAuthIdpConfigRequest(mensaje)UpdateTenantRequest(mensaje)VerifyDomainRequest(mensaje)VerifyDomainRequest.DomainVerificationAction(enum)VerifyDomainResponse(mensaje)
ProjectConfigService
Configuración del proyecto para Identity Toolkit
| CreateDefaultSupportedIdpConfig |
|---|
|
Crea una configuración de IdP compatible predeterminada para un proyecto de Identity Toolkit.
|
| CreateInboundSamlConfig |
|---|
|
Crea una configuración SAML de entrada para un proyecto de Identity Toolkit.
|
| CreateOAuthIdpConfig |
|---|
|
Crea una configuración de IdP de OIDC para un proyecto de Identity Toolkit.
|
| DeleteDefaultSupportedIdpConfig |
|---|
|
Borra una configuración de IDP compatible predeterminada para un proyecto de Identity Toolkit.
|
| DeleteInboundSamlConfig |
|---|
|
Borra una configuración SAML entrante para un proyecto de Identity Toolkit.
|
| DeleteOAuthIdpConfig |
|---|
|
Borra la configuración de un IDP de OIDC para un proyecto de Identity Toolkit.
|
| EnableCicp |
|---|
|
Habilita CICP para un proyecto de Cloud. Cloud Identity for Customers and Partners (CICP) es un sistema de autenticación de extremo a extremo para que los usuarios externos accedan a tus apps y servicios. Estos pueden incluir apps web y para dispositivos móviles, juegos, APIs y mucho más.
|
| GetConfig |
|---|
|
Recupera la configuración de un proyecto de Identity Toolkit.
|
| GetDefaultSupportedIdpConfig |
|---|
|
Recupera una configuración de IdP compatible predeterminada para un proyecto de Identity Toolkit.
|
| GetInboundSamlConfig |
|---|
|
Recupera una configuración de SAML entrante para un proyecto de Identity Toolkit.
|
| GetOAuthIdpConfig |
|---|
|
Recupera una configuración de IdP de OIDC para un proyecto de Identity Toolkit.
|
| ListDefaultSupportedIdpConfigs |
|---|
|
Muestra una lista de todas las configuraciones de IDP compatibles predeterminadas para un proyecto de Identity Toolkit.
|
| ListDefaultSupportedIdps |
|---|
|
Enumera todos los proveedores de identidad admitidos de forma predeterminada.
|
| ListInboundSamlConfigs |
|---|
|
Muestra una lista de todas las configuraciones de SAML entrantes para un proyecto de Identity Toolkit.
|
| ListOAuthIdpConfigs |
|---|
|
Muestra una lista de todas las configuraciones del IDP de OIDC para un proyecto de Identity Toolkit.
|
| UpdateConfig |
|---|
|
Actualiza la configuración de un proyecto de Identity Toolkit.
|
| UpdateDefaultSupportedIdpConfig |
|---|
|
Actualiza una configuración de IDP compatible predeterminada para un proyecto de Identity Toolkit.
|
| UpdateInboundSamlConfig |
|---|
|
Actualiza una configuración de SAML entrante para un proyecto de Identity Toolkit.
|
| UpdateOAuthIdpConfig |
|---|
|
Actualiza la configuración de un IDP de OIDC para un proyecto de Identity Toolkit.
|
| VerifyDomain |
|---|
|
Verifica que el dominio personalizado solicitado tenga los registros DNS necesarios.
|
TenantManagementService
Servicio de administración de inquilinos para GCIP.
| CreateTenant |
|---|
|
Crea un usuario. Requiere permiso de escritura en el proyecto del agente.
|
| DeleteTenant |
|---|
|
Borra un usuario. Requiere permiso de escritura en el proyecto del agente.
|
| GetTenant |
|---|
|
Obtén un usuario. Requiere permiso de lectura en el recurso del inquilino.
|
| ListTenants |
|---|
|
Muestra una lista de los inquilinos del proyecto de agente determinado. Requiere permiso de lectura en el proyecto del agente.
|
| UpdateTenant |
|---|
|
Actualiza un usuario. Requiere permiso de escritura en el recurso del inquilino.
|
BlockingFunctionsConfig
Configuración relacionada con el bloqueo de funciones.
| Campos | |
|---|---|
triggers |
Mapa del activador al tipo de evento. La clave debe ser uno de los tipos de eventos admitidos: "beforeCreate", "beforeSignIn". |
Activador
Función de Cloud Functions síncrona con activador HTTP
| Campos | |
|---|---|
function_uri |
Activador de URI HTTP para la función de Cloud |
update_time |
Cuándo se cambió el activador. |
ClientConfig
Son opciones relacionadas con la forma en que se deben configurar los clientes que realizan solicitudes en nombre de un proyecto.
| Campos | |
|---|---|
api_key |
Solo salida. Clave de API que se puede usar cuando se realizan solicitudes para este proyecto. |
permissions |
Configuración relacionada con la restricción de la capacidad de un usuario para afectar su cuenta. |
firebase_subdomain |
Solo salida. Subdominio de Firebase |
Permisos
Configuración relacionada con la restricción de la capacidad de un usuario para afectar su cuenta.
| Campos | |
|---|---|
disabled_user_signup |
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. |
disabled_user_deletion |
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. |
Configuración
Representa un proyecto de Identity Toolkit.
| Campos | |
|---|---|
name |
Solo salida. Es el nombre del recurso de configuración. Ejemplo: "projects/my-awesome-project/config" |
sign_in |
Configuración relacionada con los métodos de acceso local |
notification |
Configuración relacionada con el envío de notificaciones a los usuarios. |
quota |
Configuración relacionada con las cuotas. |
monitoring |
Configuración relacionada con la supervisión de la actividad del proyecto. |
authorized_domains[] |
Lista de dominios autorizados para redireccionamientos de OAuth |
subtype |
Solo salida. Es el subtipo de esta configuración. |
client |
Son opciones relacionadas con la forma en que se deben configurar los clientes que realizan solicitudes en nombre de un proyecto. |
mfa |
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 |
blocking_functions |
Configuración relacionada con el bloqueo de funciones. |
Subtipo
Es el subtipo de esta configuración.
| Enums | |
|---|---|
SUBTYPE_UNSPECIFIED |
Valor predeterminado No se debe usar. |
CUSTOMER_IDENTITY |
Un proyecto de identidad del cliente |
FIREBASE_AUTH |
Un proyecto de Firebase Authentication |
CreateDefaultSupportedIdpConfigRequest
Solicitud para CreateDefaultSupportedIdpConfig
| Campos | |
|---|---|
parent |
El nombre del recurso superior en el que se creará la configuración, por ejemplo: "projects/my-awesome-project" La autorización requiere el siguiente permiso IAM en el recurso especificado
|
idp_id |
Es el ID del IDP para el que se creará una configuración. Llama a ListDefaultSupportedIdps para obtener una lista de todos los IDPs compatibles predeterminados. |
default_supported_idp_config |
El recurso de configuración que reemplaza el recurso en el servidor. |
CreateInboundSamlConfigRequest
Solicitud para CreateInboundSamlConfig
| Campos | |
|---|---|
parent |
El nombre del recurso superior en el que se creará la configuración, por ejemplo: "projects/my-awesome-project" La autorización requiere el siguiente permiso IAM en el recurso especificado
|
inbound_saml_config_id |
Es el ID que se usará para esta configuración. |
inbound_saml_config |
El recurso de configuración que se creará. El cliente no debe configurar el campo |
CreateOAuthIdpConfigRequest
Solicitud para CreateOAuthIdpConfig
| Campos | |
|---|---|
parent |
El nombre del recurso superior en el que se creará la configuración, por ejemplo: "projects/my-awesome-project" La autorización requiere el siguiente permiso IAM en el recurso especificado
|
oauth_idp_config_id |
Es el ID que se usará para esta configuración. |
oauth_idp_config |
El recurso de configuración que se creará. El cliente no debe configurar el campo |
CreateTenantRequest
Es el mensaje de solicitud de CreateTenant.
| Campos | |
|---|---|
parent |
Es el nombre del recurso superior en el que se creará el inquilino. Por ejemplo, "projects/project1". La autorización requiere el siguiente permiso IAM en el recurso especificado
|
tenant |
Obligatorio. Es el inquilino que se creará. |
DefaultSupportedIdp
IDP de confianza estándar de Identity Toolkit
| Campos | |
|---|---|
idp_id |
ID del IdP |
description |
Descripción del IDP |
DefaultSupportedIdpConfig
Son opciones de configuración para autenticarse con un conjunto estándar de proveedores de identidad de confianza de Identity Toolkit.
| Campos | |
|---|---|
name |
El nombre del recurso DefaultSupportedIdpConfig, por ejemplo: "projects/my-awesome-project/defaultSupportedIdpConfigs/google.com" |
enabled |
Es verdadero si permite que el usuario acceda con el proveedor. |
client_id |
ID de cliente de OAuth |
client_secret |
Secreto del cliente de OAuth |
display_on_cloud_console |
Solo salida. Indica si se debe mostrar la configuración del IdP en Pantheon si este se encuentra inhabilitado. |
DeleteDefaultSupportedIdpConfigRequest
Solicitud para DeleteDefaultSupportedIdpConfig
| Campos | |
|---|---|
name |
El nombre del recurso de la configuración, por ejemplo: "projects/my-awesome-project/defaultSupportedIdpConfigs/google.com" La autorización requiere el siguiente permiso IAM en el recurso especificado
|
DeleteInboundSamlConfigRequest
Solicitud para DeleteInboundSamlConfig
| Campos | |
|---|---|
name |
El nombre del recurso de la configuración que se borrará, por ejemplo: "projects/my-awesome-project/inboundSamlConfigs/my-config-id". La autorización requiere el siguiente permiso IAM en el recurso especificado
|
DeleteOAuthIdpConfigRequest
Solicitud para DeleteOAuthIdpConfig
| Campos | |
|---|---|
name |
Es el nombre del recurso de la configuración que se borrará, por ejemplo: "projects/my-awesome-project/oauthIdpConfigs/oauth-config-id". La autorización requiere el siguiente permiso IAM en el recurso especificado
|
DeleteTenantRequest
Es el mensaje de solicitud para DeleteTenant.
| Campos | |
|---|---|
name |
Es el nombre del recurso del inquilino que se borrará. La autorización requiere el siguiente permiso IAM en el recurso especificado
|
EnableCicpRequest
Solicitud para EnableCicp.
| Campos | |
|---|---|
project |
Es el nombre del recurso del proyecto de destino para el que el desarrollador desea habilitar CICP. La autorización requiere el siguiente permiso IAM en el recurso especificado
|
EnableCicpResponse
Este tipo no tiene campos.
Respuesta para EnableCicp. Por ahora, está vacía.
GetConfigRequest
Solicitud para GetConfig
| Campos | |
|---|---|
name |
Es el nombre del recurso de la configuración, por ejemplo: "projects/my-awesome-project/config". La autorización requiere el siguiente permiso IAM en el recurso especificado
|
GetDefaultSupportedIdpConfigRequest
Solicitud para GetDefaultSupportedIdpConfig
| Campos | |
|---|---|
name |
El nombre del recurso de la configuración, por ejemplo: "projects/my-awesome-project/defaultSupportedIdpConfigs/google.com" La autorización requiere el siguiente permiso IAM en el recurso especificado
|
GetInboundSamlConfigRequest
Solicitud para GetInboundSamlConfig
| Campos | |
|---|---|
name |
Es el nombre del recurso de la configuración, por ejemplo: "projects/my-awesome-project/inboundSamlConfigs/my-config-id". La autorización requiere el siguiente permiso IAM en el recurso especificado
|
GetOAuthIdpConfigRequest
Solicitud de GetOAuthIdpConfig
| Campos | |
|---|---|
name |
Es el nombre del recurso de la configuración, por ejemplo: "projects/my-awesome-project/oauthIdpConfigs/oauth-config-id". La autorización requiere el siguiente permiso IAM en el recurso especificado
|
GetTenantRequest
Mensaje de solicitud para GetTenant.
| Campos | |
|---|---|
name |
Es el nombre del recurso del usuario que se recuperará. La autorización requiere el siguiente permiso IAM en el recurso especificado
|
HashConfig
Información del historial del algoritmo y la clave de hash. Las contraseñas de diferentes cuentas pueden generarse con diferentes versiones.
| Campos | |
|---|---|
algorithm |
Solo salida. Diferentes algoritmos de hash de contraseñas que se usan en Identity Toolkit. |
signer_key |
Solo salida. Clave del firmante en base64. |
salt_separator |
Solo salida. Es un carácter no imprimible que se inserta entre la sal y la contraseña de texto sin formato en base64. |
rounds |
Solo salida. Cuántas rondas para el cálculo de hash. Lo usan scrypt y otros algoritmos de derivación de contraseñas similares. |
memory_cost |
Solo salida. Es el costo de memoria para el cálculo de hash. Lo usan scrypt y otros algoritmos de derivación de contraseñas similares. Consulta https://tools.ietf.org/html/rfc7914 para obtener una explicación del campo. |
HashAlgorithm
Diferentes algoritmos de hash de contraseñas que se usan en Identity Toolkit.
| Enums | |
|---|---|
HASH_ALGORITHM_UNSPECIFIED |
Valor predeterminado No se debe usar. |
HMAC_SHA256 |
HMAC_SHA256 |
HMAC_SHA1 |
HMAC_SHA1 |
HMAC_MD5 |
HMAC_MD5 |
SCRYPT |
SCRYPT |
PBKDF_SHA1 |
PBKDF_SHA1 |
MD5 |
MD5 |
HMAC_SHA512 |
HMAC_SHA512 |
SHA1 |
SHA1 |
BCRYPT |
BCRYPT |
PBKDF2_SHA256 |
PBKDF2_SHA256 |
SHA256 |
SHA256 |
SHA512 |
SHA512 |
STANDARD_SCRYPT |
STANDARD_SCRYPT |
IdpCertificate
El proto de los datos del certificado del IdP para verificar la firma en la SAMLResponse que emitió el IdP.
| Campos | |
|---|---|
x509_certificate |
El certificado x509 |
InboundSamlConfig
El proto para almacenar un par de configuraciones de RP-IdP de SAML cuando el proyecto actúa como la parte de confianza.
| Campos | |
|---|---|
name |
El nombre del recurso InboundSamlConfig, por ejemplo: "projects/my-awesome-project/inboundSamlConfigs/my-config-id". Se ignora durante las solicitudes de creación. |
idp_config |
Es el proto para almacenar la configuración del IdP (proveedor de identidad) de SAML cuando el proyecto actúa como la parte de confianza. |
sp_config |
Es el proto para almacenar la configuración del SP (proveedor de servicios) de SAML cuando el proyecto actúa como la parte de confianza para recibir y aceptar una aserción de autenticación emitida por un proveedor de identidad de SAML. |
display_name |
Es el nombre visible de la configuración que establecen los desarrolladores. |
enabled |
Es verdadero si permite que el usuario acceda con el proveedor. |
IdpConfig
Es el proto para almacenar la configuración del IdP (proveedor de identidad) de SAML cuando el proyecto actúa como la parte de confianza.
| Campos | |
|---|---|
idp_entity_id |
Es el identificador único de todas las entidades SAML. |
sso_url |
Es la URL a la que se enviará la solicitud de autenticación. |
idp_certificates[] |
Son las claves públicas del IDP para verificar la firma en las aserciones. |
sign_request |
Indica si se debe firmar la SAMLRequest saliente. |
SpConfig
Es el proto para almacenar la configuración del SP (proveedor de servicios) de SAML cuando el proyecto actúa como la parte de confianza para recibir y aceptar una aserción de autenticación emitida por un proveedor de identidad de SAML.
| Campos | |
|---|---|
sp_entity_id |
Es el identificador único de todas las entidades SAML. |
callback_uri |
Es el URI de devolución de llamada en el que se controlan las respuestas del IDP. |
sp_certificates[] |
Solo salida. Son certificados públicos que genera el servidor para verificar la firma en SAMLRequest en el flujo iniciado por el SP. |
ListDefaultSupportedIdpConfigsRequest
Solicitud para ListDefaultSupportedIdpConfigs
| Campos | |
|---|---|
parent |
El nombre del recurso superior, por ejemplo, "projects/my-awesome-project". La autorización requiere el siguiente permiso IAM en el recurso especificado
|
page_size |
La cantidad máxima de elementos que se mostrarán. |
page_token |
El valor next_page_token que se muestra de una solicitud de lista anterior, si existe. |
ListDefaultSupportedIdpConfigsResponse
Respuesta para ListDefaultSupportedIdpConfigs
| Campos | |
|---|---|
default_supported_idp_configs[] |
Es el conjunto de parámetros de configuración. |
next_page_token |
Token para recuperar la página siguiente de resultados o vaciar si no hay más resultados en la lista. |
ListDefaultSupportedIdpsRequest
Solicitud para ListDefaultSupportedIdps
| Campos | |
|---|---|
page_size |
La cantidad máxima de elementos que se mostrarán. |
page_token |
El valor next_page_token que se muestra de una solicitud de lista anterior, si existe. |
ListDefaultSupportedIdpsResponse
Respuesta para ListDefaultSupportedIdps
| Campos | |
|---|---|
default_supported_idps[] |
Es el conjunto de parámetros de configuración. |
next_page_token |
Token para recuperar la página siguiente de resultados o vaciar si no hay más resultados en la lista. |
ListInboundSamlConfigsRequest
Solicitud para ListInboundSamlConfigs
| Campos | |
|---|---|
parent |
El nombre del recurso superior, por ejemplo, "projects/my-awesome-project". La autorización requiere el siguiente permiso IAM en el recurso especificado
|
page_size |
La cantidad máxima de elementos que se mostrarán. |
page_token |
El valor next_page_token que se muestra de una solicitud de lista anterior, si existe. |
ListInboundSamlConfigsResponse
Respuesta para ListInboundSamlConfigs
| Campos | |
|---|---|
inbound_saml_configs[] |
Es el conjunto de parámetros de configuración. |
next_page_token |
Token para recuperar la página siguiente de resultados o vaciar si no hay más resultados en la lista. |
ListOAuthIdpConfigsRequest
Solicitud para ListOAuthIdpConfigs
| Campos | |
|---|---|
parent |
El nombre del recurso superior, por ejemplo, "projects/my-awesome-project". La autorización requiere el siguiente permiso IAM en el recurso especificado
|
page_size |
La cantidad máxima de elementos que se mostrarán. |
page_token |
El valor next_page_token que se muestra de una solicitud de lista anterior, si existe. |
ListOAuthIdpConfigsResponse
Respuesta para ListOAuthIdpConfigs
| Campos | |
|---|---|
oauth_idp_configs[] |
Es el conjunto de parámetros de configuración. |
next_page_token |
Token para recuperar la página siguiente de resultados o vaciar si no hay más resultados en la lista. |
ListTenantsRequest
Mensaje de solicitud para ListTenants.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso superior para el que se enumeran los inquilinos. La autorización requiere el siguiente permiso IAM en el recurso especificado
|
page_token |
Es el token de paginación de la respuesta de una solicitud anterior. |
page_size |
Es la cantidad máxima de resultados que se mostrarán, con un límite de 1,000. Si no se especifica, el valor predeterminado es 20. |
ListTenantsResponse
Mensaje de respuesta para ListTenants.
| Campos | |
|---|---|
tenants[] |
Es una lista de inquilinos del proyecto de agente determinado. |
next_page_token |
Es el token para obtener la siguiente página de resultados. |
MonitoringConfig
Configuración relacionada con la supervisión de la actividad del proyecto.
| Campos | |
|---|---|
request_logging |
Configuración para registrar las solicitudes que se realizan a este proyecto en Stackdriver Logging |
RequestLogging
Configuración para registrar las solicitudes que se realizan a este proyecto en Stackdriver Logging
| Campos | |
|---|---|
enabled |
Indica si los registros están habilitados para este proyecto o no. |
MultiFactorAuthConfig
Son opciones relacionadas con la autenticación de varios factores para el proyecto.
| Campos | |
|---|---|
state |
Indica si se habilitó la autenticación de varios factores para este proyecto. |
enabled_providers[] |
Es una lista de los segundos factores que se pueden usar para este proyecto. |
Proveedor
Es una lista de los segundos factores que se pueden usar para este proyecto.
| Enums | |
|---|---|
PROVIDER_UNSPECIFIED |
Proveedor ilegal, no se debe usar |
PHONE_SMS |
Los SMS están habilitados como segundo factor para este proyecto. |
Estado
Indica si se habilitó la autenticación de varios factores para este proyecto.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Estado ilegal, no se debe usar. |
DISABLED |
No se puede usar la autenticación de varios factores para este proyecto |
ENABLED |
Se puede usar la autenticación de varios factores para este proyecto |
ADMIN_ENABLED |
Se puede usar la autenticación de varios factores para este proyecto, pero solo los administradores del proyecto pueden configurarla. |
NotificationConfig
Configuración relacionada con el envío de notificaciones a los usuarios.
| Campos | |
|---|---|
send_email |
Opciones para enviar correos electrónicos. |
send_sms |
Opciones para enviar SMS. |
default_locale |
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.
| Campos | |
|---|---|
method |
Es el método que se usa para enviar un correo electrónico. |
reset_password_template |
Plantilla de correo electrónico para restablecer la contraseña |
verify_email_template |
Plantilla de correo electrónico para verificar el correo electrónico |
change_email_template |
Plantilla de correo electrónico para cambiar el correo electrónico |
legacy_reset_password_template |
Plantilla de correo electrónico de restablecimiento de contraseña para la app heredada de Firebase V1. |
callback_uri |
URL de acción en la plantilla de correo electrónico. |
dns_info |
Información de la verificación de DNS del dominio personalizado |
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 |
Usa un servidor de retransmisión de SMTP personalizado |
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.
| Campos | |
|---|---|
custom_domain |
Solo salida. El dominio personalizado verificado aplicado. |
use_custom_domain |
Indica si se debe usar un dominio personalizado. |
pending_custom_domain |
Solo salida. El dominio personalizado que se verificará. |
custom_domain_state |
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. |
domain_verification_request_time |
Solo salida. Es la marca de tiempo de la solicitud inicial para la verificación de dominio actual. |
VerificationState
Es el estado de verificación actual del dominio personalizado.
| Enums | |
|---|---|
VERIFICATION_STATE_UNSPECIFIED |
Valor predeterminado No se debe usar. |
NOT_STARTED |
La verificación aún no comienza. |
IN_PROGRESS |
La verificación está en curso. |
FAILED |
Falló la verificación. |
SUCCEEDED |
La verificación se realizó correctamente y está lista para aplicarse. |
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.
| Campos | |
|---|---|
sender_local_part |
Parte local de la dirección de origen |
subject |
Asunto del correo electrónico |
sender_display_name |
Nombre visible del remitente |
body |
Cuerpo del correo electrónico |
body_format |
Formato del cuerpo del correo electrónico |
reply_to |
Dirección de respuesta |
customized |
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 |
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
| Campos | |
|---|---|
sender_email |
Correo electrónico del remitente para la retransmisión de SMTP |
host |
Host de retransmisión de SMTP |
port |
Puerto de retransmisión de SMTP |
username |
Nombre de usuario de la retransmisión de SMTP |
password |
Contraseña de la retransmisión de SMTP |
security_mode |
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 |
SendSms
Opciones para el envío de SMS.
| Campos | |
|---|---|
use_device_locale |
Indica si se debe usar el encabezado accept_language para los SMS. |
sms_template |
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.
| Campos | |
|---|---|
content |
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. |
OAuthIdpConfig
Opciones de configuración para autenticar con un IDP de OAuth
| Campos | |
|---|---|
name |
El nombre del recurso OAuthIdpConfig, por ejemplo: "projects/my-awesome-project/oauthIdpConfigs/oauth-config-id". Se ignora durante las solicitudes de creación. |
client_id |
El ID de cliente de un cliente OAuth. |
issuer |
Para los proveedores de identidad de OIDC, el identificador del emisor. |
display_name |
Es el nombre visible de la configuración que establecen los desarrolladores. |
enabled |
Es verdadero si permite que el usuario acceda con el proveedor. |
client_secret |
El secreto de cliente del cliente de OAuth para habilitar el flujo de código de OIDC |
response_type |
Es el tipo de respuesta que se debe solicitar en el flujo de autorización de OAuth. Puedes establecer |
OAuthResponseType
Es el tipo de respuesta que se debe solicitar en el flujo de autorización de OAuth. Puedes establecer id_token o code como verdadero, pero no ambos. Aún no se admite configurar ambos tipos como verdaderos de forma simultánea ({code: true, id_token: true}).
Consulta https://openid.net/specs/openid-connect-core-1_0.html#Authentication para obtener una asignación del tipo de respuesta al flujo de OAuth 2.0.
| Campos | |
|---|---|
id_token |
Si es verdadero, se muestra el token de ID desde el extremo de autorización del IdP. |
code |
Si es verdadero, el código de autorización se muestra desde el extremo de autorización del IdP. |
token |
No se debe usar. Por el momento, no se admite el tipo de respuesta |
QuotaConfig
Configuración relacionada con las cuotas.
| Campos | |
|---|---|
sign_up_quota_config |
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
| Campos | |
|---|---|
quota |
Corresponde al campo "refill_token_count" en la configuración de QuotaServer. |
start_time |
Cuándo entrará en vigencia esta cuota |
quota_duration |
Cuánto tiempo estará activa esta cuota |
SignInConfig
Configuración relacionada con los métodos de acceso local
| Campos | |
|---|---|
email |
Son opciones de configuración relacionadas con la autenticación de un usuario por su dirección de correo electrónico. |
phone_number |
Son opciones de configuración relacionadas con la autenticación de un usuario por su número de teléfono. |
anonymous |
Son opciones de configuración relacionadas con la autenticación de un usuario anónimo. |
allow_duplicate_emails |
Indica si se permite que más de una cuenta tenga el mismo correo electrónico. |
hash_config |
Solo salida. Información de configuración de hash |
Anónimo
Son opciones de configuración relacionadas con la autenticación de un usuario anónimo.
| Campos | |
|---|---|
enabled |
Indica si la autenticación de usuarios anónimos está habilitada para el proyecto o no. |
Correo electrónico
Son opciones de configuración relacionadas con la autenticación de un usuario por su dirección de correo electrónico.
| Campos | |
|---|---|
enabled |
Indica si la autenticación por correo electrónico está habilitada para el proyecto o no. |
password_required |
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. |
hash_config |
Solo salida. Información de configuración de hash |
PhoneNumber
Son opciones de configuración relacionadas con la autenticación de un usuario por su número de teléfono.
| Campos | |
|---|---|
enabled |
Indica si la autenticación con número de teléfono está habilitada para el proyecto. |
test_phone_numbers |
Un mapa de <número de teléfono de prueba, código falso> que se puede usar para pruebas de autenticación telefónica. |
SpCertificate
El proto de los datos del certificado del SP para que el IdP verifique la SAMLRequest que generó el SP.
| Campos | |
|---|---|
x509_certificate |
Certificado público autofirmado |
expires_at |
Marca de tiempo de la instancia de vencimiento del certificado |
Usuario
Un usuario contiene la configuración del usuario en un proyecto multiusuario.
| Campos | |
|---|---|
name |
Es el nombre del recurso de un usuario. Por ejemplo: "projects/project1/tenants/tenant1" |
display_name |
Es el nombre visible del inquilino. |
saml_configs[] |
Se solicitaron configuraciones de SAML. |
idp_configs[] |
Se solicitaron configuraciones de IDP. |
allow_password_signup |
Si se permite el registro con correo electrónico y contraseña. |
enable_email_link_signin |
Indica si se debe habilitar el registro con un vínculo de correo electrónico. |
disable_auth |
Indica si el usuario está inhabilitado para la autenticación. Los usuarios del inquilino inhabilitado no pueden acceder. Los administradores del usuario inhabilitado no pueden administrar a sus usuarios. |
UpdateConfigRequest
Solicitud para UpdateConfig
| Campos | |
|---|---|
config |
El recurso de configuración que reemplaza el recurso en el servidor. La autorización requiere el siguiente permiso IAM en el recurso especificado
|
update_mask |
La máscara de actualización se aplica al recurso. Se ignorarán los campos establecidos en la configuración, pero que no se incluyen en esta máscara de actualización. Para ver la definición de |
UpdateDefaultSupportedIdpConfigRequest
Solicitud para UpdateDefaultSupportedIdpConfig
| Campos | |
|---|---|
default_supported_idp_config |
El recurso de configuración que reemplaza el recurso en el servidor. La autorización requiere el siguiente permiso IAM en el recurso especificado
|
update_mask |
La máscara de actualización se aplica al recurso. Para ver la definición de |
UpdateInboundSamlConfigRequest
Solicitud para UpdateInboundSamlConfig
| Campos | |
|---|---|
inbound_saml_config |
El recurso de configuración que reemplaza el recurso en el servidor. La autorización requiere el siguiente permiso IAM en el recurso especificado
|
update_mask |
La máscara de actualización se aplica al recurso. Si la máscara de actualización está vacía, no se actualizará nada. Para ver la definición de |
UpdateOAuthIdpConfigRequest
Solicitud para UpdateOAuthIdpConfig
| Campos | |
|---|---|
oauth_idp_config |
El recurso de configuración que reemplaza el recurso en el servidor. La autorización requiere el siguiente permiso IAM en el recurso especificado
|
update_mask |
La máscara de actualización se aplica al recurso. Si la máscara de actualización está vacía, no se actualizará nada. Para ver la definición de |
UpdateTenantRequest
Es el mensaje de solicitud para UpdateTenant.
| Campos | |
|---|---|
tenant |
Obligatorio. Es el inquilino que se actualizará. La autorización requiere el siguiente permiso IAM en el recurso especificado
|
update_mask |
La máscara de actualización se aplica al recurso. Para ver la definición de |
VerifyDomainRequest
Mensaje de solicitud para verificar que el dominio personalizado solicitado tenga los registros DNS requeridos.
| Campos | |
|---|---|
resource |
Es el nombre del recurso cuyo dominio se verificará. Actualmente, este método acepta la verificación de dominios para proyectos (por ejemplo, "projects/my-awesome-project") o inquilinos (por ejemplo, "projects/my-awesome-project/tenants/my-awesome-tenant"). La autorización requiere el siguiente permiso IAM en el recurso especificado
|
domain |
Es el dominio de destino de esta solicitud. |
action |
La acción que se intenta realizar en el dominio determinado |
DomainVerificationAction
La acción que se intenta realizar en el dominio determinado
| Enums | |
|---|---|
DOMAIN_VERIFICATION_ACTION_UNSPECIFIED |
Valor predeterminado No se debe usar. |
VERIFY |
Verifica el dominio en la solicitud. |
CANCEL |
Cancela el proceso de verificación actual. |
APPLY |
Aplica el dominio personalizado en el envío de correos electrónicos. |
VerifyDomainResponse
Es la respuesta a la solicitud de VerifyDomain.
| Campos | |
|---|---|
verification_state |
Es el estado resultante del dominio determinado después de que se procesa esta solicitud. |
verification_error |
Cuando corresponda, una explicación textual de por qué no se pudo verificar el dominio |