Skip to main content

Setup Checklist

Complete this checklist before starting any integration. Takes about 5 minutes.

Step 1: Create Your Nexorix Account​

SyAuth is part of the Nexorix ecosystem. You must create an account on Nexorix to access the SyAuth Dashboard.

  1. Go to Nexorix and create an account.
  2. Once registered, use your Nexorix credentials to log in to SyAuth.
tip

Use your work email if you're building for a company. You can add team members to your Workspace later.

Step 2: Create a Workspace​

After signing in, you'll be prompted to create a Workspace. A Workspace is where all your applications, users, and settings live.

FieldWhat to EnterExample
NameYour company or project nameAcme Corp or My Side Project

When to use multiple Workspaces:

  • Separate production and development environments
  • Separate projects for different clients
  • Isolate test accounts from real users

Step 3: Create Your First OAuth Client​

An OAuth Client represents your application in SyAuth.

  1. In the sidebar, click OAuth Clients.
  2. Click Create OAuth Client.
  3. Select your application type:
    • Regular Web Application: For Next.js, Django, etc. Public + PKCE is recommended.
    • Single Page Application: For client-side React, Vue. Uses Public + PKCE.
    • Native Application: For mobile or desktop apps.
    • Machine to Machine: For backend services and CLIs.

👉 View detailed guide: Configuring OAuth Clients

Step 4: Copy Your OAuth Credentials​

After creating your OAuth Client, you'll see your credentials. Store them securely.

  • Client ID: Safe to use in frontend code.
  • Client Secret: Only required if you chose Confidential Client. Shown only once.
warning

The Client Secret is shown only once! If you lose it, you'll need to Regenerate it.

Step 5: Create an API Token​

API Tokens (Keys) allow your server-side code to perform operations like registering users via the API.

  1. In the sidebar, click API Tokens.
  2. Click Create Token.
  3. Name your token and select any necessary scopes (Read/Write).
  4. Copy your token immediately — it will never be shown again.

👉 View detailed guide: Managing API Tokens

Step 6: Set Up Environment Variables​

Create an .env.local file (or equivalent for your framework) with your credentials:

Next.js​

NEXT_PUBLIC_SYAUTH_API_URL=https://api.syauth.com/e/v1
NEXT_PUBLIC_SYAUTH_CLIENT_ID=your-client-id
NEXT_PUBLIC_SYAUTH_REDIRECT_URI=http://localhost:3000/auth/callback
NEXT_PUBLIC_SYAUTH_API_KEY=your-api-key

Django​

# settings.py
SYAUTH = {
    'API_URL': 'https://api.syauth.com/e/v1',
    'CLIENT_ID': 'your-client-id',
    'API_KEY': 'your-api-key',
    'REDIRECT_URI': 'http://localhost:8000/auth/callback/',
}

Other Frameworks​

SYAUTH_API_URL=https://api.syauth.com/e/v1
SYAUTH_CLIENT_ID=your-client-id
SYAUTH_CLIENT_SECRET=your-client-secret
SYAUTH_REDIRECT_URI=http://localhost:3000/callback

✓ Checklist Complete!​

You're ready to integrate SyAuth. Choose your quickstart guide:

Troubleshooting Setup​

"I can't find my Client Secret"​

Client Secrets are shown only once when created. If you didn't copy it:

  1. Go to Dashboard → OAuth Clients → Your App
  2. Click Regenerate Secret
  3. Copy the new secret immediately

"I added the wrong Redirect URI"​

  1. Go to Dashboard → OAuth Clients → Your App
  2. In the Redirect URIs section, edit or remove incorrect URIs
  3. Add the correct URI
  4. Save changes

"I need to add a team member"​

  1. Go to Dashboard → Workspace Settings
  2. Click Members
  3. Click Invite Member
  4. Enter their email address