Your suggested change has been received. Thank you.

close
Thales Logo

All

  • All
  • CipherTrust Manager
  • CipherTrust Application Data Protection (CADP)
  • CipherTrust Application Key Management (CAKM)
  • CipherTrust Batch Data Transformation (BDT)
  • CipherTrust Cloud Key Management (CCKM)
  • CipherTrust Data Discovery and Classification (DDC)
  • CipherTrust Data Protection Gateway (DPG)
  • CipherTrust Database Protection (CDP)
  • CipherTrust Intelligent Protection (CIP)
  • CipherTrust Integrations
  • CipherTrust Migrations
  • CipherTrust RESTful Data Protection (CRDP)
  • CipherTrust Transparent Encryption (CTE)
  • CipherTrust Transparent Encryption Userspace (CTE-U)
  • CipherTrust Secrets Management (CSM)
  • CipherTrust Vaulted Tokenization (CT-V)
  • CipherTrust Vaultless Tokenization (CT-VL)
  • CTE-Linux
  • CTE-Windows
  • CTE-AIX
  • CTE-K8s
  • CTE-U
  • Crypto Command Center
  • Data Protection on Demand
  • Luna Cloud HSM
  • Luna Network HSM
  • Luna PCIe HSM
  • Luna USB HSM
  • OneWelcome Identity Platform
  • ProtectApp LUKS
  • ProtectServer 2 HSM
  • ProtectServer 3 HSM
  • SafeNet Trusted Access (STA)
  • SafeNet MobilePASS+
  • SafeNet MobilePASS+ for Android
  • SafeNet MobilePASS+ for Chrome
  • SafeNet MobilePASS+ for macOS
  • SafeNet MobilePASS+ for iOS
  • SafeNet MobilePASS+ for WatchOS
  • SafeNet MobilePASS+ for Windows
  • SafeNet Synchronization Agent
  • SafeNet Logging Agent
  • SafeNet Agent for FreeRADIUS
  • SafeNet Agent for NPS
  • SafeNet Agent for Windows Logon
  • SafeNet Authentication Service Private Cloud Edition (SAS PCE)
  • SafeNet Remote Logging Agent
  • SafeNet Keycloak Agent
  • SafeNet IDPrime Virtual (IDPV)
  • SafeNet FIDO Key Manager
  • SafeNet FIDO Key Manager for Android
  • SafeNet FIDO Key Manager for iOS
  • SafeNet FIDO Key Manager for Windows
back

OneWelcome ReactNative SDK 1.0.0

User authentication

search
printsuggest an edit

User authentication

copy link to clipboardIntroduction

This topic guide explains all the steps required to add user authentication to your app. In case you didn't add user registration functionality to your application project yet, please follow the steps in the User registration registration topic guide.

copy link to clipboardGet registered profiles

The ReactNative SDK provides a function getUserProfiles to get all registered profiles on the device. You will need to use these to authenticate a profile with the SDK.

OneWelcomeSdk.getUserProfiles()
  .then(profiles => {
    console.log('User profiles registered on this device: ', profiles)
  })
  .catch(error => {
    console.error('Error:', error.message)
  })

copy link to clipboardAuthenticate a registered user

Once a user has been registered, it can be logged in using the authenticateUser method. This method takes the profileId of an already registered user and an optional authenticatorId, returning a promise. You can find out which authenticators are available by calling the getRegisteredAuthenticators method passing in the profileId. After starting user authentication the app needs to handle certain events sent by the SDK. Event listeners will need to be set up for PinAuthenticationEvent before starting authentication, using the addEventListener method. The SDK expects certain input depending on what kind of authentication was started before it will resolve or reject. The events sent by the SDK indicate what kind of input it is expecting. 

OneWelcomeSdk.authenticateUser(profileId, null)
  .then(authData => {
    console.log('User authentication succeed!')
  })
  .catch(error => {
    console.log('User authentication failed!: ', error.message)
  })

interface OneWelcomeSDK {
  authenticateUser(
    profileId: string,
    authenticatorId: string | null,
  ): Promise<Types.AuthData>;
 __ ...
}

copy link to clipboardAuthenticate with pin

When authenticating with pin, you will need to handle the PinAuthenticationEvent. You can listen for this events and handle it as follows.

const handleAuthNotification = useCallback(
  async (event: Events.PinAuthenticationEvent) => {
    console.log('handle PIN notification event: ', event);
    switch (event.action) {
      case Events.PinAuthentication.Open:
        await handleAuthOpen(event);
        break;
      case Events.PinAuthentication.Close:
        setInitialState();
        break;
      case Events.PinAuthentication.IncorrectPin:
        handleIncorrectPin(event);
        break;
    }
  },
  [handleAuthOpen, setInitialState, handleIncorrectPin],
);

const authListener = OnewelcomeSdk.addEventListener(
  Events.SdkNotification.PinAuth,
  handleAuthNotification,
);

During pin authentication you should communicate the pin to the SDK using the submitPin method or cancel it using the cancelPinAuthentication method. Please note that the submitPin method expects you to specify for what kind of flow you are submiting the pin. Note that canceling the pin authentication will result in the promise from authenticateUser() rejecting. You can use that to handle any logic for your app.

If authentication was succesfull, the SDK will resolve the promise from authenticateUser() . It will also send a PinAuthenticationCloseEvent event.

PinAuthenticationEvent Description
PinAuthenticationOpenEvent Sent when the SDK is ready to receive a pin for authentication.
PinAuthenticationCloseEvent Sent by the SDK when it has finished authentication.
IncorrectPinEvent Sent by the SDK when it has received an incorrect pin.

On this page