robosystems-ai Auth API

openapi: 3.2.0
info:
  title: RoboSystems Auth API
  description: 'The REST and GraphQL API for RoboSystems — an open-source, AI-native platform for accounting, financial reporting and investment management. It powers RoboLedger and RoboInvestor.


    ## Two surfaces


    **Platform** — `/v1/…` — graphs, queries, schema, documents, search, memory, connections, billing and access. Reads are REST `GET`s; every write is a named operation at `/operations/{name}` returning an `OperationEnvelope`, accepting an `Idempotency-Key`, and streaming progress at `/v1/operations/{id}/stream`.

    → API reference


    **Extensions** — `/extensions/…` — RoboLedger and RoboInvestor, scoped by `graph_id` in the URL. Reads are GraphQL at `POST /extensions/{graph_id}/graphql` and change nothing; writes are named operations at `/extensions/{domain}/{graph_id}/operations/{name}`; analytical views read the materialized graph.

    → Extensions reference · every GraphQL query


    ## Authenticating


    `X-API-Key: rfs…` on REST, GraphQL and per-graph MCP. Browser sessions use JWTs from `POST /v1/auth/login`. The graph-agnostic MCP endpoint `/v1/mcp` takes OAuth 2.1 bearer tokens only.


    ## Connecting an AI client


    Every graph is an MCP server at `POST /v1/graphs/{graph_id}/mcp`, and `POST /v1/mcp` serves OAuth clients that pick their graph at consent.

    → MCP guide


    ## Clients


    `robosystems-client` for Python, `@robosystems/client` for TypeScript.

    → Guides · Technical docs'
  version: 1.20.6
tags:
- name: Auth
  description: 🔐 Authentication - Register, sign in, manage the session, verify email, and reset passwords
