Ruby

Authenticate requests and manage Passage users with Ruby.

Installation

To learn more, see our Github repo with up to date requirements and installation steps.

Requirements: Passage App ID and API Key from Console

Ruby Gem: passageidentity

Session Management

Passage uses two types of tokens: auth tokens and refresh tokens for security. To learn more, see our full guide on Tokens.

auth.authenticate_request()

Deprecated use auth.validate_jwt() instead.

auth.revoke_user_refresh_tokens()

auth.validate_jwt()

App

Retrieve information about the Passage app.

get_app()

User Management

Users of the app can be managed, all are reflected on the app's Users page in Console. To learn more about user management and correlating users between Passage and your database view our guide here.

user.activate()

user.create()

user.deactivate()

user.delete()

user.get()

user.get_by_identifier()

user.update()

user.signout()

Deprecated use auth.revoke_user_refresh_tokens() instead.

User Passkey Device Management

When a user creates a passkey, the device is saved. Devices can be retrieved and deleted from the user's profile.

user.delete_device()

user.list_devices()

Creating Magic Links

The Ruby SDK can be used to generate custom magic links for users, that can be embedded into any content medium. To learn more, see our full guide on Embedded Magic Links.

create_magic_link()