# AUTO-GENERATED tier-A mirror spec — do not edit.
# Source: openapi/runtime/oauth-clients.yaml (runtime 0.124.0)
#  + policy: openapi/mirror-policies/oauth-clients.json
# Regenerate: node scripts/generate-mirror-specs.mjs
openapi: 3.0.3
info:
  title: naturali.ai — OAuth Clients API
  version: 1.0.0
  description: >-
    OAuth clients: the apps a project registers at third-party providers, through which its actors
    connect their accounts. 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 Clients
    description: Manage OAuth clients (your apps at third-party providers)
security:
  - bearerAuth: []
  - oauth2:
      - mcp:access
paths:
  /v1/projects/{project_id}/oauth-clients:
    get:
      tags:
        - Oauth Clients
      summary: List OAuth clients
      description: Returns the OAuth clients of a project.
      operationId: listOauthClients
      parameters:
        - $ref: "#/components/parameters/Limit"
        - $ref: "#/components/parameters/Cursor"
      responses:
        "200":
          description: OAuth clients
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/Page"
                  - properties:
                      data:
                        type: array
                        items:
                          $ref: "#/components/schemas/OauthClient"
        "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 Clients
      summary: Create an OAuth client
      description: Registers your app at a provider. `client_secret` is a `{{secret:sec_...}}` reference,
        and the caller needs `secrets:UseSecret` on it.
      operationId: createOauthClient
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
                - name
                - authorize_url
                - token_url
                - client_id
                - scopes
              properties:
                name:
                  type: string
                  description: A label for the client, such as the provider's name.
                  example: x
                authorize_url:
                  $ref: "#/components/schemas/AuthorizeUrl"
                token_url:
                  $ref: "#/components/schemas/TokenUrl"
                revocation_url:
                  $ref: "#/components/schemas/RevocationUrl"
                client_id:
                  $ref: "#/components/schemas/ClientId"
                client_secret:
                  $ref: "#/components/schemas/ClientSecret"
                scopes:
                  $ref: "#/components/schemas/Scopes"
                pkce:
                  $ref: "#/components/schemas/Pkce"
                token_endpoint_auth_method:
                  $ref: "#/components/schemas/TokenEndpointAuthMethod"
                redirect_uri:
                  $ref: "#/components/schemas/RedirectUri"
                authorize_params:
                  $ref: "#/components/schemas/AuthorizeParams"
      responses:
        "201":
          description: The OAuth client
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OauthClient"
        "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-clients/{oauth_client_id}:
    parameters:
      - name: oauth_client_id
        in: path
        required: true
        description: OAuth client ID
        schema:
          type: string
          example: oauc_V1StGXR8Z5jdHi6B
      - $ref: "#/components/parameters/ProjectId"
    get:
      tags:
        - Oauth Clients
      summary: Get an OAuth client
      description: Returns the client; `client_secret` is its secret reference.
      operationId: getOauthClient
      responses:
        "200":
          description: The OAuth client
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OauthClient"
        "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"
    patch:
      tags:
        - Oauth Clients
      summary: Update an OAuth client
      description: Changes only the fields sent; `null` clears a nullable one.
      operationId: updateOauthClient
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                  description: A label for the client, such as the provider's name.
                authorize_url:
                  $ref: "#/components/schemas/AuthorizeUrl"
                token_url:
                  $ref: "#/components/schemas/TokenUrl"
                revocation_url:
                  $ref: "#/components/schemas/RevocationUrl"
                client_id:
                  $ref: "#/components/schemas/ClientId"
                client_secret:
                  $ref: "#/components/schemas/ClientSecret"
                scopes:
                  $ref: "#/components/schemas/Scopes"
                pkce:
                  $ref: "#/components/schemas/Pkce"
                token_endpoint_auth_method:
                  $ref: "#/components/schemas/TokenEndpointAuthMethod"
                redirect_uri:
                  $ref: "#/components/schemas/RedirectUri"
                authorize_params:
                  $ref: "#/components/schemas/AuthorizeParams"
      responses:
        "200":
          description: The updated OAuth client
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OauthClient"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "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"
    delete:
      tags:
        - Oauth Clients
      summary: Delete an OAuth client
      description: Deletes the client and every connection made through it.
      operationId: deleteOauthClient
      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:
    AuthorizeUrl:
      type: string
      description: The provider's authorization endpoint. Query parameters it already carries are kept.
      example: https://x.com/i/oauth2/authorize
    TokenUrl:
      type: string
      description: The provider's token endpoint.
      example: https://api.x.com/2/oauth2/token
    RevocationUrl:
      type: string
      nullable: true
      description: The provider's RFC 7009 revocation endpoint, called when a connection is deleted.
        `null` skips revocation.
      example: https://api.x.com/2/oauth2/revoke
    ClientId:
      type: string
      description: Your app's client ID at the provider.
      example: Tm9ZWdEX2hQ
    ClientSecret:
      type: string
      nullable: true
      description: A `{{secret:sec_...}}` reference to your app's client secret, never the value. `null`
        for a public client, which relies on PKCE.
      example: "{{secret:sec_V1StGXR8Z5jdHi6B}}"
    Scopes:
      type: array
      items:
        type: string
      description: The scopes requested at authorization.
      example:
        - tweet.read
        - users.read
        - offline.access
    Pkce:
      type: boolean
      default: true
      description: Whether the authorization uses PKCE (`S256`).
    TokenEndpointAuthMethod:
      type: string
      enum:
        - client_secret_basic
        - client_secret_post
      default: client_secret_basic
      description: How the client authenticates at the token endpoint.
    RedirectUri:
      type: string
      nullable: true
      description: The callback the provider redirects to, as registered with the provider. Absent on
        create, or `null`, it is this API's own `https://api.naturali.ai/v1/oauth/callback`, the URL
        to register with the provider; a front end that receives the redirect itself forwards `code`
        and `state` there.
      example: https://app.example.com/oauth/callback
    AuthorizeParams:
      type: object
      nullable: true
      additionalProperties:
        type: string
      description: "Extra query parameters for the authorize URL, such as Google's `access_type: offline`
        and `prompt: consent` for a refresh token."
      example:
        prompt: consent
    OauthClient:
      type: object
      properties:
        id:
          type: string
          example: oauc_V1StGXR8Z5jdHi6B
        project_id:
          x-naturali-ref: projects
          type: string
          example: proj_V1StGXR8Z5jdHi6B
        name:
          type: string
          example: x
        authorize_url:
          $ref: "#/components/schemas/AuthorizeUrl"
        token_url:
          $ref: "#/components/schemas/TokenUrl"
        revocation_url:
          $ref: "#/components/schemas/RevocationUrl"
        client_id:
          $ref: "#/components/schemas/ClientId"
        client_secret:
          $ref: "#/components/schemas/ClientSecret"
        scopes:
          $ref: "#/components/schemas/Scopes"
        pkce:
          $ref: "#/components/schemas/Pkce"
        token_endpoint_auth_method:
          $ref: "#/components/schemas/TokenEndpointAuthMethod"
        redirect_uri:
          $ref: "#/components/schemas/RedirectUri"
        authorize_params:
          $ref: "#/components/schemas/AuthorizeParams"
        created_at:
          type: string
          format: date-time
        updated_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`.
  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"