paths:
  /v1/auth/register:
    post:
      tags:
      - Auth
      summary: Register New User
      description: Creates the user and a personal organization. CAPTCHA required in production. Sends verification email when email verification is enabled.
      operationId: registerUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterRequest'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Email already registered
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Registration temporarily disabled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/auth/login:
    post:
      tags:
      - Auth
      summary: User Login
      description: Returns a JWT token on success. IP-based progressive delays apply after repeated failures.
      operationId: loginUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoginRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/auth/logout:
    post:
      tags:
      - Auth
      summary: User Logout
      operationId: logoutUser
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Logoutuser
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/auth/me:
    get:
      tags:
      - Auth
      summary: Get Current User
      operationId: getCurrentAuthUser
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Getcurrentauthuser
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/auth/refresh:
    post:
      tags:
      - Auth
      summary: Refresh Session
      description: Revokes the current token and issues a new one. Accepts recently-expired tokens within the grace period.
      operationId: refreshAuthSession
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/auth/email/resend:
    post:
      tags:
      - Auth
      summary: Resend Email Verification
      description: Resend verification email to the authenticated user. Rate limited to 3 per hour.
      operationId: resendVerificationEmail
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Resendverificationemail
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Email service unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/auth/email/verify:
    post:
      tags:
      - Auth
      summary: Verify Email
      description: Verify email address with token from email link. Returns JWT for auto-login.
      operationId: verifyEmail
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailVerificationRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/auth/invitations/{token}:
    get:
      tags:
      - Auth
      summary: Preview Invitation
      description: Look up a pending org invitation by its token so the registration page can show what is being joined. Returns 404 for unknown, expired, revoked, or accepted tokens.
      operationId: getInvitationPreview
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
          title: Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvitationPreviewResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/auth/password/policy:
    get:
      tags:
      - Auth
      summary: Get Password Policy
      operationId: getPasswordPolicy
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordPolicyResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/auth/password/check:
    post:
      tags:
      - Auth
      summary: Check Password Strength
      operationId: checkPasswordStrength
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordCheckRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordCheckResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/auth/password/forgot:
    post:
      tags:
      - Auth
      summary: Forgot Password
      description: Request password reset email. Always returns success to prevent email enumeration.
      operationId: forgotPassword
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ForgotPasswordRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Forgotpassword
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/auth/password/reset/validate:
    get:
      tags:
      - Auth
      summary: Validate Reset Token
      description: Check if a password reset token is valid without consuming it. Returns masked email on success.
      operationId: validateResetToken
      parameters:
      - name: token
        in: query
        required: true
        schema:
          type: string
          description: Password reset token
          title: Token
        description: Password reset token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResetPasswordValidateResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/auth/password/reset:
    post:
      tags:
      - Auth
      summary: Reset Password
      description: Reset password with token from email. Invalidates all existing sessions. Returns JWT for auto-login.
      operationId: resetPassword
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResetPasswordRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/auth/captcha/config:
    get:
      tags:
      - Auth
      summary: Get CAPTCHA Configuration
      description: Returns site key and whether CAPTCHA is required. Site key is null when CAPTCHA is disabled.
      operationId: getCaptchaConfig
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/auth/providers:
    get:
      tags:
      - Auth
      summary: Get Auth Providers
      description: Returns which authentication methods this deployment offers. The login surface renders its posture from this instead of hardcoding methods.
      operationId: getAuthProviders
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthProvidersResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ForgotPasswordRequest:
      properties:
        email:
          type: string
          format: email
          title: Email
          description: Email address to send reset link
      type: object
      required:
      - email
      title: ForgotPasswordRequest
      description: Forgot password request model.
    LoginRequest:
      properties:
        email:
          type: string
          format: email
          title: Email
          description: User's email address
        password:
          type: string
          minLength: 8
          title: Password
          description: User's password
      type: object
      required:
      - email
      - password
      title: LoginRequest
      description: Login request model.
    InvitationPreviewResponse:
      properties:
        org_name:
          type: string
          title: Org Name
        email:
          type: string
          title: Email
        role:
          $ref: '#/components/schemas/OrgRole'
        expires_at:
          type: string
          format: date-time
          title: Expires At
      type: object
      required:
      - org_name
      - email
      - role
      - expires_at
      title: InvitationPreviewResponse
      description: Public preview of an invitation, looked up by its token.
    PasswordCheckResponse:
      properties:
        is_valid:
          type: boolean
          title: Is Valid
          description: Whether password meets requirements
        strength:
          type: string
          title: Strength
          description: Password strength level
        score:
          type: integer
          title: Score
          description: Password strength score (0-100)
        errors:
          items:
            type: string
          type: array
          title: Errors
          description: Validation errors
        suggestions:
          items:
            type: string
          type: array
          title: Suggestions
          description: Improvement suggestions
        character_types:
          additionalProperties:
            type: boolean
          type: object
          title: Character Types
          description: Character type analysis
      type: object
      required:
      - is_valid
      - strength
      - score
      - errors
      - suggestions
      - character_types
      title: PasswordCheckResponse
      description: Password strength check response model.
    OIDCProviderInfo:
      properties:
        enabled:
          type: boolean
          title: Enabled
          description: Whether OIDC SSO is available
        provider_label:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider Label
          description: Display label for the OIDC provider (e.g. 'Okta')
      type: object
      required:
      - enabled
      title: OIDCProviderInfo
      description: OIDC provider availability model.
    RegisterRequest:
      properties:
        name:
          type: string
          maxLength: 100
          minLength: 1
          title: Name
          description: User's display name
        email:
          type: string
          format: email
          title: Email
          description: User's email address
        password:
          type: string
          maxLength: 128
          minLength: 12
          title: Password
          description: User's password (must meet security requirements)
        captcha_token:
          anyOf:
          - type: string
          - type: 'null'
          title: Captcha Token
          description: CAPTCHA verification token (required in production)
        invite_token:
          anyOf:
          - type: string
          - type: 'null'
          title: Invite Token
          description: Org invitation token from an invitation email. When present, the new user joins the inviting organization at the invited role instead of receiving a personal organization.
      type: object
      required:
      - name
      - email
      - password
      title: RegisterRequest
      description: Registration request model.
    PasswordCheckRequest:
      properties:
        password:
          type: string
          maxLength: 128
          minLength: 1
          title: Password
          description: Password to check
        email:
          anyOf:
          - type: string
          - type: 'null'
          title: Email
          description: User email for personalization checks
      type: object
      required:
      - password
      title: PasswordCheckRequest
      description: Password strength check request model.
    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
    PasswordPolicyResponse:
      properties:
        policy:
          additionalProperties: true
          type: object
          title: Policy
          description: Current password policy requirements
      type: object
      required:
      - policy
      title: PasswordPolicyResponse
      description: Password policy response model.
    ResetPasswordRequest:
      properties:
        token:
          type: string
          title: Token
          description: Password reset token from email link
        new_password:
          type: string
          maxLength: 128
          minLength: 12
          title: New Password
          description: New password (must meet security requirements)
      type: object
      required:
      - token
      - new_password
      title: ResetPasswordRequest
      description: Reset password request model.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ResetPasswordValidateResponse:
      properties:
        valid:
          type: boolean
          title: Valid
          description: Whether the token is valid
        email:
          anyOf:
          - type: string
          - type: 'null'
          title: Email
          description: Masked email address if token is valid
      type: object
      required:
      - valid
      title: ResetPasswordValidateResponse
      description: Password reset token validation response model.
    OrgRole:
      type: string
      enum:
      - owner
      - admin
      - member
      title: OrgRole
    AuthResponse:
      properties:
        user:
          additionalProperties: true
          type: object
          title: User
          description: User information
        org:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Org
          description: Organization information (personal org created automatically on registration)
        message:
          type: string
          title: Message
          description: Success message
        status:
          type: string
          enum:
          - authenticated
          - mfa_required
          - mfa_enrollment_required
          title: Status
          description: 'Login flow state: authenticated (token present), or a passkey MFA step is required before a session is issued (mfa_token present)'
          default: authenticated
        mfa_token:
          anyOf:
          - type: string
          - type: 'null'
          title: Mfa Token
          description: Short-lived token authorizing the MFA second step or forced enrollment; present only when status is not 'authenticated'
        token:
          anyOf:
          - type: string
          - type: 'null'
          title: Token
          description: JWT authentication token (optional for cookie-based auth)
        expires_in:
          anyOf:
          - type: integer
          - type: 'null'
          title: Expires In
          description: Token expiry time in seconds from now
        refresh_threshold:
          anyOf:
          - type: integer
          - type: 'null'
          title: Refresh Threshold
          description: Recommended refresh threshold in seconds before expiry
      type: object
      required:
      - user
      - message
      title: AuthResponse
      description: Authentication response model.
    ErrorResponse:
      properties:
        detail:
          type: string
          title: Detail
          description: Human-readable error message explaining what went wrong
          examples:
          - Insufficient credits for operation
        code:
          anyOf:
          - type: string
          - type: 'null'
          title: Code
          description: Machine-readable error code for programmatic handling
          examples:
          - INSUFFICIENT_CREDITS
        request_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Request Id
          description: Unique request ID for tracking and debugging
          examples:
          - req_1234567890abcdef
        timestamp:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Timestamp
          description: Timestamp when the error occurred
          examples:
          - '2024-01-01T00:00:00Z'
      type: object
      required:
      - detail
      title: ErrorResponse
      description: Error body returned by every endpoint.
      example:
        code: RESOURCE_NOT_FOUND
        detail: Resource not found
        request_id: req_1234567890abcdef
        timestamp: '2024-01-01T00:00:00Z'
    EmailVerificationRequest:
      properties:
        token:
          type: string
          title: Token
          description: Email verification token from email link
      type: object
      required:
      - token
      title: EmailVerificationRequest
      description: Email verification request model.
    AuthProvidersResponse:
      properties:
        password_auth:
          type: boolean
          title: Password Auth
          description: Whether password authentication is available
        oidc:
          $ref: '#/components/schemas/OIDCProviderInfo'
          description: OIDC SSO availability
        registration:
          type: boolean
          title: Registration
          description: Whether self-service registration is open
        passkeys:
          type: boolean
          title: Passkeys
          description: Whether passkey authentication is available
      type: object
      required:
      - password_auth
      - oidc
      - registration
      - passkeys
      title: AuthProvidersResponse
      description: 'Auth posture response model.


        Describes which authentication methods this deployment offers so the

        login surface can render the correct posture from runtime configuration.'
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT bearer token