# AUTO-GENERATED tier-A mirror spec — do not edit.
# Source: openapi/runtime/policies.yaml (runtime 0.124.0)
#  + policy: openapi/mirror-policies/policies.json
# Regenerate: node scripts/generate-mirror-specs.mjs
openapi: 3.0.3
info:
  title: naturali.ai — Policies API
  version: 1.0.0
  description: >-
    Policies: IAM documents a project attaches to agents and triggers through `policy_ids`,
    narrowing what their runs may do. 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: Policies
    description: Manage policies
security:
  - bearerAuth: []
  - oauth2:
      - mcp:access
paths:
  /v1/projects/{project_id}/policies:
    get:
      tags:
        - Policies
      summary: List policies
      description: >
        Returns the policies of the project `project_id` names, or of the project a project-scoped
        credential is bound to. Without either, the unrestricted admin lists every policy, global
        and project ones. Pass `user_id` (unrestricted admin only) to list only the policies
        attached to that user.
      operationId: listPolicies
      parameters:
        - name: user_id
          in: query
          required: false
          description: Return only policies attached to this user (user_...)
          schema:
            type: string
        - $ref: "#/components/parameters/Limit"
        - $ref: "#/components/parameters/Cursor"
      responses:
        "200":
          description: List of policies
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/Page"
                  - properties:
                      data:
                        type: array
                        items:
                          $ref: "#/components/schemas/PolicyRecord"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "403":
          description: "Forbidden: the caller may not list policies in the project, or lists global policies
            without being the unrestricted admin"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "404":
          $ref: "#/components/responses/ProjectNotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalError"
    post:
      tags:
        - Policies
      summary: Create a policy
      description: "Creates a project policy when `project_id` is given or the credential is bound to a
        project: its `Allow` statements may name only that project's resources
        (`srn:<project_id>:<type>:<id>`), else `400`; an `Allow` without `resource` grants every
        resource of that project. Without a project, creates a global policy, which only the
        unrestricted admin may."
      operationId: createPolicy
      x-naturali-agent-exclude: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - document
              additionalProperties: false
              properties:
                name:
                  type: string
                  example: ReadOnlyAccess
                description:
                  type: string
                  example: Allows read-only access to all resources
                document:
                  $ref: "#/components/schemas/PolicyDocument"
      responses:
        "201":
          description: Policy created successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PolicyRecord"
        "400":
          description: "Bad request: an invalid policy document, or an `Allow` resource outside the policy's
            project"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "403":
          description: Forbidden (the caller may not act on this policy)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "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}/policies/{policy_id}:
    get:
      tags:
        - Policies
      summary: Get a policy
      description: Returns a policy. A project policy needs `policies:GetPolicy` in its project; a global
        one, the unrestricted admin.
      operationId: getPolicy
      parameters:
        - name: policy_id
          in: path
          required: true
          description: Policy public ID (pol_ prefix)
          schema:
            type: string
            example: pol_V1StGXR8Z5jdHi6B
      responses:
        "200":
          description: Policy details
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PolicyRecord"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "403":
          description: Forbidden (the caller may not act on this policy)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "404":
          description: Policy not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalError"
    put:
      tags:
        - Policies
      summary: Update a policy
      description: Updates a policy. A project policy needs `policies:UpdatePolicy` in its project and its
        `Allow` statements stay within that project; a global one, the unrestricted admin. The
        project never changes.
      operationId: updatePolicy
      x-naturali-agent-exclude: true
      parameters:
        - name: policy_id
          in: path
          required: true
          description: Policy public ID (pol_ prefix)
          schema:
            type: string
            example: pol_V1StGXR8Z5jdHi6B
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - document
              additionalProperties: false
              properties:
                name:
                  type: string
                description:
                  type: string
                document:
                  $ref: "#/components/schemas/PolicyDocument"
      responses:
        "200":
          description: Policy updated successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PolicyRecord"
        "400":
          description: "Bad request: an invalid policy document, or an `Allow` resource outside the policy's
            project"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "403":
          description: Forbidden (the caller may not act on this policy)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "404":
          description: Policy not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "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:
        - Policies
      summary: Delete a policy
      description: Deletes a policy. A project policy needs `policies:DeletePolicy` in its project; a
        global one, the unrestricted admin. Refused with `409 POLICY_HAS_DEPENDENTS` while a
        trigger, agent, webhook, user or API key names it in its `policy_ids`.
      operationId: deletePolicy
      x-naturali-agent-exclude: true
      parameters:
        - name: policy_id
          in: path
          required: true
          description: Policy public ID (pol_ prefix)
          schema:
            type: string
            example: pol_V1StGXR8Z5jdHi6B
      responses:
        "204":
          description: Policy deleted successfully
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "403":
          description: Forbidden (the caller may not act on this policy)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "404":
          description: Policy not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "409":
          description: "`POLICY_HAS_DEPENDENTS`: a trigger, agent, webhook, user or API key still names the
            policy in its `policy_ids`. Detach it or delete them first."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "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"
