OmniAuth Authentiq

Official OmniAuth strategy for authenticating with an Authentiq ID mobile app (iOS, Android). Application credentials can be obtained at Authentiq.

Installation

Add this line to your application's Gemfile

gem 'omniauth-authentiq', '~> 0.2.0'

Then bundle:

$ bundle install

Basic Usage with Rails

use OmniAuth::Builder do
  provider :authentiq, ENV['AUTHENTIQ_KEY'], ENV['AUTHENTIQ_SECRET'],
           scope: 'aq:name email~rs aq:push'
end

Scopes

Authentiq adds the capability to request personal information like name, email, phone number, and address from the Authentiq ID app (iOS, Android). During authentication, and only after the user consents, this information will be shared by the Authentiq ID app.

Requesting specific information or "scopes" is done by modifying the scope parameter in the basic usage example above. Depending on your implementation, you may also need to provide the redirect_uri parameter.

Example:

use OmniAuth::Builder do
  provider :authentiq, ENV['AUTHENTIQ_KEY'], ENV['AUTHENTIQ_SECRET'], 
           scope: 'aq:name email~rs aq:push phone address',
           redirect_uri: '<REDIRECT_URI>'
end

Available scopes are:

• aq:name for Name
• email for Email
• phone for Phone
• address for Address
• aq:location for Location (geo coordinates)
• aq:push to request permission to sign in via Push Notifications in the Authentiq ID app

Append ~r to a scope to explicitly require it from the user.

Append ~s to phone or email scope to explicitly require a verified (signed) scope.

The ~s and ~r can be combined to ~rs to indicate that the scope is both required and should be / have been verified.

Tests

Tests are coming soon.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/AuthentiqID/omniauth-authentiq.