openapi: 3.0.0
info:
  title: Secret Server Rest Activations Proxy 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: Proxy
  description: Retrieve and update SSH and RDP proxy configurations
paths:
  /v1/proxy/ssh/client-overrides/{clientOverrideId}:
    delete:
      tags:
      - Proxy
      summary: Deletes SSH Terminal client overrides
      description: Deletes SSH Terminal client overrides
      operationId: ProxyService_DeleteTerminalClientOverrides
      parameters:
      - name: clientOverrideId
        in: path
        description: clientOverrideId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: A list of SSH Terminal client overrides
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletedModel'
        '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
    patch:
      tags:
      - Proxy
      summary: Updates SSH Terminal client overrides
      description: Updates SSH Terminal client overrides
      operationId: ProxyService_UpdateTerminalClientOverrides
      parameters:
      - name: clientOverrideId
        in: path
        description: clientOverrideId
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        $ref: '#/components/requestBodies/ProxyClientOverrideSummary'
      responses:
        '200':
          description: A list of SSH Terminal client overrides
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyClientOverrideSummary'
        '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/proxy/ssh/config:
    get:
      tags:
      - Proxy
      summary: Get the SSH proxy configuration
      description: Get the SSH proxy configuration
      operationId: ProxyService_GetSshProxyConfiguration
      responses:
        '200':
          description: SSH Proxy Configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SshProxyConfigurationViewModel'
        '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
    patch:
      tags:
      - Proxy
      summary: Update the SSH proxy configuration
      description: Update the SSH proxy configuration
      operationId: ProxyService_PatchSshProxyConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SshProxyConfigurationViewModel'
        description: viewModel
      responses:
        '200':
          description: SSH Proxy Configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SshProxyConfigurationViewModel'
        '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/proxy/rdp/config:
    get:
      tags:
      - Proxy
      summary: Get the RDP proxy configuration
      description: Get the RDP proxy configuration
      operationId: ProxyService_GetRdpProxyConfiguration
      responses:
        '200':
          description: RDP Proxy Configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RdpProxyConfigurationViewModel'
        '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
    patch:
      tags:
      - Proxy
      summary: Update the RDP proxy configuration
      description: Update the RDP proxy configuration
      operationId: ProxyService_PatchRdpProxyConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RdpProxyConfigurationViewModel'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RdpProxyConfigurationViewModel'
        description: viewModel
      responses:
        '200':
          description: RDP Proxy Configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RdpProxyConfigurationViewModel'
        '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/proxy/explanation:
    get:
      tags:
      - Proxy
      summary: Get Proxy Explanations
      description: Get an explanation of the SSH proxy, SSH terminal, and RDP proxy features
      operationId: ProxyService_GetExplanations
      responses:
        '200':
          description: Explanations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyExplanationsViewModel'
        '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/proxy/audit:
    get:
      tags:
      - Proxy
      summary: Get the Proxy Audit List
      description: Search, filter, sort, and page Proxy Audits.
      operationId: ProxyService_GetAudits
      parameters:
      - name: isExporting
        in: query
        description: isExporting
        required: false
        schema:
          type: boolean
      - 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: A paginated list of Proxy Audits.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfProxyAuditModel'
        '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/proxy/endpoints:
    get:
      tags:
      - Proxy
      summary: Get the proxy endpoints list
      description: Get the proxy endpoints list
      operationId: ProxyService_GetEndpoints
      responses:
        '200':
          description: A list of nodes, sites, and engines with proxy configurations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyEndpointsViewModel'
        '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/proxy/ssh/notification:
    get:
      tags:
      - Proxy
      summary: Get a notification of where the SSH proxy is running
      description: Get a notification of where the SSH proxy is running
      operationId: ProxyService_GetSshEndpointNotification
      responses:
        '200':
          description: A list of nodes, sites, and engines with proxy configurations
          content:
            application/json:
              schema:
                description: String
                type: string
        '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/proxy/rdp/notification:
    get:
      tags:
      - Proxy
      summary: Get a notification of where the RDP proxy is running
      description: Get a notification of where the RDP proxy is running
      operationId: ProxyService_GetRdpEndpointNotification
      responses:
        '200':
          description: A list of nodes, sites, and engines with proxy configurations
          content:
            application/json:
              schema:
                description: String
                type: string
        '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/proxy/endpoints/notification:
    get:
      tags:
      - Proxy
      summary: Get endpoint warnings
      description: Get endpoint warnings
      operationId: ProxyService_GetEndpointNotification
      responses:
        '200':
          description: A list of nodes, sites, and engines with proxy configurations
          content:
            application/json:
              schema:
                description: String
                type: string
        '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/proxy/ssh/clients:
    get:
      tags:
      - Proxy
      summary: Get SSH Terminal clients
      description: Get SSH Terminal clients
      operationId: ProxyService_GetTerminalClients
      parameters:
      - name: filter.ipAddress
        in: query
        description: IpAddress
        required: false
        schema:
          type: string
      - name: filter.terminalClientType
        in: query
        description: TerminalClientType
        required: false
        x-nullable: true
        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: A list of SSH Terminal clients
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfProxyClientSummaryAndSshProxyClientsFilterQuery'
        '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/proxy/ssh/clienthistory:
    get:
      tags:
      - Proxy
      summary: Get SSH Terminal client history
      description: Get SSH Terminal client history
      operationId: ProxyService_GetTerminalClientHistory
      parameters:
      - name: filter.authenticateResult
        in: query
        description: AuthenticateResult
        required: false
        schema:
          type: string
      - name: filter.endDate
        in: query
        description: EndDate
        required: false
        schema:
          type: string
      - name: filter.engineIdentityGuid
        in: query
        description: EngineIdentityGuid
        required: false
        schema:
          type: string
      - name: filter.ipAddress
        in: query
        description: IpAddress
        required: false
        schema:
          type: string
      - name: filter.startDate
        in: query
        description: StartDate
        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: A list of SSH Terminal client history
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfProxyClientHistorySummaryAndSshProxyClientHistoryFilterQuery'
        '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/proxy/ssh/client-overrides:
    get:
      tags:
      - Proxy
      summary: Get SSH Terminal client overrides
      description: Get SSH Terminal client overrides
      operationId: ProxyService_GetTerminalClientOverrides
      responses:
        '200':
          description: A list of SSH Terminal client overrides
          content:
            application/json:
              schema:
                description: A list of SSH Terminal client overrides
                items:
                  $ref: '#/components/schemas/ProxyClientOverrideSummary'
                type: array
        '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
    post:
      tags:
      - Proxy
      summary: Creates SSH Terminal client overrides
      description: Creates SSH Terminal client overrides
      operationId: ProxyService_CreateTerminalClientOverrides
      requestBody:
        $ref: '#/components/requestBodies/ProxyClientOverrideSummary'
      responses:
        '200':
          description: A list of SSH Terminal client overrides
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyClientOverrideSummary'
        '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/proxy/state:
    get:
      tags:
      - Proxy
      summary: Get proxy state
      description: Get proxy state
      operationId: ProxyService_GetProxyingState
      responses:
        '200':
          description: Proxy state
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyingStateModel'
        '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/proxy/endpoints/nodes/{id}:
    patch:
      tags:
      - Proxy
      summary: Update a node proxy configuration
      description: Update a node proxy configuration
      operationId: ProxyService_PatchNode
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyNodeViewModel'
        description: node
      responses:
        '200':
          description: A list of nodes, sites, and engines with proxy configurations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyEndpointsViewModel'
        '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/proxy/endpoints/sites/{id}:
    patch:
      tags:
      - Proxy
      summary: Update a site proxy configuration
      description: Update a site proxy configuration
      operationId: ProxyService_PatchSite
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxySiteViewModel'
        description: site
      responses:
        '200':
          description: A list of nodes, sites, and engines with proxy configurations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyEndpointsViewModel'
        '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/proxy/endpoints/engines/{id}:
    patch:
      tags:
      - Proxy
      summary: Update an engine proxy configuration
      description: Update an engine proxy configuration
      operationId: ProxyService_PatchEngine
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyEngineViewModel'
        description: engine
      responses:
        '200':
          description: A list of nodes, sites, and engines with proxy configurations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyEndpointsViewModel'
        '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/proxy/ssh/clients/{clientId}:
    patch:
      tags:
      - Proxy
      summary: Updates a SSH Terminal client type
      description: Updates a SSH Terminal client type
      operationId: ProxyService_UpdateTerminalClientType
      parameters:
      - name: clientId
        in: path
        description: clientId
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyClientSummary'
        description: client
      responses:
        '200':
          description: A list of SSH Terminal clients
          content:
            application/json:
              schema:
                description: Boolean
                type: boolean
        '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/proxy/ssh/generate-key:
    post:
      tags:
      - Proxy
      summary: Generate SSH Host Key
      description: Generates a new SSH host key and returns the SSH configuration with the updated host key
      operationId: ProxyService_GenerateSshHostKey
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateSshHostKeyArgs'
        description: args
      responses:
        '200':
          description: SSH Proxy Configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SshProxyConfigurationViewModel'
        '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/proxy/rdp/generate-certificate:
    post:
      tags:
      - Proxy
      summary: Generate RDP server certificate
      description: Generates a new RDP server certificate and returns the RDP configuration with the updated server certificate
      operationId: ProxyService_GenerateRdpProxyCertificate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateRdpCertificateArgs'
        description: args
      responses:
        '200':
          description: RDP Proxy Configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RdpProxyConfigurationViewModel'
        '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:
    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
    ProxyClientSummary:
      description: Query results
      properties:
        clientId:
          description: ClientId
          type: integer
          format: int32
        ipAddress:
          description: IpAddress
          type: string
        lastConnectionDate:
          description: LastConnectionDate
          type: string
          format: date-time
          nullable: true
        terminalClientType:
          $ref: '#/components/schemas/ProxyClientType'
      type: object
    ProxyExplanationsViewModel:
      description: ProxyExplanationsViewModel
      properties:
        rdpProxyExplanation:
          description: RdpProxyExplanation
          type: string
        sshProxyExplanation:
          $ref: '#/components/schemas/DictionaryOfStringAndString'
        sshTerminalBlockListExplanation:
          description: SshTerminalBlockListExplanation
          type: string
        sshTerminalBlockListOverrideExplanation:
          description: SshTerminalBlockListOverrideExplanation
          type: string
        sshTerminalExplanation:
          description: SshTerminalExplanation
          type: string
      type: object
    SortDirection:
      description: Sort direction
      properties: {}
      type: string
      enum:
      - None
      - Asc
      - Desc
    PagingOfProxyClientSummaryAndSshProxyClientsFilterQuery:
      description: Specify filtering, paging, 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
        filter:
          $ref: '#/components/schemas/SshProxyClientsFilterQuery'
        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/ProxyClientSummary'
          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
    Severity:
      description: Error severity level
      properties: {}
      type: string
      enum:
      - None
      - Retry
      - Warn
      - Critical
      - Fatal
    ProxyClientHistorySummary:
      description: Query results
      properties:
        authenticateResult:
          $ref: '#/components/schemas/TerminalAuthenticateResult'
        createdDate:
          description: CreatedDate
          type: string
          format: date-time
        engineIdentityGuid:
          description: EngineIdentityGuid
          type: string
        ipAddress:
          description: IpAddress
          type: string
      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
    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
    ProxyNodeViewModel:
      description: Nodes
      properties:
        bindIpAddress:
          description: BindIpAddress
          type: string
        jumpboxAvailablePortRange:
          description: JumpboxAvailablePortRange
          type: string
        machineName:
          description: MachineName
          type: string
        nodeId:
          description: NodeId
          type: integer
          format: int32
        publicHost:
          description: PublicHost
          type: string
      type: object
    ProxyAuditModel:
      description: Query results
      properties:
        action:
          description: Action
          type: string
        dateRecorded:
          description: DateRecorded
          type: string
          format: date-time
        displayName:
          description: DisplayName
          type: string
        ipAddress:
          description: IpAddress
          type: string
        notes:
          description: Notes
          type: string
      type: object
    ProxyClientType:
      description: TerminalClientType
      properties: {}
      type: string
      enum:
      - Unknown
      - AllowList
      - BlockList
    ProxyingStateModel:
      description: ProxyingStateModel
      properties:
        showLogs:
          description: If the logs should be shown
          type: boolean
      type: object
    DeletedModel:
      description: Information about an object that was deleted
      properties:
        id:
          description: ID of the deleted object
          type: integer
          format: int32
        objectType:
          description: Type of the deleted object
          type: string
        responseCodes:
          description: List of response codes from the delete operation
          items:
            type: string
          type: array
      type: object
    TerminalAuthenticateResult:
      description: AuthenticateResult
      properties: {}
      type: string
      enum:
      - Unknown
      - Successful
      - Failed
      - Refused
    PagingOfProxyAuditModel:
      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/ProxyAuditModel'
          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
    RdpProxyConfigurationViewModel:
      description: RdpProxyConfigurationViewModel
      properties:
        allowSiteSelectionForActiveDirectoryAccounts:
          description: Allows users to select a site when launching or generating proxy credentials for a RDP proxied secret
          type: boolean
          nullable: true
        daysToKeepOperationalLogs:
          description: The number of days to store RDP proxy logs before they are rolled over
          type: integer
          format: int32
          nullable: true
        enableRdpProxy:
          description: Whether or not to enable the RDP proxy
          type: boolean
          nullable: true
        enableRemoteHostValidation:
          description: Whether or not to enforce certificate validation on remote hosts that the proxy connects to
          type: boolean
          nullable: true
        isCloud:
          description: IsCloud
          type: boolean
        proxyNewSecretsByDefault:
          description: Whether or not new RDP-enabled secrets should be created with 'Proxy Enabled' set
          type: boolean
          nullable: true
        rdpProxyPort:
          description: The port that the RDP proxy will run on
          type: integer
          format: int32
          nullable: true
        rdpServerCertificate:
          $ref: '#/components/schemas/RdpProxyCertificateViewModel'
        rdpServerCertificateMultipart:
          description: 'The certificate that is server when connections begin to the RDP proxy (used "Content-Type: multipart/form-data" only)'
          type: string
          format: binary
        rdpServerCertificateMultipartPassword:
          description: 'The password used to protect the certificate (only used for updating with "Content-Type: multipart/form-data" only)'
          type: string
      type: object
    RdpProxyCertificateViewModel:
      description: 'The certificate that is server when connections begin to the RDP proxy (used "Content-Type: application/json" only)'
      properties:
        rdpServerCertificate:
          description: The certificate (x509/pfx) that is served to users connecting to the RDP proxy.
          type: string
          format: binary
        rdpServerCertificateFileName:
          description: The name of the RDP server certificate file
          type: string
        rdpServerCertificatePassword:
          description: The password used to protect the certificate (only used for updating)
          type: string
      type: object
    AuthenticationFailedResponse:
      description: Response object for authentication failures
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
      type: object
    ProxyClientOverrideSummary:
      description: ProxyClientOverrideSummary
      properties:
        clientOverrideId:
          description: ClientOverrideId
          type: integer
          format: int32
        ipAddressRange:
          description: IpAddressRange
          type: string
        terminalClientType:
          $ref: '#/components/schemas/ProxyClientType'
      type: object
    GenerateSshHostKeyArgs:
      description: GenerateSshHostKeyArgs
      properties:
        algorithm:
          description: The Algorithm used for generating the host key
          type: string
      type: object
    SshProxyClientHistoryFilterQuery:
      description: Additional query options
      properties:
        authenticateResult:
          description: AuthenticateResult
          type: string
        endDate:
          description: EndDate
          type: string
        engineIdentityGuid:
          description: EngineIdentityGuid
          type: string
        ipAddress:
          description: IpAddress
          type: string
        startDate:
          description: StartDate
          type: string
      type: object
    ProxyEndpointsViewModel:
      description: ProxyEndpointsViewModel
      properties:
        defaultRdpProxyPort:
          description: DefaultRdpProxyPort
          type: integer
          format: int32
        defaultSshProxyPort:
          description: DefaultSshProxyPort
          type: integer
          format: int32
        engines:
          description: Engines
          items:
            $ref: '#/components/schemas/ProxyEngineViewModel'
          type: array
        nodes:
          description: Nodes
          items:
            $ref: '#/components/schemas/ProxyNodeViewModel'
          type: array
        rdpProxyEnabled:
          description: RdpProxyEnabled
          type: boolean
        sites:
          description: Sites
          items:
            $ref: '#/components/schemas/ProxySiteViewModel'
          type: array
        sshProxyEnabled:
          description: SshProxyEnabled
          type: boolean
      type: object
    SshProxyClientsFilterQuery:
      description: Additional query options
      properties:
        ipAddress:
          description: IpAddress
          type: string
        terminalClientType:
          description: TerminalClientType
          type: string
          nullable: true
      type: object
    ProxySiteViewModel:
      description: Sites
      properties:
        enableRdpProxy:
          description: EnableRdpProxy
          type: boolean
          nullable: true
        enableSshProxy:
          description: EnableSshProxy
          type: boolean
          nullable: true
        rdpProxyPort:
          description: RdpProxyPort
          type: integer
          format: int32
          nullable: true
        rdpProxyPortInherited:
          description: RdpProxyPortInherited
          type: boolean
          nullable: true
        siteId:
          description: SiteId
          type: integer
          format: int32
        siteName:
          description: SiteName
          type: string
        sshJumpboxAvailablePortRange:
          description: SshJumpboxAvailablePortRange
          type: string
        sshProxyPort:
          description: SshProxyPort
          type: integer
          format: int32
          nullable: true
        sshProxyPortInherited:
          description: SshProxyPortInherited
          type: boolean
          nullable: true
      type: object
    PagingOfProxyClientHistorySummaryAndSshProxyClientHistoryFilterQuery:
      description: Specify filtering, paging, 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
        filter:
          $ref: '#/components/schemas/SshProxyClientHistoryFilterQuery'
        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/ProxyClientHistorySummary'
          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
    ProxyEngineViewModel:
      description: Engines
      properties:
        bindIpAddress:
          description: BindIpAddress
          type: string
        engineId:
          description: EngineId
          type: integer
          format: int32
        friendlyName:
          description: FriendlyName
          type: string
        publicHost:
          description: PublicHost
          type: string
        siteName:
          description: SiteName
          type: string
      type: object
    DictionaryOfStringAndString:
      description: SshProxyExplanation
      properties: {}
      type: object
    GenerateRdpCertificateArgs:
      description: GenerateRdpCertificateArgs
      properties:
        dnsName:
          description: The DNS name to use when generating the self-signed certificate
          type: string
      type: object
    SshProxyConfigurationViewModel:
      description: SshProxyConfigurationViewModel
      properties:
        availablePortRange:
          description: Range of unused ports available on the SSH Proxy endpoint to be used for Jumpbox port forwarding
          type: string
        daysToKeepOperationalLogs:
          description: The number of days to store SSH proxy logs before they are rolled over
          type: integer
          format: int32
          nullable: true
        enablePasswordHiding:
          description: Enable to hide passwords from SSH keystroke capture. This prevents logging user input on lines that are determined to be a password prompt.
          type: boolean
          nullable: true
        enableProxyBlockListing:
          description: Enable block listing of IP Addresses that connect and fail to authenticate too many times
          type: boolean
          nullable: true
        enableProxyInactivityTimeout:
          description: Whether or not the proxy should disconnect inactive sessions
          type: boolean
          nullable: true
        enableSshProxy:
          description: Whether or not the SSH proxy is enabled
          type: boolean
          nullable: true
        enableSshPublicKeyAuth:
          description: Whether or not the SSH Terminal can allow key authentication
          type: boolean
        enableSshTerminal:
          description: Whether or not the SSH terminal is enabled
          type: boolean
          nullable: true
        enableSshTunneling:
          description: Whether or not to allow SSH tunneling through the proxy for proxied RDP sessions
          type: boolean
          nullable: true
        enableTerminalInactivityTimeout:
          description: Whether or not the SSH terminal should disconnect inactive sessions
          type: boolean
          nullable: true
        enableWindowTitleChangeCommand:
          description: Send window title change command on startup
          type: boolean
          nullable: true
        isCloud:
          description: IsCloud
          type: boolean
        passwordRegexFilter:
          description: Regular Expression used to identify password prompts. The default expression search for either prompts beginning with 'sudo password for' or prompts ending with 'password:'
          type: string
        proxyAutoBlockListingMaxHistory:
          description: The number of history entries to keep per client
          type: integer
          format: int32
          nullable: true
        proxyAutoBlockListingMaxNum:
          description: The number of failed authentication attempts before being blocked
          type: integer
          format: int32
          nullable: true
        proxyAutoBlockListingTimeFrameMinutes:
          description: The time frame in which all the failed attempts must happen before being blocked
          type: integer
          format: int32
          nullable: true
        proxyInactivityTimeoutSeconds:
          description: The amount of time in seconds to wait before disconnecting inactive proxy sessions
          type: integer
          format: int32
          nullable: true
        proxyNewSecretsByDefault:
          description: Whether or not new SSH-enabled secrets should be created with 'Proxy Enabled' set
          type: boolean
          nullable: true
        sshHostKey:
          description: The host key that will the proxy will serve
          type: string
        sshProxyBanner:
          description: The banner that is display when someone opens an shell connection to the proxy
          type: string
        sshProxyHostFingerprint:
          description: The fingerprint of the host key that the proxy will serve
          type: string
        sshProxyPort:
          description: The port that that SSH proxy runs on
          type: integer
          format: int32
          nullable: true
        sshTerminalBanner:
          description: The banner that is displayed when someone authenticates to the SSH terminal
          type: string
        terminalInactivityTimeoutSeconds:
          description: The amount of time in seconds to wait before disconnecting inactive terminal sessions
          type: integer
          format: int32
          nullable: true
        tunnelKeepAliveInSeconds:
          description: 'Keep alive signals to local port forwarding tunnels at this interval (in seconds). Prevents port forwarding tunnels from closing. (0-86400) '
          type: integer
          format: int32
          nullable: true
      type: object
  requestBodies:
    ProxyClientOverrideSummary:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProxyClientOverrideSummary'
      description: clientOverride
  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