# AUTO-GENERATED tier-A mirror spec — do not edit.
# Source: openapi/runtime/oauth-connections.yaml (runtime 0.124.0)
#  + policy: openapi/mirror-policies/oauth-connections.json
# Regenerate: node scripts/generate-mirror-specs.mjs
openapi: 3.0.3
info:
  title: naturali.ai — OAuth Connections API
  version: 1.0.0
  description: >-
    OAuth connections: one actor's grant at a provider through an OAuth client. The runtime runs the
    authorization code flow, keeps the tokens encrypted and refreshes them; no route returns a
    token. A fully runtime-backed module — this spec is generated verbatim from the runtime's own,
    re-rooted under /v1/projects/{project_id}. The project in the path is authorized by naturali and
    enforced upstream by the project's scoped credential.


    This module mirrors the upstream runtime verbatim (tier A): paths are the runtime's own
    re-rooted under /v1/projects/{project_id}, and every field, method, status code and error shape
    passes through unchanged. Errors raised by the runtime arrive in its envelope; errors raised by
    naturali itself (authentication, project resolution, an unreachable runtime) use naturali's.
  contact:
    name: naturali.ai
    url: https://naturali.ai
servers:
  - url: "{baseUrl}"
    description: Host of your naturali.ai deployment; every path carries the /v1 prefix.
    variables:
      baseUrl:
        description: Base host URL.
        default: https://api.naturali.ai
tags:
  - name: Oauth Connections
    description: Connect actors to third-party providers
security:
  - bearerAuth: []
  - oauth2:
      - mcp:access
paths:
  /v1/projects/{project_id}/oauth-connections:
    get:
      tags:
        - Oauth Connections
      summary: List OAuth connections
      description: Returns a project's OAuth connections, without tokens.
      operationId: listOauthConnections
      parameters:
        - name: actor_id
          in: query
          description: Only this actor's connections
          schema:
            type: string
            example: actor_V1StGXR8Z5jdHi6B
        - name: oauth_client_id
          in: query
          description: Only connections through this OAuth client
          schema:
            type: string
            example: oauc_V1StGXR8Z5jdHi6B
        - $ref: "#/components/parameters/Limit"
        - $ref: "#/components/parameters/Cursor"
      responses:
        "200":
          description: OAuth connections
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/Page"
                  - properties:
                      data:
                        type: array
                        items:
                          $ref: "#/components/schemas/OauthConnection"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/ProjectNotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalError"
    post:
      tags:
        - Oauth Connections
      summary: Start an OAuth connection
      description: "Starts the authorization of an actor through an OAuth client and returns the
        `authorize_url` to send the person to; it is single-use and expires after 10 minutes.
        Starting again for the same actor and client restarts the same connection (`200`), and a
        connected one keeps its tokens until the new authorization completes. Hand the
        `authorize_url` only to the person the actor is: whoever consents connects their account to
        that actor."
      operationId: createOauthConnection
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
                - oauth_client_id
                - actor_id
              properties:
                oauth_client_id:
                  x-naturali-ref: oauth-clients
                  type: string
                  description: The OAuth client to connect through.
                  example: oauc_V1StGXR8Z5jdHi6B
                actor_id:
                  x-naturali-ref: actors
                  type: string
                  description: The actor the grant is for.
                  example: actor_V1StGXR8Z5jdHi6B
                return_url:
                  type: string
                  description: Where the callback redirects the person's browser when it completes, with
                    `oauth_connection_id` and `status` (`connected` or `failed`) added to its query.
                  example: https://app.example.com/settings/connections
      responses:
        "200":
          description: The existing connection, restarted
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/StartedOauthConnection"
        "201":
          description: The new pending connection
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/StartedOauthConnection"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/ProjectNotFound"
        "413":
          $ref: "#/components/responses/PayloadTooLarge"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalError"
        "502":
          $ref: "#/components/responses/AdmissionUnavailable"
        4XX:
          $ref: "#/components/responses/AdmissionRefused"
    parameters:
      - $ref: "#/components/parameters/ProjectId"
  /v1/projects/{project_id}/oauth-connections/{oauth_connection_id}:
    parameters:
      - name: oauth_connection_id
        in: path
        required: true
        description: OAuth connection ID
        schema:
          type: string
          example: ocon_V1StGXR8Z5jdHi6B
      - $ref: "#/components/parameters/ProjectId"
    get:
      tags:
        - Oauth Connections
      summary: Get an OAuth connection
      description: Returns the connection's status, without tokens.
      operationId: getOauthConnection
      responses:
        "200":
          description: The OAuth connection
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OauthConnection"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalError"
    delete:
      tags:
        - Oauth Connections
      summary: Delete an OAuth connection
      description: Revokes the grant at the provider's `revocation_url`, when the client has one, and
        deletes the connection. A failed revocation does not stop the deletion.
      operationId: deleteOauthConnection
      responses:
        "204":
          description: Deleted
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalError"
        "502":
          $ref: "#/components/responses/AdmissionUnavailable"
        4XX:
          $ref: "#/components/responses/AdmissionRefused"
