Delinea PbaConfiguration API

openapi: 3.2.0
info:
  title: Secret Server Rest Activations Pba Configuration 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: PbaConfiguration
  description: View and configure Privilege Behavior Analytics
paths:
  /v1/pba-configuration:
    get:
      tags:
      - PbaConfiguration
      summary: Get Pba Configuration
      description: Get Pba Configuration
      operationId: PbaConfigurationService_GetPbaConfiguration
      responses:
        '200':
          description: Pba Configuration object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PbaConfigurationModel'
        '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
    put:
      tags:
      - PbaConfiguration
      summary: Update Pba Configuration
      description: Update Pba Configuration
      operationId: PbaConfigurationService_UpdatePbaConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PbaConfigurationUpdateArgs'
        description: Pba Configuration Update Options
      responses:
        '200':
          description: Pba Configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PbaConfigurationModel'
        '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/pba-configuration/get-historical-import-status:
    get:
      tags:
      - PbaConfiguration
      summary: Get Historical Import Status
      description: Get Historical Import Status.
      operationId: PbaConfigurationService_GetHistoricalImportStatus
      responses:
        '200':
          description: PbaHistoricalImportStatusResponseMessage object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PbaHistoricalImportStatusResponseMessage'
        '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/pba-history-import:
    post:
      tags:
      - PbaConfiguration
      summary: Process Pba Historical Import
      description: Process Pba Historical Import
      operationId: PbaConfigurationService_ProcessPbaHistoryImport
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PbaHistoricalImportArgs'
        description: Pba Historical Import Options
      responses:
        '200':
          description: Pba Historical Import
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PbaHistoricalImportViewModel'
        '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/pba-test-connection:
    post:
      tags:
      - PbaConfiguration
      summary: Test Pba Connection
      description: Test Pba Connection
      operationId: PbaConfigurationService_TestPbaConnection
      responses:
        '200':
          description: Success
          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/pba-confirm-pair:
    post:
      tags:
      - PbaConfiguration
      summary: Confirm Pba Pair
      description: Confirm SS Key Pair with Pba
      operationId: PbaConfigurationService_ConfirmPbaPair
      responses:
        '200':
          description: Pba Confirm Pair Model
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PbaConfirmPairModel'
        '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/pba-sync-metadata:
    post:
      tags:
      - PbaConfiguration
      summary: Sync Pba Metadata
      description: Sync Pba Metadata
      operationId: PbaConfigurationService_SyncPbaMetadata
      responses:
        '200':
          description: Success
          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
components:
  schemas:
    ApplicationKeyStatus:
      description: PBA Key Status
      properties: {}
      type: string
      enum:
      - Unapproved
      - Approved
      - Disabled
    PbaConfirmPairModel:
      description: PBA Confirm Pair
      properties:
        alreadyApproved:
          description: Already Approved
          type: boolean
        success:
          description: Success
          type: boolean
      type: object
    PbaHistoricalImportViewModel:
      description: PBA Historical Import
      properties:
        numberOfEventsProcessed:
          description: Number Of Events Processed
          type:
          - integer
          - 'null'
          format: int32
        success:
          description: Success
          type: boolean
      type: object
    PbaConfigurationModel:
      description: PBA Configuration
      properties:
        allowImportData:
          description: Allow Import Data
          type: boolean
        challengeEnabled:
          description: Challenge Enabled
          type: boolean
        challengeLockoutIntegratedEnabled:
          description: Challenge Lockout Integrated Enabled
          type: boolean
        challengeLockoutSamlEnabled:
          description: Challenge Lockout SAML Enabled
          type: boolean
        enabled:
          description: Enabled
          type: boolean
        encryptionEnabled:
          description: Encryption Enabled
          type: boolean
        eventDataUploadInterval:
          description: Event Data Upload Interval
          type: integer
          format: int32
        eventDataUploadSizeThreshold:
          description: Event Data Upload Size Threshold
          type:
          - integer
          - 'null'
          format: int32
        externalPbaUrl:
          description: External PBA URL
          type: string
        fileUploadEnabled:
          description: File Upload Enabled
          type: boolean
        firstEnabledDate:
          description: First Enabled Date
          type:
          - string
          - 'null'
          format: date-time
        metadataInterval:
          description: Metadata Interval
          type: integer
          format: int32
        metadataLastSynchronized:
          description: Metadata Last Synchronized
          type:
          - string
          - 'null'
          format: date-time
        pbaIntegrationKeySet:
          description: PBA Integration Key Set
          type: boolean
        pbaKey:
          description: PBA Key
          type:
          - string
          - 'null'
          format: uuid
        pbaKeyCreatedDate:
          description: PBA Key Created Date
          type:
          - string
          - 'null'
          format: date-time
        pbaKeyStatus:
          $ref: '#/components/schemas/ApplicationKeyStatus'
        respectOwnerEditorRequireApprovalEnabled:
          description: Respect Owner Editor Require Approval Enabled
          type: boolean
        retentionDays:
          description: Retention Days
          type: integer
          format: int32
        secretServerKey:
          description: Secret Server Key
          type:
          - string
          - 'null'
          format: uuid
        secretServerKeyCreatedDate:
          description: Secret Server Key Created Date
          type:
          - string
          - 'null'
          format: date-time
        secretServerKeyStatus:
          $ref: '#/components/schemas/ApplicationKeyStatus'
        siteId:
          description: Id of Site
          type: integer
          format: int32
        storageDirectoryPath:
          description: Storage Directory Path
          type: string
        warningMessage:
          description: Warning Message
          type: string
      type: object
    PbaHistoricalImportArgs:
      description: PbaHistoricalImportArgs
      properties:
        endDate:
          $ref: '#/components/schemas/OptionalDateTimeOffset'
        processImport:
          description: ProcessImport
          type: boolean
        startDate:
          $ref: '#/components/schemas/OptionalDateTimeOffset'
      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
    PbaConfigurationUpdateModel:
      description: Update PBA Configuration
      properties:
        challengeEnabled:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        challengeLockoutIntegratedEnabled:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        challengeLockoutSamlEnabled:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        enabled:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        encryptionEnabled:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        eventDataUploadInterval:
          $ref: '#/components/schemas/UpdateFieldValueOfInt32'
        eventDataUploadSizeThreshold:
          $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32'
        externalPbaUrl:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        fileUploadEnabled:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        metadataInterval:
          $ref: '#/components/schemas/UpdateFieldValueOfInt32'
        pbaIntegrationKey:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        respectOwnerEditorRequireApprovalEnabled:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        retentionDays:
          $ref: '#/components/schemas/UpdateFieldValueOfInt32'
        siteId:
          $ref: '#/components/schemas/UpdateFieldValueOfInt32'
        storageDirectoryPath:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
      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
    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
    OptionalDateTimeOffset:
      description: CreationDate
      properties:
        date:
          description: Date
          type: string
          format: date-time
        dateTime:
          description: DateTime
          type: string
          format: date-time
        day:
          description: Day
          type: integer
          format: int32
        dayOfWeek:
          $ref: '#/components/schemas/DayOfWeek'
        dayOfYear:
          description: DayOfYear
          type: integer
          format: int32
        hour:
          description: Hour
          type: integer
          format: int32
        localDateTime:
          description: LocalDateTime
          type: string
          format: date-time
        millisecond:
          description: Millisecond
          type: integer
          format: int32
        minute:
          description: Minute
          type: integer
          format: int32
        month:
          description: Month
          type: integer
          format: int32
        offset:
          description: Offset
          type: string
          format: time-span
        second:
          description: Second
          type: integer
          format: int32
        ticks:
          description: Ticks
          type: integer
          format: int64
        timeOfDay:
          description: TimeOfDay
          type: string
          format: time-span
        utcDateTime:
          description: UtcDateTime
          type: string
          format: date-time
        utcTicks:
          description: UtcTicks
          type: integer
          format: int64
        year:
          description: Year
          type: integer
          format: int32
      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
    UpdateFieldValueOfBoolean:
      description: Active
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: boolean
      type: object
    UpdateFieldValueOfOptionalInt32:
      description: The minimum length required for local user passwords
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type:
          - integer
          - 'null'
          format: int32
      type: object
    PbaConfigurationUpdateArgs:
      description: PbaConfigurationUpdateArgs
      properties:
        data:
          $ref: '#/components/schemas/PbaConfigurationUpdateModel'
      type: object
    DayOfWeek:
      description: DayOfWeek
      properties: {}
      type: string
      enum:
      - Sunday
      - Monday
      - Tuesday
      - Wednesday
      - Thursday
      - Friday
      - Saturday
    PbaHistoricalImportStatusResponseMessage:
      description: PbaHistoricalImportStatusResponseMessage
      properties:
        totalHistoricalEvents:
          description: TotalHistoricalEvents
          type: integer
          format: int32
        unprocessedHistoricalEvents:
          description: UnprocessedHistoricalEvents
          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