Skip to content

Authsignal React Native SDK for authenticating with passkeys, push, email OTP, SMS OTP and authenticator app (TOTP)

License

Notifications You must be signed in to change notification settings

authsignal/react-native-authsignal

Repository files navigation

react-native-authsignal

Check out our official React Native documentation.

Installation

Install the Authsignal React Native SDK using npm or yarn:

npm install react-native-authsignal

Then link the native iOS dependencies:

npx pod-install ios

Initialization

Initialize the Authsignal client in your code:

import { Authsignal } from 'react-native-authsignal';

const authsignal = new Authsignal({
  tenantId: 'YOUR_TENANT_ID',
  baseUrl: 'YOUR_REGION_BASE_URL',
});

You can find your tenantId in the Authsignal Portal.

You must specify the correct baseUrl for your tenant's region.

Region Base URL
US (Oregon) https://api.authsignal.com/v1
AU (Sydney) https://au.api.authsignal.com/v1
EU (Dublin) https://eu.api.authsignal.com/v1

Usage

Passkeys

For more detailed info on how add passkeys to your app using Authsignal, check out our official passkey documentation for React Native.

Push

To see how to add push authentication to your app using Authsignal, see our official push documentation for React Native.

Examples

Passkeys

You can check out this Github repo to see an example app which implements a sign-in with passkey flow using the Authsignal React Native SDK.

To see an example app which demonstrates integration with AWS Cognito + Amplify, take a look at this this branch.