AxAxolite Docs
DocsStarter

Quickstart

Get Axolite live with Teams, Clients, Modules, and Microsoft auth.

Before you begin

RequirementWhy it matters
Dashboard accountTeam owner creates and manages resources
TeamOwns clients and servers
Stored credentialsKeep client_secret server-side only

Resource hierarchy

User (Team Owner) -> Team -> Client/Server -> Client Modules

  • Current client module: ms_auth
  • Current server capability: create and manage servers (single or network)

Minimal checks

curl https://api.axolite.dev/health

First integration path (client)

  1. Create a client with /client/apps.
  2. Enable module with /client/apps/:client_id/modules/ms-auth.
  3. Start auth with /client/ms-auth/start.
  4. Open returned auth_url.
  5. Handle callback on Axolite and finalize consent with /client/ms-auth/authorize.
  6. Poll status with /client/ms-auth/poll and validate session via /client/ms-auth/session/validate.

First integration path (server)

Use /server/servers and choose:

  • kind: "single" for one standalone server
  • kind: "network" with network_name for grouped network setups

Example: start MS auth

curl -X POST https://api.axolite.dev/client/ms-auth/start \
  -H "content-type: application/json" \
  -d '{"client_id":"<client_uuid>","client_secret":"<client_secret>"}'

Troubleshooting

  • 401 means invalid client credentials or expired auth request.
  • 400 on server creation with network means network_name is missing.
  • 400 on MS auth start means module not enabled for that client.
StartEnd