Introduction

Welcome to the auth.hawaiian.gg developer documentation.
This guide gives you an overview of the platform, its concepts, and how to integrate authentication into your apps.

TIP

If you're just starting, we recommend reading Oauth2 Documentation before jumping into the API reference.

What is auth.hawaiian.gg?

auth.hawaiian.gg is a secure, developer-friendly authentication service that helps you:

Authenticate users via OAuth2
Generate and validate JWT tokens
Receive real-time webhook events
Manage roles, scopes, and permissions
Integrate authentication with minimal setup

It’s built for speed, security, and flexibility — so you can spend more time building features and less time worrying about auth.

Key Features

OAuth2 Authorization – Connect with multiple identity providers seamlessly
JWT Token Issuance – Signed tokens for API calls
Webhooks – Real-time event notifications
Role & Permission Management – Fine-grained access control
Session Management – Track and revoke sessions securely

INFO

All requests to the API are made over HTTPS and must be authenticated using an access token.

Common Use Cases

Authenticating users in web or mobile apps
Linking accounts across multiple platforms
Securing API endpoints with verified identities
Managing multi-role systems with permissions

Core Concepts

Applications – Your registered projects on auth.hawaiian.gg
Clients – Your app’s credentials (Client ID & Secret)
Scopes – Permissions you can request during OAuth2 authorization
Tokens – Access and refresh tokens used for API calls
Webhooks – Event notifications for user actions

Developer Integration Flow

mermaid

sequenceDiagram
    autonumber
    participant User
    participant YourApp
    participant auth.hawaiian.gg
    User->>YourApp: Click "Sign in"
    YourApp->>auth.hawaiian.gg: Redirect to OAuth2 URL
    User->>auth.hawaiian.gg: Authenticate & consent
    auth.hawaiian.gg->>YourApp: Redirect with auth code
    YourApp->>auth.hawaiian.gg: Exchange code for tokens
    auth.hawaiian.gg->>YourApp: Return access & refresh tokens
    YourApp->>auth.hawaiian.gg: API calls with access token

WARNING

Never expose your Client Secret in frontend code. Keep it secure on the server side.

Introduction ​

What is auth.hawaiian.gg? ​

Key Features ​

Common Use Cases ​

Core Concepts ​