Skip to content

Cbox ID documentation

Cbox ID documentation

Cbox ID is an identity platform: sign-in, organizations, Enterprise SSO, Directory Sync, API keys, App audit logs and an Admin Portal for your customers' IT admins, with every change reachable from the console, a REST API, an MCP server and the cbox CLI.

Start here

Sign in to your first app in under ten minutes. Pick your framework: Next.js · React · Laravel · Nuxt · Go · Python. Each one creates the app, installs the SDK, and walks through sign-in, the callback, a protected route and sign-out.

Then read Workspaces & organizations: five minutes on how your workspace, projects, environments and your customers' organizations fit together saves an afternoon later.

By what you are doing

You are… Go to
building an app that signs people in Quickstarts, then Getting started
selling to enterprises: SSO, SCIM, audit logs Enterprise SSO, Directory Sync, App audit logs, Admin Portal
wiring an AI agent to Cbox ID Agents and MCP, Actions, Step-up approvals, Actions reference
automating from a backend or CI Keys and tokens, Run your tenancy from your backend, Actions reference
administering an environment in the console Admin guides
a customer's IT admin holding an Admin Portal link For IT admins
running Cbox ID yourself Self-hosting

Sections

  • Quickstarts — zero to first sign-in, per framework.
  • Concepts — the hierarchy, planes and hosts, keys versus delegated tokens, actions ("one action, four doors"), approvals, and the two audit records.
  • Getting started — the next layer after the first sign-in: registering apps, organizations in your app, CLIs, customer API keys, the management API.
  • Admin guides — one per console page, linked from the "?" beside each page title.
  • For IT admins — for your customers' IT administrators: what an Admin Portal link lets them do, with setup guides for Okta, Microsoft Entra ID, Google Workspace and generic SAML, OIDC and SCIM.
  • Reference — every action per plane, and the OpenAPI documents.
  • Self-hosting — install, configure, deploy and operate it. Configuration, Operations and Security are the operator manual.

The framework underneath

Cbox ID is the deployable app built on the cboxdk/laravel-id framework, which provides the identity engine: crypto, tenancy, OAuth and OpenID Connect, SAML, SCIM, audit. The protocol level is documented with the framework, at github.com/cboxdk/laravel-id. References into it are canonical URLs, never relative paths: the two are separate repositories.

The console is Inertia and React over server-rendered props, with session-cookie auth and no tokens in the browser, because it is the sign-in surface.