Índice
AccountManagementService
(interfaz)AuthenticationService
(interfaz)ProjectConfigService
(interfaz)SessionManagementService
(interfaz)Argon2Parameters
(mensaje)Argon2Parameters.HashType
(enum)Argon2Parameters.Version
(enum)BatchDeleteAccountsRequest
(mensaje)BatchDeleteAccountsResponse
(mensaje)BatchDeleteAccountsResponse.BatchDeleteErrorInfo
(mensaje)ClientType
(enum)CreateAuthUriRequest
(mensaje)CreateAuthUriResponse
(mensaje)CreateSessionCookieRequest
(mensaje)CreateSessionCookieResponse
(mensaje)DeleteAccountRequest
(mensaje)DeleteAccountResponse
(mensaje)DownloadAccountRequest
(mensaje)DownloadAccountResponse
(mensaje)EmailInfo
(mensaje)EmailTemplate
(mensaje)EmailTemplate.EmailBodyFormat
(enum)ErrorInfo
(mensaje)GetAccountInfoRequest
(mensaje)GetAccountInfoRequest.FederatedUserIdentifier
(mensaje)GetAccountInfoResponse
(mensaje)GetOobCodeRequest
(mensaje)GetOobCodeResponse
(mensaje)GetProjectConfigRequest
(mensaje)GetProjectConfigResponse
(mensaje)GetRecaptchaParamResponse
(mensaje)GetSessionCookiePublicKeysResponse
(mensaje)IdpConfig
(mensaje)IdpConfig.Provider
(enum)IssueSamlResponseRequest
(mensaje)IssueSamlResponseResponse
(mensaje)MfaEnrollment
(mensaje)OobReqType
(enum)OpenIdConnectKey
(mensaje)ProviderUserInfo
(mensaje)QueryUserInfoRequest
(mensaje)QueryUserInfoRequest.Order
(enum)QueryUserInfoRequest.SortByField
(enum)QueryUserInfoRequest.SqlExpression
(mensaje)QueryUserInfoResponse
(mensaje)RecaptchaVersion
(enum)ResetPasswordRequest
(mensaje)ResetPasswordResponse
(mensaje)SendVerificationCodeRequest
(mensaje)SendVerificationCodeRequest.AutoRetrievalInfo
(mensaje)SendVerificationCodeResponse
(mensaje)SetAccountInfoRequest
(mensaje)SetAccountInfoRequest.MfaInfo
(mensaje)SetAccountInfoRequest.UserAttributeName
(enum)SetAccountInfoResponse
(mensaje)SignInWithCustomTokenRequest
(mensaje)SignInWithCustomTokenResponse
(mensaje)SignInWithEmailLinkRequest
(mensaje)SignInWithEmailLinkResponse
(mensaje)SignInWithGameCenterRequest
(mensaje)SignInWithGameCenterResponse
(mensaje)SignInWithIdpRequest
(mensaje)SignInWithIdpResponse
(mensaje)SignInWithPasswordRequest
(mensaje)SignInWithPasswordResponse
(mensaje)SignInWithPhoneNumberRequest
(mensaje)SignInWithPhoneNumberRequest.VerifyOp
(enum)SignInWithPhoneNumberResponse
(mensaje)SignUpRequest
(mensaje)SignUpRequest.MfaFactor
(mensaje)SignUpResponse
(mensaje)TotpInfo
(mensaje)UploadAccountRequest
(mensaje)UploadAccountRequest.PasswordHashOrder
(enum)UploadAccountResponse
(mensaje)UserInfo
(mensaje)UserNotification
(mensaje)UserNotification.NotificationCode
(enum)VerifyIosClientRequest
(mensaje)VerifyIosClientResponse
(mensaje)
AccountManagementService
Administración de cuentas para Identity Toolkit
BatchDeleteAccounts |
---|
La eliminación masiva borra varias cuentas. En el caso de las cuentas que no se borran, la información de error se incluye en la respuesta. El método ignora las cuentas que no existen o que están duplicadas en la solicitud. Este método requiere una credencial de OAuth 2.0 de Google con los permisos adecuados.
|
DeleteAccount |
---|
Borra la cuenta de un usuario.
|
DownloadAccount |
---|
Descargar la información de la cuenta de todas las cuentas del proyecto de forma paginada Para usar este método, se requiere una credencial de OAuth 2.0 de Google con los permisos adecuados. Además, se necesitan permisos adicionales para obtener el hash, la sal y la versión de la contraseña de las cuentas. De lo contrario, estos campos se ocultan.
|
GetAccountInfo |
---|
Obtiene información de la cuenta para todas las cuentas coincidentes. Para una solicitud de usuario final, recupera la cuenta del usuario final. Para una solicitud de administrador con credencial de OAuth 2.0 de Google, recupera una o varias cuentas con criterios coincidentes.
|
GetOobCode |
---|
Envía un código de confirmación fuera de banda para una cuenta. De manera opcional, las solicitudes de una solicitud autenticada pueden mostrar un vínculo que incluya el código fuera del alcance en lugar de enviarlo.
|
QueryUserInfo |
---|
Busca cuentas de usuario dentro de un proyecto o un grupo de usuarios según las condiciones de la solicitud.
|
ResetPassword |
---|
Restablece la contraseña de una cuenta con un código fuera de banda que genera [sendOobCode][v1.accounts.sendOobCode] o especificando el correo electrónico y la contraseña de la cuenta que se modificará. También puede verificar el propósito de un código fuera de banda sin consumirlo.
|
SetAccountInfo |
---|
Actualiza la información relacionada con la cuenta del usuario especificado configurando campos específicos o aplicando códigos de acción. Se admiten solicitudes de administradores y usuarios finales.
|
UploadAccount |
---|
Sube varias cuentas al proyecto de Google Cloud. Si hay un problema para subir una o más de las cuentas, se subirá el resto y se mostrará una lista de los errores. Para usar este método, se requiere una credencial de OAuth 2.0 de Google con los permisos adecuados.
|
AuthenticationService
Autenticación para Identity Toolkit
CreateAuthUri |
---|
Si se especifica un identificador de correo electrónico, comprueba y muestra si hay alguna cuenta de usuario registrada con el correo electrónico. Si hay una cuenta registrada, recupera todos los proveedores asociados con el correo electrónico de la cuenta. Si se especifica el ID del proveedor de un proveedor de identidad (IdP), se crea un URI de autorización para el IdP. Se puede dirigir al usuario a este URI para que acceda con el IdP. Se requiere una clave de API en la solicitud para identificar el proyecto de Google Cloud.
|
GetPublicKeys |
---|
Recupera las claves públicas del firmante de tokens de Identity Toolkit heredado para permitir que terceros verifiquen el token de ID heredado. Por el momento, el certificado X509 PEM es el único formato admitido.
|
GetRecaptchaParam |
---|
Obtiene los parámetros necesarios para generar un desafío de reCAPTCHA.
|
IssueSamlResponse |
---|
Experimental
|
SendVerificationCode |
---|
Envía un código de verificación por SMS para el acceso con número de teléfono. Para localizar el texto del SMS que se envía al usuario, establece el encabezado HTTP Se requiere una clave de API en la solicitud para identificar el proyecto de Google Cloud.
|
SignInWithCustomToken |
---|
Permite que un usuario acceda o se registre mediante el intercambio de un token de Auth personalizado. Cuando el acceso o el registro son correctos, se emiten un nuevo token de ID y un token de actualización de Identity Platform para el usuario. Se requiere una clave de API en la solicitud para identificar el proyecto de Google Cloud.
|
SignInWithEmailLink |
---|
Permite que un usuario acceda o se registre con un código fuera de banda desde un vínculo de correo electrónico. Si no existe un usuario con la dirección de correo electrónico proporcionada, se creará un registro de usuario. Si el acceso se realiza de forma correcta, se emite un ID de Identity Platform y un token de actualización para el usuario autenticado. Se requiere una clave de API en la solicitud para identificar el proyecto de Google Cloud.
|
SignInWithGameCenter |
---|
Permite que un usuario acceda o se registre con credenciales de Game Center para iOS. Si el acceso se realiza de forma correcta, se emiten un nuevo token de ID y un token de actualización de Identity Platform para el usuario autenticado. El ID del paquete es obligatorio en el encabezado de la solicitud como Se requiere una clave de API en la solicitud para identificar el proyecto de Google Cloud. Apple dio de baja el campo La actualización de las integraciones de acceso a Game Center existentes a la versión 10.5.0 o posterior del SDK es irreversible.
|
SignInWithIdp |
---|
Permite que un usuario acceda o se registre con credenciales de un proveedor de identidad (IdP). Para ello, proporciona una credencial de IdP de forma manual o la respuesta de autorización obtenida a través de la solicitud de autorización de CreateAuthUri. Si el acceso se realiza de forma correcta, se emiten un nuevo token de ID y un token de actualización de Identity Platform para el usuario autenticado. Se creará una nueva cuenta de usuario de Identity Platform si el usuario no accedió anteriormente a la IdP con la misma cuenta. Además, cuando se habilita el parámetro de configuración "Una cuenta por dirección de correo electrónico", no debe haber una cuenta de usuario existente de Identity Platform con la misma dirección de correo electrónico para que se cree una nueva. Se requiere una clave de API en la solicitud para identificar el proyecto de Google Cloud.
|
SignInWithPassword |
---|
Permite que un usuario acceda con un correo electrónico y una contraseña. Si el acceso se realiza de forma correcta, se emiten un nuevo token de ID y un token de actualización de Identity Platform para el usuario autenticado. Se requiere una clave de API en la solicitud para identificar el proyecto de Google Cloud.
|
SignInWithPhoneNumber |
---|
Completa un intento de autenticación con número de teléfono. Si ya existe un usuario con el número de teléfono determinado, se acuña un token de ID para ese usuario. De lo contrario, se crea un usuario nuevo y se lo asocia con el número de teléfono. Este método también se puede usar para vincular un número de teléfono a un usuario existente. Para localizar el texto del SMS que se envía al usuario, establece el encabezado HTTP Se requiere una clave de API en la solicitud para identificar el proyecto de Google Cloud.
|
SignUp |
---|
Registra un usuario nuevo con correo electrónico y contraseña o un usuario anónimo, o bien actualiza un usuario anónimo a correo electrónico y contraseña. Para una solicitud de administrador con una credencial de OAuth 2.0 de Google con los permisos adecuados, se crea un usuario anónimo nuevo con correo electrónico y contraseña, o número de teléfono. Se requiere una clave de API en la solicitud para identificar el proyecto de Google Cloud.
|
VerifyIosClient |
---|
Verifica que un cliente de iOS sea un dispositivo iOS real. Si la solicitud es válida, se enviará un recibo en la respuesta y un secreto a través del Servicio de notificaciones push de Apple. El cliente debe volver a enviar ambos a ciertas APIs de Identity Platform en una llamada posterior (por ejemplo, /accounts:sendVerificationCode) para verificarlo. El ID del paquete es obligatorio en el encabezado de la solicitud como Se requiere una clave de API en la solicitud para identificar el proyecto de Google Cloud.
|
ProjectConfigService
Configuración del proyecto para Identity Toolkit
GetProjectConfig |
---|
Obtiene la configuración pública de Identity Toolkit de un proyecto. (heredado) Este método también admite llamadas autenticadas de un desarrollador para recuperar la configuración no pública.
|
SessionManagementService
Administración de sesiones para Identity Platform
createSessionCookie |
---|
Crea una cookie de sesión para el token de ID de Identity Platform determinado. El cliente usa la cookie de sesión para preservar el estado de acceso del usuario.
|
GetSessionCookiePublicKeys |
---|
Recupera el conjunto de claves públicas del firmante de token web JSON (JWT) de la cookie de sesión que se puede usar para validar la cookie de sesión creada a través de [createSessionCookie][v1.projects.createSessionCookie]. |
Argon2Parameters
Los parámetros del algoritmo de hash Argon2.
Campos | |
---|---|
hash_length_bytes |
Obligatorio. Es la longitud de hash deseada en bytes. El mínimo es 4 y el máximo es 1,024. |
hash_type |
Obligatorio. No debe ser HASH_TYPE_UNSPECIFIED. |
parallelism |
Obligatorio. Es el grado de paralelismo, también llamado subprocesos o carriles. El mínimo es 1 y el máximo es 16. |
iterations |
Obligatorio. Es la cantidad de iteraciones que se deben realizar. El mínimo es 1 y el máximo es 16. |
memory_cost_kib |
Obligatorio. El costo de memoria en kibibytes. El máximo es 32,768. |
version |
Es la versión del algoritmo Argon2. Si no se especifica, el valor predeterminado es VERSION_13. |
associated_data |
Si se proporcionan, los datos asociados adicionales se agregan al valor de hash para proporcionar una capa adicional de seguridad. Es una cadena codificada en base64 si se especifica a través de JSON. |
HashType
Los tipos de algoritmos
Enums | |
---|---|
HASH_TYPE_UNSPECIFIED |
No se especificó el tipo de hash. |
ARGON2_D |
Una variante de Argon2, Argon2d. |
ARGON2_ID |
Una variante de Argon2, Argonid. (recomendado) |
ARGON2_I |
Una variante de Argon2, Argon2i. |
Versión
Es la versión del algoritmo.
Enums | |
---|---|
VERSION_UNSPECIFIED |
No se especifica la versión. |
VERSION_10 |
La versión anterior, 0x10. |
VERSION_13 |
La versión actual, 0x13. Es el valor predeterminado para la versión. |
BatchDeleteAccountsRequest
Es el mensaje de solicitud de BatchDeleteAccounts.
Campos | |
---|---|
target_project_id |
Si se especifica La autorización requiere el siguiente permiso IAM en el recurso especificado
|
local_ids[] |
Obligatorio. Es la lista de IDs de usuario que se borrarán. |
force |
Si se debe forzar la eliminación de las cuentas que no están inhabilitadas Si es falso, solo se borrarán las cuentas inhabilitadas, y las que no lo estén se agregarán a |
tenant_id |
Si las cuentas pertenecen a un usuario de Identity Platform, el ID del usuario. Si las cuentas pertenecen a un proyecto predeterminado de Identity Platform, no se necesita el campo. |
BatchDeleteAccountsResponse
Es el mensaje de respuesta a BatchDeleteAccounts.
Campos | |
---|---|
errors[] |
Información detallada del error para las cuentas que no se pueden borrar |
BatchDeleteErrorInfo
No se pudo borrar la información de error de la cuenta.
Campos | |
---|---|
index |
Es el índice del artículo con errores en el campo local_ids original. |
local_id |
El ID de usuario correspondiente. |
error_message |
Mensaje de error detallado |
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. |
CreateAuthUriRequest
Es un mensaje de solicitud para CreateAuthUri.
Campos | |
---|---|
identifier |
Es el identificador de correo electrónico de la cuenta de usuario para la que se recuperarán los proveedores asociados. Se debe establecer al menos uno de los campos La longitud de la dirección de correo electrónico debe ser inferior a 256 caracteres y debe tener el formato |
continue_uri |
Es una URL válida a la que el IdP redireccionará al usuario. La URL no puede contener fragmentos ni el parámetro de consulta |
openid_realm |
|
provider_id |
El ID del proveedor del IdP con el que el usuario accederá Debe ser un ID de proveedor habilitado para el acceso, que puede ser de la lista de IdPs compatibles predeterminados o del formato |
oauth_consumer_key |
|
oauth_scope |
Alcances de OAuth 2.0 adicionales delimitados por espacios que especifican el alcance de la solicitud de autenticación con el IdP. Se usa para los proveedores de identidades de OAuth 2.0. En el caso del proveedor de Google, se usará el flujo de código de autorización si se configura este campo. |
context |
Es una cadena opaca que se usa para mantener la información contextual entre la solicitud de autenticación y la devolución de llamada del IdP. |
ota_app |
|
app_id |
|
hosted_domain |
Se usa para el proveedor de Google. El dominio alojado de G Suite del usuario para restringir el acceso de los usuarios a ese dominio |
session_id |
Un ID de sesión que se puede verificar en SignInWithIdp para evitar ataques de fijación de sesión. Si no se incluye, se generará una cadena aleatoria y se mostrará como el ID de sesión. |
auth_flow_type |
Se usa para el proveedor de Google. Es el tipo de flujo de autenticación que se usará. Si está presente, debe ser |
custom_parameter |
Son parámetros de consulta personalizados adicionales que se agregarán al URI de autorización. Los siguientes parámetros están reservados y no se pueden agregar: En el caso del proveedor de Microsoft, el usuario de Azure AD al que se accede se puede especificar en el parámetro personalizado |
tenant_id |
El ID del usuario de Identity Platform para crear un URI de autorización o buscar un identificador de correo electrónico Si no se establece, la operación se realizará en la instancia predeterminada de Identity Platform en el proyecto. |
CreateAuthUriResponse
Es el mensaje de respuesta de CreateAuthUri.
Campos | |
---|---|
kind |
|
auth_uri |
El URI de autorización para el proveedor solicitado. Solo está presente cuando se establece un ID de proveedor en la solicitud. |
all_providers[] |
|
registered |
Indica si el identificador de correo electrónico representa una cuenta existente. Solo está presente cuando se establece un identificador de correo electrónico en la solicitud. |
provider_id |
El ID del proveedor de la solicitud, si se proporciona |
for_existing_provider |
Indica si el usuario accedió anteriormente con el ID del proveedor en la solicitud. Solo está presente cuando se establece un identificador de correo electrónico registrado en la solicitud. |
captcha_required |
Si se necesita un CAPTCHA porque el usuario realizó demasiados intentos de acceso fallidos Solo está presente cuando se establece un identificador de correo electrónico registrado en la solicitud. |
session_id |
El ID de sesión de la solicitud o una cadena aleatoria generada por CreateAuthUri si no está presente. Se usa para evitar ataques de fijación de sesión. |
signin_methods[] |
La lista de métodos de acceso que el usuario usó anteriormente. Cada elemento es uno de |
CreateSessionCookieRequest
Es un mensaje de solicitud para CreateSessionCookie.
Campos | |
---|---|
id_token |
Obligatorio. Un token de ID de Identity Platform válido |
valid_duration |
Es la cantidad de segundos hasta que vence la cookie de sesión. Especifica una duración en segundos, entre cinco minutos y catorce días inclusive. |
target_project_id |
Es el ID del proyecto al que pertenece la cuenta. |
tenant_id |
El ID del usuario de Identity Platform al que pertenece la cuenta. |
CreateSessionCookieResponse
Es el mensaje de respuesta de CreateSessionCookie.
Campos | |
---|---|
session_cookie |
La cookie de sesión que se creó a partir del token de ID de Identity Platform especificado en la solicitud Tiene la forma de un token web JSON (JWT). Siempre presente. |
DeleteAccountRequest
Es el mensaje de solicitud para DeleteAccount.
Campos | |
---|---|
local_id |
Es el ID de la cuenta de usuario que se borrará. Para especificar este campo, se requiere una credencial de OAuth 2.0 de Google con los permisos adecuados. Las solicitudes de los usuarios que no tienen la credencial deben pasar un token de ID. |
delegated_project_number |
|
id_token |
El token de ID de Identity Platform de la cuenta que se borrará. Se debe especificar para las solicitudes de los usuarios finales que no tienen la credencial de OAuth 2.0 de Google. Las solicitudes autenticadas que tengan una credencial de OAuth2 de Google con los permisos adecuados pueden pasar local_id para especificar la cuenta que se borrará de forma alternativa. |
tenant_id |
El ID del grupo de usuarios al que pertenece la cuenta, si corresponde. Solo se requiere especificarlo para las solicitudes autenticadas que tengan una credencial de OAuth 2.0 de Google que especifique el local_id de una cuenta que pertenezca a un inquilino de Identity Platform. |
target_project_id |
Es el ID del proyecto al que pertenece la cuenta. Solo debe especificarse en solicitudes autenticadas que especifiquen el local_id de una cuenta. La autorización requiere el siguiente permiso IAM en el recurso especificado
|
DeleteAccountResponse
Mensaje de respuesta para DeleteAccount.
Campos | |
---|---|
kind |
|
DownloadAccountRequest
Mensaje de solicitud para DownloadAccount
Campos | |
---|---|
delegated_project_number |
|
next_page_token |
Es el token de paginación de la respuesta de una solicitud anterior. |
max_results |
La cantidad máxima de resultados que se mostrarán. Debe ser de al menos 1 y no superior a 1,000. De forma predeterminada, es 20. |
target_project_id |
Si se especifica La autorización requiere el siguiente permiso IAM en el recurso especificado
|
tenant_id |
El ID del usuario de Identity Platform al que pertenecen las cuentas. Si no se especifica, se muestran las cuentas del proyecto de Identity Platform. |
DownloadAccountResponse
Mensaje de respuesta para DownloadAccount.
Campos | |
---|---|
kind |
|
users[] |
Todas las cuentas que pertenecen al proyecto o al usuario limitado por max_results en la solicitud |
next_page_token |
Si hay más cuentas que se deben descargar, un token que se puede pasar a DownloadAccount para obtener más cuentas De lo contrario, este campo queda en blanco. |
EmailInfo
Información sobre la MFA por correo electrónico
Campos | |
---|---|
email_address |
Es la dirección de correo electrónico a la que se debe enviar una verificación de MFA. |
EmailTemplate
Plantilla de correo electrónico
Campos | |
---|---|
disabled |
Indica si la plantilla está inhabilitada. Si es verdadero, se usará una plantilla predeterminada. |
from |
Dirección de origen del correo electrónico |
body |
Cuerpo del correo electrónico |
subject |
Asunto del correo electrónico |
from_display_name |
Desde el nombre visible |
format |
Formato del cuerpo del correo electrónico |
reply_to |
Dirección de respuesta |
from_local_part |
Parte local de la dirección de origen |
locale |
El valor está en formato de código de idioma III (p.ej., "zh-CN", "es"). Se aceptan los separadores "-" y "_". |
customized |
Indica si el cuerpo o el asunto del correo electrónico están personalizados. |
EmailBodyFormat
Formato del cuerpo del correo electrónico
Enums | |
---|---|
EMAIL_BODY_FORMAT_UNSPECIFIED |
Valor predeterminado No se debe usar. |
PLAINTEXT |
El cuerpo del correo electrónico está en formato de texto sin formato. |
HTML |
El cuerpo del correo electrónico está en formato HTML. |
ErrorInfo
Información de error que explica por qué no se puede subir una cuenta. Carga masiva.
Campos | |
---|---|
index |
Es el índice del elemento, cuyo rango es [0, request.size - 1]. |
error_message |
Mensaje de error detallado |
GetAccountInfoRequest
Es el mensaje de solicitud de GetAccountInfo.
Campos | |
---|---|
id_token |
El token de ID de Identity Platform de la cuenta que se recuperará. Se debe especificar para las solicitudes de los usuarios finales. |
local_id[] |
El ID de una o más cuentas que se recuperarán. Solo deben especificarse las solicitudes autenticadas que tengan una credencial de OAuth 2.0 de Google con los permisos adecuados. |
email[] |
Es la dirección de correo electrónico de una o más cuentas que se recuperarán. La longitud del correo electrónico debe ser inferior a 256 caracteres y debe tener el formato |
delegated_project_number |
|
phone_number[] |
Es el número de teléfono de una o más cuentas que se recuperarán. Solo debe especificarse mediante solicitudes autenticadas de un desarrollador y debe estar en formato E.164, por ejemplo, +15555555555. |
federated_user_id[] |
|
tenant_id |
Es el ID del grupo de usuarios al que pertenece la cuenta. Solo debe especificarse mediante solicitudes autenticadas de un desarrollador. |
target_project_id |
Es el ID del proyecto de Google Cloud al que pertenece la cuenta o el usuario de Identity Platform que especifica La autorización requiere el siguiente permiso IAM en el recurso especificado
|
initial_email[] |
Es el correo electrónico inicial de una o más cuentas que se recuperarán. La longitud del correo electrónico debe ser inferior a 256 caracteres y debe tener el formato |
FederatedUserIdentifier
Es el identificador de usuario federado en un proveedor de identidad.
Campos | |
---|---|
provider_id |
El ID de los proveedores de identidad admitidos. Debe ser un ID de proveedor habilitado para el acceso, que puede ser de la lista de IdPs compatibles predeterminados o del formato |
raw_id |
Es el ID de usuario de la cuenta en el proveedor de identidad de terceros que especifica |
GetAccountInfoResponse
Mensaje de respuesta para GetAccountInfo.
Campos | |
---|---|
kind |
|
users[] |
La información de cuentas de usuario específicas que coinciden con los parámetros de la solicitud |
GetOobCodeRequest
Mensaje de solicitud para GetOobCode.
Campos | |
---|---|
req_type |
Obligatorio. Es el tipo de código fuera de banda (OOB) que se enviará. Según este valor, otros campos de esta solicitud serán obligatorios o tendrán diferentes significados. Existen 4 códigos fuera del servicio diferentes que se pueden enviar: * PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL |
email |
La dirección de correo electrónico de la cuenta a la que se enviará el código fuera del dispositivo y, por lo general, la dirección de correo electrónico de la cuenta que se debe actualizar. Obligatorio para PASSWORD_RESET, EMAIL_SIGNIN y VERIFY_EMAIL. Solo es obligatorio para las solicitudes VERIFY_AND_CHANGE_EMAIL cuando return_oob_link se establece en verdadero. En este caso, es el correo electrónico original del usuario. |
challenge |
|
captcha_resp |
Para una solicitud de PASSWORD_RESET, se requiere una respuesta de reCAPTCHA cuando el sistema detecta una posible actividad de abuso. En esos casos, esta es la respuesta del desafío de reCAPTCHA que se usa para verificar al llamador. |
user_ip |
La dirección IP del emisor de la llamada. Solo es obligatorio para las solicitudes de PASSWORD_RESET. |
new_email |
La dirección de correo electrónico a la que se actualizará la cuenta. Solo es obligatorio para las solicitudes de VERIFY_AND_CHANGE_EMAIL. |
id_token |
Un token de ID para la cuenta. Es obligatorio para las solicitudes VERIFY_AND_CHANGE_EMAIL y VERIFY_EMAIL, a menos que return_oob_link esté configurado como verdadero. |
continue_url |
Es la URL para continuar después de que el usuario hace clic en el vínculo que se envió por correo electrónico. Esta es la URL que permitirá que el widget web controle el código fuera del alcance. |
ios_bundle_id |
Si una app para iOS asociada puede controlar el código fuera del alcance, el ID del paquete de iOS de esta app. Esto permitirá que se abra la app correcta si ya está instalada. |
ios_app_store_id |
Si una app para iOS asociada puede controlar el código fuera del alcance, el ID de App Store de esta app. Esto permitirá que App Store abra la app correcta si aún no está instalada. |
android_package_name |
Si una app para Android asociada puede controlar el código fuera del alcance, el nombre del paquete de Android de la app para Android que controlará la devolución de llamada cuando se use este código fuera del alcance. Esto permitirá que se abra la app correcta si ya está instalada o que Google Play Store abra la app correcta si aún no está instalada. |
android_install_app |
Si una app para Android asociada puede controlar el código fuera del alcance, si se debe instalar o no la app para Android en el dispositivo en el que se abre el vínculo si aún no está instalada. |
android_minimum_version_code |
Si una app para Android asociada puede controlar el código fuera del alcance, la versión mínima de la app. Si la versión del dispositivo es inferior a esta, se dirige al usuario a Google Play Store para que actualice la app. |
can_handle_code_in_app |
Cuando se establece como verdadero, el vínculo del código fuera del alcance se envía como vínculo universal o vínculo de app para Android, y la app correspondiente lo abrirá si está instalada. Si no se establece o se establece como falso, el código fuera del alcance se enviará primero al widget web y, luego, se redireccionará a la app, si está instalada. |
tenant_id |
El ID del usuario de Identity Platform al que pertenece la cuenta. |
target_project_id |
El ID del proyecto de Identity Platform al que pertenece la cuenta. Para especificar este campo, se requiere una credencial de OAuth 2.0 de Google con los permisos adecuados. La autorización requiere el siguiente permiso IAM en el recurso especificado
|
dynamic_link_domain |
Para garantizar que la URL que se usa se pueda abrir fácilmente en iOS o Android, creamos un vínculo dinámico de Firebase. La mayoría de los proyectos de Identity Platform solo tendrán habilitado un dominio de vínculo dinámico y pueden dejar este campo en blanco. Este campo contiene un dominio de Dynamic Links especificado para los proyectos que tienen varios habilitados. |
return_oob_link |
Indica si se debe mostrar el vínculo de confirmación que contiene el código fuera del alcance en la respuesta (no se envía ningún correo electrónico). Se usa cuando un desarrollador quiere crear la plantilla de correo electrónico y enviarla por su cuenta. De forma predeterminada, este valor es falso. Para especificar este campo y establecerlo como verdadero, se requiere una credencial de Google OAuth 2.0 con los permisos adecuados. |
client_type |
El tipo de cliente: Web, Android o iOS Obligatorio cuando la protección de reCAPTCHA Enterprise está habilitada. |
recaptcha_version |
La versión de reCAPTCHA del token de reCAPTCHA en captcha_response. |
link_domain |
Opcional. Para garantizar que la URL que se usa se pueda abrir fácilmente en iOS o Android, creamos un vínculo de Hosting "/__/auth/links". Este campo opcional contiene el dominio que se usará cuando se construya un vínculo de Hosting. Si no se establece, se usará el dominio " |
GetOobCodeResponse
Mensaje de respuesta para GetOobCode.
Campos | |
---|---|
kind |
|
oob_code |
Si return_oob_link es verdadero en la solicitud, es el código OOB que se enviará. |
email |
Si return_oob_link es falso en la solicitud, se muestra la dirección de correo electrónico a la que se envió la verificación. |
oob_link |
Si return_oob_link es verdadero en la solicitud, es el vínculo fuera del alcance que se enviará al usuario. Esto muestra el vínculo creado, incluidos los parámetros relacionados con Firebase Dynamic Links. |
GetProjectConfigRequest
Es el mensaje de solicitud para GetProjectconfig.
Campos | |
---|---|
delegated_project_number |
Es el número de proyecto de la solicitud de proyecto delegada. Este campo solo debe usarse como parte de la migración de Firebase V1. |
project_number |
Es el número de proyecto de la configuración que se desea recuperar. Este campo está obsoleto y las integraciones nuevas no deben usarlo. |
return_dynamic_link |
Indica si se debe mostrar el vínculo dinámico. |
android_package_name |
Es el nombre del paquete de Android que se debe comparar con el nombre real del paquete de Android. Si se proporciona este campo y no se proporciona sha1_cert_hash, la acción arrojará un error si no coincide con el nombre real del paquete de Android. |
ios_bundle_id |
Es el ID del paquete de iOS que se compara con el ID del paquete de iOS real. Si se proporciona este campo, la acción arrojará un error si no coincide con el ID de paquete real de iOS. |
client_id |
El ID de cliente de OAuth del RP Si se establece, se realizará una verificación para garantizar que el cliente de OAuth sea válido para el proyecto recuperado y que se rechace la solicitud con un error de cliente si no es válido. |
sha1_cert |
Hash de certificado de aplicación de Android SHA-1 Si se establece, se realizará una verificación para garantizar que el hash del certificado sea válido para el proyecto recuperado y android_package_name. |
firebase_app_id |
El ID de app de Firebase, para las aplicaciones que usan Firebase Puedes encontrar esta información en Firebase console de tu proyecto. Si se establece, se realizará una verificación para garantizar que el ID de la app sea válido para el proyecto recuperado. Si no es válido, la solicitud se rechazará con un error del cliente. |
GetProjectConfigResponse
Mensaje de respuesta para GetProjectConfig.
Campos | |
---|---|
project_id |
El ID del proyecto de la configuración recuperada. |
api_key |
Clave de la API de Google Cloud. Este campo solo se muestra para las llamadas autenticadas de un desarrollador. |
allow_password_user |
Indica si se permite el registro de cuentas con contraseña. Este campo solo se muestra para las llamadas autenticadas de un desarrollador. |
idp_config[] |
Configuración del proveedor de OAuth2 Este campo solo se muestra para las llamadas autenticadas de un desarrollador. |
authorized_domains[] |
Dominios autorizados para el redireccionamiento de widgets. |
enable_anonymous_user |
Indica si el usuario anónimo está habilitado. Este campo solo se muestra para las llamadas autenticadas de un desarrollador. |
dynamic_links_domain |
Es el dominio de Firebase Dynamic Links que se usa para crear vínculos de redireccionamiento a apps nativas. |
use_email_sending |
Si se debe usar el envío de correos electrónicos. Este campo solo se muestra para las llamadas autenticadas de un desarrollador. |
reset_password_template |
Plantilla de correo electrónico para restablecer la contraseña Este campo solo se muestra para las llamadas autenticadas de un desarrollador. |
verify_email_template |
Plantilla de correo electrónico para verificar el correo electrónico. Este campo solo se muestra para las llamadas autenticadas de un desarrollador. |
change_email_template |
Plantilla de correo electrónico para cambiar el correo electrónico. Este campo solo se muestra para las llamadas autenticadas de un desarrollador. |
legacy_reset_password_template |
Es la plantilla de correo electrónico para restablecer la contraseña de la app heredada de Firebase V1. Este campo solo se muestra para las llamadas autenticadas de un desarrollador. |
revert_second_factor_addition_template |
Plantilla de correo electrónico para revertir la adición de un segundo factor Este campo solo se muestra para las llamadas autenticadas de un desarrollador. |
GetRecaptchaParamResponse
Es el mensaje de respuesta de GetRecaptchaParam.
Campos | |
---|---|
kind |
|
recaptcha_stoken |
|
recaptcha_site_key |
La clave del sitio de reCAPTCHA v2 que se usa para invocar el servicio de reCAPTCHA. Siempre presente. |
producer_project_number |
Es el número de proyecto del productor que se usa para generar tokens de PIA. |
GetSessionCookiePublicKeysResponse
Es el mensaje de respuesta para GetSessionCookiePublicKeys.
Campos | |
---|---|
keys[] |
Claves públicas del firmante de cookies de sesión, con el formato de claves web JSON (JWK) |
IdpConfig
Configuración de un proveedor de identidad
Campos | |
---|---|
provider |
|
enabled |
Es verdadero si permite que el usuario acceda con el proveedor. |
experiment_percent |
Porcentaje de usuarios a los que se les solicitará o redireccionará el acceso federado para este IdP |
key |
ID de cliente de OAuth2. |
secret |
Secreto de cliente de OAuth2 |
whitelisted_audiences[] |
IDs de cliente incluidos en la lista de entidades permitidas para la verificación de público |
Proveedor
Es el nombre del proveedor de identidad.
Enums | |
---|---|
PROVIDER_UNSPECIFIED |
|
MSLIVE |
Microsoft Live como proveedor de identidad |
GOOGLE |
Google como proveedor de identidad |
FACEBOOK |
Facebook como proveedor de identidad |
PAYPAL |
PayPal como proveedor de identidad |
TWITTER |
Twitter como proveedor de identidad |
YAHOO |
Yahoo como proveedor de identidad |
AOL |
AOL como proveedor de identidad |
GITHUB |
GitHub como proveedor de identidad |
GOOGLE_PLAY_GAMES |
Google Play Juegos como proveedor de identidad |
LINKEDIN |
LinkedIn como proveedor de identidad |
IOS_GAME_CENTER |
Game Center de iOS como proveedor de identidad |
IssueSamlResponseRequest
Es un mensaje de solicitud para IssueSamlResponse.
Campos | |
---|---|
rp_id |
Es el identificador de la parte de confianza, que es el público de la SAMLResponse emitida. |
id_token |
El token de ID de Identity Platform Se verificará y, luego, se convertirá en una nueva SAMLResponse. |
saml_app_entity_id |
El ID de entidad de la app de SAML especificado en la Consola del administrador de Google para cada app. Si los desarrolladores quieren redireccionar a una app de terceros en lugar de a una app de G Suite, es probable que necesiten este ID. Cuando se use, mostraremos un RelayState. Esto incluye un SAMLRequest, que se puede usar para activar un flujo de SAML iniciado por la AC para redireccionar a la app real. |
IssueSamlResponseResponse
Respuesta a la solicitud de IssueSamlResponse.
Campos | |
---|---|
saml_response |
Se creó una SAMLResponse firmada para la parte de confianza. |
acs_endpoint |
El extremo de ACS que consume la SAMLResponse que se muestra. |
relay_state |
RelayState generado. |
email |
Es el correo electrónico del usuario. |
first_name |
Es el nombre del usuario. |
last_name |
Es el apellido del usuario. |
is_new_user |
Indica si esta solicitud creó el usuario que accedió. |
MfaEnrollment
Información sobre qué proveedores de autenticación de varios factores (MFA) están habilitados para una cuenta.
Campos | |
---|---|
mfa_enrollment_id |
Es el ID de esta opción de MFA. |
display_name |
Es el nombre visible de esta opción de MFA, p.ej., "teléfono celular corporativo". |
enrolled_at |
Marca de tiempo de cuando la cuenta inscribió este segundo factor. |
Campo de unión mfa_value . Es el valor definitorio de la opción de MFA. mfa_value puede ser solo uno de los siguientes: |
|
phone_info |
Por lo general, se mostrará el número de teléfono asociado con esta inscripción. En algunas situaciones, como después de un acceso con un primer factor, solo se mostrará la versión ofuscada del número de teléfono asociado. |
totp_info |
Contiene información específica de la AUA de TOTP. |
email_info |
Contiene información específica de la MFA por correo electrónico. |
Campo de unión
|
|
unobfuscated_phone_info |
Solo salida. phone_info no ofuscado |
OobReqType
El tipo de acción solicitado para un código fuera del alcance.
Enums | |
---|---|
OOB_REQ_TYPE_UNSPECIFIED |
No se especificó el tipo de código fuera de banda. |
PASSWORD_RESET |
restablecer contraseña |
OLD_EMAIL_AGREE |
|
NEW_EMAIL_ACCEPT |
|
VERIFY_EMAIL |
enviar un correo electrónico para verificar la dirección de correo electrónico de la cuenta |
RECOVER_EMAIL |
|
EMAIL_SIGNIN |
acceder solo con correo electrónico |
VERIFY_AND_CHANGE_EMAIL |
Este flujo envía un correo electrónico a la dirección de correo electrónico nueva especificada y, cuando se aplica haciendo clic en el vínculo del correo electrónico, cambia el correo electrónico de la cuenta al nuevo. Se usa cuando la cuenta debe tener un correo electrónico verificado en todo momento, como en el caso de las cuentas de MFA. |
REVERT_SECOND_FACTOR_ADDITION |
OpenIdConnectKey
Representa una clave pública del firmante de cookies de sesión con el formato de una clave web JSON (JWK).
Campos | |
---|---|
type |
Tipo de clave |
algorithm |
Algoritmo de firma |
use |
Uso de la clave |
id |
Es una cadena única para identificar esta clave. |
modulus |
Es el módulo de la clave pública de RSA y se representa como la codificación base64url de la representación big-endian del valor. |
exponent |
Es el exponente de la clave pública de RSA y se representa como la codificación base64url de la representación big-endian del valor. |
ProviderUserInfo
Información sobre el usuario proporcionada por varios proveedores de identidad.
Campos | |
---|---|
provider_id |
Es el ID del proveedor de identidad. |
display_name |
Es el nombre visible del usuario en el proveedor de identidad. |
photo_url |
La URL de la foto de perfil del usuario en el proveedor de identidad |
federated_id |
Es el identificador del usuario en el proveedor de identidad. |
email |
La dirección de correo electrónico del usuario en el proveedor de identidad |
raw_id |
Es el identificador sin procesar del usuario que se devuelve directamente desde el proveedor de identidad. |
screen_name |
Es el screen_name del usuario en Twitter o el nombre de acceso en GitHub. |
phone_number |
El número de teléfono del usuario en el proveedor de identidad |
QueryUserInfoRequest
Es el mensaje de solicitud para QueryUserInfo.
Campos | |
---|---|
return_user_info |
Si es |
limit |
Es la cantidad máxima de cuentas que se mostrarán, con un límite superior de 500. El valor predeterminado es 500. Solo es válido cuando |
offset |
Es la cantidad de cuentas que se omitirán desde el comienzo de los registros coincidentes. Solo es válido cuando |
sort_by |
|
order |
|
target_project_id |
Es el ID del proyecto al que se aplica el resultado. La autorización requiere el siguiente permiso IAM en el recurso especificado
|
tenant_id |
Es el ID del grupo de usuarios al que se aplica el resultado. |
expression[] |
Pedido
Es un orden para ordenar el resultado de la consulta.
Enums | |
---|---|
ORDER_UNSPECIFIED |
No se especificó el orden. |
ASC |
Ordena de forma ascendente. |
DESC |
Ordena de forma descendente. |
SortByField
Es un campo que se usa para ordenar las cuentas de usuario.
Enums | |
---|---|
SORT_BY_FIELD_UNSPECIFIED |
No se especificó el campo de ordenamiento. |
USER_ID |
Ordena el resultado por userId. |
NAME |
Ordena los resultados por nombre. |
CREATED_AT |
Ordena el resultado por createdAt. |
LAST_LOGIN_AT |
Ordena el resultado por lastLoginAt. |
USER_EMAIL |
Ordena el resultado por userEmail. |
SqlExpression
Condiciones de consulta que se usan para filtrar los resultados.
Campos | |
---|---|
email |
Es una cadena que no distingue mayúsculas de minúsculas con la que debe coincidir el correo electrónico de la cuenta. Solo se debe especificar uno de los siguientes valores: |
user_id |
Es una cadena con la que debe coincidir el ID local de la cuenta. Solo se debe especificar uno de |
phone_number |
Es una cadena con la que debe coincidir el número de teléfono de la cuenta. Solo se debe especificar uno de los siguientes valores: |
QueryUserInfoResponse
Mensaje de respuesta para QueryUserInfo.
Campos | |
---|---|
records_count |
Si |
user_info[] |
Si |
RecaptchaVersion
La versión de reCAPTCHA.
Enums | |
---|---|
RECAPTCHA_VERSION_UNSPECIFIED |
No se especificó la versión de reCAPTCHA. |
RECAPTCHA_ENTERPRISE |
La empresa de reCAPTCHA. |
ResetPasswordRequest
Es el mensaje de solicitud para ResetPassword.
Campos | |
---|---|
oob_code |
Es un código fuera de banda (OOB) que genera la solicitud GetOobCode. Especifica solo este parámetro (o solo este parámetro y un ID de inquilino) para obtener el tipo de código fuera de banda en la respuesta sin modificar el estado de la cuenta. Solo se puede consumir un código fuera de banda PASSWORD_RESET a través de este método. |
new_password |
La contraseña nueva que se establecerá para esta cuenta. Si especificas este campo, se realizará un cambio en la cuenta y se consumirá el código fuera de banda si se especificó uno y es del tipo PASSWORD_RESET. |
old_password |
La contraseña actual de la cuenta que se modificará. Especifica esta información y el correo electrónico para cambiar la contraseña de una cuenta sin usar un código fuera de banda. |
email |
Opcional. El correo electrónico de la cuenta que se modificará. Especifica este valor y la contraseña anterior para cambiar la contraseña de una cuenta sin usar un código fuera de banda. |
tenant_id |
Opcional. El ID del usuario de Identity Platform al que pertenece la cuenta. |
ResetPasswordResponse
Mensaje de respuesta para ResetPassword.
Campos | |
---|---|
kind |
|
email |
El correo electrónico asociado con el código fuera de banda que se usó |
new_email |
|
req_type |
|
mfa_info |
SendVerificationCodeRequest
Es un mensaje de solicitud para SendVerificationCode. Se requiere "captcha_response" cuando reCAPTCHA Enterprise está habilitado. De lo contrario, se debe especificar al menos uno de (ios_receipt
y ios_secret
), recaptcha_token
o safety_net_token
para verificar que el código de verificación se envíe en nombre de una app real y no de un emulador.
Campos | |
---|---|
phone_number |
Es el número de teléfono al que se enviará el código de verificación en formato E.164. |
ios_receipt |
Recibir una validación correcta del token de la app para iOS Se debe especificar al menos uno de ( |
ios_secret |
El secreto se entrega a la app para iOS como una notificación push. Se debe pasar con un |
recaptcha_token |
Token de reCAPTCHA para la verificación de apps. Se debe especificar al menos uno de ( |
tenant_id |
Es el ID de grupo de usuarios de Identity Platform al que accede el usuario. |
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 debe especificar al menos uno de ( |
play_integrity_token |
Solo para Android. Se usa para confirmar la identidad de la aplicación en lugar de un token de reCAPTCHA (y safety_net_token). Se debe especificar al menos uno de ( |
captcha_response |
Opcional. El token de reCAPTCHA Enterprise que proporciona la integración del cliente de reCAPTCHA. Obligatorio cuando reCAPTCHA Enterprise está habilitado. |
client_type |
Opcional. El tipo de cliente, web, Android o iOS. Obligatorio cuando reCAPTCHA Enterprise está habilitado. |
recaptcha_version |
Opcional. La versión de reCAPTCHA del token de reCAPTCHA en captcha_response. Obligatorio cuando reCAPTCHA Enterprise está habilitado. |
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 |
SendVerificationCodeResponse
Es el mensaje de respuesta de SendVerificationCode.
Campos | |
---|---|
session_info |
Información de la sesión encriptada Se puede usar en [signInWithPhoneNumber][v1.accounts.signInWithPhoneNumber] para autenticar el número de teléfono. |
SetAccountInfoRequest
Es el mensaje de solicitud para SetAccountInfo.
Campos | |
---|---|
id_token |
Un token de ID de Identity Platform válido Obligatorio cuando se intenta cambiar la información relacionada con el usuario. |
local_id |
El ID del usuario Para especificar este campo, se requiere una credencial de OAuth 2.0 de Google con los permisos adecuados. En el caso de las solicitudes de los usuarios finales, se debe pasar un token de ID. |
display_name |
Es el nuevo nombre visible del usuario que se actualizará en los atributos de la cuenta. La longitud del nombre visible debe ser inferior o igual a 256 caracteres. |
email |
Es el correo electrónico nuevo del usuario que se actualizará en los atributos de la cuenta. La longitud del correo electrónico debe ser inferior a 256 caracteres y debe tener el formato |
password |
La nueva contraseña del usuario que se actualizará en los atributos de la cuenta. La contraseña debe tener al menos 6 caracteres. |
provider[] |
Los proveedores de identidad con los que se debe asociar la cuenta. |
oob_code |
Es el código fuera de banda que se aplicará a la cuenta del usuario. Se admiten los siguientes tipos de códigos fuera de banda: * VERIFY_EMAIL * RECOVER_EMAIL * REVERT_SECOND_FACTOR_ADDITION * VERIFY_AND_CHANGE_EMAIL |
email_verified |
Indica si se verificó el correo electrónico del usuario. Para especificar este campo, se requiere una credencial de OAuth 2.0 de Google con los permisos adecuados. |
upgrade_to_federated_login |
Indica si la cuenta debe restringirse para usar solo el acceso federado. |
captcha_challenge |
|
captcha_response |
La respuesta del desafío de reCAPTCHA. Esto es obligatorio cuando el sistema detecta posibles actividades de abuso. |
valid_since |
Especifica la marca de tiempo mínima en segundos para que un token de ID de Identity Platform se considere válido. |
disable_user |
Si es verdadero, marca la cuenta como inhabilitada, lo que significa que el usuario ya no podrá acceder. |
instance_id |
|
delegated_project_number |
|
photo_url |
La nueva URL de foto del usuario para que se actualice la foto de perfil de la cuenta en sus atributos. La longitud de la URL debe ser inferior o igual a 2,048 caracteres. |
delete_attribute[] |
|
return_secure_token |
Indica si se debe mostrar o no un ID y un token de actualización. Siempre debe ser verdadero. |
delete_provider[] |
Los proveedores de identidad que se desvincularán de la cuenta del usuario |
last_login_at |
Es la marca de tiempo, en milisegundos, en la que se accedió a la cuenta por última vez. |
created_at |
Es la marca de tiempo, en milisegundos, en la que se creó la cuenta. |
phone_number |
Es el número de teléfono que se actualizará en los atributos de la cuenta. |
custom_attributes |
Atributos personalizados con formato JSON que se almacenarán en el token de ID de Identity Platform. Para especificar este campo, se requiere una credencial de OAuth 2.0 de Google con los permisos adecuados. |
tenant_id |
El ID de usuario del usuario de Identity Platform al que pertenece la cuenta. Las solicitudes de los usuarios finales deben pasar un token de ID de Identity Platform en lugar de configurar este campo. |
target_project_id |
Es el ID del proyecto al que pertenece la cuenta. Para especificar este campo, se requiere una credencial de OAuth 2.0 de Google con los permisos adecuados. En su lugar, las solicitudes de los usuarios finales deben pasar un token de ID de Identity Platform. La autorización requiere el siguiente permiso IAM en el recurso especificado
|
mfa |
Es la información relacionada con la autenticación de varios factores que se establecerá en la cuenta del usuario. Esta acción reemplazará cualquier información relacionada con la autenticación de varios factores que se haya ingresado anteriormente en la cuenta. Para especificar este campo, se requiere una credencial de OAuth 2.0 de Google con los permisos adecuados. |
link_provider_user_info |
Es el proveedor que se vinculará a la cuenta del usuario. Para especificar este campo, se requiere una credencial de OAuth 2.0 de Google con los permisos adecuados. |
MfaInfo
Información relacionada con la autenticación de varios factores.
Campos | |
---|---|
enrollments[] |
Los segundos factores que inscribió el usuario |
UserAttributeName
Los atributos de la cuenta que se pueden borrar
Enums | |
---|---|
USER_ATTRIBUTE_NAME_UNSPECIFIED |
No se especificó el nombre del atributo del usuario. |
EMAIL |
El nombre de clave del atributo del usuario es email. |
DISPLAY_NAME |
El nombre de clave del atributo del usuario es displayName. |
PROVIDER |
El nombre de la clave del atributo del usuario es provider. |
PHOTO_URL |
El nombre de la clave del atributo del usuario es photoURL. |
PASSWORD |
El nombre de clave del atributo del usuario es password. |
RAW_USER_INFO |
El nombre de la clave del atributo del usuario es rawUserInfo. |
SetAccountInfoResponse
Mensaje de respuesta para SetAccountInfo
Campos | |
---|---|
kind |
|
local_id |
El ID del usuario autenticado. |
email |
La dirección de correo electrónico de la cuenta |
display_name |
El nombre visible de la cuenta. |
id_token |
Un token de ID de Identity Platform para la cuenta. Se usa para el registro de usuarios heredados. |
provider_user_info[] |
Los proveedores de identidad vinculados en la cuenta |
new_email |
Es el correo electrónico nuevo que se configuró en los atributos de la cuenta del usuario. |
photo_url |
La URL de la foto del usuario para la foto de perfil de la cuenta. |
refresh_token |
Un token de actualización para la cuenta. Se usa para el registro de usuarios heredados. |
expires_in |
Es la cantidad de segundos hasta que vence el token de ID de Identity Platform. |
password_hash |
Obsoleto. Actualmente, no se muestra ningún hash de contraseña real. |
email_verified |
Indica si se verificó el correo electrónico de la cuenta. |
SignInWithCustomTokenRequest
Es un mensaje de solicitud para SignInWithCustomToken.
Campos | |
---|---|
token |
Obligatorio. Es el token de autenticación personalizado que declara el desarrollador. El token debe ser un token web JSON (JWT) que incluya las reclamaciones que se indican en la referencia de la API, en la sección "Reivindicaciones de tokens personalizados". |
instance_id |
|
return_secure_token |
Siempre debe ser verdadero. |
delegated_project_number |
|
tenant_id |
El ID del grupo de usuarios de Identity Platform al que accede el usuario. Si está presente, el ID debe coincidir con el tenant_id en el token. |
SignInWithCustomTokenResponse
Es el mensaje de respuesta de SignInWithCustomToken.
Campos | |
---|---|
kind |
|
id_token |
Un token de ID de Identity Platform para el usuario autenticado. |
refresh_token |
Un token de actualización de Identity Platform para el usuario autenticado. |
expires_in |
Es la cantidad de segundos hasta que vence el token de ID. |
is_new_user |
Indica si esta solicitud creó el usuario autenticado. |
SignInWithEmailLinkRequest
Mensaje de solicitud para SignInWithEmailLink
Campos | |
---|---|
oob_code |
Obligatorio. El código fuera de banda del vínculo del correo electrónico |
email |
Obligatorio. La dirección de correo electrónico a la que se envió el vínculo de acceso La longitud del correo electrónico debe ser inferior a 256 caracteres y debe tener el formato |
id_token |
Un token de ID válido para una cuenta de Identity Platform Si se aprueba, esta solicitud vinculará la dirección de correo electrónico al usuario representado por este token de ID y habilitará el vínculo de acceso con correo electrónico en la cuenta para el futuro. |
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. |
SignInWithEmailLinkResponse
Mensaje de respuesta para SignInWithEmailLink.
Campos | |
---|---|
kind |
|
id_token |
Un token de ID de Identity Platform para el usuario autenticado. |
email |
El correo electrónico con el que accedió el usuario. Siempre está presente en la respuesta. |
refresh_token |
Token de actualización para el usuario autenticado. |
expires_in |
Es la cantidad de segundos hasta que vence el token de ID. |
local_id |
El ID del usuario autenticado. Siempre está presente en la respuesta. |
is_new_user |
Indica si esta solicitud creó el usuario autenticado. |
mfa_pending_credential |
Es una cadena opaca que funciona como prueba de que el usuario pasó correctamente la verificación del primer factor. |
mfa_info[] |
Información sobre qué proveedores de autenticación de varios factores están habilitados. Se muestra si el usuario necesita completar el acceso con la autenticación de varios factores. |
SignInWithGameCenterRequest
Mensaje de solicitud para SignInWithGameCenter
Campos | |
---|---|
player_id |
Obligatorio. El ID de jugador de Game Center del usuario. Apple dio de baja esta función. Pasa |
public_key_url |
Obligatorio. Apple firma la URL para recuperar la clave pública de Apple y verificar la firma determinada. |
signature |
Obligatorio. Los datos de la firma de verificación que genera Apple |
salt |
Obligatorio. Es una cadena aleatoria que se usa para generar la firma determinada. |
timestamp |
Obligatorio. Es la hora en la que Apple creó la firma, expresada en milisegundos desde la época. |
id_token |
Un token de ID válido para una cuenta de Identity Platform Si está presente, esta solicitud vinculará el ID de jugador de Game Center a la cuenta representada por este token de ID. |
display_name |
El nombre visible de Game Center del usuario. |
tenant_id |
El ID del grupo de usuarios de Identity Platform al que accede el usuario. |
team_player_id |
El ID de jugador del equipo de Game Center del usuario Es un identificador único para un jugador de todos los partidos que distribuyes con tu cuenta de desarrollador. https://developer.apple.com/documentation/gamekit/gkplayer/3174857-teamplayerid |
game_player_id |
El ID de jugador del juego de Game Center del usuario. Es un identificador único para un jugador del juego. https://developer.apple.com/documentation/gamekit/gkplayer/3113960-gameplayerid |
SignInWithGameCenterResponse
Mensaje de respuesta para SignInWithGameCenter
Campos | |
---|---|
local_id |
El ID del usuario autenticado. Siempre está presente en la respuesta. |
player_id |
El ID de jugador de Game Center del usuario. Pasa |
id_token |
Un token de ID de Identity Platform para el usuario autenticado. |
refresh_token |
Un token de actualización de Identity Platform para el usuario autenticado. |
expires_in |
Es la cantidad de segundos hasta que vence el token de ID. |
is_new_user |
Indica si esta solicitud creó el usuario que accedió. |
display_name |
Es el nombre visible del usuario autenticado. |
team_player_id |
El ID de jugador del equipo de Game Center del usuario Es un identificador único para un jugador de todos los partidos que distribuyes con tu cuenta de desarrollador. https://developer.apple.com/documentation/gamekit/gkplayer/3174857-teamplayerid |
game_player_id |
El ID de jugador del juego de Game Center del usuario. Es un identificador único para un jugador del juego. https://developer.apple.com/documentation/gamekit/gkplayer/3113960-gameplayerid |
SignInWithIdpRequest
Es un mensaje de solicitud para SignInWithIdp.
Campos | |
---|---|
request_uri |
Obligatorio. Es la URL a la que el IdP redirecciona al usuario. Se puede establecer en |
post_body |
Si el usuario accede con una respuesta de autorización obtenida a través de una solicitud de autorización de CreateAuthUri anterior, este es el cuerpo de la devolución de llamada POST HTTP del IdP, si está presente. De lo contrario, si el usuario accede con una credencial de IdP proporcionada de forma manual, este debe ser un formulario codificado en URL que contenga la credencial (p.ej., un token de ID o un token de acceso para los IdP de OAuth 2.0) y el ID del proveedor del IdP que emitió la credencial. Por ejemplo, si el usuario accede al proveedor de Google con un token de ID de Google, este debe establecerse en id_token Si el usuario accede al proveedor de Facebook con un token de autenticación de Facebook, este debe establecerse en id_token Si el usuario accede al proveedor de Facebook con un token de acceso de Facebook, este debe establecerse en access_token Si el usuario accede al proveedor de Twitter con una credencial de OAuth 1.0 de Twitter, se debe establecer en access_token |
pending_id_token |
|
return_refresh_token |
Indica si se debe mostrar o no el token de actualización de OAuth del IdP, si está disponible. |
session_id |
El ID de sesión que se muestra desde una llamada anterior a CreateAuthUri. Este campo se verifica con ese ID de sesión para evitar ataques de fijación de sesión. Obligatorio si el usuario accede con una respuesta de autorización de una solicitud de autorización de CreateAuthUri anterior. |
delegated_project_number |
|
id_token |
Un token de ID de Identity Platform válido Si se aprueba, la cuenta del usuario en el IdP se vinculará a la cuenta representada por este token de ID. |
return_secure_token |
Siempre debe ser verdadero. |
return_idp_credential |
Indica si se deben mostrar o no las credenciales de OAuth del IdP en los siguientes errores: |
auto_create |
|
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. |
pending_token |
Es una cadena opaca de una respuesta anterior de SignInWithIdp. Si se establece, se puede usar para repetir la operación de acceso de la operación SignInWithIdp anterior. Esto puede ocurrir si el usuario necesita confirmar la información de su cuenta como parte de un intento de acceso federado anterior o realizar la vinculación de la cuenta. |
SignInWithIdpResponse
Mensaje de respuesta para SignInWithIdp.
Campos | |
---|---|
federated_id |
El ID de la cuenta del usuario en el IdP Siempre está presente en la respuesta. |
provider_id |
El ID del proveedor del IdP al que accede el usuario. Siempre está presente en la respuesta. |
email |
Es la dirección de correo electrónico de la cuenta del usuario en el IdP. |
email_verified |
Indica si se verificó la dirección de correo electrónico de la cuenta de usuario. |
first_name |
El nombre de la cuenta del usuario en el IdP. |
full_name |
Es el nombre completo de la cuenta del usuario en el IdP. |
last_name |
El apellido de la cuenta del usuario en el IdP. |
nick_name |
Es el sobrenombre de la cuenta del usuario en el IdP. |
language |
Es la preferencia de idioma de la cuenta del usuario en el IdP. |
time_zone |
Es la zona horaria de la cuenta del usuario en el IdP. |
photo_url |
La URL de la foto de perfil del usuario en el IdP |
date_of_birth |
Es la fecha de nacimiento de la cuenta del usuario en el IdP. |
input_email |
|
original_email |
La dirección de correo electrónico principal (de nivel superior) de la cuenta de Identity Platform del usuario, si es diferente de la dirección de correo electrónico del IdP Solo está presente si se habilita la configuración “Una cuenta por dirección de correo electrónico”. |
local_id |
El ID del usuario autenticado de Identity Platform. Siempre está presente en la respuesta. |
email_recycled |
Si existe o no una cuenta de usuario de Identity Platform existente con la misma dirección de correo electrónico, pero vinculada a una cuenta diferente en el mismo IdP Solo está presente si se habilita la configuración “Una cuenta por dirección de correo electrónico” y se verifica la dirección de correo electrónico en el IdP. |
display_name |
Es el nombre visible de la cuenta del usuario en el IdP. |
id_token |
Un token de ID de Identity Platform para el usuario autenticado. |
context |
Es la cadena opaca establecida en CreateAuthUri que se usa para mantener la información contextual entre la solicitud de autenticación y la devolución de llamada del IdP. |
verified_provider[] |
Es una lista de IDs de proveedores a los que el usuario puede acceder para resolver un error de |
need_confirmation |
Si existe o no una cuenta de usuario de Identity Platform existente con la misma dirección de correo electrónico que la cuenta actual a la que se accedió en el IdP y si la dirección de correo electrónico de la cuenta no está verificada en el IdP El usuario deberá acceder a la cuenta existente de Identity Platform y, luego, vincular la credencial actual del IdP a ella. Solo está presente si se habilita el parámetro de configuración “Una cuenta por dirección de correo electrónico”. |
oauth_access_token |
El token de acceso de OAuth del IdP (si está disponible). |
oauth_refresh_token |
El token de actualización de OAuth 2.0 del IdP, si está disponible y |
oauth_expire_in |
Es la cantidad de segundos hasta que vence el token de acceso de OAuth del IdP. |
oauth_authorization_code |
El código de autorización de OAuth 2.0, si está disponible Solo está presente para el proveedor de Google. |
need_email |
|
oauth_token_secret |
El secreto de token de OAuth 1.0 del IdP (si está disponible). Solo está presente para el proveedor de Twitter. |
refresh_token |
Un token de actualización de Identity Platform para el usuario autenticado. |
expires_in |
Es la cantidad de segundos hasta que vence el token de ID de Identity Platform. |
oauth_id_token |
El token de ID de OpenID Connect del IdP, si está disponible |
screen_name |
El nombre de pantalla de la cuenta del usuario en el IdP de Twitter o el nombre de acceso de la cuenta del usuario en el IdP de GitHub. |
raw_user_info |
La respuesta JSON en cadena que contiene todos los datos correspondientes a la cuenta del usuario en el IdP. |
error_message |
Es el mensaje de error que se muestra si |
is_new_user |
Indica si se creó o no una cuenta nueva de Identity Platform para el usuario autenticado. |
kind |
|
pending_token |
Es una cadena opaca que se puede usar como credencial del IdP al que accede el usuario. El token pendiente que se obtiene aquí se puede establecer en una solicitud de SignInWithIdp futura para que el mismo usuario vuelva a acceder con el IdP. |
tenant_id |
El valor del campo |
mfa_pending_credential |
Es una cadena opaca que funciona como prueba de que el usuario aprobó correctamente la autenticación del primer factor. |
mfa_info[] |
Información sobre los proveedores de autenticación de varios factores habilitados para la cuenta Se muestra si el usuario necesita completar el acceso con la autenticación de varios factores. |
SignInWithPasswordRequest
Es un mensaje de solicitud para SignInWithPassword.
Campos | |
---|---|
email |
Obligatorio. El correo electrónico con el que accede el usuario. La longitud del correo electrónico debe ser inferior a 256 caracteres y debe tener el formato |
password |
Obligatorio. Es la contraseña que proporciona el usuario para acceder a la cuenta. |
pending_id_token |
|
captcha_challenge |
|
captcha_response |
Es el token de reCAPTCHA que proporciona la integración del cliente de reCAPTCHA. reCAPTCHA Enterprise lo usa para la evaluación de riesgos. Obligatorio cuando reCAPTCHA Enterprise está habilitado. |
instance_id |
|
delegated_project_number |
|
id_token |
|
return_secure_token |
Siempre debe ser verdadero. |
tenant_id |
El ID del grupo de usuarios de Identity Platform al que accede el usuario. Si no se establece, el usuario accederá a la instancia predeterminada de Identity Platform en el proyecto. |
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. |
SignInWithPasswordResponse
Mensaje de respuesta para SignInWithPassword.
Campos | |
---|---|
kind |
|
local_id |
El ID del usuario autenticado. Siempre está presente en la respuesta. |
email |
El correo electrónico del usuario autenticado Siempre está presente en la respuesta. |
display_name |
Es el nombre visible del usuario almacenado en los atributos de la cuenta. |
id_token |
Un token de ID de Identity Platform para el usuario autenticado. |
registered |
Indica si el correo electrónico es para una cuenta existente. Siempre es verdadero. |
profile_picture |
La foto de perfil del usuario almacenada en los atributos de la cuenta. |
oauth_access_token |
El token de acceso de OAuth2. |
oauth_expire_in |
Es la fecha de vencimiento del token de acceso en segundos. |
oauth_authorization_code |
|
refresh_token |
Un token de actualización de Identity Platform para el usuario autenticado. |
expires_in |
Es la cantidad de segundos hasta que vence el token de ID de Identity Platform. |
mfa_pending_credential |
Es una cadena opaca que funciona como prueba de que el usuario aprobó correctamente la autenticación del primer factor. |
mfa_info[] |
Información sobre los proveedores de autenticación de varios factores habilitados para la cuenta Se muestra si el usuario necesita completar el acceso con la autenticación de varios factores. |
user_notifications[] |
Notificaciones de advertencia para el usuario |
SignInWithPhoneNumberRequest
Es un mensaje de solicitud para SignInWithPhoneNumber.
Campos | |
---|---|
session_info |
Información de la sesión encriptada de la respuesta de [sendVerificationCode][v1.accounts.sendVerificationCode]. En el caso de la autenticación con un código SMS, se debe especificar, pero en el caso de usar una prueba temporal, no se puede especificar. |
phone_number |
Es el número de teléfono del usuario con el que se accede. Esto es necesario en el caso de usar un comprobante temporal, en cuyo caso debe coincidir con el número de teléfono que se autenticó en la solicitud que generó el comprobante temporal. Este campo se ignora si se pasa información de la sesión. |
code |
Es el código de verificación que ingresa el usuario a partir de un SMS que se envía a su teléfono. |
temporary_proof |
Un comprobante de la verificación del número de teléfono, proporcionado a partir de una solicitud [signInWithPhoneNumber][v1.accounts.signInWithPhoneNumber] anterior Si se pasa este valor, el llamador también debe pasar el número de teléfono que se verificó en la solicitud anterior en el campo phone_number. |
verification_proof |
No se debe usar. |
id_token |
Un token de ID válido para una cuenta de Identity Platform Si se aprueba, esta solicitud vinculará el número de teléfono al usuario representado por este token de ID si el número de teléfono no está en uso, o bien volverá a autenticar al usuario si el número de teléfono ya está vinculado a él. |
operation |
|
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. |
VerifyOp
Operación prevista.
Enums | |
---|---|
VERIFY_OP_UNSPECIFIED |
No se especificó la operación. |
SIGN_UP_OR_IN |
Verifica que la operación sea registrarse o acceder. |
REAUTH |
Verifica que la operación sea de volver a autenticar. |
UPDATE |
Verifica que la operación sea de actualización. |
LINK |
Verifica que la operación sea vincular. |
SignInWithPhoneNumberResponse
Es el mensaje de respuesta de SignInWithPhoneNumber.
Campos | |
---|---|
id_token |
Token de ID de Identity Platform para el usuario autenticado. |
refresh_token |
Token de actualización para el usuario autenticado. |
expires_in |
Es la cantidad de segundos hasta que vence el token de ID. |
local_id |
El ID del usuario autenticado. Se presenta en el caso de una autenticación correcta. Si se pudo verificar el teléfono, pero no se pudo realizar la operación de la cuenta, se mostrará una prueba temporal. |
is_new_user |
Indica si esta solicitud creó el usuario autenticado. |
temporary_proof |
Un comprobante de la verificación del número de teléfono, que se proporciona si una autenticación telefónica se realiza correctamente, pero la operación del usuario falla. Esto ocurre cuando la solicitud intenta vincular un número de teléfono a un usuario con un token de ID o volver a autenticarlo con un token de ID, pero el número de teléfono está vinculado a otro usuario. |
verification_proof |
No se debe usar. |
verification_proof_expires_in |
No se debe usar. |
phone_number |
Es el número de teléfono del usuario autenticado. Siempre está presente en la respuesta. |
temporary_proof_expires_in |
Es la cantidad de segundos hasta que vence la prueba temporal. |
SignUpRequest
Es el mensaje de solicitud para SignUp.
Campos | |
---|---|
email |
El correo electrónico que se asignará al usuario creado. La longitud del correo electrónico debe ser inferior a 256 caracteres y debe tener el formato |
password |
La contraseña que se asignará al usuario creado. La contraseña debe tener al menos 6 caracteres. Si se establece, también se debe establecer el campo |
display_name |
Es el nombre visible del usuario que se creará. |
captcha_challenge |
|
captcha_response |
Es el token de reCAPTCHA que proporciona la integración del cliente de reCAPTCHA. reCAPTCHA Enterprise lo usa para la evaluación. Obligatorio cuando reCAPTCHA Enterprise está habilitado. |
instance_id |
|
id_token |
Un token de ID válido para un usuario de Identity Platform Si se establece, esta solicitud vinculará la credencial de autenticación al usuario representado por este token de ID. Para una solicitud que no sea de administrador, se deben configurar los campos |
email_verified |
Indica si se verificó el correo electrónico del usuario. Para especificar este campo, se requiere una credencial de OAuth 2.0 de Google con los permisos adecuados. |
photo_url |
La URL de la foto de perfil del usuario que se creará. |
disabled |
Indica si el usuario se inhabilitará cuando se cree. No se puede acceder a las cuentas inhabilitadas, excepto para las solicitudes que tengan una credencial de OAuth2 de Google con los permisos adecuados. |
local_id |
El ID del usuario que se creará. El ID debe ser único en el proyecto en el que se crea el usuario. Para especificar este campo, se requiere una credencial de OAuth 2.0 de Google con los permisos adecuados. |
phone_number |
Es el número de teléfono del usuario que se creará. Para especificar este campo, se requiere una credencial de OAuth 2.0 de Google con los permisos adecuados. |
tenant_id |
El ID del usuario de Identity Platform en el que se creará un usuario. Si no se configura, el usuario se creará en el proyecto predeterminado de Identity Platform. |
target_project_id |
Es el ID del proyecto al que debe pertenecer el usuario. Para especificar este campo, se requiere una credencial de OAuth 2.0 de Google con los permisos adecuados. Si no se establece, el proyecto de destino se infiere del alcance asociado al token de acceso de portador. |
mfa_info[] |
Los proveedores de autenticación de varios factores que el usuario debe crear |
client_type |
El tipo de cliente: Web, Android o iOS Obligatorio cuando se habilita la protección de reCAPTCHA Enterprise. |
recaptcha_version |
La versión de reCAPTCHA del token de reCAPTCHA en captcha_response. |
MfaFactor
Campos | |
---|---|
display_name |
Es el nombre visible de esta opción de MFA, p.ej., "teléfono celular corporativo". |
Campo de unión
|
|
phone_info |
Número de teléfono para recibir la OTP de la MFA |
SignUpResponse
Mensaje de respuesta para SignUp.
Campos | |
---|---|
kind |
|
id_token |
Un token de ID de Identity Platform para el usuario creado. Este campo solo se establece para solicitudes que no son de administrador. |
display_name |
El nombre visible del usuario creado. |
email |
El correo electrónico del usuario creado. |
refresh_token |
Un token de actualización de Identity Platform para el usuario creado. Este campo solo se establece para solicitudes que no son de administrador. |
expires_in |
Es la cantidad de segundos hasta que vence el token de ID. |
local_id |
El ID del usuario creado. Siempre está presente en la respuesta. |
TotpInfo
Este tipo no tiene campos.
Información sobre la MFA de TOTP
UploadAccountRequest
Es el mensaje de solicitud para UploadAccount.
Campos | |
---|---|
hash_algorithm |
Obligatorio. Es la función de hash que se usa para generar un hash para las contraseñas de la cuenta. Debe ser una de las siguientes opciones: * HMAC_SHA256 * HMAC_SHA1 * HMAC_MD5 * SCRYPT * PBKDF_SHA1 * MD5 * HMAC_SHA512 * SHA1 * BCRYPT * PBKDF2_SHA256 * SHA256 * SHA512 * STANDARD_SCRYPT * ARGON2 |
signer_key |
La clave del firmante que se usa para generar un hash de la contraseña. Obligatorio para las siguientes funciones de hash: * SCRYPT, * HMAC_MD5, * HMAC_SHA1, * HMAC_SHA256, * HMAC_SHA512 |
salt_separator |
Son uno o más bytes que se insertan entre la sal y la contraseña de texto sin formato. Para mayor seguridad, debe ser un solo carácter no imprimible. |
rounds |
Es la cantidad de rondas que se usan para el cálculo de hash. Solo es obligatorio para las siguientes funciones de hash: * MD5 * SHA1 * SHA256 * SHA512 * PBKDF_SHA1 * PBKDF2_SHA256 * SCRYPT |
memory_cost |
Es el costo de memoria para el cálculo de hash. Solo es obligatorio cuando la función de hash es SCRYPT. |
users[] |
Una lista de cuentas para subir. |
delegated_project_number |
|
sanity_check |
Si es verdadero, el servicio realizará la siguiente lista de verificaciones antes de subir una cuenta: * Correos electrónicos duplicados * IDs federados duplicados * Validación del proveedor de IDs federados. Si la duplicación existe en la lista de cuentas que se subirán, se impedirá que se suba toda la lista. Si el correo electrónico o el ID federado es un duplicado de un usuario que ya está en el proyecto o el inquilino, no se subirá la cuenta, pero el resto de las cuentas no se verá afectado. Si es falso, se omitirán estas verificaciones. |
target_project_id |
El ID del proyecto de Identity Platform al que pertenece la cuenta. La autorización requiere el siguiente permiso IAM en el recurso especificado
|
allow_overwrite |
Indica si se debe reemplazar una cuenta existente en Identity Platform con un |
cpu_mem_cost |
Es el parámetro de costo de memoria de la CPU que usará la función de hash STANDARD_SCRYPT. Este parámetro, junto con block_size y cpu_mem_cost, ayuda a ajustar los recursos necesarios para generar un hash de una contraseña y se debe ajustar a medida que avanzan las velocidades del procesador y las tecnologías de memoria. |
parallelization |
Es el parámetro de costo de paralelización que usará la función de hash STANDARD_SCRYPT. Este parámetro, junto con block_size y cpu_mem_cost, ayuda a ajustar los recursos necesarios para generar un hash de una contraseña y se debe ajustar a medida que avanzan las velocidades del procesador y las tecnologías de memoria. |
block_size |
Es el parámetro de tamaño de bloque que usa la función de hash STANDARD_SCRYPT. Este parámetro, junto con la paralelización y cpu_mem_cost, ayuda a ajustar los recursos necesarios para generar un hash de una contraseña y se debe ajustar a medida que avanzan las velocidades del procesador y las tecnologías de memoria. |
dk_len |
Es la longitud de clave deseada para la función de hash STANDARD_SCRYPT. Debe ser 1 como mínimo. |
password_hash_order |
|
tenant_id |
El ID del usuario de Identity Platform al que pertenece la cuenta. |
argon2_parameters |
Los parámetros del algoritmo de hash Argon2. |
PasswordHashOrder
Cuando se genera un hash de contraseñas, se debe determinar si la contraseña debe ir antes o después de la sal.
Enums | |
---|---|
UNSPECIFIED_ORDER |
No se especifica el orden. |
SALT_AND_PASSWORD |
El orden es primero la sal y, luego, la contraseña. |
PASSWORD_AND_SALT |
El orden es primero la contraseña y, luego, la sal. |
UploadAccountResponse
Es el mensaje de respuesta de UploadAccount.
Campos | |
---|---|
kind |
|
error[] |
Información detallada del error para las cuentas que no se pueden subir |
UserInfo
La información de una cuenta de Identity Platform
Campos | |
---|---|
local_id |
Inmutable. El ID único de la cuenta. |
email |
La dirección de correo electrónico de la cuenta La longitud del correo electrónico debe ser inferior a 256 caracteres y debe tener el formato |
display_name |
El nombre visible de la cuenta. Identity Platform no usa este atributo de cuenta. Solo está disponible con fines informativos. |
language |
Solo salida. Es la preferencia de idioma de la cuenta. Identity Platform no usa este atributo de cuenta. Solo está disponible con fines informativos. |
photo_url |
La URL de la foto de perfil de la cuenta. Identity Platform no usa este atributo de cuenta. Solo está disponible con fines informativos. |
time_zone |
Solo salida. Es la preferencia de zona horaria de la cuenta. Identity Platform no usa este atributo de cuenta. Solo está disponible con fines informativos. |
date_of_birth |
Solo salida. Es la fecha de nacimiento establecida para la cuenta. Identity Platform no usa este atributo de cuenta. Solo está disponible con fines informativos. |
password |
La contraseña con hash de la cuenta. Solo pueden acceder a él las solicitudes que tengan una credencial de OAuth2 de Google con los permisos adecuados. |
salt |
La sal de la contraseña de la cuenta. Solo las solicitudes que tengan una credencial de OAuth2 de Google con los permisos adecuados pueden acceder a él. |
version |
La versión de la contraseña de la cuenta. Solo las solicitudes que tengan una credencial de OAuth2 de Google con los permisos adecuados pueden acceder a él. |
email_verified |
Indica si se verificó la dirección de correo electrónico de la cuenta. |
password_updated_at |
Es la marca de tiempo, en milisegundos desde la época de 1970-01-01T00:00:00Z, cuando se actualizó la contraseña de la cuenta por última vez. |
provider_user_info[] |
Información sobre el usuario proporcionada por varios proveedores de identidad. |
valid_since |
Es la marca de tiempo más antigua, en segundos desde la época, que se debe considerar válida para un token de ID. Todos los tokens de ID emitidos antes de este momento se consideran no válidos. |
disabled |
Si la cuenta está inhabilitada. No se puede acceder a las cuentas inhabilitadas, excepto para las solicitudes que tengan una credencial de OAuth2 de Google con los permisos adecuados. |
last_login_at |
Es la última vez, en milisegundos desde la época, en que se accedió a esta cuenta. |
created_at |
Es la hora, en milisegundos desde la época, en la que se creó la cuenta. |
screen_name |
Solo salida. El nombre de pantalla de esta cuenta en Twitter o el nombre de acceso en GitHub |
custom_auth |
Solo salida. Indica si esta cuenta se autenticó con SignInWithCustomToken. |
raw_password |
Solo entrada. Es la contraseña de texto sin formato que se usa para actualizar la contraseña de una cuenta. Este campo solo se usa como entrada en una solicitud. Identity Platform usa un hash seguro criptográficamente cuando administra contraseñas y nunca almacenará ni transmitirá la contraseña de un usuario en texto sin formato. |
phone_number |
Es el número de teléfono de la cuenta. |
custom_attributes |
Son los reclamos personalizados que se agregarán a cualquier token de ID creado para la cuenta. Debe tener un máximo de 1,000 caracteres y estar en formato JSON válido. |
email_link_signin |
Solo salida. Indica si la cuenta puede autenticarse con un vínculo de correo electrónico. |
tenant_id |
Es el ID del grupo de usuarios al que pertenece esta cuenta. Solo se establece si esta cuenta pertenece a un inquilino. |
mfa_info[] |
Información sobre qué proveedores de autenticación de varios factores están habilitados para esta cuenta. |
initial_email |
La primera dirección de correo electrónico asociada a esta cuenta. El correo electrónico inicial de la cuenta no se puede cambiar una vez establecido y se usa para recuperar el acceso a esta cuenta si se pierde a través del flujo RECOVER_EMAIL en GetOobCode. Debe coincidir con la especificación de dirección de RFC 822. |
last_refresh_at |
Marca de tiempo de la última vez que se acuñó un token de ID para esta cuenta. |
UserNotification
Notificaciones de advertencia para el usuario
Campos | |
---|---|
notification_code |
Enum de notificación de advertencia. Se puede usar para la localización. |
notification_message |
Es la cadena de la notificación de advertencia. Se puede usar como resguardo. |
NotificationCode
Enum de notificación de advertencia. Se puede usar para la localización.
Enums | |
---|---|
NOTIFICATION_CODE_UNSPECIFIED |
No se especificó ninguna notificación. |
MISSING_LOWERCASE_CHARACTER |
Falta un carácter en minúscula en la contraseña. |
MISSING_UPPERCASE_CHARACTER |
Falta un carácter en mayúscula en la contraseña. |
MISSING_NUMERIC_CHARACTER |
Falta un carácter numérico en la contraseña. |
MISSING_NON_ALPHANUMERIC_CHARACTER |
Falta un carácter que no sea alfanumérico en la contraseña. |
MINIMUM_PASSWORD_LENGTH |
La contraseña es inferior a la longitud mínima requerida. |
MAXIMUM_PASSWORD_LENGTH |
La contraseña es superior a la longitud máxima requerida. |
VerifyIosClientRequest
Mensaje de solicitud para VerifyIosClient
Campos | |
---|---|
app_token |
Es un token de dispositivo que el cliente de iOS obtiene después de registrarse en los APNS (servicio de notificaciones push de Apple). |
is_sandbox |
Indica si el token de la app está en la zona de pruebas de iOS. Si es falso, el token de la app está en el entorno de producción. |
VerifyIosClientResponse
Es el mensaje de respuesta de VerifyIosClient.
Campos | |
---|---|
receipt |
Recibir una validación correcta del token de la app |
suggested_timeout |
Es el tiempo sugerido que el cliente debe esperar en segundos para que se entregue la notificación push. |