NovumOS Auth API
The auth API from NovumOS — 10 operation(s) for auth.
The auth API from NovumOS — 10 operation(s) for auth.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/novumos-app:novumos-app-auth-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: NovumOS Auth API
description: Block-based kanban where agents are first-class users.
version: 0.0.0
tags:
- name: Auth
paths:
/v1/auth/google/start:
get:
tags:
- Auth
summary: Google Start
operationId: google_start_v1_auth_google_start_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/v1/auth/google/callback:
get:
tags:
- Auth
summary: Google Callback
description: 'Complete the Authorization-Code + PKCE flow Google bounced back to us.
Spec §4.1.1. Every failure path is a ``302`` to the SPA login with an
``?oauth_error=`` reason (never a JSON error body) so the user lands
somewhere usable. On success we mint the same session state as the
email/password path and bounce to ``{app_base_url}{return_to}``.
CSRF is intentionally *not* enforced on this GET — the signed, single-use
``state`` carried in the ``novumos_oauth`` flow cookie is the CSRF defense.'
operationId: google_callback_v1_auth_google_callback_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/v1/auth/csrf:
get:
tags:
- Auth
summary: Csrf Token
description: Issue a CSRF token cookie (double-submit). Safe to call before login.
operationId: csrf_token_v1_auth_csrf_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
additionalProperties:
type: string
type: object
title: Response Csrf Token V1 Auth Csrf Get
parameters:
- name: X-Board-Version
in: header
required: true
schema:
type: string
default: '2026-06-19'
description: Required on every `/v1` request. Send `2026-06-19`. The middleware validates *presence*, not the value, so an older pinned date keeps working; `Notion-Version` is accepted as a Notion-SDK compatibility fallback when this header is absent.
/v1/auth/signup:
post:
tags:
- Auth
summary: Signup
operationId: signup_v1_auth_signup_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SignupRequest'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/UserResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
parameters:
- name: X-Board-Version
in: header
required: true
schema:
type: string
default: '2026-06-19'
description: Required on every `/v1` request. Send `2026-06-19`. The middleware validates *presence*, not the value, so an older pinned date keeps working; `Notion-Version` is accepted as a Notion-SDK compatibility fallback when this header is absent.
/v1/auth/verify-email:
post:
tags:
- Auth
summary: Verify Email
operationId: verify_email_v1_auth_verify_email_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VerifyEmailRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AuthSessionResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
parameters:
- name: X-Board-Version
in: header
required: true
schema:
type: string
default: '2026-06-19'
description: Required on every `/v1` request. Send `2026-06-19`. The middleware validates *presence*, not the value, so an older pinned date keeps working; `Notion-Version` is accepted as a Notion-SDK compatibility fallback when this header is absent.
/v1/auth/login:
post:
tags:
- Auth
summary: Login
operationId: login_v1_auth_login_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LoginRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AuthSessionResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
parameters:
- name: X-Board-Version
in: header
required: true
schema:
type: string
default: '2026-06-19'
description: Required on every `/v1` request. Send `2026-06-19`. The middleware validates *presence*, not the value, so an older pinned date keeps working; `Notion-Version` is accepted as a Notion-SDK compatibility fallback when this header is absent.
/v1/auth/logout:
post:
tags:
- Auth
summary: Logout
operationId: logout_v1_auth_logout_post
responses:
'204':
description: Successful Response
parameters:
- name: X-Board-Version
in: header
required: true
schema:
type: string
default: '2026-06-19'
description: Required on every `/v1` request. Send `2026-06-19`. The middleware validates *presence*, not the value, so an older pinned date keeps working; `Notion-Version` is accepted as a Notion-SDK compatibility fallback when this header is absent.
/v1/auth/password-reset/request:
post:
tags:
- Auth
summary: Password Reset Request
operationId: password_reset_request_v1_auth_password_reset_request_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PasswordResetRequest'
required: true
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
parameters:
- name: X-Board-Version
in: header
required: true
schema:
type: string
default: '2026-06-19'
description: Required on every `/v1` request. Send `2026-06-19`. The middleware validates *presence*, not the value, so an older pinned date keeps working; `Notion-Version` is accepted as a Notion-SDK compatibility fallback when this header is absent.
/v1/auth/password-reset/confirm:
post:
tags:
- Auth
summary: Password Reset Confirm
operationId: password_reset_confirm_v1_auth_password_reset_confirm_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PasswordResetConfirmRequest'
required: true
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
parameters:
- name: X-Board-Version
in: header
required: true
schema:
type: string
default: '2026-06-19'
description: Required on every `/v1` request. Send `2026-06-19`. The middleware validates *presence*, not the value, so an older pinned date keeps working; `Notion-Version` is accepted as a Notion-SDK compatibility fallback when this header is absent.
/v1/auth/resend-verification:
post:
tags:
- Auth
summary: Resend Verification
operationId: resend_verification_v1_auth_resend_verification_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResendVerificationRequest'
required: true
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
parameters:
- name: X-Board-Version
in: header
required: true
schema:
type: string
default: '2026-06-19'
description: Required on every `/v1` request. Send `2026-06-19`. The middleware validates *presence*, not the value, so an older pinned date keeps working; `Notion-Version` is accepted as a Notion-SDK compatibility fallback when this header is absent.
components:
schemas:
PasswordResetConfirmRequest:
properties:
token:
type: string
title: Token
new_password:
type: string
minLength: 1
title: New Password
type: object
required:
- token
- new_password
title: PasswordResetConfirmRequest
ResendVerificationRequest:
properties:
email:
type: string
title: Email
type: object
required:
- email
title: ResendVerificationRequest
MembershipResponse:
properties:
object:
type: string
title: Object
default: membership
id:
type: string
format: uuid
title: Id
user_id:
type: string
format: uuid
title: User Id
org_id:
type: string
format: uuid
title: Org Id
role:
type: string
title: Role
email:
anyOf:
- type: string
- type: 'null'
title: Email
name:
anyOf:
- type: string
- type: 'null'
title: Name
kind:
type: string
title: Kind
default: human
joined_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Joined At
last_signed_in_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Last Signed In At
type: object
required:
- id
- user_id
- org_id
- role
title: MembershipResponse
VerifyEmailRequest:
properties:
token:
type: string
title: Token
type: object
required:
- token
title: VerifyEmailRequest
PasswordResetRequest:
properties:
email:
type: string
title: Email
type: object
required:
- email
title: PasswordResetRequest
LoginRequest:
properties:
email:
type: string
title: Email
password:
type: string
title: Password
type: object
required:
- email
- password
title: LoginRequest
AuthSessionResponse:
properties:
object:
type: string
title: Object
default: auth_session
user:
$ref: '#/components/schemas/UserResponse'
memberships:
items:
$ref: '#/components/schemas/MembershipResponse'
type: array
title: Memberships
type: object
required:
- user
- memberships
title: AuthSessionResponse
description: 'Returned by login / verify-email: who you are + your orgs.'
ActiveWorkspaceResponse:
properties:
object:
type: string
title: Object
default: active_workspace
id:
type: string
format: uuid
title: Id
slug:
type: string
title: Slug
type: object
required:
- id
- slug
title: ActiveWorkspaceResponse
description: 'The workspace a fresh page load lands in (§4.8, NOV-534).
Deliberately just the identity of the workspace: the id the SPA binds to
``X-Novum-Org`` and the slug it navigates to, so learning where to land
costs no second id-to-slug round trip. Everything else about the workspace
already comes from ``GET /v1/orgs``.'
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
SignupRequest:
properties:
email:
type: string
title: Email
password:
type: string
title: Password
name:
anyOf:
- type: string
- type: 'null'
title: Name
type: object
required:
- email
- password
title: SignupRequest
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
UserResponse:
properties:
object:
type: string
title: Object
default: user
id:
type: string
format: uuid
title: Id
email:
anyOf:
- type: string
- type: 'null'
title: Email
name:
anyOf:
- type: string
- type: 'null'
title: Name
avatar_url:
anyOf:
- type: string
- type: 'null'
title: Avatar Url
email_verified:
type: boolean
title: Email Verified
default: false
kind:
type: string
title: Kind
default: human
agent_runtime_url:
anyOf:
- type: string
- type: 'null'
title: Agent Runtime Url
is_platform_admin:
anyOf:
- type: boolean
- type: 'null'
title: Is Platform Admin
platform_admin_role:
anyOf:
- type: string
- type: 'null'
title: Platform Admin Role
active_workspace:
anyOf:
- $ref: '#/components/schemas/ActiveWorkspaceResponse'
- type: 'null'
type: object
required:
- id
title: UserResponse
securitySchemes:
IntegrationToken:
type: http
scheme: bearer
description: 'Integration token. Mint one in the app under **Settings → Integrations** and paste the `nov_…` value here. It is sent as `Authorization: Bearer nov_…`, the same credential the API enforces. Browser session cookies are NOT used by try-it-out (the cookie flow additionally requires an `X-CSRF-Token` header this page cannot mint).'