RegardingWork Hub API Documentation

Centralized authentication and Single Sign-On service for the RegardingWork ecosystem

Building with an AI agent?

Feed your agent one of these instead of crawling the docs site:

View llms.txt

Pick your integration type

Mini-app → SSO

Internal app on a *.regardingwork.com subdomain. One redirect, JWT in callback URL. Done in <1 hour.

Mini-App Guide Request SSO Access
Third-party → OAuth 2.0

External app on your own domain. Authorization-code flow with PKCE. Requires registered client + secret.

Third-Party Guide OAuth Reference

Overview

Our RESTful API enables secure authentication and user management across all RegardingWork services (Game, Premium, Display, Desk, CE, Family, etc.).

Base URL:
https://hub.regardingwork.com/api
Authentication:
JWT Bearer tokens (30-day expiration)
Login identifier:
USERNAME (not email)
CORS:
Enabled for RegardingWork subdomains

Quick Start

Ready to integrate authentication with RegardingWork Hub?

Note: Hub uses USERNAME for login (not email)
Get Started Auth Guide Troubleshooting
New to RegardingWork Hub?

Get your app integrated with Hub authentication in under 2 hours.

Get Started
Having Issues?

Fix common authentication problems with step-by-step solutions.

Fix Issues
API Reference

Detailed documentation for all endpoints and OAuth flows.

View API Docs
Hub Authentication System Status: ✅ Operational

SSO domain validation fixed • OAuth token exchange working • Ready for all RegardingWork apps

Test Credentials:
janechen / jane123

Features

  • JWT Authentication (30-day tokens)
  • Refresh token system (30-day)
  • OAuth 2.0 Authorization Code Flow
  • PKCE Security Extension
  • Single Sign-On (SSO) integration
  • User registration and management
  • Profile management endpoints
  • Team management with roles
  • Team invitations system
  • Secure password hashing (scrypt)
  • Cross-domain CORS support
  • Token blacklisting for security

Core API Endpoints

Authentication & User Management
Endpoint Method Description
/api/auth/register POST Register new user account
/api/auth/login POST Authenticate user and get tokens
/api/auth/logout POST Logout user and blacklist tokens
/api/auth/validate GET Validate JWT token ⚠️ Critical for all mini-apps
/api/auth/refresh POST Refresh access token
/api/auth/me GET Get current user data
OAuth 2.0 Endpoints
Endpoint Method Description
/api/oauth/authorize GET OAuth 2.0 authorization endpoint
/api/oauth/token POST Exchange authorization code for tokens
Single Sign-On (SSO)
Endpoint Method Description
/api/auth/sso/authorize GET SSO authorization endpoint
/api/auth/sso/token POST Get SSO token for authenticated user
Team Management APIs
Endpoint Method Description
/api/teams GET List all teams (with pagination and filtering)
/api/teams POST Create a new team
/api/teams/<slug> GET Get team details by slug
/api/teams/<slug>/members GET List team members with roles
/api/teams/<slug>/members POST Add member to team
/api/teams/<slug>/members/<username> PUT Update member role in team
/api/teams/<slug>/members/<username> DELETE Remove member from team
/api/user/teams GET Get current user's teams
/api/teams/<slug>/invite POST Send team invitation
/api/invitations/<token> POST Accept team invitation
/api/user/invitations GET Get user's pending invitations

Live API Demo

Test the API endpoints right here:

Health Check Test

Complete Documentation Index

🚀 Getting Started
🛠️ Troubleshooting
📚 API Reference
🔗 External Resources
Need Help?

Start with the Standardized Authentication Guide to choose the right method for your app, then follow the specific implementation guide.

Having issues? Check the Troubleshooting Guide for solutions to common problems.