Índice
AccountManagementService(interfaz)AuthenticationService(interfaz)AutoRetrievalInfo(mensaje)ClientType(enum)FinalizeMfaEnrollmentRequest(mensaje)FinalizeMfaEnrollmentResponse(mensaje)FinalizeMfaPhoneRequestInfo(mensaje)FinalizeMfaPhoneResponseInfo(mensaje)FinalizeMfaSignInRequest(mensaje)FinalizeMfaSignInResponse(mensaje)FinalizeMfaTotpEnrollmentRequestInfo(mensaje)FinalizeMfaTotpEnrollmentResponseInfo(mensaje)GetPasswordPolicyRequest(mensaje)GetRecaptchaConfigRequest(mensaje)MfaTotpSignInRequestInfo(mensaje)PasswordPolicy(mensaje)PasswordPolicy.CustomStrengthOptions(mensaje)PasswordPolicy.EnforcementState(enum)RecaptchaConfig(mensaje)RecaptchaEnforcementState(mensaje)RecaptchaEnforcementState.EnforcementState(enum)RecaptchaEnforcementState.RecaptchaProvider(enum)RecaptchaVersion(enum)RevokeTokenRequest(mensaje)RevokeTokenRequest.TokenType(enum)RevokeTokenResponse(mensaje)StartMfaEnrollmentRequest(mensaje)StartMfaEnrollmentResponse(mensaje)StartMfaPhoneRequestInfo(mensaje)StartMfaPhoneResponseInfo(mensaje)StartMfaSignInRequest(mensaje)StartMfaSignInResponse(mensaje)StartMfaTotpEnrollmentRequestInfo(mensaje)StartMfaTotpEnrollmentResponseInfo(mensaje)WithdrawMfaRequest(mensaje)WithdrawMfaResponse(mensaje)
AccountManagementService
Administración de cuentas para Identity Toolkit
| FinalizeMfaEnrollment |
|---|
|
Termina de inscribir un segundo factor para el usuario.
|
| StartMfaEnrollment |
|---|
|
Primer paso del proceso de inscripción de la AUA. En el caso de los SMS, se envía un código de verificación por SMS al usuario.
|
| WithdrawMfa |
|---|
|
Revoca un segundo factor de los métodos de dos factores inscritos de una cuenta.
|
AuthenticationService
Autenticación para Identity Toolkit
| FinalizeMfaSignIn |
|---|
|
Verifica el desafío de la MFA y accede
|
| GetPasswordPolicy |
|---|
|
Obtiene la configuración de la política de contraseñas establecida en el proyecto o el inquilino.
|
| GetRecaptchaConfig |
|---|
|
Obtiene los parámetros necesarios para el análisis de reCAPTCHA.
|
| RevokeToken |
|---|
|
Revoca el token de un usuario de un proveedor de identidad (IdP). Para ello, proporciona manualmente una credencial de IdP y los tipos de tokens para la revocación. Se requiere una clave de API en la solicitud para identificar el proyecto de Google Cloud.
|
| StartMfaSignIn |
|---|
|
Envía el desafío de MFA
|
AutoRetrievalInfo
Es la información necesaria para recuperar automáticamente un SMS.
| Campos | |
|---|---|
app_signature_hash |
El hash de firma de la app para Android para la API de SMS Retriever de los Servicios de Google Play |
ClientType
Es el tipo de plataforma del cliente: Web, Android o iOS.
| Enums | |
|---|---|
CLIENT_TYPE_UNSPECIFIED |
No se especificó el tipo de cliente. |
CLIENT_TYPE_WEB |
El tipo de cliente es web. |
CLIENT_TYPE_ANDROID |
El tipo de cliente es Android. |
CLIENT_TYPE_IOS |
El tipo de cliente es iOS. |
FinalizeMfaEnrollmentRequest
Termina de inscribir un segundo factor para el usuario.
| Campos | |
|---|---|
id_token |
Obligatorio. Token de ID |
display_name |
Es el nombre visible que ingresan los usuarios para distinguir entre diferentes segundos factores con el mismo tipo o con un tipo diferente. |
tenant_id |
El ID del grupo de usuarios de Identity Platform al que pertenece el usuario que inscribe la MFA. Si no se establece, el usuario pertenece al proyecto predeterminado de Identity Platform. |
Campo de unión verification_info. Se debe verificar la información de inscripción de la MFA. verification_info puede ser solo uno de los siguientes: |
|
phone_verification_info |
Información de verificación para autorizar el envío de un SMS de verificación telefónica |
totp_verification_info |
Información de verificación para TOTP. |
FinalizeMfaEnrollmentResponse
Respuesta de FinalizeMfaEnrollment.
| Campos | |
|---|---|
id_token |
Se actualizó el token de ID para reflejar la inscripción de la MFA. |
refresh_token |
Se actualizó el token de actualización para reflejar la inscripción de la MFA. |
Campo de unión auxiliary_auth_info. Información de inscripción verificada por la MFA auxiliary_auth_info puede ser solo uno de los siguientes: |
|
phone_auth_info |
Información de autenticación auxiliar específica de la autenticación telefónica. |
totp_auth_info |
Información de autenticación auxiliar específica de la autenticación de TOTP. |
FinalizeMfaPhoneRequestInfo
Información de verificación por teléfono para una solicitud de FinalizeMfa.
| Campos | |
|---|---|
session_info |
Es una cadena opaca que representa la sesión de inscripción. |
code |
Es el código de verificación que ingresó el usuario. |
android_verification_proof |
Solo para Android. Se usa para la verificación "instantánea" del número de teléfono a través de GmsCore. |
phone_number |
Obligatorio si se presenta un comprobante de verificación de Android. |
FinalizeMfaPhoneResponseInfo
Información de verificación telefónica para una respuesta de FinalizeMfa.
| Campos | |
|---|---|
android_verification_proof |
Solo para Android. Reemplazo de larga duración para un código válido vinculado a un dispositivo Android. |
android_verification_proof_expire_time |
Solo para Android. Es el tiempo de vencimiento de la prueba de verificación en segundos. |
phone_number |
Para la prueba de verificación de Android. |
FinalizeMfaSignInRequest
Verifica el desafío de MFA para finalizar el acceso.
| Campos | |
|---|---|
mfa_pending_credential |
Obligatorio. Credenciales pendientes del acceso con el primer factor |
tenant_id |
El ID del grupo de usuarios de Identity Platform al que accede el usuario. Si no se establece, el usuario accederá al proyecto predeterminado de Identity Platform. |
mfa_enrollment_id |
El ID de inscripción de la MFA de la lista de inscripciones actuales de la MFA del usuario |
Campo de unión verification_info. Prueba de finalización del desafío de MFA verification_info puede ser solo uno de los siguientes: |
|
phone_verification_info |
Prueba de que se completó el desafío de la MFA basada en SMS |
totp_verification_info |
Prueba de que se completó el desafío de MFA basado en TOTP |
FinalizeMfaSignInResponse
Respuesta de FinalizeMfaSignIn.
| Campos | |
|---|---|
id_token |
Token de ID para el usuario autenticado |
refresh_token |
Token de actualización para el usuario autenticado. |
Campo de unión auxiliary_auth_info. Información de acceso verificada con la MFA auxiliary_auth_info puede ser solo uno de los siguientes: |
|
phone_auth_info |
Información adicional de autenticación telefónica, incluida la prueba de verificación de Android |
FinalizeMfaTotpEnrollmentRequestInfo
Información de la solicitud de MFA específica para la autenticación de TOTP para FinalizeMfa.
| Campos | |
|---|---|
session_info |
Es una cadena opaca que representa la sesión de inscripción. |
verification_code |
Es el código de verificación que ingresó el usuario. |
FinalizeMfaTotpEnrollmentResponseInfo
Este tipo no tiene campos.
Información de respuesta de MFA específica para la autenticación de TOTP para FinalizeMfa.
GetPasswordPolicyRequest
La solicitud para GetPasswordPolicy.
| Campos | |
|---|---|
tenant_id |
Es el ID de un grupo de usuarios. |
GetRecaptchaConfigRequest
La solicitud para GetRecaptchaConfig.
| Campos | |
|---|---|
tenant_id |
Es el ID de un grupo de usuarios. |
client_type |
reCAPTCHA Enterprise usa claves de sitio independientes para diferentes tipos de clientes. Especifica el tipo de cliente para obtener la clave correspondiente. |
version |
La versión de reCAPTCHA. |
MfaTotpSignInRequestInfo
Información de verificación de TOTP para FinalizeMfaSignInRequest.
| Campos | |
|---|---|
verification_code |
Es el código de verificación que ingresó el usuario. |
PasswordPolicy
Configuración de la política de contraseñas.
| Campos | |
|---|---|
custom_strength_options |
Las opciones de seguridad personalizadas que aplica la política de contraseñas |
schema_version |
Solo salida. Es el número de versión del esquema de la política de contraseñas. |
allowed_non_alphanumeric_characters[] |
Solo salida. Son caracteres permitidos que cumplen con el requisito de no ser alfanuméricos. |
enforcement_state |
Solo salida. Es el modo de aplicación forzosa que se usará para la política de contraseñas. |
force_upgrade_on_signin |
Los usuarios deben tener una contraseña que cumpla con la política de contraseñas para acceder. |
CustomStrengthOptions
Opciones de nivel de seguridad personalizadas para aplicar en las contraseñas de los usuarios
| Campos | |
|---|---|
min_password_length |
Longitud mínima de la contraseña El rango disponible varía de 6 a 30. |
max_password_length |
Es la longitud máxima de la contraseña. Sin duración máxima predeterminada |
contains_lowercase_character |
La contraseña debe contener un carácter en minúscula. |
contains_uppercase_character |
La contraseña debe contener un carácter en mayúscula. |
contains_numeric_character |
La contraseña debe contener un número. |
contains_non_alphanumeric_character |
La contraseña debe contener un carácter que no sea alfanumérico. |
EnforcementState
Estado de aplicación forzosa de la política de contraseñas
| Enums | |
|---|---|
ENFORCEMENT_STATE_UNSPECIFIED |
No se estableció el estado de aplicación forzosa. |
OFF |
No se usará la Política de Contraseñas en el proyecto. |
ENFORCE |
Las contraseñas que no cumplan con la política de contraseñas se rechazarán y se mostrará un error. |
RecaptchaConfig
Configuración de reCAPTCHA
| Campos | |
|---|---|
recaptcha_enforcement_state[] |
Es el estado de aplicación forzosa de reCAPTCHA para los proveedores que admiten la protección de reCAPTCHA en GCIP. |
recaptcha_key |
Es el nombre del recurso de la clave de reCAPTCHA Enterprise, p.ej., "projects/{project}/keys/{key}". Solo se mostrará cuando el estado de aplicación de reCAPTCHA sea AUDIT o ENFORCE en al menos uno de los proveedores de reCAPTCHA. |
use_sms_bot_score |
Indica si se debe usar la puntuación de bot de rCE para el proveedor de telefonía de reCAPTCHA. |
use_sms_toll_fraud_protection |
Indica si se debe usar la puntuación de riesgo de protección contra el fraude de cargos telefónicos por SMS de rCE para el proveedor de telefonía de reCAPTCHA. |
RecaptchaEnforcementState
Estados de aplicación para la protección de reCAPTCHA
| Campos | |
|---|---|
provider |
El proveedor que tiene protección de reCAPTCHA. |
enforcement_state |
Es el estado de aplicación forzosa de reCAPTCHA para el proveedor. |
EnforcementState
Estados de aplicación forzosa para la protección de reCAPTCHA por proveedor
| Enums | |
|---|---|
ENFORCEMENT_STATE_UNSPECIFIED |
No se estableció el estado de aplicación forzosa. |
OFF |
No se aplica. |
AUDIT |
Se crea la evaluación de reCAPTCHA, pero el resultado no se usa para aplicarla. |
ENFORCE |
Se crea la evaluación de reCAPTCHA y se usa el resultado para aplicarla. |
RecaptchaProvider
Los proveedores de GCIP que admiten la protección de reCAPTCHA
| Enums | |
|---|---|
RECAPTCHA_PROVIDER_UNSPECIFIED |
No se especificó el proveedor de reCAPTCHA |
EMAIL_PASSWORD_PROVIDER |
Proveedor de contraseñas de correo electrónico |
PHONE_PROVIDER |
Proveedor de autenticación telefónica |
RecaptchaVersion
La versión de reCAPTCHA.
| Enums | |
|---|---|
RECAPTCHA_VERSION_UNSPECIFIED |
No se especificó la versión de reCAPTCHA. |
RECAPTCHA_ENTERPRISE |
La empresa de reCAPTCHA. |
RevokeTokenRequest
Es un mensaje de solicitud para RevokeToken.
| Campos | |
|---|---|
provider_id |
Obligatorio. El proveedor de IdP del token. Actualmente, solo se admite el ID de Apple. El formato debe ser “apple.com”. |
token_type |
Obligatorio. Es el tipo de token que se revocará. |
token |
Obligatorio. Es el token que se revocará. Si se pasa un authorization_code, la API primero intercambiará el código por un token de acceso y, luego, revocará el token intercambiado. |
id_token |
Obligatorio. Un token de ID de Identity Platform válido para vincular la cuenta Si se realizó correctamente una solicitud de revocación de token en la cuenta y no se generan tokens después de la revocación, se ignorarán las solicitudes duplicadas y se mostrarán de inmediato. |
tenant_id |
El ID del grupo de usuarios de Identity Platform al que accede el usuario. Si no se establece, el usuario accederá al proyecto predeterminado de Identity Platform. |
redirect_uri |
Es el URI de redireccionamiento proporcionado en la solicitud de autorización inicial que el cliente realiza al IDP. El URI debe usar el protocolo HTTPS, incluir un nombre de dominio y no puede contener una dirección IP ni un host local. Obligatorio si token_type es CODE. |
TokenType
Es el tipo de token que se revocará.
| Enums | |
|---|---|
TOKEN_TYPE_UNSPECIFIED |
Es un valor predeterminado que no se debe usar. |
REFRESH_TOKEN |
El tipo de token es refresh_token. |
ACCESS_TOKEN |
El tipo de token es access_token. |
CODE |
El tipo de token es authorization_code. |
RevokeTokenResponse
Este tipo no tiene campos.
Mensaje de respuesta para RevokeToken. Por ahora, está vacía.
StartMfaEnrollmentRequest
Envía un SMS de verificación de inscripción de la MFA a un usuario.
| Campos | |
|---|---|
id_token |
Obligatorio. Token de ID del usuario |
tenant_id |
El ID del grupo de usuarios de Identity Platform al que pertenece el usuario que inscribe la MFA. Si no se establece, el usuario pertenece al proyecto predeterminado de Identity Platform. |
Campo de unión enrollment_info. Información de la MFA por tipo de segundo factor enrollment_info puede ser solo uno de los siguientes: |
|
phone_enrollment_info |
Información de verificación para autorizar el envío de un SMS de verificación telefónica |
totp_enrollment_info |
Información de acceso específica de la autenticación de TOTP |
StartMfaEnrollmentResponse
Respuesta de StartMfaEnrollment.
| Campos | |
|---|---|
Campo de unión enrollment_response. Respuesta de la inscripción de inicio de la MFA por tipo de segundo factor enrollment_response puede ser solo uno de los siguientes: |
|
phone_session_info |
Información de verificación para autorizar el envío de un SMS de verificación telefónica |
totp_session_info |
Información de la respuesta de inscripción específica de la autenticación TOTP. |
StartMfaPhoneRequestInfo
Información de verificación de la app para una solicitud de StartMfa.
| Campos | |
|---|---|
phone_number |
Obligatorio para la inscripción. Es el número de teléfono que se inscribirá como MFA. |
ios_receipt |
Solo para iOS. Recibir la validación correcta del token de la app con APNS |
ios_secret |
Solo para iOS. El secreto se entrega a la app para iOS a través de APNS. |
recaptcha_token |
Solo en la Web. Solución de reCAPTCHA. |
auto_retrieval_info |
Solo para Android. Los Servicios de Google Play lo usan para identificar la app para la recuperación automática. |
safety_net_token |
Solo para Android. Se usa para confirmar la identidad de la aplicación en lugar de un token de reCAPTCHA. Se puede generar un token de SafetyNet a través de la API de SafetyNet Android Attestation, con la codificación Base64 del campo |
play_integrity_token |
Solo para Android. Se usa para confirmar la identidad de la aplicación en lugar de un token de reCAPTCHA (o token de red de seguridad). Se puede generar un token de Play Integrity a través de la API de PlayIntegrity aplicando SHA256 al campo |
captcha_response |
El token de reCAPTCHA Enterprise que proporciona la integración del cliente de reCAPTCHA. Obligatorio cuando reCAPTCHA Enterprise está habilitado. |
client_type |
El tipo de cliente, web, Android o iOS. Obligatorio cuando reCAPTCHA Enterprise está habilitado. |
recaptcha_version |
La versión de reCAPTCHA del token de reCAPTCHA en captcha_response. Obligatorio cuando reCAPTCHA Enterprise está habilitado. |
StartMfaPhoneResponseInfo
Información de verificación telefónica para una respuesta de StartMfa.
| Campos | |
|---|---|
session_info |
Es una cadena opaca que representa la sesión de inscripción. |
StartMfaSignInRequest
Inicia el acceso de varios factores enviando el desafío de autenticación de varios factores.
| Campos | |
|---|---|
mfa_pending_credential |
Obligatorio. Credenciales pendientes del acceso con el primer factor |
mfa_enrollment_id |
Obligatorio. El ID de inscripción de la MFA de la lista de inscripciones actuales de la MFA del usuario |
tenant_id |
El ID del grupo de usuarios de Identity Platform al que accede el usuario. Si no se establece, el usuario accederá al proyecto predeterminado de Identity Platform. |
Campo de unión sign_in_info. Información de la MFA por tipo de segundo factor sign_in_info puede ser solo uno de los siguientes: |
|
phone_sign_in_info |
Información de verificación para autorizar el envío de un SMS de verificación telefónica |
StartMfaSignInResponse
Respuesta de StartMfaSignIn.
| Campos | |
|---|---|
Campo de unión response_info. Respuesta de inicio de sesión de MultiFactor por tipo de segundo factor response_info puede ser solo uno de los siguientes: |
|
phone_response_info |
Información de la sesión de acceso de varios factores específica de los segundos factores de tipo SMS. Junto con el código de un solo uso recuperado del SMS enviado, el contenido de esta información de la sesión se debe pasar a FinalizeMfaSignIn para completar el acceso. |
StartMfaTotpEnrollmentRequestInfo
Este tipo no tiene campos.
Información de la solicitud de MFA específica para la autenticación de TOTP para StartMfa.
StartMfaTotpEnrollmentResponseInfo
Información de respuesta de MFA específica para la autenticación de TOTP para StartMfa.
| Campos | |
|---|---|
shared_secret_key |
Es una cadena codificada en base 32 que representa el secreto compartido de TOTP. La codificación base 32 es la que se especifica en RFC4648#section-6. (Esto es lo mismo que la codificación en base 32 de RFC3548#section-5). |
verification_code_length |
Es la longitud del código de verificación que se debe generar. |
hashing_algorithm |
Es el algoritmo de hash que se usa para generar el código de verificación. |
period_sec |
Es la duración en segundos en la que cambiará el código de verificación. |
session_info |
Es una cadena codificada que representa la sesión de inscripción. |
finalize_enrollment_time |
La hora a la que debe finalizar la inscripción |
WithdrawMfaRequest
Retira la MFA.
| Campos | |
|---|---|
id_token |
Obligatorio. Token de ID del usuario |
mfa_enrollment_id |
Obligatorio. Es el ID de inscripción de la MFA de una inscripción actual de la MFA. |
tenant_id |
El ID del grupo de usuarios de Identity Platform al que pertenece el usuario que cancela la inscripción de la MFA. Si no se establece, el usuario pertenece al proyecto predeterminado de Identity Platform. |
WithdrawMfaResponse
Retira la respuesta de MultiFactorAuth.
| Campos | |
|---|---|
id_token |
Se actualizó el token de ID para reflejar la eliminación del segundo factor. |
refresh_token |
Se actualizó el token de actualización para reflejar la eliminación del segundo factor. |