components:
  schemas:
    OauthConnection:
      type: object
      properties:
        id:
          type: string
          example: ocon_V1StGXR8Z5jdHi6B
        project_id:
          x-naturali-ref: projects
          type: string
          example: proj_V1StGXR8Z5jdHi6B
        oauth_client_id:
          x-naturali-ref: oauth-clients
          type: string
          example: oauc_V1StGXR8Z5jdHi6B
        actor_id:
          x-naturali-ref: actors
          type: string
          example: actor_V1StGXR8Z5jdHi6B
        status:
          type: string
          enum:
            - pending
            - connected
            - disconnected
          description: "`pending` until the first authorization completes; `connected` while tool calls can
            use it; `disconnected` after a refused authorization or refresh, until the actor
            connects again."
        scopes:
          type: array
          items:
            type: string
          description: The scopes the provider granted.
        expires_at:
          type: string
          format: date-time
          nullable: true
          description: When the current access token expires; it is refreshed before use.
        connected_at:
          type: string
          format: date-time
          nullable: true
        error:
          nullable: true
          description: Why the last authorization or refresh failed.
          allOf:
            - $ref: "#/components/schemas/StoredError"
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    StartedOauthConnection:
      allOf:
        - $ref: "#/components/schemas/OauthConnection"
        - type: object
          properties:
            authorize_url:
              type: string
              description: Where to send the person to consent.
              example: https://x.com/i/oauth2/authorize?response_type=code&client_id=Tm9ZWdEX2hQ&state=...
            authorize_url_expires_at:
              type: string
              format: date-time
    Page:
      type: object
      description: One page of a list. Rows inserted or removed between two calls neither repeat nor skip
        a row on the next page.
      required:
        - data
        - next_cursor
      properties:
        data:
          type: array
          description: This page's items, in the list's order.
          items: {}
        next_cursor:
          type: string
          nullable: true
          description: Pass as `cursor` to fetch the next page; `null` on the last page.
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          description: Structured error. Every error response uses this shape, so `code` can be read without
            first checking the type of `error`.
          required:
            - code
            - message
            - hint
          properties:
            code:
              type: string
              pattern: ^[A-Z][A-Z0-9_]*$
              description: Machine-readable error code, UPPER_SNAKE whether naturali or the runtime raises it.
              example: FORBIDDEN
            message:
              type: string
              description: Human-readable explanation.
              example: Your role in this project does not carry this action.
            hint:
              type: string
              description: What to do about it, naming the routes of this API to call. For people and agents; it
                may change, so branch on `code`.
              example: Use a credential whose scope includes this action, or ask a project `admin` or `owner` to
                act; the caller's role or key excludes it.
            meta:
              type: object
              additionalProperties: true
              description: Structured context, such as the `resource` and `limit` of a `PLAN_LIMIT_REACHED`.
    StoredError:
      type: object
      description: Why a resource's work failed, in the shape of an error response's `error` without
        `hint`. Every `error` field a resource records carries it, so `code` can be read without
        first checking the type of `error`.
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: A key from the server's ERROR_CODES registry, documented on the Error Codes page.
            `INTERNAL_ERROR`, with the message `Internal Server Error`, records an unexpected
            failure whose detail reaches the server log only.
          example: AI_PROVIDER_ERROR
        message:
          type: string
          example: "Provider returned 402: insufficient credits"
        meta:
          type: object
          additionalProperties: true
          description: The failure's own structured context, when it names any.
  parameters:
    ProjectId:
      name: project_id
      in: path
      required: true
      description: Project public ID (proj_ prefix).
      schema:
        type: string
        example: proj_V1StGXR8Z5jdHi6B
    Limit:
      name: limit
      in: query
      required: false
      description: Results per page, 1 to 100 (default 50). Above 100 it is clamped; below 1 or not an
        integer it is `400`.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
    Cursor:
      name: cursor
      in: query
      required: false
      description: The previous page's `next_cursor`; omit it for the first page. A cursor this list did
        not issue is `400`.
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: A naturali API key (nat_sk_…) or a session JWT.
    oauth2:
      type: oauth2
      description: "A connected app's OAuth access token, issued by this API's authorization server
        (discovery: /.well-known/oauth-authorization-server). Its one scope carries every operation,
        confined to the projects the user chose when approving the app."
      flows:
        authorizationCode:
          authorizationUrl: https://api.naturali.ai/authorize
          tokenUrl: https://api.naturali.ai/token
          refreshUrl: https://api.naturali.ai/token
          scopes:
            mcp:access: Every operation this API serves, on the projects the grant covers.
  responses:
    BadRequest:
      description: The request was malformed or failed validation.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    Unauthorized:
      description: Missing or invalid credentials.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    Forbidden:
      description: The credential is scoped to a different project, or the caller's role in the project
        does not carry this action.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    TooManyRequests:
      description: "`QUOTA_EXCEEDED` — a `requests` quota on the calling API key or its project is spent
        for the window; `Retry-After` says when it reopens"
      headers:
        Retry-After:
          description: Seconds until the quota window admits a request again
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    InternalError:
      description: Unexpected server error — `INTERNAL_ERROR`, with the raw message never forwarded
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    PayloadTooLarge:
      description: "`REQUEST_REJECTED` — the request body is over the size the body parser accepts"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    AdmissionUnavailable:
      description: The deployment's admission service is asked about this write and did not answer —
        `ADMISSION_UNAVAILABLE`; the write did not happen
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    AdmissionRefused:
      description: The deployment's admission service refused this write — answered under the service's
        own `4xx` status, with its `code` (matching `^[A-Za-z_][A-Za-z0-9_]{0,63}$`, not necessarily
        an `ERROR_CODES` key), `message` and `meta`; the write did not happen. A status this
        operation also declares on its own is documented there
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    NotFound:
      description: The resource does not exist (existence is not leaked).
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    ProjectNotFound:
      description: The project does not exist or the caller is not a member of it (`RESOURCE_NOT_FOUND`).
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
