Delinea EventPipelineTrigger API

openapi: 3.0.0
info:
  title: Secret Server Rest Activations EventPipelineTrigger 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: EventPipelineTrigger
  description: EventPipelineTriggerController
paths:
  /v1/event-pipeline/{id}/trigger:
    get:
      tags:
      - EventPipelineTrigger
      summary: Get the triggers for an Event Pipeline
      description: Returns the triggers for the Event Pipeline that has the provided ID
      operationId: EventPipelineTriggerService_GetEventPipelineTriggers
      parameters:
      - name: id
        in: path
        description: Event Pipeline ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The list of Event Pipeline Triggers
          content:
            application/json:
              schema:
                description: The list of Event Pipeline Triggers
                items:
                  $ref: '#/components/schemas/EventPipelineTriggerSummary'
                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/event-pipeline/trigger/stub:
    get:
      tags:
      - EventPipelineTrigger
      summary: Stub an Event Pipeline Trigger
      description: Creates an empty Event Pipeline Trigger to be populated
      operationId: EventPipelineTriggerService_GetEventPipelineStub
      responses:
        '200':
          description: The empty Event Pipeline Trigger
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventPipelineTrigger'
        '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/event-pipeline/trigger/options:
    get:
      tags:
      - EventPipelineTrigger
      summary: Get Pipeline Trigger Options
      description: returns all available pipeline trigger options for a specific entity type
      operationId: EventPipelineTriggerService_GetEventPipelineTriggerOptions
      parameters:
      - name: eventEntityTypeId
        in: query
        description: eventEntityTypeId
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: List of triggers
          content:
            application/json:
              schema:
                description: List of triggers
                items:
                  $ref: '#/components/schemas/EventPipelineTriggerSummary'
                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
components:
  schemas:
    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
    EventPipelineTriggerSummary:
      description: EventPipelineTriggerSummary[]
      properties:
        entityTypeDisplayName:
          description: Entity Type Display Name
          type: string
        eventActionId:
          description: Event Action ID ID
          type: integer
          format: int32
        eventEntityTypeId:
          description: Event Entity Type ID
          type: integer
          format: int32
        eventPipelineId:
          description: Event Pipeline ID
          type: integer
          format: int32
        eventPipelineTriggerId:
          description: Event Pipeline Trigger ID
          type: integer
          format: int32
        triggerDisplayName:
          description: Trigger Display Name
          type: string
      type: object
    InternalServerErrorResponse:
      description: Response object for internal server errors
      required:
      - message
      - exceptionMessage
      - exceptionType
      - stackTrace
      properties:
        message:
          description: Error message
          type: string
        exceptionMessage:
          description: Error message from exception
          type: string
        exceptionType:
          description: Exception type
          type: string
        stackTrace:
          description: Exception stack trace
          type: string
      type: object
    EventPipelineTrigger:
      description: EventPipelineTrigger
      properties:
        entityTypeDisplayName:
          description: EntityTypeDisplayName
          type: string
        eventActionId:
          description: EventActionId
          type: integer
          format: int32
        eventActionName:
          description: EventActionName
          type: string
        eventEntityTypeId:
          description: EventEntityTypeId
          type: integer
          format: int32
        eventPipelineId:
          description: EventPipelineId
          type: integer
          format: int32
        eventPipelineTriggerId:
          description: EventPipelineTriggerId
          type: integer
          format: int32
        triggerDisplayName:
          description: TriggerDisplayName
          type: string
      type: object
    AuthenticationFailedResponse:
      description: Response object for authentication failures
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
      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