Overview

Authenticated tenant and platform administration API.

Authrim Admin API 0.5.0

Initial OpenAPI contract for the Authrim Admin API implemented by the @authrim/ar-management Worker. This document is safe to keep near the package because it describes externally observable HTTP contracts only. Do not add secrets, environment-specific credentials, vulnerability notes, or private operational runbooks here. When coordinated SAML DR export is enabled, every operation can additionally return HTTP 503 while source updates are paused or update admission is unavailable. This availability response has Content-Type text/plain;charset=UTF-8, Cache-Control no-store, Retry-After 5, and the body “Service temporarily unavailable” (no response body for HEAD). Clients may retry after the indicated delay; a failed response does not establish whether an earlier write completed.

Information

OpenAPI version: 3.2.0

Operations

Authentication

replicationExportCredential

A 256-bit grant-specific export credential issued once after fresh human MFA. Does not authorize ordinary Admin APIs.

Security scheme type: http

adminBearer

Admin API bearer token for headless/API usage.

Security scheme type: http

adminSessionCookie

Admin UI session cookie for browser usage.

Security scheme type: apiKey

Cookie parameter name: authrim_admin_session