---
title: API reference
path: reference/api
status: published
---

# API reference

Comprehensive reference for every ScaiKey API endpoint, organized by resource area. Each page is self-contained — endpoint signatures, parameters, request and response shapes, and the full schema definitions referenced.

If you spot drift between these pages and the running platform, regenerate from `_generate_api_reference.py` against the current backend.

## Endpoint groups

| Group | Endpoints |
|---|---|
| [Admin Auth](/docs/scaikey/reference/api/admin-auth) | 4 |
| [Admin Roles](/docs/scaikey/reference/api/admin-roles) | 6 |
| [App Assignments](/docs/scaikey/reference/api/app-assignments) | 9 |
| [Applications](/docs/scaikey/reference/api/applications) | 7 |
| [Audit](/docs/scaikey/reference/api/audit) | 5 |
| [Authentication](/docs/scaikey/reference/api/authentication) | 9 |
| [Authorized Apps](/docs/scaikey/reference/api/authorized-apps) | 2 |
| [Custom Attributes](/docs/scaikey/reference/api/custom-attributes) | 5 |
| [Dashboard](/docs/scaikey/reference/api/dashboard) | 2 |
| [Federation](/docs/scaikey/reference/api/federation) | 12 |
| [Groups](/docs/scaikey/reference/api/groups) | 19 |
| [Identity Providers](/docs/scaikey/reference/api/identity-providers) | 18 |
| [MCP Agents](/docs/scaikey/reference/api/mcp-agents) | 7 |
| [MFA](/docs/scaikey/reference/api/mfa) | 11 |
| [OIDC](/docs/scaikey/reference/api/oidc) | 11 |
| [Organizational Units](/docs/scaikey/reference/api/organizational-units) | 7 |
| [Partners](/docs/scaikey/reference/api/partners) | 5 |
| [Platform OAuth](/docs/scaikey/reference/api/platform-oauth) | 10 |
| [Platform Settings](/docs/scaikey/reference/api/platform-settings) | 4 |
| [Portal Auth](/docs/scaikey/reference/api/portal-auth) | 6 |
| [Profile](/docs/scaikey/reference/api/profile) | 4 |
| [Registration Requests](/docs/scaikey/reference/api/registration-requests) | 6 |
| [SCIM 2.0](/docs/scaikey/reference/api/scim) | 18 |
| [SCIM Bulk](/docs/scaikey/reference/api/scim-bulk) | 1 |
| [SCIM Groups](/docs/scaikey/reference/api/scim-groups) | 6 |
| [SCIM Tokens](/docs/scaikey/reference/api/scim-tokens) | 6 |
| [SCIM Users](/docs/scaikey/reference/api/scim-users) | 6 |
| [Sessions](/docs/scaikey/reference/api/sessions) | 14 |
| [Tenants](/docs/scaikey/reference/api/tenants) | 5 |
| [Users](/docs/scaikey/reference/api/users) | 17 |
| [Webhooks](/docs/scaikey/reference/api/webhooks) | 12 |
| [public](/docs/scaikey/reference/api/public) | 4 |
| [registration](/docs/scaikey/reference/api/registration) | 4 |

## What's not on this page

- **MCP Server tools** — the 96 MCP-tool endpoints for AI agent integrations aren't documented here. They're a separate surface and warrant their own page family.
- **Internal endpoints** — `/_internal/*` is platform-internal and not part of the public contract.

## Authentication

Every endpoint uses Bearer JWT. To obtain a token, see [Quickstart](/docs/scaikey/quickstart) for service-to-service or [Tutorials](/docs/scaikey/tutorials) for the user-facing flow.

## Cross-cutting reference pages

- [OAuth endpoints](/docs/scaikey/reference/oauth-endpoints) — authorize / token / userinfo / discovery / jwks / end_session, both platform and tenant flavors.
- [Admin API overview](/docs/scaikey/reference/admin-api) — the conceptual map of admin resources and access tiers.
- [Webhooks](/docs/scaikey/reference/webhooks) — receiving-side spec for the events ScaiKey emits.