openapi: 3.0.0
info:
  title: Secret Server Rest Activations SshCommand API
  description: REST API documentation for Secret Server. This document describes how to use the REST API. All requests require an authentication token; please see the <a href="../OAuth/">authentication document</a> for more information. The <a href="swagger.json">Swagger specification</a> for this API is also available.
  termsOfService: https://delinea.com/eula
  contact:
    name: Support
    url: https://delinea.com
  version: 11.7.2
servers:
- url: /SecretServer/api
security:
- BearerToken: []
tags:
- name: SshCommand
  description: View and maintain SSH Commands
paths:
  /v1/ssh-command/{id}:
    get:
      tags:
      - SshCommand
      summary: Get an SSH Command
      description: Returns the SSH Command for the provided ID
      operationId: SshCommandService_GetSshCommand
      parameters:
      - name: id
        in: path
        description: SSH Command ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The SSH Command View
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SshCommandModel'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
  /v1/ssh-command/list:
    get:
      tags:
      - SshCommand
      summary: Get a list of SSH Commands
      description: Returns a list of SSH Commands that meet the paging/searching critera
      operationId: SshCommandService_GetSshCommands
      parameters:
      - name: filter.commandPermissionType
        in: query
        description: CommandPermissionType
        required: false
        x-nullable: true
        schema:
          type: string
      - name: filter.nameOrCommand
        in: query
        description: NameOrCommand
        required: false
        schema:
          type: string
      - name: skip
        in: query
        description: Number of records to skip before taking results
        required: false
        schema:
          type: integer
          format: int32
      - name: sortBy[0].direction
        in: query
        description: Sort direction
        required: false
        schema:
          type: string
      - name: sortBy[0].name
        in: query
        description: Sort field name
        required: false
        schema:
          type: string
      - name: sortBy[0].priority
        in: query
        description: Priority index. Sorts with lower values are executed earlier
        required: false
        schema:
          type: integer
          format: int32
      - name: take
        in: query
        description: Maximum number of records to include in results
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The list of SSH Commands
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSshCommandSummaryModel'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
  /v1/ssh-command/stub:
    get:
      tags:
      - SshCommand
      summary: Stub an empty SSH Command
      description: Returns an empty SSH Command to be filled out.
      operationId: SshCommandService_GetSshCommandStub
      responses:
        '200':
          description: An empty SSH Command
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SshCommandDto'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
  /v1/ssh-command/{sshCommandId}:
    patch:
      tags:
      - SshCommand
      summary: Update an SSH Command
      description: Update an SSH Command
      operationId: SshCommandService_UpdateSshCommand
      parameters:
      - name: sshCommandId
        in: path
        description: sshCommandId
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SshCommandPatchArgs'
        description: SSH Command Update Options
      responses:
        '200':
          description: SSH Command
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SshCommandModel'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
  /v1/ssh-command:
    post:
      tags:
      - SshCommand
      summary: Add an SSH Command
      description: Add an SSH Command
      operationId: SshCommandService_CreateSshCommand
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SshCommandCreateArgs'
        description: SSH Command add options
      responses:
        '200':
          description: SSH Command
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SshCommandModel'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
components:
  schemas:
    CommandPermissionType:
      description: Allowed or Blocked
      properties: {}
      type: string
      enum:
      - Allowed
      - Blocked
    SshCommandCreateModel:
      description: SSH Command Create Model
      properties:
        command:
          description: SSH command
          type: string
        commandPermissionType:
          $ref: '#/components/schemas/CommandPermissionType'
        name:
          description: SSH command name
          type: string
        sshCommandGuid:
          description: SSH command Guid
          type: string
          format: uuid
          nullable: true
      type: object
    Sort:
      description: Sort options. Multiple sort options can be provided in the query string.
      required:
      - name
      - direction
      properties:
        direction:
          $ref: '#/components/schemas/SortDirection'
        name:
          description: Sort field name
          type: string
        priority:
          description: Priority index. Sorts with lower values are executed earlier
          type: integer
          format: int32
      type: object
    SshCommandSummaryModel:
      description: SSH command
      properties:
        command:
          description: SSH command
          type: string
        commandPermissionType:
          $ref: '#/components/schemas/CommandPermissionType'
        name:
          description: SSH command name
          type: string
        sortOrder:
          description: Sort order
          type: integer
          format: int32
          nullable: true
        sshCommandGuid:
          description: SSH command Guid
          type: string
          format: uuid
        sshCommandId:
          description: SSH command ID
          type: integer
          format: int32
      type: object
    BadRequestResponse:
      description: Response object for invalid requests
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
        messageDetail:
          description: Error message detail
          type: string
        errorCode:
          description: Error message code
          type: string
        modelState:
          description: An object describing validation errors
          type: object
      type: object
    SshCommandPatchArgs:
      description: SshCommandPatchArgs
      properties:
        data:
          $ref: '#/components/schemas/SshCommandPatchModel'
      type: object
    PagingOfSshCommandSummaryModel:
      description: Specify paging and sorting options for querying records and returning results
      properties:
        batchCount:
          description: Number of result batches available with current query options
          type: integer
          format: int32
        currentPage:
          description: Index of current result page
          type: integer
          format: int32
        hasNext:
          description: Whether there are any results in additional pages
          type: boolean
        hasPrev:
          description: Whether there are any results in previous pages
          type: boolean
        nextSkip:
          description: Correct value of 'skip' for the next page of results
          type: integer
          format: int32
        pageCount:
          description: Number of result pages available with current query options
          type: integer
          format: int32
        prevSkip:
          description: Correct value of 'skip' for the previous page of results
          type: integer
          format: int32
        records:
          description: Query results
          items:
            $ref: '#/components/schemas/SshCommandSummaryModel'
          type: array
        severity:
          $ref: '#/components/schemas/Severity'
        skip:
          description: Number of records to skip before taking results
          type: integer
          format: int32
        sortBy:
          description: List of sort properties
          items:
            $ref: '#/components/schemas/Sort'
          type: array
        success:
          description: Whether the query executed successfully
          type: boolean
        take:
          description: Maximum number of records to include in results
          type: integer
          format: int32
        total:
          description: Total number of results available
          type: integer
          format: int32
      type: object
    SortDirection:
      description: Sort direction
      properties: {}
      type: string
      enum:
      - None
      - Asc
      - Desc
    SshCommandCreateArgs:
      description: Options to create SSH Command
      properties:
        data:
          $ref: '#/components/schemas/SshCommandCreateModel'
      type: object
    Severity:
      description: Error severity level
      properties: {}
      type: string
      enum:
      - None
      - Retry
      - Warn
      - Critical
      - Fatal
    SshCommandModel:
      description: SSH Command
      properties:
        command:
          description: SSH command
          type: string
        commandPermissionType:
          $ref: '#/components/schemas/CommandPermissionType'
        name:
          description: SSH command name
          type: string
        sortOrder:
          description: Sort order
          type: integer
          format: int32
          nullable: true
        sshCommandGuid:
          description: SSH command Guid
          type: string
          format: uuid
        sshCommandId:
          description: SSH command ID
          type: integer
          format: int32
      type: object
    SshCommandDto:
      description: SshCommandDto
      properties:
        command:
          description: Command
          type: string
        commandPermissionType:
          $ref: '#/components/schemas/CommandPermissionType'
        name:
          description: Name
          type: string
        sshCommandGuid:
          description: SshCommandGuid
          type: string
          format: uuid
        sshCommandId:
          description: SshCommandId
          type: integer
          format: int32
      type: object
    InternalServerErrorResponse:
      description: Response object for internal server errors
      required:
      - message
      - exceptionMessage
      - exceptionType
      - stackTrace
      properties:
        message:
          description: Error message
          type: string
        exceptionMessage:
          description: Error message from exception
          type: string
        exceptionType:
          description: Exception type
          type: string
        stackTrace:
          description: Exception stack trace
          type: string
      type: object
    SshCommandPatchModel:
      description: SshCommands
      properties:
        command:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        name:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        sortOrder:
          $ref: '#/components/schemas/UpdateFieldValueOfInt32'
        sshCommandGuid:
          description: SshCommandGuid
          type: string
          format: uuid
          nullable: true
        sshCommandId:
          description: SshCommandId
          type: integer
          format: int32
          nullable: true
      type: object
    UpdateFieldValueOfString:
      description: Description
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: string
      type: object
    AuthenticationFailedResponse:
      description: Response object for authentication failures
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
      type: object
    UpdateFieldValueOfInt32:
      description: How many days until the password expires.
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: integer
          format: int32
      type: object
  securitySchemes:
    BearerToken:
      type: apiKey
      description: 'Perform a POST request to `/oauth2/token`. It should include three form data parameters - `username`, `password`, and `grant_type`.The `grant_type` parameter should always have the value `password`.The access token returned should be included in the header of subsequent requests, like ''Authorization: Bearer <em>token</em>''. The token remains valid for a time period returned in the ''expires_in'' property (in seconds). For details, see the <a href="../OAuth/">token request documentation</a>.'
      name: Authorization
      in: header