https://github.com/authsignal/authsignal-ios

Authsignal iOS SDK for authenticating with passkeys, push, email OTP, SMS OTP and Authenticator App (TOTP)
https://github.com/authsignal/authsignal-ios

authentication authenticator-app email-otp fido2 ios mfa passkeys passwordless push sms-otp swift totp webauthn

Last synced: about 2 months ago
JSON representation

Authsignal iOS SDK for authenticating with passkeys, push, email OTP, SMS OTP and Authenticator App (TOTP)

• Host: GitHub
• URL: https://github.com/authsignal/authsignal-ios
• Owner: authsignal
• License: mit
• Created: 2023-03-15T20:48:00.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-10T22:00:18.000Z (about 2 months ago)
• Last Synced: 2024-11-10T22:06:41.388Z (about 2 months ago)
• Topics: authentication, authenticator-app, email-otp, fido2, ios, mfa, passkeys, passwordless, push, sms-otp, swift, totp, webauthn
• Language: Swift
• Homepage: https://docs.authsignal.com/
• Size: 73.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Authsignal iOS

Check out our [official iOS documentation](https://docs.authsignal.com/sdks/client/ios).

## Installation

#### Cocoapods

Add Authsignal to your Podfile:

```rb

pod 'Authsignal', '~> 1.0.13'

```

#### Swift Package Manager

Add authsignal-ios to the dependencies value of your Package.swift.

```swift

dependencies: [

    .package(url: "https://github.com/authsignal/authsignal-ios.git", from: "1.0.13")

]

```

## Initialization

```swift

import Authsignal

...

let authsignal = Authsignal(clientID: "YOUR_TENANT_ID", baseURL: "YOUR_REGION_BASE_URL")

```

You can find your client or tenant ID in the [Authsignal Portal](https://portal.authsignal.com/organisations/tenants/api).

You must specify the correct base URL 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 iOS](https://docs.authsignal.com/sdks/client/ios#passkeys).

### Push auth

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