Skip to content

Clients

Overview

A client is an application identity that connects to an Oblax project’s API. Every client receives a clientAppId that identifies it within the platform. Clients use this ID to authenticate, manage sessions, and interact with project resources through the SDK or REST API.

When you register a client for a project, the platform creates an application entry that holds the client’s configuration, authentication settings, and access scopes. The clientAppId is used in SDK initialization and API requests to route traffic to the correct project.


Client Identity

Each client is identified by a clientAppId — a unique string that maps to your project’s API endpoint. The SDK uses this ID to construct the correct request URL and attach the appropriate authentication headers.

const oblax = new Oblax({
  clientAppId: 'literate-camel-cnoqeve3lg59f9urb2j0',
  platform: browserPlatform(),
  modules: [session(), bookmarks()],
});

The clientAppId is project-scoped. A single project can have multiple clients, each with different module configurations and access scopes.


Client Types

TypeUse CaseAuthentication
Web ApplicationBrowser-based frontendSession-based JWT with auto-refresh
Mobile ApplicationiOS or Android native appSession-based JWT with platform-specific storage
Server-side ApplicationBackend service or cron jobStatic JWT or service account token
CLI ToolDeveloper workstationCLI session token

Client and Project Relationship

A client belongs to exactly one project. The project defines which modules the client can access, and the ACL rules determine which endpoints the client’s tokens can reach.

Project
  ├── Client A (webapp) → Forms, Bookmarks, Auth
  ├── Client B (mobile) → Bookmarks, Auth
  └── Client C (server) → Flux Scripts, Storage

Each client operates within the project’s environment. A client configured for staging cannot access production resources unless explicitly reconfigured.


Where to next

SectionDescription
Authentication and AuthorizationUnderstand how clients authenticate using JWTs
ACL and PermissionsControl which client tokens can access which endpoints
RealmsScope client access using security domains