openapi: 3.0.0
info:
  title: Secret Server Rest Activations SecretHooks 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: SecretHooks
  description: View and maintain Secret hooks
paths:
  /v1/secret-detail/{secretId}/hook/{secretHookId}:
    put:
      tags:
      - SecretHooks
      summary: Update Secret Hook
      description: Update Secret hook
      operationId: SecretHooksService_UpdateHook
      parameters:
      - name: secretHookId
        in: path
        description: secretHookId
        required: true
        schema:
          type: integer
          format: int32
      - name: secretId
        in: path
        description: secretId
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        $ref: '#/components/requestBodies/SecretDetailHookUpdateArgs'
      responses:
        '200':
          description: Secret hook retrieved after updates
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailHookModel'
        '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
    delete:
      tags:
      - SecretHooks
      summary: Delete Secret Hook
      description: Delete Secret Hook
      operationId: SecretHooksService_DeleteHook
      parameters:
      - name: secretHookId
        in: path
        description: secretHookId
        required: true
        schema:
          type: integer
          format: int32
      - name: secretId
        in: path
        description: secretId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success or failure
          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/secret-detail/{secretId}/hooks:
    get:
      tags:
      - SecretHooks
      summary: Get Secret Hooks
      description: Get all of the hooks for the specified secret
      operationId: SecretHooksService_GetHooks
      parameters:
      - name: secretId
        in: path
        description: secretId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: A collection
          content:
            application/json:
              schema:
                description: A collection
                items:
                  $ref: '#/components/schemas/SecretDetailHookSummaryViewModel'
                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/secret-detail/{secretId}/hook/stub/{scriptId}:
    get:
      tags:
      - SecretHooks
      summary: Stub Hook
      description: Get stub for a new Secret hook
      operationId: SecretHooksService_StubHook
      parameters:
      - name: scriptId
        in: path
        description: scriptId
        required: true
        schema:
          type: integer
          format: int32
      - name: secretId
        in: path
        description: secretId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Stub for a new Secret hook
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailHookModel'
        '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-detail/{secretId}/hook/get/{secretHookId}:
    get:
      tags:
      - SecretHooks
      summary: Get Secret hook details
      description: Get Secret hook details
      operationId: SecretHooksService_GetHook
      parameters:
      - name: secretHookId
        in: path
        description: secretHookId
        required: true
        schema:
          type: integer
          format: int32
      - name: secretId
        in: path
        description: secretId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Secret hook details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailHookModel'
        '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-detail/{secretId}/hooks:
    get:
      tags:
      - SecretHooks
      summary: Get Secret Hooks
      description: Get all of the hooks for the specified secret
      operationId: SecretHooksService_GetHooksV2
      parameters:
      - name: secretId
        in: path
        description: secretId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: A collection
          content:
            application/json:
              schema:
                description: A collection
                items:
                  $ref: '#/components/schemas/SecretDetailHookSummaryViewModel'
                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
  /v2/secret-detail/{secretId}/hook/stub/{scriptId}:
    get:
      tags:
      - SecretHooks
      summary: Stub Hook
      description: Get stub for a new Secret hook
      operationId: SecretHooksService_StubHookV2
      parameters:
      - name: scriptId
        in: path
        description: scriptId
        required: true
        schema:
          type: integer
          format: int32
      - name: secretId
        in: path
        description: secretId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Stub for a new Secret hook
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailHookModel'
        '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-detail/{secretId}/hook/get/{secretHookId}:
    get:
      tags:
      - SecretHooks
      summary: Get Secret hook details
      description: Get Secret hook details
      operationId: SecretHooksService_GetHookV2
      parameters:
      - name: secretHookId
        in: path
        description: secretHookId
        required: true
        schema:
          type: integer
          format: int32
      - name: secretId
        in: path
        description: secretId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Secret hook details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailHookModel'
        '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-detail/{secretId}/hook:
    post:
      tags:
      - SecretHooks
      summary: Create Secret hook
      description: Create Secret hook
      operationId: SecretHooksService_CreateHook
      parameters:
      - name: secretId
        in: path
        description: secretId
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        $ref: '#/components/requestBodies/SecretDetailHookCreateArgs'
      responses:
        '200':
          description: Newly created Secret hook
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailHookModel'
        '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-detail/{secretId}/hook:
    post:
      tags:
      - SecretHooks
      summary: Create Secret hook v2
      description: Create Secret hook v2
      operationId: SecretHooksService_CreateHookV2
      parameters:
      - name: secretId
        in: path
        description: secretId
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        $ref: '#/components/requestBodies/SecretDetailHookCreateArgs'
      responses:
        '200':
          description: Newly created Secret hook
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailHookModel'
        '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-detail/{secretId}/hook/{secretHookId}:
    put:
      tags:
      - SecretHooks
      summary: Update Secret Hook
      description: Update Secret hook
      operationId: SecretHooksService_UpdateHookV2
      parameters:
      - name: secretHookId
        in: path
        description: secretHookId
        required: true
        schema:
          type: integer
          format: int32
      - name: secretId
        in: path
        description: secretId
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        $ref: '#/components/requestBodies/SecretDetailHookUpdateArgs'
      responses:
        '200':
          description: Secret hook retrieved after updates
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDetailHookModel'
        '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:
    UpdateFieldValueOfBoolean:
      description: Active
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: boolean
      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
    SecretDetailHookUpdateArgs:
      description: SecretDetailHookUpdateArgs
      properties:
        data:
          $ref: '#/components/schemas/SecretDetailHookUpdateModel'
      type: object
    SecretDetailHookSummaryViewModel:
      description: SecretDetailHookSummaryViewModel[]
      properties:
        description:
          description: Hook Description
          type: string
        eventActionName:
          description: Event Action Name
          type: string
        hookId:
          description: Hook Id
          type: integer
          format: int32
        name:
          description: Hook Name
          type: string
        prePostOption:
          description: Hook PRE or POST Option
          type: string
        scriptId:
          description: Script Id
          type: integer
          format: int32
        scriptName:
          description: Script Name
          type: string
        scriptTypeName:
          description: Script Type Name
          type: string
        secretHookId:
          description: Secret Hook Id
          type: integer
          format: int32
        sortOrder:
          description: Hook Sort Order
          type: integer
          format: int32
        status:
          description: Hook Status
          type: boolean
        stopOnFailure:
          description: Stop On Failure
          type: boolean
      type: object
    SecretDetailHookParameterViewModel:
      description: Hook Parameter
      properties:
        parameterName:
          description: Parameter Name
          type: string
        parameterType:
          description: Parameter Type
          type: string
        parameterValue:
          description: Parameter Value
          type: string
      type: object
    SecretDetailHooksCreateModel:
      description: Secret Detail Hook Create Model
      properties:
        arguments:
          description: Arguments
          type: string
        asSys:
          description: As Sys
          type: boolean
        database:
          description: Database
          type: string
        description:
          description: Hook Description
          type: string
        eventActionId:
          description: Event Action Id
          type: integer
          format: int32
        failureMessage:
          description: Failure MEssage
          type: string
        name:
          description: Hook Name
          type: string
        parameters:
          description: Hook Parameters
          items:
            $ref: '#/components/schemas/SecretDetailHookParameterViewModel'
          type: array
        port:
          description: Port
          type: string
        prePostOption:
          description: Hook Pre or Post Option
          type: string
        privilegedSecretId:
          description: Privileged Secret Id
          type: integer
          format: int32
          nullable: true
        scriptId:
          description: Script Id
          type: integer
          format: int32
        secretId:
          description: Secret Id
          type: integer
          format: int32
        serverKeyDigest:
          description: Server Key Digest
          type: string
        serverName:
          description: Server Name
          type: string
        sshKeySecretId:
          description: SSH Key Secret Id
          type: integer
          format: int32
          nullable: true
        sslServerCertDN:
          description: SSL Server Cert DN
          type: string
        stopOnFailure:
          description: Stop On Failure
          type: boolean
        tnsAdmin:
          description: TNS Admin
          type: string
        walletLocation:
          description: Wallet Location
          type: string
      type: object
    SecretDetailHookUpdateModel:
      description: Secret Detail Hook Update Model
      properties:
        arguments:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        asSys:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        asSysString:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        database:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        description:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        eventActionId:
          $ref: '#/components/schemas/UpdateFieldValueOfInt32'
        failureMessage:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        name:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        parameters:
          description: Parameters
          items:
            $ref: '#/components/schemas/SecretDetailHookParameterViewModel'
          type: array
        port:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        prePostOption:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        privilegedSecretId:
          $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32'
        scriptId:
          $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32'
        scriptTypeId:
          $ref: '#/components/schemas/UpdateFieldValueOfInt32'
        serverKeyDigest:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        serverName:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        sortOrder:
          $ref: '#/components/schemas/UpdateFieldValueOfInt32'
        sshKeySecretId:
          $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32'
        sslServerCertDN:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        status:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        stopOnFailure:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        tnsAdmin:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        walletLocation:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
      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
    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
    SecretDetailHookModel:
      description: Secret Detail Hook View Model
      properties:
        arguments:
          description: Arguments
          type: string
        database:
          description: Database
          type: string
        description:
          description: Hook Description
          type: string
        eventActionId:
          description: Event Action Id
          type: integer
          format: int32
        failureMessage:
          description: Failure Message
          type: string
        hookId:
          description: Hook Id
          type: integer
          format: int32
        name:
          description: Hook Name
          type: string
        parameters:
          description: Parameters
          items:
            $ref: '#/components/schemas/SecretDetailHookParameterViewModel'
          type: array
        port:
          description: Port
          type: string
        prePostOption:
          description: Hook PRE or POST Option
          type: string
        privilegedSecretId:
          description: Privilige Secret Id
          type: integer
          format: int32
          nullable: true
        scriptId:
          description: Script Id
          type: integer
          format: int32
        scriptTypeId:
          description: Script Type Id
          type: integer
          format: int32
        secretHookId:
          description: Secret Hook Id
          type: integer
          format: int32
        serverKeyDigest:
          description: Server Key Digest
          type: string
        serverName:
          description: Server Name
          type: string
        sortOrder:
          description: Hook Sort Order
          type: integer
          format: int32
        sshKeySecretId:
          description: SSH Key Secret Id
          type: integer
          format: int32
          nullable: true
        status:
          description: Hook Status
          type: boolean
        stopOnFailure:
          description: Stop on Failure
          type: boolean
      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
    UpdateFieldValueOfOptionalInt32:
      description: The minimum length required for local user passwords
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: integer
          format: int32
          nullable: true
      type: object
    SecretDetailHookCreateArgs:
      description: Create Secret Hook Arguments
      properties:
        data:
          $ref: '#/components/schemas/SecretDetailHooksCreateModel'
      type: object
  requestBodies:
    SecretDetailHookUpdateArgs:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SecretDetailHookUpdateArgs'
      description: args
    SecretDetailHookCreateArgs:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SecretDetailHookCreateArgs'
      description: args
  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