https://github.com/authsignal/react-native-authsignal

Authsignal React Native SDK for authenticating with passkeys, push, email OTP, SMS OTP and authenticator app (TOTP)
https://github.com/authsignal/react-native-authsignal

android authentication authenticator-app email-otp fido2 ios mfa passkeys passwordless push react-native sms-otp totp typescript webauthn

Last synced: 1 day ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/authsignal/react-native-authsignal
• Owner: authsignal
• License: mit
• Created: 2022-10-26T02:26:45.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-30T00:15:19.000Z (15 days ago)
• Last Synced: 2024-11-08T07:45:14.081Z (6 days ago)
• Topics: android, authentication, authenticator-app, email-otp, fido2, ios, mfa, passkeys, passwordless, push, react-native, sms-otp, totp, typescript, webauthn
• Language: Kotlin
• Homepage: https://docs.authsignal.com
• Size: 315 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# react-native-authsignal

Check out our [official React Native documentation](https://docs.authsignal.com/sdks/client/react-native).

## Installation

Install the Authsignal React Native SDK using npm or yarn:

```bash

npm install react-native-authsignal

```

Then link the native iOS dependencies:

```bash

npx pod-install ios

```

## Initialization

Initialize the Authsignal client in your code:

```ts

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](https://portal.authsignal.com/organisations/tenants/api).

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](https://docs.authsignal.com/sdks/client/react-native#passkeys).

### Push

To see how to add push authentication to your app using Authsignal, see our [official push documentation for React Native](https://docs.authsignal.com/sdks/client/react-native#push).

## Examples

### Passkeys

You can check out [this Github repo](https://github.com/authsignal/react-native-passkey-example) 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](https://github.com/authsignal/react-native-passkey-example/tree/with-aws-cognito).