Delinea WorkflowTemplates API

openapi: 3.0.0
info:
  title: Secret Server Rest Activations WorkflowTemplates 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: WorkflowTemplates
  description: View and maintain Workflow Templates
paths:
  /v1/workflows/templates:
    get:
      tags:
      - WorkflowTemplates
      summary: Search Workflow Templates
      description: Search, filter, sort, and page Workflow Templates.
      operationId: WorkflowTemplatesService_SearchWorkflowTemplates
      parameters:
      - name: filter.includeInactive
        in: query
        description: IncludeInactive
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.workflowType
        in: query
        description: WorkflowType
        required: false
        x-nullable: true
        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: A paginated list of Workflow Templates.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfWorkflowTemplateDetailModel'
        '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
    post:
      tags:
      - WorkflowTemplates
      summary: Create a Workflow Template
      description: Create a new Workflow Template.
      operationId: WorkflowTemplatesService_CreateWorkflowTemplate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowTemplateCreateArgs'
        description: Workflow Template creation options
      responses:
        '200':
          description: The new Workflow Template's ID.
          content:
            application/json:
              schema:
                description: Int32
                type: integer
                format: int32
        '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/workflows/templates/stub:
    get:
      tags:
      - WorkflowTemplates
      summary: Get a Workflow Template Stub
      description: Get an empty Workflow Template.
      operationId: WorkflowTemplatesService_StubWorkflowTemplate
      responses:
        '200':
          description: An Workflow Template.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowTemplateDetailModel'
        '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/workflows/templates/{id}:
    get:
      tags:
      - WorkflowTemplates
      summary: Get a Workflow Template
      description: Request a specific Workflow Template by ID.
      operationId: WorkflowTemplatesService_GetTemplate
      parameters:
      - name: id
        in: path
        description: Workflow Template Id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The requested Workflow Template.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowTemplateDetailModel'
        '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:
      - WorkflowTemplates
      summary: Update a Workflow Template
      description: Update a single Workflow Template by ID.
      operationId: WorkflowTemplatesService_UpdateWorkflowTemplate
      parameters:
      - name: id
        in: path
        description: Workflow Template ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowTemplateUpdateModel'
        description: Workflow Template update options
      responses:
        '200':
          description: The updated Workflow Template.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowTemplateDetailModel'
        '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/workflows/templates/{id}/audits:
    get:
      tags:
      - WorkflowTemplates
      summary: Get a Workflow Template Audit List
      description: Search, filter, sort, and page Workflow Template Audits.
      operationId: WorkflowTemplatesService_SearchTemplateAudit
      parameters:
      - name: id
        in: path
        description: Workflow Template 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: A paginated list of Workflow Template Audits.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfWorkflowTemplateAuditModel'
        '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/workflows/templates/{id}/entities/{includeAll}:
    get:
      tags:
      - WorkflowTemplates
      summary: Count of Entities using a Workflow Template
      description: Request the number of entities that use the Workflow Template.
      operationId: WorkflowTemplatesService_GetWorkflowEntities
      parameters:
      - name: id
        in: path
        description: Workflow Template Id
        required: true
        schema:
          type: integer
          format: int32
      - name: includeAll
        in: path
        description: includeAll
        required: true
        schema:
          type: boolean
      responses:
        '200':
          description: The number of entities that use the workflow template.
          content:
            application/json:
              schema:
                description: Int32
                type: integer
                format: int32
        '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/workflows/templates/{id}/cancel-requests:
    post:
      tags:
      - WorkflowTemplates
      summary: Cancel Workflow Requests
      description: Cancel all Workflow Requests that are using the provided Workflow Template.
      operationId: WorkflowTemplatesService_CancelRequest
      parameters:
      - name: id
        in: path
        description: Workflow Template Id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Confirmation of cancellation.
          content:
            application/json:
              schema:
                description: String
                type: string
        '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
    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
    WorkflowTemplateAuditModel:
      description: Query results
      properties:
        action:
          description: Action
          type: string
        databaseName:
          description: DatabaseName
          type: string
        dateRecorded:
          description: DateRecorded
          type: string
          format: date-time
        delegatedUserName:
          description: DelegatedUserName
          type: string
        delegateUserId:
          description: DelegateUserId
          type: integer
          format: int32
          nullable: true
        displayName:
          description: DisplayName
          type: string
        formattedDate:
          description: FormattedDate
          type: string
        ipAddress:
          description: IpAddress
          type: string
        machineName:
          description: MachineName
          type: string
        notes:
          description: Notes
          type: string
        userId:
          description: UserId
          type: integer
          format: int32
        userName:
          description: UserName
          type: string
        workflowTemplateAuditId:
          description: WorkflowTemplateAuditId
          type: integer
          format: int32
        workflowTemplateId:
          description: WorkflowTemplateId
          type: integer
          format: int32
      type: object
    SortDirection:
      description: Sort direction
      properties: {}
      type: string
      enum:
      - None
      - Asc
      - Desc
    PagingOfWorkflowTemplateDetailModel:
      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/WorkflowTemplateDetailModel'
          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
    Severity:
      description: Error severity level
      properties: {}
      type: string
      enum:
      - None
      - Retry
      - Warn
      - Critical
      - Fatal
    WorkflowType:
      description: WorkflowType
      properties: {}
      type: string
      enum:
      - AccessRequest
      - SecretEraseRequest
    WorkflowTemplateCreateArgs:
      description: WorkflowTemplateCreateArgs
      required:
      - workflowType
      - name
      properties:
        configurationJson:
          description: ConfigurationJson
          type: string
        description:
          description: Description
          type: string
        expirationMinutes:
          description: ExpirationMinutes
          type: integer
          format: int32
          nullable: true
        name:
          description: Name
          type: string
        workflowType:
          $ref: '#/components/schemas/WorkflowType'
      type: object
    WorkflowTemplateUpdateModel:
      description: WorkflowTemplateUpdateModel
      properties:
        active:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        configurationJson:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        description:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        expirationMinutes:
          $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32'
        isCopy:
          $ref: '#/components/schemas/UpdateFieldValueOfOptionalBoolean'
        name:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
      type: object
    UpdateFieldValueOfString:
      description: Description
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: string
      type: object
    PagingOfWorkflowTemplateAuditModel:
      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/WorkflowTemplateAuditModel'
          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
    AuthenticationFailedResponse:
      description: Response object for authentication failures
      required:
      - message
      properties:
        message:
          description: Error message
          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
    WorkflowTemplateDetailModel:
      description: WorkflowTemplateDetailModel
      properties:
        active:
          description: Active
          type: boolean
        configurationJson:
          description: ConfigurationJson
          type: string
        description:
          description: Description
          type: string
        expirationMinutes:
          description: ExpirationMinutes
          type: integer
          format: int32
          nullable: true
        name:
          description: Name
          type: string
        reusable:
          description: Reusable
          type: boolean
        typeName:
          description: TypeName
          type: string
        workflowTemplateId:
          description: WorkflowTemplateId
          type: integer
          format: int32
        workflowType:
          $ref: '#/components/schemas/WorkflowType'
      type: object
    UpdateFieldValueOfOptionalBoolean:
      description: Use RADIUS Username for DUO
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: boolean
          nullable: true
      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
  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