components:
  schemas:
    PolicyStatement:
      type: object
      required:
        - effect
        - action
      properties:
        effect:
          type: string
          enum:
            - Allow
            - Deny
          example: Allow
        action:
          type: array
          items:
            type: string
          example:
            - files:ListFiles
            - files:CreateFile
        resource:
          type: array
          items:
            type: string
          description: Resource SRN patterns. Omitted, an `Allow` in a project policy matches every resource
            of the policy's project (`srn:<project_id>:*:*`); anywhere else it matches every
            resource.
          example:
            - srn:proj_abc:files:*
        condition:
          type: object
          additionalProperties: true
          description: >
            Optional condition block. Keys are condition operators (e.g. StringEquals) mapping to
            context-key/value maps; evaluated by the policy compiler. A context key must be one the
            platform supplies — `iam:ResourceType`, `iam:ResourceTag/<tag>` (the tag on the target
            resource) or `iam:RequestTag/<key>` (the tag value the request writes) — because an
            unknown key is absent from the evaluation context, so a `Deny` naming one would never
            deny. The tag name after the slash is opaque and unconstrained. Operator and context
            keys are matched by exact string and are never case-converted, so they round-trip
            exactly as written: `iam:ResourceTag/cost_center` selects the tag `cost_center`, not
            `costCenter`.
          example:
            StringEquals:
              iam:ResourceTag/env: prod
        denial:
          $ref: "#/components/schemas/PolicyDenial"
    PolicyDenial:
      type: object
      additionalProperties: false
      required:
        - code
        - message
      description: "On a `Deny` only: what a request this statement denies answers in place of
        `FORBIDDEN`. `code` is one the deployment declares; `meta` is added beside `action`,
        `resource` and `denied_by`. Only an unrestricted admin writes a policy carrying one (`403
        POLICY_DENIAL_RESERVED`)."
      properties:
        code:
          type: string
          example: PLAN_FEATURE_NOT_INCLUDED
        message:
          type: string
          example: Guardrails are not included in this plan.
        meta:
          type: object
          additionalProperties: true
          description: Snake_case keys, none of `action`, `resource`, `denied_by`.
          example:
            feature: guardrails
    PolicyDocument:
      type: object
      required:
        - statement
      properties:
        statement:
          type: array
          items:
            $ref: "#/components/schemas/PolicyStatement"
    PolicyRecord:
      type: object
      properties:
        id:
          type: string
          description: Public policy ID (pol_ prefix)
          example: pol_V1StGXR8Z5jdHi6B
        project_id:
          type: string
          nullable: true
          description: The project the policy belongs to; `null` for a global policy.
          example: proj_V1StGXR8Z5jdHi6B
        name:
          type: string
          nullable: true
          example: ReadOnlyAccess
        description:
          type: string
          nullable: true
        document:
          $ref: "#/components/schemas/PolicyDocument"
        created_at:
          type: string
          format: date-time
          example: 2024-01-01T00:00:00.000Z
        updated_at:
          type: string
          format: date-time
          example: 2024-01-01T00:00:00.000Z
    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"
    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"
    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"
