Oneschema AWS Secrets Manager Secrets API

openapi: 3.1.0
info:
  title: OneSchema AWS Secrets Manager AWS Secrets Manager Accounts AWS Secrets Manager Secrets API
  version: '1'
  description: Configure AWS Secrets Manager account connections and managed secret references for use in Multi FileFeeds.
  contact:
    name: OneSchema Support
    email: support@oneschema.co
  termsOfService: https://www.oneschema.co/terms-and-conditions
  license:
    name: proprietary
    url: https://www.oneschema.co/terms-and-conditions
servers:
- url: https://api.oneschema.co
  description: Production server (hosted in the US)
- url: https://api.eu.oneschema.co
  description: Production server (hosted in the EU)
- url: https://api.ca.oneschema.co
  description: Production server (hosted in Canada)
- url: https://api.au.oneschema.co
  description: Production server (hosted in Australia)
security:
- ApiKeyAuth: []
tags:
- name: AWS Secrets Manager Secrets
  description: Manage secret references within AWS Secrets Manager accounts
paths:
  /v0/aws-secrets-manager/accounts/{account-id}/secrets:
    post:
      operationId: create-aws-secrets-manager-secret
      summary: Create Managed Secret
      description: Create a new managed secret reference within an AWS Secrets Manager account.
      parameters:
      - name: account-id
        in: path
        required: true
        description: The ID of the AWS Secrets Manager account
        schema:
          type: integer
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aws-managed-secret-resource'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '401':
          description: Unauthorized (missing or invalid API key)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
      tags:
      - AWS Secrets Manager Secrets
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/aws-managed-secret-post-request'
    get:
      operationId: list-aws-secrets-manager-account-secrets
      summary: List Managed Secrets for Account
      description: Returns all managed secrets belonging to a specific AWS Secrets Manager account.
      parameters:
      - name: account-id
        in: path
        required: true
        description: The ID of the AWS Secrets Manager account
        schema:
          type: integer
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/aws-managed-secret-resource'
        '401':
          description: Unauthorized (missing or invalid API key)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
      tags:
      - AWS Secrets Manager Secrets
  /v0/aws-secrets-manager/secrets/{secret-id}:
    delete:
      operationId: delete-aws-secrets-manager-secret
      summary: Delete Managed Secret
      description: Delete a specific managed secret.
      parameters:
      - name: secret-id
        in: path
        required: true
        description: The ID of the managed secret
        schema:
          type: integer
      responses:
        '200':
          description: Successful response. The primary way to verify the request's success or failure is the response status code. In a future API version this endpoint may not return any response body at all.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/empty-response'
        '401':
          description: Unauthorized (missing or invalid API key)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
      tags:
      - AWS Secrets Manager Secrets
    get:
      operationId: get-aws-secrets-manager-secret
      summary: Get Managed Secret
      description: Get a specific managed secret.
      parameters:
      - name: secret-id
        in: path
        required: true
        description: The ID of the managed secret
        schema:
          type: integer
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aws-managed-secret-resource'
        '401':
          description: Unauthorized (missing or invalid API key)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
      tags:
      - AWS Secrets Manager Secrets
    patch:
      operationId: update-aws-secrets-manager-secret
      summary: Update Managed Secret
      description: Update a specific managed secret.
      parameters:
      - name: secret-id
        in: path
        required: true
        description: The ID of the managed secret
        schema:
          type: integer
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aws-managed-secret-resource'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '401':
          description: Unauthorized (missing or invalid API key)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
      tags:
      - AWS Secrets Manager Secrets
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/aws-managed-secret-patch-request'
  /v0/aws-secrets-manager/secrets:
    get:
      operationId: list-aws-secrets-manager-secrets
      summary: List All Managed Secrets
      description: Returns all AWS managed secrets across all accounts in the organization.
      parameters: []
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/aws-managed-secret-resource'
        '401':
          description: Unauthorized (missing or invalid API key)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
      tags:
      - AWS Secrets Manager Secrets
components:
  schemas:
    error-response:
      type: object
      required:
      - message
      properties:
        code:
          type: string
          description: A machine-readable error code
        param:
          type: string
          description: The parameter that caused the error
        message:
          type: string
          description: A human-readable error message
        data:
          type: object
          description: Additional error context
    aws-managed-secret-patch-request:
      type: object
      properties:
        name:
          type: string
          description: A descriptive label for this secret reference
        description:
          anyOf:
          - type: string
          - type: 'null'
          description: An optional description
        secret_identifier:
          type: string
          description: The name or ARN of the secret in AWS Secrets Manager
        region:
          type: string
          description: The AWS region where the secret is stored
        secret_version:
          anyOf:
          - type: string
          - type: 'null'
          description: A specific version ID or stage label
        version_kind:
          type: string
          enum:
          - id
          - stage
          description: Selects whether secret_version is treated as a VersionId or VersionStage for AWS GetSecretValue
    aws-managed-secret-post-request:
      type: object
      required:
      - name
      - secret_identifier
      - region
      properties:
        name:
          type: string
          description: A descriptive label for this secret reference
        secret_identifier:
          type: string
          description: The name or ARN of the secret in AWS Secrets Manager
        region:
          type: string
          description: The AWS region where the secret is stored
        description:
          anyOf:
          - type: string
          - type: 'null'
          description: An optional description
        secret_version:
          anyOf:
          - type: string
          - type: 'null'
          description: A specific version ID or stage label (omit to use the latest version)
        version_kind:
          type: string
          enum:
          - id
          - stage
          description: Selects whether secret_version is treated as a VersionId or VersionStage for AWS GetSecretValue
    aws-managed-secret-resource:
      type: object
      properties:
        id:
          type: integer
          description: The unique identifier of the managed secret
        name:
          type: string
          description: The name of the managed secret
        description:
          anyOf:
          - type: string
          - type: 'null'
          description: An optional description
        account_id:
          type: integer
          description: The account this secret belongs to
        secret_identifier:
          type: string
          description: The identifier used to fetch the secret from AWS Secrets Manager
        secret_version:
          anyOf:
          - type: string
          - type: 'null'
        region:
          type: string
          description: The AWS region where the secret is stored
        version_kind:
          anyOf:
          - type: string
            enum:
            - id
            - stage
          - type: 'null'
          description: Selects whether secret_version is treated as a VersionId or VersionStage for AWS GetSecretValue
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    empty-response:
      type: object
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY