openapi: 3.1.0
info:
  title: Orkes Conductor REST Authentication Secrets API
  description: The Orkes Conductor REST API provides endpoints for managing workflows, tasks, human tasks, secrets, schedules, and other resources in the Orkes workflow orchestration platform built on Netflix Conductor.
  version: 2.0.0
  contact:
    name: Orkes
    url: https://orkes.io/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: '{baseUrl}/api'
  description: Orkes Conductor Server
  variables:
    baseUrl:
      default: https://play.orkes.io
security:
- BearerAuth: []
tags:
- name: Secrets
paths:
  /secrets/{key}:
    get:
      operationId: getSecret
      summary: Get a secret
      description: Returns a secret value (if permitted).
      tags:
      - Secrets
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
    put:
      operationId: putSecret
      summary: Create or update a secret
      description: Creates or updates a secret value.
      tags:
      - Secrets
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          text/plain:
            schema:
              type: string
      responses:
        '200':
          description: Secret saved
    delete:
      operationId: deleteSecret
      summary: Delete a secret
      description: Deletes a secret.
      tags:
      - Secrets
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Secret deleted
  /secrets:
    get:
      operationId: listSecrets
      summary: List secret names
      description: Returns a list of all secret names.
      tags:
      - Secrets
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer