Delinea SecretSessions API

openapi: 3.0.0
info:
  title: Secret Server Rest Activations SecretSessions 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: SecretSessions
  description: View recorded sessions
paths:
  /v1/recorded-sessions/ssh-session:
    get:
      tags:
      - SecretSessions
      summary: Get the SSH proxy session data
      description: Get the SSH proxy session data
      operationId: SecretSessionsService_GetSshProxyData
      parameters:
      - name: auditSecretId
        in: query
        description: Either the secret session ID or the secret audit record ID or secret session key must be passed
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: byteLimit
        in: query
        description: Amout of data in bytes to return
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int64
      - name: filterType
        in: query
        description: Filter by server, client, or both
        required: false
        schema:
          type: string
      - name: searchTerm
        in: query
        description: Search term to filter
        required: false
        schema:
          type: string
      - name: secretSessionId
        in: query
        description: Either the secret session ID, the secret audit record ID, secret session key, or the session GUID must be passed
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: secretSessionKey
        in: query
        description: Either the secret session ID, the secret audit record ID, secret session key, or the session GUID must be passed
        required: false
        schema:
          type: string
      - name: sessionGuid
        in: query
        description: This can be the secret session key or the launcher guid Either the secret session ID, the secret audit record ID, secret session key, or the session GUID must be passed
        required: false
        schema:
          type: string
      responses:
        '200':
          description: SSH Proxy Session Data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SshProxyDataSearchViewModel'
        '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/recorded-sessions/ssh-session-file:
    get:
      tags:
      - SecretSessions
      summary: Get the SSH proxy session data as an attached file
      description: Get the SSH proxy session data as an attached file
      operationId: SecretSessionsService_GetSshProxyDataAsFile
      parameters:
      - name: auditSecretId
        in: query
        description: Either the secret session ID or the secret audit record ID or secret session key must be passed
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filterType
        in: query
        description: Filter by server, client, or both
        required: false
        schema:
          type: string
      - name: searchTerm
        in: query
        description: Search term to filter
        required: false
        schema:
          type: string
      - name: secretSessionId
        in: query
        description: Either the secret session ID, the secret audit record ID, secret session key, or the session GUID must be passed
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: secretSessionKey
        in: query
        description: Either the secret session ID, the secret audit record ID, secret session key, or the session GUID must be passed
        required: false
        schema:
          type: string
      - name: sessionGuid
        in: query
        description: This can be the secret session key or the launcher guid Either the secret session ID, the secret audit record ID, secret session key, or the session GUID must be passed
        required: false
        schema:
          type: string
      responses:
        '200':
          description: SSH Proxy Session Data as an attached file
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamContentResult'
        '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/secret-sessions/{id}/summary:
    get:
      tags:
      - SecretSessions
      summary: Get a summary of the secret session data
      description: Get a summary of the secret session data
      operationId: SecretSessionsService_GetSecretSessionBySecretSessionId
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Secret Session Summary
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretSessionSummaryModel'
        '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/recorded-sessions:
    get:
      tags:
      - SecretSessions
      summary: Search Recorded Sessions
      description: Search, filter, sort, and page recorded sessions
      operationId: SecretSessionsService_SearchSessions
      parameters:
      - name: filter.active
        in: query
        description: Filter by active or inactive status
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.dateRange
        in: query
        description: Return sessions within a certain number of days
        required: false
        x-nullable: true
        schema:
          type: string
          format: time-span
      - name: filter.endDate
        in: query
        description: EndDate
        required: false
        x-nullable: true
        schema:
          type: string
          format: date-time
      - name: filter.endTime
        in: query
        description: EndTime
        required: false
        schema:
          type: string
      - name: filter.excludedApplications
        in: query
        description: Exclude particular Applications from search
        required: false
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter.folderId
        in: query
        description: Filter by folder
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.groupIds
        in: query
        description: Return sessions for specific groups
        required: false
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: filter.hasError
        in: query
        description: Filter to only records with errors
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.includeNonSecretServerSessions
        in: query
        description: IncludeNonSecretServerSessions
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.includeOnlyLaunchedSuccessfully
        in: query
        description: Return only sessions that launched successfully
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.includeRestricted
        in: query
        description: Whether to include restricted secret sessions
        required: false
        schema:
          type: boolean
      - name: filter.includeSubFolders
        in: query
        description: Whether to include subfolders in a folder search
        required: false
        schema:
          type: boolean
      - name: filter.launcherTypeId
        in: query
        description: Filter by launcher type
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.searchText
        in: query
        description: Search text
        required: false
        schema:
          type: string
      - name: filter.searchTypes
        in: query
        description: Specifies the sources of information you want to search across, can be many of (SecretItems, Username, Hostname, Domain, RdpKeystroke, RdpApplication, ProxyClient)
        required: false
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter.secretIds
        in: query
        description: Return sessions for specific secrets
        required: false
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: filter.siteId
        in: query
        description: SiteId
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.startDate
        in: query
        description: StartDate
        required: false
        x-nullable: true
        schema:
          type: string
          format: date-time
      - name: filter.startTime
        in: query
        description: StartTime
        required: false
        schema:
          type: string
      - name: filter.userIds
        in: query
        description: Return sessions for specific users
        required: false
        explode: true
        schema:
          type: array
          items:
            type: integer
      - 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: Recorded session search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSecretSessionSummary'
        '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/recorded-sessions/{id}:
    get:
      tags:
      - SecretSessions
      summary: Get Recorded Session
      description: Get a single recorded session by ID
      operationId: SecretSessionsService_Get
      parameters:
      - name: id
        in: path
        description: Recorded session ID
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Recorded session object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretSessionModel'
        '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/recorded-sessions/{id}/summary:
    get:
      tags:
      - SecretSessions
      summary: Recorded Session Summary
      description: Get the summary for a recorded session
      operationId: SecretSessionsService_GetSummary
      parameters:
      - name: id
        in: path
        description: Recorded session ID
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Recorded session summary
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretSessionSummary'
        '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/recorded-sessions/{id}/points-of-interest:
    get:
      tags:
      - SecretSessions
      summary: Recorded Session Points of Interest
      description: Get the points of interest for a recorded session
      operationId: SecretSessionsService_SearchPointsOfInterest
      parameters:
      - name: id
        in: path
        description: Recorded session ID
        required: true
        schema:
          type: string
          format: uuid
      - name: filter.searchText
        in: query
        description: Search text
        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: Recorded session points of interest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSecretSessionPointOfInterestModel'
        '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/recorded-sessions/{id}/points-of-interest-summary:
    get:
      tags:
      - SecretSessions
      summary: Recorded Session Points of Interest Summary
      description: Get the points of interest summary for a recorded session
      operationId: SecretSessionsService_SearchPointsOfInterestSummary
      parameters:
      - name: id
        in: path
        description: Recorded session ID
        required: true
        schema:
          type: string
          format: uuid
      - name: filter.searchText
        in: query
        description: Search text
        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: Recorded session points of interest summary
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfISecretSessionPointOfInterestSummaryModel'
        '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/recorded-sessions/{id}/session-recordings/{fileName}:
    get:
      tags:
      - SecretSessions
      summary: Get Recorded Session Video Stream
      description: Get the video stream for a recorded session
      operationId: SecretSessionsService_GetSessionRecording
      parameters:
      - name: fileName
        in: path
        description: fileName
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: Recorded session ID
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Recorded session video stream
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamContentResult'
        '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/recorded-sessions/{id}/session-recordings:
    get:
      tags:
      - SecretSessions
      summary: Get Recorded Session Video Stream by ID
      description: Get the video stream for a recorded session by ID
      operationId: SecretSessionsService_GetSessionRecordingById
      parameters:
      - name: id
        in: path
        description: Recorded session ID
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Recorded session video stream
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamContentResult'
        '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/recorded-sessions/session-image-by-key/{secretSessionKey}/{imageId?}:
    get:
      tags:
      - SecretSessions
      summary: Get Session Image By the Session Key
      description: Get Session Image By the Session Key
      operationId: SecretSessionsService_GetSessionImageByKey
      parameters:
      - name: imageId
        in: query
        description: imageId
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: secretSessionKey
        in: path
        description: secretSessionKey
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Get Session Image By the Session Key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileContentResult'
        '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/recorded-sessions/session-image-by-launcher-guid/{launcherGuid}/{imageId?}:
    get:
      tags:
      - SecretSessions
      summary: Get Session Image By the Launcher Session Guid
      description: Get Session Image By the Launcher Session Guid
      operationId: SecretSessionsService_GetSessionImageLauncherGuid
      parameters:
      - name: imageId
        in: query
        description: imageId
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: launcherGuid
        in: path
        description: launcherGuid
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Get Session Image By the Launcher Session Guid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileContentResult'
        '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/recorded-sessions/session-image/{secretSessionId}/{imageId?}:
    get:
      tags:
      - SecretSessions
      summary: Get Session Image
      description: Get Session Image
      operationId: SecretSessionsService_GetSessionImage
      parameters:
      - name: imageId
        in: query
        description: imageId
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: secretSessionId
        in: path
        description: secretSessionId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Get Session Image
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileContentResult'
        '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/recorded-sessions/session-frames/{secretSessionId}/{topImageIdRecovered}:
    get:
      tags:
      - SecretSessions
      summary: Get Session Frames
      description: Get Session Frames
      operationId: SecretSessionsService_GetSessionFrames
      parameters:
      - name: secretSessionId
        in: path
        description: secretSessionId
        required: true
        schema:
          type: integer
          format: int32
      - name: topImageIdRecovered
        in: path
        description: topImageIdRecovered
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Get Session Frames
          content:
            application/json:
              schema:
                description: Get Session Frames
                items:
                  $ref: '#/components/schemas/SessionFrameModel'
                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
  /v1/recorded-sessions/{id}/request-processing:
    post:
      tags:
      - SecretSessions
      summary: Request Immediate Session Processing
      description: Issues a request for the immediate processing of a session video
      operationId: SecretSessionsService_ProcessSession
      parameters:
      - name: id
        in: path
        description: Recorded session ID
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Unknown or empty response
        '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
    SecretSessionActivityType:
      description: Logged activity type
      properties: {}
      type: string
      enum:
      - SshKeyStroke
      - ApplicationStartedOrExisting
      - ApplicationEnd
      - Keystroke
      - Image
      - ApplicationMadeActive
    SessionFrameModel:
      description: SessionFrameModel[]
      properties:
        captureTime:
          description: Capture Time
          type: string
          format: date-time
        description:
          description: Description
          type: string
        imageId:
          description: Image Id
          type: integer
          format: int32
      type: object
    SortDirection:
      description: Sort direction
      properties: {}
      type: string
      enum:
      - None
      - Asc
      - Desc
    Severity:
      description: Error severity level
      properties: {}
      type: string
      enum:
      - None
      - Retry
      - Warn
      - Critical
      - Fatal
    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
    PagingOfSecretSessionSummary:
      description: Specify paging and sorting options for querying records and returning results
      properties:

# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/delinea/refs/heads/main/openapi/delinea-secretsessions-api-openapi.yml