Skip to main content
Lock tiene muchos métodos, características y opciones configurables. Esta referencia está diseñada para ayudarle a encontrar los que necesita y explicar cómo usarlos. Haga clic a continuación para ir directamente al método que busca, o simplemente navegue. Si busca información sobre los eventos emitidos por Lock, se enumeran en la sección del método on()!
  • new Auth0Lock - Instanciar Lock
  • getUserInfo() - Obtener el perfil de un usuario que ha iniciado sesión
  • show() - Mostrar el widget de Lock
  • on() - Escuchar eventos
  • resumeAuth() - Se usa para completar el flujo de autenticación cuando autoParseHash es false
  • checkSession() - Obtener un nuevo token de Auth0 para un usuario autenticado
  • logout() - Cerrar la sesión del usuario

​
Auth0Lock

new Auth0Lock(clientID, domain, options) Inicializa una nueva instancia de Auth0Lock configurada con el clientID de su aplicación y el domain de su cuenta, obtenidos del panel de administración de Auth0. El tercer parámetro, opcional, es un objeto options que se utiliza para configurar Lock según las necesidades de su aplicación. Puede encontrar esta información en la configuración de la aplicación.
  • clientId {String}: Parámetro obligatorio. El clientId de su aplicación en Auth0.
  • domain {String}: Parámetro obligatorio. Su dominio de Auth0. Normalmente, your-account.auth0.com.
  • options {Object}: Parámetro opcional. Permite configurar la apariencia y el comportamiento de Lock. Consulte la página de opciones de configuración para obtener más detalles.

​
getUserInfo()

getUserInfo(accessToken, callback) Una vez que el usuario haya iniciado sesión y tengas un token, puedes usarlo para obtener el perfil del usuario con getUserInfo. Este método sustituye al método getProfile(), que está obsoleto.
  • accessToken {String}: Token del usuario.
  • callback {Function}: Se invocará después de recuperar el perfil del usuario.
lock.getUserInfo(accessToken, function(error, profile) {
  if (!error) {
    alert("hello " + profile.name);
  }
});

​
show()

show(options) El método show muestra el widget. A partir de la versión 10.2.0 de Lock, el método show puede aceptar un objeto options como parámetro. Tenga en cuenta que este parámetro está pensado para usarse como una forma de sobrescribir las options de su Lock para esta visualización concreta del widget. Las opciones deben establecerse al instanciar Lock y sobrescribirse solo si es necesario para su caso de uso específico. Se puede sobrescribir el siguiente subconjunto de options con respecto a los valores asignados (o sus valores predeterminados) cuando se instanció Lock:
  • allowedConnections
  • auth.params
  • allowLogin
  • allowSignUp
  • allowForgotPassword
  • initialScreen
  • rememberLastLogin
Para obtener más información sobre la lista completa de opciones configurables que pueden elegirse al instanciar Lock, en lugar del subconjunto limitado anterior que puede sobrescribirse en el método show, consulte la página de opciones configurables por el usuario. Ejemplos de sobrescritura de opciones: 
// Mostrar el widget Lock sin sobrescribir ninguna opción
lock.show();

// Mostrar el widget Lock sobrescribiendo algunas opciones
lock.show({
  allowedConnections: ["twitter", "facebook"],
  allowSignUp: false
});
Las opciones deben establecerse al crear una instancia de Lock por primera vez: var lock = new Auth0Lock(clientId, domain, options);. Las opciones solo deben pasarse a show para sobrescribir las opciones configuradas previamente al mostrar el widget en ese momento y contexto concretos. Hay una opción adicional que se puede establecer en el método show, llamada flashMessage.

​
flashMessage

Este objeto solo está disponible como opción para el método show, no para usarse en el objeto options estándar al instanciar Lock. El objeto flashMessage muestra un mensaje flash de error o de éxito cuando se muestra Lock. Tiene los siguientes parámetros:
  • type {String}: El tipo de mensaje; debe ser error o success.
  • text {String}: El texto que se mostrará.
lock.show({
  flashMessage:{
    type: 'success',
    text: 'Amazing Success!!'
  }
});
Una aplicación práctica de la opción flashMessage es gestionar errores de autorización. flashMessage puede contener el texto descriptivo del error. 
lock.on('authorization_error', function(error) {
  lock.show({
    flashMessage: {
      type: 'error',
      text: error.errorDescription
    }
  });
});
Por lo tanto, si tester@example.com intentara ahora iniciar sesión, al ser un usuario bloqueado, se le volverá a mostrar Lock, con una barra superior en la que se muestra el mensaje de error, en lugar de que simplemente falle el inicio de sesión y Lock se cierre.

​
hide()

hide() El método hide cierra el widget si está abierto en ese momento. El widget se cierra automáticamente en la mayoría de los casos, por lo que este método suele invocarse solo en casos de uso específicos. Por ejemplo, es posible que quiera escuchar el evento unrecoverable_error y luego aplicar hide a Lock para redirigir al usuario a una página de error personalizada. Otro ejemplo es el de quienes implementan el modo emergente y podrían necesitar ejecutar hide manualmente en el widget después de que se dispare el evento authenticated. Ejemplo de uso para ocultar (cerrar) el widget Lock en modo emergente: 
// Escuchar el evento authenticated y ocultar Lock
lock.on("authenticated", function() {
  lock.hide();

  // Cualquier otra acción que desees realizar en el evento authenticated

});

