SDK Reference

@ghayma/sdk is the runtime SDK for apps running on Ghayma — the code your app calls at runtime, not the code that builds your infrastructure. It is one package with two entry points.

One package, two entry points

Building a mobile app? ghayma_auth is the same client for Dart and Flutter — its own package on pub.dev, with the browser entry’s endpoints, error codes and session handling in Dart idioms.

Server-side in PHP or Laravel? ghayma/sdk covers both the admin API and end-user auth.

One install covers both:

npm install @ghayma/sdk

pnpm add @ghayma/sdk

yarn add @ghayma/sdk

bun add @ghayma/sdk

// Server — this half holds the key, so it never ships to a browser
import { Ghayma } from "@ghayma/sdk";
const ghayma = new Ghayma({ apiKey: process.env.GHAYMA_API_KEY });
const { users } = await ghayma.auth.listUsers("my-app");
 
// Browser — authenticates with the app slug alone
import { GhaymaAuth } from "@ghayma/sdk/client";
const auth = new GhaymaAuth({ appSlug: "my-app" });
await auth.login({ email, password });

Creating, deleting and resizing infrastructure is not in the SDK: buckets, databases and auth apps live in the console  and the ghayma CLI. A project whose code runs elsewhere — a mobile app, or a backend you host yourself — needs no site either: answer No site at ghayma init.

Minimum versions for 2FA

Since 2026-09-30 the auth service applies an app’s 2FA policy to Google and GitHub sign-in as well as to the password login (how). These versions surface the pending second factor from their OAuth methods as a typed error: