openapi: 3.0.0
info:
  title: Secret Server Rest Activations SecretPolicy 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: SecretPolicy
  description: Retrieve and update Secret Policies
paths:
  /v1/secret-policy/search:
    get:
      tags:
      - SecretPolicy
      summary: Search Secret Policies
      description: Search Secret Policies
      operationId: SecretPolicyService_SearchSecretPolicies
      parameters:
      - name: filter.includeInactive
        in: query
        description: Whether or not to include inactive secret policies
        required: false
        schema:
          type: boolean
      - name: filter.secretPolicyName
        in: query
        description: Results will contain this text in the policy name
        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: Secret Policies that matched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSecretPolicyModel'
        '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
  /v2/secret-policy/stub:
    get:
      tags:
      - SecretPolicy
      summary: Get Secret Policy Stub
      description: Get Secret Policy
      operationId: SecretPolicyService_GetSecretPolicyStubV2
      responses:
        '200':
          description: Stub of a Secret Policy Detail model
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretPolicyDetailModelV2'
        '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
  /v2/secret-policy/{id}:
    get:
      tags:
      - SecretPolicy
      summary: Get Secret Policy
      description: Get Secret Policy for passed in Id
      operationId: SecretPolicyService_GetSecretPolicyV2
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Secret Policy if found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretPolicyDetailModelV2'
        '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:
      - SecretPolicy
      summary: Update a Secret Policy
      description: Update a Secret Policy and return detail model
      operationId: SecretPolicyService_UpdateSecretPolicyV2
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretPolicyUpdateArgsV2'
        description: args
      responses:
        '200':
          description: Secret Policy that was updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretPolicyDetailModelV2'
        '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-policy/{id}/audit:
    get:
      tags:
      - SecretPolicy
      summary: Get Secret Policy Audits
      description: Get Secret Policy Audits for passed in Id
      operationId: SecretPolicyService_GetSecretPolicyAudit
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - 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: Secret Policy Audits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPagingOfSecretPolicyAuditSummary'
        '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-policy/{id}/status:
    get:
      tags:
      - SecretPolicy
      summary: Get the Secret Policy status
      description: Gets the status of what secrets and folders the policy is applied to.
      operationId: SecretPolicyService_GetSecretPolicyStatus
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Secret Policy status for queried policy.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretPolicyStatusModel'
        '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
  /v2/secret-policy:
    post:
      tags:
      - SecretPolicy
      summary: Create a Secret Policy
      description: Create a Secret Policy and return detail model
      operationId: SecretPolicyService_CreateSecretPolicyV2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretPolicyCreateArgsV2'
        description: args
      responses:
        '200':
          description: Secret Policy that was created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretPolicyDetailModelV2'
        '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
    SecretPolicyUpdateArgsV2:
      description: SecretPolicyUpdateArgsV2
      properties:
        data:
          $ref: '#/components/schemas/SecretPolicyUpdateModelV2'
      type: object
    SecretPolicyUpdateModelV2:
      description: Secret Policy Update Model V2
      properties:
        active:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        generalItems:
          $ref: '#/components/schemas/SecretPolicyGeneralItemsUpdateModel'
        launcherItems:
          $ref: '#/components/schemas/SecretPolicyLauncherItemsUpdateModel'
        rpcItems:
          $ref: '#/components/schemas/SecretPolicyRpcItemsUpdateModel'
        secretPolicyDescription:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        secretPolicyName:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        securityItems:
          $ref: '#/components/schemas/SecretPolicySecurityItemsUpdateModel'
      type: object
    SecretPolicyRpcItemsUpdateModel:
      description: Secret Policy RPC Items Update Model
      properties:
        associatedSecretId1:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalInt32'
        associatedSecretId2:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalInt32'
        autoChangeOnExpiration:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalBoolean'
        autoChangeSchedule:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfAutoChangeScheduleDataModel'
        heartBeatEnabled:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalBoolean'
        passwordTypeWebScriptId:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalInt32'
        privilegedSecretId:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalInt32'
      type: object
    UpdateFieldValueOfBoolean:
      description: Active
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: boolean
      type: object
    UserGroupMapModel:
      description: User Group Map Model
      properties:
        displayName:
          description: Group Name
          type: string
        groupId:
          description: Group Id
          type: integer
          format: int32
        userGroupMapType:
          $ref: '#/components/schemas/UserGroupMapType'
      type: object
    AutoChangeScheduleModel:
      description: Auto Change Schedule Model
      properties:
        changeOnlyWhenExpired:
          description: The password will only be changed when the Secret has expired
          type: boolean
        changeType:
          description: Schedule Change Type
          type: string
          nullable: true
        days:
          description: Days of Recurrence if Daily ScheduleType
          type: integer
          format: int32
          nullable: true
        friday:
          description: Occurs on Fridays when set if Weekly ScheduleType
          type: boolean
          nullable: true
        monday:
          description: Occurs on Mondays when set if Weekly ScheduleType
          type: boolean
          nullable: true
        monthlyDay:
          description: Day(s) used if DayOfWeekMonth and Monthly ScheduleType
          type: string
          nullable: true
        monthlyDayOfMonth:
          description: Day of Month if DayOfMonth and Monthly ScheduleType
          type: integer
          format: int32
          nullable: true
        monthlyDayOrder:
          description: Day Order used if DayOfWeekMonth and Monthly ScheduleType
          type: string
          nullable: true
        monthlyDayOrderRecurrence:
          description: Months of Recurrence if DayOfWeekMonth and Monthly ScheduleType
          type: integer
          format: int32
          nullable: true
        monthlyDayRecurrence:
          description: Months of Recurrence if DayOfMonth and Monthly ScheduleType
          type: integer
          format: int32
          nullable: true
        monthlyScheduleType:
          description: Selection used if Monthly ScheduleType
          type: string
          nullable: true
        saturday:
          description: Occurs on Saturdays when set if Weekly ScheduleType
          type: boolean
          nullable: true
        startingOn:
          description: Day for Schedule to start
          type: string
          format: date-time
        sunday:
          description: Occurs on Sundays when set if Weekly ScheduleType
          type: boolean
          nullable: true
        thursday:
          description: Occurs on Thursdays when set if Weekly ScheduleType
          type: boolean
          nullable: true
        tuesday:
          description: Occurs on Tuesdays when set if Weekly ScheduleType
          type: boolean
          nullable: true
        wednesday:
          description: Occurs on Wednesdays when set if Weekly ScheduleType
          type: boolean
          nullable: true
        weeks:
          description: Weeks of Recurrence if Weekly ScheduleType
          type: integer
          format: int32
          nullable: true
      type: object
    SortDirection:
      description: Sort direction
      properties: {}
      type: string
      enum:
      - None
      - Asc
      - Desc
    IPagingOfSecretPolicyAuditSummary:
      description: IPagingOfSecretPolicyAuditSummary
      properties:
        records:
          description: Records
          items:
            $ref: '#/components/schemas/SecretPolicyAuditSummary'
          type: array
        sortBy:
          description: SortBy
          items:
            $ref: '#/components/schemas/Sort'
          type: array
      type: object
    SecretPolicyStatusModel:
      description: Secret Policy Status Model
      properties:
        inProgressSecretCount:
          description: Number of secrets that are queued to change to the queried policy.
          type: number
          format: double
        secretCount:
          description: Number of secrets the policy is applied to.
          type: number
          format: double
        secretPercentComplete:
          description: Completion percentage for the applied secrets. Value is between 0 and 1
          type: number
          format: double
        secretPolicyId:
          description: Id of the Secret Policy
          type: integer
          format: int32
      type: object
    Severity:
      description: Error severity level
      properties: {}
      type: string
      enum:
      - None
      - Retry
      - Warn
      - Critical
      - Fatal
    PolicyApplyType:
      description: PolicyApplyType
      properties: {}
      type: string
      enum:
      - NotSet
      - Default
      - Enforced
    SecretPolicyLauncherItemsModel:
      description: Secret Policy Launcher Item Model
      properties:
        launcherSettings:
          $ref: '#/components/schemas/SecretPolicyItemOfLauncherSettingsModel'
        webLauncherRequiresIncognitoMode:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalBoolean'
      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
    SshCommandMenuGroupModel:
      description: Ssh Command Menu Group Model
      properties:
        groupId:
          description: Group Id
          type: integer
          format: int32
        sshCommandMenuId:
          description: Ssh Command Menu Id
          type: integer
          format: int32
          nullable: true
      type: object
    SshCommandMenuGroupMapModel:
      description: Ssh Command Menu Group Map Model
      properties:
        groupId:
          description: Group Id
          type: integer
          format: int32
        sshCommandMenuId:
          description: Ssh Command Menu Id
          type: integer
          format: int32
          nullable: true
        sshCommandMenuName:
          description: Ssh Command Menu Name
          type: string
        userGroupDisplayName:
          description: User Or Group Display Name
          type: string
        userGroupMapType:
          $ref: '#/components/schemas/UserGroupMapType'
      type: object
    UpdateFieldValueOfSecretPolicyDataItemOfOptionalInt32:
      description: Site Id
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalInt32'
      type: object
    SecretPolicyDataItemOfAutoChangeScheduleDataModel:
      description: Value
      properties:
        policyApplyType:
          $ref: '#/components/schemas/PolicyApplyType'
        value:
          $ref: '#/components/schemas/AutoChangeScheduleDataModel'
      type: object
    SecretPolicyDetailModelV2:
      description: Secret Policy Detail Model V2
      properties:
        active:
          description: Indicates the policy is active
          type: boolean
        affectedFolderCount:
          description: The count of total folders that would be affected by changing this policy
          type: integer
          format: int32
        affectedInheritingFoldersCount:
          description: The count of inherited secrets that would be affected by changing this policy
          type: integer
          format: int32
        affectedInheritingSecretsCount:
          description: The count of inherited secrets that would be affected by changing this policy
          type: integer
          format: int32
        affectedSecretCount:
          description: The count of total secrets that would be affected by changing this policy
          type: integer
          format: int32
        generalItems:
          $ref: '#/components/schemas/SecretPolicyGeneralItemsModel'
        launcherItems:
          $ref: '#/components/schemas/SecretPolicyLauncherItemsModel'
        rpcItems:
          $ref: '#/components/schemas/SecretPolicyRpcItemsModel'
        secretPolicyDescription:
          description: Secret Policy Description
          type: string
        secretPolicyId:
          description: Secret Policy Id
          type: integer
          format: int32
          nullable: true
        secretPolicyName:
          description: Secret Policy Name
          type: string
        securityItems:
          $ref: '#/components/schemas/SecretPolicySecurityItemsModel'
      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
    UpdateFieldValueOfSecretPolicyDataItemOfLauncherSettingsData:
      description: RDP Launcher Settings as defined by the Secret Policy
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          $ref: '#/components/schemas/SecretPolicyDataItemOfLauncherSettingsData'
      type: object
    SecretPolicyCreateArgsV2:
      description: SecretPolicyCreateArgsV2
      properties:
        data:
          $ref: '#/components/schemas/SecretPolicyCreateModelV2'
      type: object
    SecretPolicyDataItemOfLauncherSettingsData:
      description: Value
      properties:
        policyApplyType:
          $ref: '#/components/schemas/PolicyApplyType'
        value:
          $ref: '#/components/schemas/LauncherSettingsData'
      type: object
    SecretPolicyDataItemOfOptionalGuid:
      description: Value
      properties:
        policyApplyType:
          $ref: '#/components/schemas/PolicyApplyType'
        value:
          description: Value
          type: string
          format: uuid
          nullable: true
      type: object
    AutoChangeScheduleDataModel:
      description: Auto Change Schedule Data Model
      properties:
        changeOnlyWhenExpired:
          description: The password will only be changed when the Secret has expired
          type: boolean
        changeType:
          description: Schedule Change Type
          type: string
          nullable: true
        days:
          description: Days of Recurrence if Daily ScheduleType
          type: integer
          format: int32
          nullable: true
        friday:
          description: Occurs on Fridays when set if Weekly ScheduleType
          type: boolean
          nullable: true
        monday:
          description: Occurs on Mondays when set if Weekly ScheduleType
          type: boolean
          nullable: true
        monthlyDay:
          description: Day(s) used if DayOfWeekMonth and Monthly ScheduleType
          type: string
          nullable: true
        monthlyDayOfMonth:
          description: Day of Month if DayOfMonth and Monthly ScheduleType
          type: integer
          format: int32
          nullable: true
        monthlyDayOrder:
          description: Day Order used if DayOfWeekMonth and Monthly ScheduleType
          type: string
          nullable: true
        monthlyDayOrderRecurrence:
          description: Months of Recurrence if DayOfWeekMonth and Monthly ScheduleType
          type: integer
          format: int32
          nullable: true
        monthlyDayRecurrence:
          description: Months of Recurrence if DayOfMonth and Monthly ScheduleType
          type: integer
          format: int32
          nullable: true
        monthlyScheduleType:
          description: Selection used if Monthly ScheduleType
          type: string
          nullable: true
        saturday:
          description: Occurs on Saturdays when set if Weekly ScheduleType
          type: boolean
          nullable: true
        startingOn:
          description: Day for Schedule to start
          type: string
          format: date-time
        sunday:
          description: Occurs on Sundays when set if Weekly ScheduleType
          type: boolean
          nullable: true
        thursday:
          description: Occurs on Thursdays when set if Weekly ScheduleType
          type: boolean
          nullable: true
        tuesday:
          description: Occurs on Tuesdays when set if Weekly ScheduleType
          type: boolean
          nullable: true
        wednesday:
          description: Occurs on Wednesdays when set if Weekly ScheduleType
          type: boolean
          nullable: true
        weeks:
          description: Weeks of Recurrence if Weekly ScheduleType
          type: integer
          format: int32
          nullable: true
      type: object
    UserGroupMapType:
      description: User Group Map Type
      properties: {}
      type: string
      enum:
      - User
      - Group
    SecretPolicyItemOfSshCommandMenuGroupMapModelArray:
      description: Array of Ssh Command Menu Groups depends on Ssh Command Restriction Type being set
      properties:
        parentPolicyItemId:
          description: ParentPolicyItemId
          type: integer
          format: int32
          nullable: true
        policyApplyType:
          $ref: '#/components/schemas/PolicyApplyType'
        policyItemId:
          description: PolicyItemId
          type: integer
          format: int32
        value:
          description: Value
          items:
            $ref: '#/components/schemas/SshCommandMenuGroupMapModel'
          type: array
      type: object
    UpdateFieldValueOfSecretPolicyDataItemOfOptionalGuid:
      description: Jumpbox Route Id
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalGuid'
      type: object
    SecretPolicyAuditSummary:
      description: Records
      properties:
        action:
          description: Action
          type: string
        databaseName:
          description: DatabaseName
          type: string
        dateRecorded:
          description: DateRecorded
          type: string
          format: date-time
        machineName:
          description: MachineName
          type: string
        notes:
          description: Notes
          type: string
        secretPolicyAuditId:
          description: SecretPolicyAuditId
          type: integer
          format: int32
        userId:
          description: UserId
          type: integer
          format: int32
        username:
          description: Username
          type: string
      type: object
    UpdateFieldValueOfSecretPolicyDataItemOfOptionalCommandRestrictionType:
      description: Ssh Command Restriction Type depends on Enable Ssh Command Restrictions being set
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalCommandRestrictionType'
      type: object
    SecretPolicyGeneralItemsModel:
      description: Secret Policy General Item Model
      properties:
        jumpboxRouteId:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalGuid'
        siteId:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalInt32'
      type: object
    SecretPolicyRpcItemsModel:
      description: Secret Policy RPC Items Model
      properties:
        associatedSecretId1:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalInt32'
        associatedSecretId2:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalInt32'
        autoChangeOnExpiration:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalBoolean'
        autoChangeSchedule:
          $ref: '#/components/schemas/SecretPolicyItemOfAutoChangeScheduleModel'
        heartBeatEnabled:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalBoolean'
        passwordTypeWebScriptId:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalInt32'
        privilegedSecretId:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalInt32'
      type: object
    SecretPolicyDataItemOfOptionalCommandRestrictionType:
      description: Value
      properties:
        policyApplyType:
          $ref: '#/components/schemas/PolicyApplyType'
        value:
          description: Value
          type: string
          nullable: true
      type: object
    SecretPolicySecurityItemsCreateModel:
      description: Secret Policy Security Item Create Model
      properties:
        allowOwnersUnrestrictedSshCommands:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalBoolean'
        approvalGroups:
          $ref: '#/components/schemas/SecretPolicyDataItemOfUserGroupMapDataModelArray'
        approvalWorkflow:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalInt32'
        checkOutChangePassword:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalBoolean'
        checkOutEnabled:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalBoolean'
        checkOutIntervalMinutes:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalInt32'
        enableSshCommandRestrictions:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalBoolean'
        eventPipelinePolicy:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalInt32'
        hideLauncherPassword:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalBoolean'
        isMultiFactorAuthenticationRequired:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalBoolean'
        isProxyEnabled:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalBoolean'
        isSessionRecordingEnabled:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalBoolean'
        requireApprovalForAccess:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalBoolean'
        requireApprovalForAccessForEditors:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalBoolean'
        requireApprovalForAccessForOwnersAndApprovers:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalBoolean'
        requireViewComment:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalBoolean'
        runLauncherUsingSSHKeySecretId:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalInt32'
        sshCommandBlocklistEditors:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalGuid'
        sshCommandBlocklistOwners:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalGuid'
        sshCommandBlocklistViewers:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalGuid'
        sshCommandMenuGroups:
          $ref: '#/components/schemas/SecretPolicyDataItemOfSshCommandMenuGroupModelArray'
        sshCommandRestrictionType:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalCommandRestrictionType'
      type: object
    SecretPolicyGeneralItemsCreateModel:
      description: Secret Policy General Create Item Model
      properties:
        jumpboxRouteId:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalGuid'
        siteId:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalInt32'
      type: object
    SecretPolicyItemOfLauncherSettingsModel:
      description: Launcher Settings defined by the secret policy
      properties:
        parentPolicyItemId:
          description: ParentPolicyItemId
          type: integer
          format: int32
          nullable: true
        policyApplyType:
          $ref: '#/components/schemas/PolicyApplyType'
        policyItemId:
          description: PolicyItemId
          type: integer
          format: int32
        value:
          $ref: '#/components/schemas/LauncherSettingsModel'
      type: object
    SecretPolicyDataItemOfOptionalInt32:
      description: Value
      properties:
        policyApplyType:
          $ref: '#/components/schemas/PolicyApplyType'
        value:
          description: Value
          type: integer
          format: int32
          nullable: true
      type: object
    UserGroupMapDataModel:
      description: User Group Map Data Model
      properties:
        groupId:
          description: User/Group Id
          type: integer
          format: int32
        userGroupMapType:
          $ref: '#/components/schemas/UserGroupMapType'
      type: object
    SecretPolicyLauncherItemsCreateModel:
      description: Secret Policy Launcher Item Create Model
      properties:
        launcherSettings:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfLauncherSettingsData'
        webLauncherRequiresIncognitoMode:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalBoolean'
      type: object
    SecretPolicyCreateModelV2:
      description: Secret Policy Create Model V2
      properties:
        active:
          description: Indicates the policy is active
          type: boolean
        generalItems:
          $ref: '#/components/schemas/SecretPolicyGeneralItemsCreateModel'
        launcherItems:
          $ref: '#/components/schemas/SecretPolicyLauncherItemsCreateModel'
        rpcItems:
          $ref: '#/components/schemas/SecretPolicyRpcItemsCreateModel'
        secretPolicyDescription:
          description: Secret Policy Description
          type: string
        secretPolicyName:
          description: Secret Policy Name
          type: string
        securityItems:
          $ref: '#/components/schemas/SecretPolicySecurityItemsCreateModel'
      type: object
    SecretPolicyDataItemOfOptionalBoolean:
      description: Value
      properties:
        policyApplyType:
          $ref: '#/components/schemas/PolicyApplyType'
        value:
          description: Value
          type: boolean
          nullable: true
      type: object
    UpdateFieldValueOfSecretPolicyDataItemOfUserGroupMapDataModelArray:
      description: Array of UserGroupMaps depends on Require Approval For Access being set
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          $ref: '#/components/schemas/SecretPolicyDataItemOfUserGroupMapDataModelArray'
      type: object
    LauncherSettingsModel:
      description: RDP Launcher Settings
      properties:
        allowClipboard:
          description: Allow Clipboard
          type: boolean
        allowDrives:
          description: Allow Drives
          type: boolean
        allowPrinters:
          description: Allow Printers
          type: boolean
        allowSmartCards:
          description: Allow SmartCards
          type: boolean
        connectToConsole:
          description: Connect To Console
          type: boolean
        launcherHeight:
          description: Launcher Height
          type: integer
          format: int32
          nullable: true
        launcherWidth:
          description: Launcher Height
          type: integer
          format: int32
          nullable: true
        useCustomLauncherResolution:
          description: Use Custom Launcher Resolution
          type: boolean
      type: object
    AuthenticationFailedResponse:
      description: Response object for authentication failures
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
      type: object
    SecretPolicyRpcItemsCreateModel:
      description: Secret Policy RPC Items Create Model
      properties:
        associatedSecretId1:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalInt32'
        associatedSecretId2:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalInt32'
        autoChangeOnExpiration:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalBoolean'
        autoChangeSchedule:
          $ref: '#/components/schemas/SecretPolicyDataItemOfAutoChangeScheduleDataModel'
        heartBeatEnabled:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalBoolean'
        passwordTypeWebScriptId:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalInt32'
        privilegedSecretId:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalInt32'
      type: object
    SecretPolicySecurityItemsUpdateModel:
      description: Secret Policy Security Item Update Model
      properties:
        allowOwnersUnrestrictedSshCommands:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalBoolean'
        approvalGroups:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfUserGroupMapDataModelArray'
        approvalWorkflow:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalInt32'
        checkOutChangePassword:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalBoolean'
        checkOutEnabled:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalBoolean'
        checkOutIntervalMinutes:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalInt32'
        enableSshCommandRestrictions:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalBoolean'
        eventPipelinePolicy:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalInt32'
        hideLauncherPassword:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalBoolean'
        isMultiFactorAuthenticationRequired:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalBoolean'
        isProxyEnabled:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalBoolean'
        isSessionRecordingEnabled:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalBoolean'
        requireApprovalForAccess:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalBoolean'
        requireApprovalForAccessForEditors:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalBoolean'
        requireApprovalForAccessForOwnersAndApprovers:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalBoolean'
        requireViewComment:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalBoolean'
        runLauncherUsingSSHKeySecretId:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalInt32'
        sshCommandBlocklistEditors:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalGuid'
        sshCommandBlocklistOwners:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalGuid'
        sshCommandBlocklistViewers:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalGuid'
        sshCommandMenuGroups:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfSshCommandMenuGroupModelArray'
        sshCommandRestrictionType:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalCommandRestrictionType'
      type: object
    UpdateFieldValueOfSecretPolicyDataItemOfSshCommandMenuGroupModelArray:
      description: Array of Ssh Command Menu Groups depends on Ssh Command Restriction Type being set
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          $ref: '#/components/schemas/SecretPolicyDataItemOfSshCommandMenuGroupModelArray'
      type: object
    SecretPolicyModel:
      description: SecretPolicies
      properties:
        active:
          description: Whether or not the Secret Policy is Active
          type: boolean
        secretPolicyDescription:
          description: The Description of the Secret Policy
          type: string
        secretPolicyId:
          description: The Id of the Secret Policy
          type: integer
          format: int32
        secretPolicyName:
          description: The Name of the Secret Policy
          type: string
      type: object
    SecretPolicyItemOfAutoChangeScheduleModel:
      description: Auto Change Schedule depends on Auto Change On Expiration being set
      properties:
        parentPolicyItemId:
          description: ParentPolicyItemId
          type: integer
          format: int32
          nullable: true
        policyApplyType:
          $ref: '#/components/schemas/PolicyApplyType'
        policyItemId:
          description: PolicyItemId
          type: integer
          format: int32
        value:
          $ref: '#/components/schemas/AutoChangeScheduleModel'
      type: object
    SecretPolicyItemOfOptionalBoolean:
      description: Web Launcher Requires Incognito Mode
      properties:
        parentPolicyItemId:
          description: ParentPolicyItemId
          type: integer
          format: int32
          nullable: true
        policyApplyType:
          $ref: '#/components/schemas/PolicyApplyType'
        policyItemId:
          description: PolicyItemId
          type: integer
          format: int32
        value:
          description: Value
          type: boolean
          nullable: true
      type: object
    SecretPolicyItemOfUserGroupMapModelArray:
      description: Array of UserGroupMaps depends on Require Approval For Access being set
      properties:
        parentPolicyItemId:
          description: ParentPolicyItemId
          type: integer
          format: int32
          nullable: true
        policyApplyType:
          $ref: '#/components/schemas/PolicyApplyType'
        policyItemId:
          description: PolicyItemId
          type: integer
          format: int32
        value:
          description: Value
          items:
            $ref: '#/components/schemas/UserGroupMapModel'
          type: array
      type: object
    SecretPolicyItemOfOptionalGuid:
      description: Jumpbox Route Id
      properties:
        parentPolicyItemId:
          description: ParentPolicyItemId
          type: integer
          format: int32
          nullable: true
        policyApplyType:
          $ref: '#/components/schemas/PolicyApplyType'
        policyItemId:
          description: PolicyItemId
          type: integer
          format: int32
        value:
          description: Value
          type: string
          format: uuid
          nullable: true
      type: object
    SecretPolicyItemOfOptionalInt32:
      description: Site Id
      properties:
        parentPolicyItemId:
          description: ParentPolicyItemId
          type: integer
          format: int32
          nullable: true
        policyApplyType:
          $ref: '#/components/schemas/PolicyApplyType'
        policyItemId:
          description: PolicyItemId
          type: integer
          format: int32
        value:
          description: Value
          type: integer
          format: int32
          nullable: true
      type: object
    PagingOfSecretPolicyModel:
      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/SecretPolicyModel'
          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
    SecretPolicyDataItemOfSshCommandMenuGroupModelArray:
      description: Value
      properties:
        policyApplyType:
          $ref: '#/components/schemas/PolicyApplyType'
        value:
          description: Value
          items:
            $ref: '#/components/schemas/SshCommandMenuGroupModel'
          type: array
      type: object
    SecretPolicyGeneralItemsUpdateModel:
      description: Secret Policy General Update Item Model
      properties:
        jumpboxRouteId:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalGuid'
        siteId:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalInt32'
      type: object
    LauncherSettingsData:
      description: Value
      properties:
        allowClipboard:
          description: AllowClipboard
          type: boolean
        allowDrives:
          description: AllowDrives
          type: boolean
        allowPrinters:
          description: AllowPrinters
          type: boolean
        allowSmartCards:
          description: AllowSmartCards
          type: boolean
        connectToConsole:
          description: ConnectToConsole
          type: boolean
        launcherHeight:
          description: LauncherHeight
          type: integer
          format: int32
          nullable: true
        launcherWidth:
          description: LauncherWidth
          type: integer
          format: int32
          nullable: true
        useCustomLauncherResolution:
          description: UseCustomLauncherResolution
          type: boolean
      type: object
    SecretPolicySecurityItemsModel:
      description: Secret Policy Security Item Model
      properties:
        allowOwnersUnrestrictedSshCommands:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalBoolean'
        approvalGroups:
          $ref: '#/components/schemas/SecretPolicyItemOfUserGroupMapModelArray'
        approvalWorkflow:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalInt32'
        checkOutChangePassword:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalBoolean'
        checkOutEnabled:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalBoolean'
        checkOutIntervalMinutes:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalInt32'
        enableSshCommandRestrictions:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalBoolean'
        eventPipelinePolicy:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalInt32'
        hideLauncherPassword:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalBoolean'
        isMultiFactorAuthenticationRequired:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalBoolean'
        isProxyEnabled:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalBoolean'
        isSessionRecordingEnabled:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalBoolean'
        requireApprovalForAccess:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalBoolean'
        requireApprovalForAccessForEditors:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalBoolean'
        requireApprovalForAccessForOwnersAndApprovers:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalBoolean'
        requireViewComment:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalBoolean'
        runLauncherUsingSSHKeySecretId:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalInt32'
        sshCommandBlocklistEditors:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalGuid'
        sshCommandBlocklistOwners:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalGuid'
        sshCommandBlocklistViewers:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalGuid'
        sshCommandMenuGroups:
          $ref: '#/components/schemas/SecretPolicyItemOfSshCommandMenuGroupMapModelArray'
        sshCommandRestrictionType:
          $ref: '#/components/schemas/SecretPolicyItemOfOptionalCommandRestrictionType'
      type: object
    SecretPolicyLauncherItemsUpdateModel:
      description: Secret Policy Launcher Item Update Model
      properties:
        launcherSettings:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfLauncherSettingsData'
        webLauncherRequiresIncognitoMode:
          $ref: '#/components/schemas/UpdateFieldValueOfSecretPolicyDataItemOfOptionalBoolean'
      type: object
    UpdateFieldValueOfString:
      description: Description
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: string
      type: object
    SecretPolicyItemOfOptionalCommandRestrictionType:
      description: Ssh Command Restriction Type depends on Enable Ssh Command Restrictions being set
      properties:
        parentPolicyItemId:
          description: ParentPolicyItemId
          type: integer
          format: int32
          nullable: true
        policyApplyType:
          $ref: '#/components/schemas/PolicyApplyType'
        policyItemId:
          description: PolicyItemId
          type: integer
          format: int32
        value:
          description: Value
          type: string
          nullable: true
      type: object
    UpdateFieldValueOfSecretPolicyDataItemOfOptionalBoolean:
      description: Web Launcher Requires Incognito Mode
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          $ref: '#/components/schemas/SecretPolicyDataItemOfOptionalBoolean'
      type: object
    UpdateFieldValueOfSecretPolicyDataItemOfAutoChangeScheduleDataModel:
      description: Auto Change Schedule depends on Auto Change On Expiration being set
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          $ref: '#/components/schemas/SecretPolicyDataItemOfAutoChangeScheduleDataModel'
      type: object
    SecretPolicyDataItemOfUserGroupMapDataModelArray:
      description: Value
      properties:
        policyApplyType:
          $ref: '#/components/schemas/PolicyApplyType'
        value:
          description: Value
          items:
            $ref: '#/components/schemas/UserGroupMapDataModel'
          type: array
      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