​
on()

Lock emite eventos durante su ciclo de vida. El método on puede usarse para escuchar eventos concretos y reaccionar ante ellos.
  • show: se emite cuando se muestra Lock. No tiene argumentos.
  • hide: se emite cuando se oculta Lock. No tiene argumentos.
  • unrecoverable_error: se emite cuando se produce un error irrecuperable; por ejemplo, cuando no hay ninguna conexión disponible. Tiene el error como único argumento.
  • authenticated: se emite después de una autenticación correcta. Tiene el resultado de la autenticación como único argumento. El resultado de la autenticación contiene el token, que puede usarse para obtener el perfil del usuario o almacenarse para iniciar sesión en comprobaciones posteriores.
  • authorization_error: se emite cuando falla la autorización. Tiene el error como único argumento.
  • hash_parsed: cada vez que se inicializa un nuevo objeto Auth0Lock en modo de redirección (el predeterminado), intenta analizar la parte hash de la URL en busca del resultado de un intento de inicio de sesión. Este es un evento de bajo nivel para casos de uso avanzados y, cuando sea posible, deben preferirse authenticated y authorization_error. Después, este evento se emitirá con null si no pudo encontrar nada en el hash. Se emitirá con el mismo argumento que el evento authenticated después de un inicio de sesión correcto, o con el mismo argumento que authorization_error si algo salió mal. Este evento no se emitirá en modo emergente, porque no es necesario analizar la parte hash de la URL.
  • forgot_password ready: se emite cuando se muestra la pantalla “Olvidé mi contraseña”. (Solo en la versión >10.18)
  • forgot_password submit: se emite cuando el usuario hace clic en el botón de envío de la pantalla “Olvidé mi contraseña”. (Solo en la versión >10.14)
  • signin ready: se emite cuando se muestra la pantalla “Iniciar sesión”.
  • signup ready: se emite cuando se muestra la pantalla “Registrarse”.
  • signin submit: se emite cuando el usuario hace clic en el botón de envío de la pantalla “Iniciar sesión”. (Solo en la versión >10.18)
  • signup submit: se emite cuando el usuario hace clic en el botón de envío de la pantalla “Registrarse”. (Solo en la versión >10.18)
  • federated login: se emite cuando el usuario hace clic en un botón de conexión social. Tiene como argumentos el nombre de la conexión y la estrategia. (Solo en la versión >10.18)
  • socialOrPhoneNumber ready: se emite cuando se muestra la pantalla de con Social + Número de teléfono
  • socialOrPhoneNumber submit: se emite cuando se envía la pantalla sin contraseña con Social + Número de teléfono
  • socialOrEmail ready: se emite cuando se muestra la pantalla sin contraseña con Social + Correo electrónico
  • socialOrEmail submit: se emite cuando se envía la pantalla sin contraseña con Social + Correo electrónico
  • vcode ready: se emite cuando se muestra la pantalla sin contraseña con la contraseña de un solo uso
  • vcode submit: se emite cuando se envía la pantalla sin contraseña con la contraseña de un solo uso
El listener del evento authenticated tiene un único argumento: un objeto authResult. Este objeto contiene las siguientes propiedades: accessToken, idToken, state, refreshToken e idTokenPayload. Un ejemplo de uso del evento authenticated:

​
resumeAuth()

Este método solo se puede usar cuando configuras la opción auth.autoParseHash en false. Debes llamar a resumeAuth para completar el flujo de autenticación. Este método resulta útil cuando usas un enrutador del lado del cliente que utiliza # para gestionar las URL (angular2 con useHash o react-router con hashHistory).
  • hash {String}: El fragmento hash recibido de la redirección.
  • callback {Function}: Se invoca una vez finalizado el análisis. Recibe un error (si lo hay) como primer argumento y el resultado de la autenticación como segundo. Si no hay ningún hash disponible, ambos argumentos serán null.
lock.resumeAuth(hash, function(error, authResult) {
  if (error) {
    alert("Could not parse hash");
  }
  //Este es solo un ejemplo; no debes registrar tokens de acceso en producción.
  console.log(authResult.accessToken);
});

​
checkSession()

El método checkSession le permite obtener un token nuevo de Auth0 para un usuario que ya está autenticado en Auth0 para su dominio. Acepta los siguientes parámetros:
  • options {Object}: Opcional. Acepta cualquier parámetro de OAuth2 válido que normalmente se enviaría a /authorize. Si los omite, usará los proporcionados al inicializar Auth0.
  • callback {Function}: Se invocará con el resultado de la renovación del token. Recibe un error (si lo hay) como primer argumento y el resultado de la autenticación como segundo.
lock.checkSession({}, function(err, authResult) {
  // manejar el error o los nuevos tokens
});

​
logout()

Cierra la sesión del usuario.
  • options {Object}: Es opcional y sigue las mismas reglas que logout() de auth0.js.
lock.logout({
  returnTo: 'https://myapp.com/bye-bye'
});