https://github.com/authsignal/authsignal-ruby
The Authsignal Ruby Client
https://github.com/authsignal/authsignal-ruby
fido2 mfa passkeys ruby webauthn
Last synced: about 2 months ago
JSON representation
The Authsignal Ruby Client
- Host: GitHub
- URL: https://github.com/authsignal/authsignal-ruby
- Owner: authsignal
- License: mit
- Created: 2022-07-13T22:17:30.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2026-01-11T22:56:18.000Z (5 months ago)
- Last Synced: 2026-01-12T02:26:58.788Z (5 months ago)
- Topics: fido2, mfa, passkeys, ruby, webauthn
- Language: Ruby
- Homepage: https://www.authsignal.com
- Size: 1.41 MB
- Stars: 4
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Authsignal Ruby SDK
[](https://rubygems.org/gems/authsignal-ruby)
[](https://github.com/authsignal/authsignal-ruby/blob/main/LICENSE.txt)
The official Authsignal Ruby library for server-side applications. Use this SDK to easily integrate Authsignal's multi-factor authentication (MFA) and passwordless features into your Ruby backend.
## Installation
Add this line to your application's Gemfile:
```ruby
gem "authsignal-ruby"
```
And then execute:
```bash
bundle install
```
Or install it yourself as:
```bash
gem install authsignal-ruby
```
## Getting started
Initialize the Authsignal client with your secret key from the [Authsignal Portal](https://portal.authsignal.com/) and the API URL for your region.
```ruby
require 'authsignal'
# Initialize the client
Authsignal.setup do |config|
config.api_secret_key = ENV['AUTHSIGNAL_SECRET_KEY']
config.api_url = ENV['AUTHSIGNAL_API_URL'] # Use region-specific URL
end
```
### API URLs by region
| Region | API URL |
| ----------- | -------------------------------- |
| US (Oregon) | https://api.authsignal.com/v1 |
| AU (Sydney) | https://au.api.authsignal.com/v1 |
| EU (Dublin) | https://eu.api.authsignal.com/v1 |
## License
This SDK is licensed under the [MIT License](LICENSE.txt).
## Documentation
For more information and advanced usage examples, refer to the official [Authsignal server-Side SDK documentation](https://docs.authsignal.com/sdks/server/overview).