Documentation

Getting Started

Quickstart Guide Integration Guide Integration with PHP Integration with Ruby Integration with Ruby on Rails

Working with Accounts

User & Org Basics Simple Accounts Team Accounts Complex Accounts

Concepts

Realms Memberships & Permissions Sessions Single Sign-on

Logins & Signups

Handling Logins Handling Signups Configuring LoginRocket Customizing LoginRocket Redirect Handling Login Tokens (JWT) Two-Factor Authentication

Social Authentication

Other Guides

Full Start Guide

Data Import/Export

Importing Data Exporting Data

User Guide

Introduction Your Accounts Realms Realm dashboard Users Orgs Events Settings Settings: Realm Settings: Fields Settings: Sessions & JWT Settings: Auth Providers Auth Providers: Passwords Auth Providers: 2FA: TOTP Auth Providers: Facebook Auth Providers: GitHub Auth Providers: Google Auth Providers: LinkedIn Auth Providers: Slack Auth Providers: Yahoo Auth Providers: Custom OAuth2 Settings: LoginRocket Settings: Connected Apps Settings: Emails Settings: Webhooks Settings: UI Connect Integration Account: Settings Account: Team Account: API keys Account: Subscription Account: Payment method Account: Payment history Profile

Libraries

PHP Ruby & Rails authrocket.js (client-side)

API Overview

API Introduction Accessing the AuthRocket APIs Accessing the LoginRocket API Status Codes

Core API

Memberships Orgs Sessions Social Login Users

Extended API

Auth Providers Connected Apps Credentials Email and Webhooks Events JWT Keys Notifications Realms Signup Tokens

LoginRocket API

LoginRocket API

Knowledgebase

API Troubleshooting

Login URL Doesn't Exist What is a reference? Token Expired Error Querying Orgs Multiple Active Sessions Lowercase User Names Authrocket.js Response Objects

AuthRocket UI

Bulk Deleting Users Password Reset Emails Email Verification Change Billing Address Email Verification Basics Advanced Search by Username HTML Email Template Size Customizing Login Pages UI Customizations

General Information

Development, Staging, and Production Accounts User Privacy Considerations Latency and Uptime Custom Domains AuthRocket Background Migrating Data

Integration

Connecting Existing User Data Limits on Simultaneous User Sessions User Impersonation Returning a JWT with Updated User and Org Data Using AuthRocket with a Static Website Getting Memberships when Authenticating a User Making User Login Easier and Faster Super Users and Support Agents Create a Session without User Intervention What is Inside a Login Token? User Management Permissions Testing API Calls Retrieving Permissions Encoding Extended Information into a JWT Nesting Permissions

Passwords and Security

AuthRocket Security Practices Data Security Preventing Automatic Signup Attempts Error Message when Creating Users Password Expiration Dates Password Database Import Configurable User Password Requirements Keeping Users from Sharing Login Information

Social Auth

SSO Setup

Changing the URL in Email Verification Using Seamless SSO Logging Out with SSO Standard SSO vs Seamless SSO Limiting Access to Certain SSO Apps Connecting Apps with Seamless SSO

Structuring Your Data

Example: Users, Orgs, and Memberships Example: Data Structure for a SaaS Business Many-to-many Users-to-Account Structure Example: GitHub-style Users and Orgs Users, Orgs, and Memberships

Webhooks and Emails

Emails on Login Authenticating Webhooks HTTP Webhook Method Personalizing Password Reset Emails Webhooks and Webhook Retry Adding Company Logos

These docs are for AuthRocket 1. Looking for AuthRocket 2 docs?

Settings: Auth Providers: GitHub

Enabling GitHub requires setting up your own app within GitHub.

See our GitHub guide for a detailed walkthough to configuring GitHub.

Provider state

If inactive, disables authentication using this provider.

App ID

The GitHub Client ID

App Secret

The GitHub Client Secret

Extra scopes

Any additional scopes your app may require at the time of authentication. Best practices suggest requesting additional scopes just-in-time, instead of upfront. Requesting too many permissions initially may discourage users from signing up for your app to begin with.

Questions? Find a Typo? Get in touch.

Back to All Docs