Optare v1.0 is now available. Get started →
Start Here
Setup Checklist

Setup Checklist

Follow this checklist to get Optare fully integrated with your application.

Your Progress

Track your setup progress. Complete each section in order for the smoothest experience.


Phase 1: Foundation

☐ Create Your Account

  1. Sign up for Optare (opens in a new tab)
  2. Verify your email
  3. Complete your profile

Time: 2 minutes


☐ Create Your Organization

  1. Go to Console (opens in a new tab)Organizations
  2. Click Create Organization
  3. Enter your organization name and slug

Result: Your tenant is ready at https://id.optare.one/login?org=your-slug


Phase 2: Integration

☐ Register Your Application

  1. Go to ApplicationsOAuth Clients
  2. Click Create Client
  3. Configure:
    • Name: Your app name
    • Type: SPA, Web App, or Native
    • Redirect URI: Your callback URL

Result: You have a Client ID to use in your app.

→ Detailed Guide: Applications


☐ Integrate the SDK

Choose your framework:

FrameworkGuideTime
ReactReact Quickstart5 min
Next.jsNext.js Quickstart10 min
Node.jsNode.js Quickstart10 min
FlutterFlutter Quickstart15 min

Result: Users can log in to your app.


☐ Test Authentication

  1. Run your app locally
  2. Click "Log In"
  3. Create a test account
  4. Verify you're redirected back

Troubleshooting:

  • "Invalid redirect_uri" → Check your OAuth client settings
  • CORS error → Add your origin to allowed origins

Phase 3: Team Setup

☐ Invite Team Members

  1. Go to OrganizationMembers
  2. Click Invite Member
  3. Enter email and select role

Roles:

  • Owner: Full control (billing, delete)
  • Admin: Manage members, settings
  • Member: Standard access

→ Detailed Guide: Multi-Tenancy


☐ Configure Roles & Permissions

  1. Review default roles in SettingsRBAC
  2. Customize permissions as needed
  3. Assign roles to team members

→ Detailed Guide: RBAC


Phase 4: Security

☐ Enable MFA (Recommended)

  1. Go to SettingsSecurity
  2. Set MFA policy:
    • Optional
    • Required for Admins
    • Required for All

Result: Enhanced account security.


☐ Configure Session Settings

  1. Go to SettingsSecurity
  2. Set:
    • Access token lifetime
    • Refresh token lifetime
    • Idle timeout

Recommended:

  • Access Token: 1 hour
  • Refresh Token: 30 days
  • Idle Timeout: 24 hours

Phase 5: Production

☐ Add Production Redirect URIs

  1. Go to your OAuth client settings
  2. Add production URLs:
    https://yourapp.com/callback
    https://yourapp.com/api/auth/callback

☐ Set Up Custom Domain (Optional)

  1. Go to SettingsCustom Domains
  2. Add your domain: auth.yourcompany.com
  3. Configure DNS CNAME record
  4. Verify and enable

→ Detailed Guide: Custom Domains


☐ Configure Branding

  1. Upload your logo
  2. Set primary brand color
  3. Preview and publish

→ Detailed Guide: Branding


☐ Deploy to Production

  1. Update environment variables with production values
  2. Deploy your application
  3. Test the full login flow

Phase 6: Advanced (Optional)

☐ Set Up Webhooks

Receive notifications when events occur:

  1. Go to Webhooks
  2. Add your endpoint URL
  3. Select events to receive

→ Detailed Guide: Webhooks


☐ Add Enterprise SSO

For enterprise customers with existing IdPs:

  1. Go to SettingsEnterprise SSO
  2. Configure SAML or OIDC
  3. Test with an enterprise account

→ Detailed Guide: Connections


☐ Set Up Licensing

Control feature access per organization:

  1. Create Products
  2. Create Subscriptions
  3. Check licenses in your app

→ Detailed Guide: License Checking


You're All Set! 🎉

Your Optare integration is complete. Here's what's next:


Quick Reference

TaskWhere
Manage membersOrganization → Members
View logsDashboard → Audit Logs
Get API keySettings → API Keys
Help & SupportDashboard → Support