Delinea WorkflowStepTemplates API
View and maintain Workflow Template Steps
OpenAPI Specification
openapi: 3.0.0
info:
title: Secret Server Rest Activations WorkflowStepTemplates 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: WorkflowStepTemplates
description: View and maintain Workflow Template Steps
paths:
/v1/workflows/templates/{id}/steps:
get:
tags:
- WorkflowStepTemplates
summary: Get Workflow Template Steps
description: Get all the steps for a workflow template
operationId: WorkflowStepTemplatesService_GetTemplateSteps
parameters:
- name: id
in: path
description: Workflow Template ID
required: true
schema:
type: integer
format: int32
- 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 list of workflow step models
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfWorkflowStepTemplateDetailModel'
'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:
- WorkflowStepTemplates
summary: Update Workflow Template Steps
description: Update the steps for a workflow template
operationId: WorkflowStepTemplatesService_UpdateStep
parameters:
- name: id
in: path
description: Workflow Template ID
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowStepTemplateUpdateArgs'
description: Workflow Template Steps creation options
responses:
'200':
description: The workflow template steps
content:
application/json:
schema:
description: The workflow template steps
items:
$ref: '#/components/schemas/WorkflowStepTemplateDetailModel'
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
post:
tags:
- WorkflowStepTemplates
summary: Create Workflow Step
description: Create a step for a Workflow Template
operationId: WorkflowStepTemplatesService_CreateStep
parameters:
- name: id
in: path
description: Workflow Template Id
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowStepTemplateCreateArgs'
description: Workflow Template Step creation options
responses:
'200':
description: New Workflow Template Steps 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/steps/stub:
get:
tags:
- WorkflowStepTemplates
summary: Get a Workflow Template Step Stub
description: Get an empty Workflow Template Step
operationId: WorkflowStepTemplatesService_Stub
responses:
'200':
description: An empty workflow step
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}/steps/{stepNum}:
get:
tags:
- WorkflowStepTemplates
summary: Get a Workflow Template Step
description: Get a step for a workflow template
operationId: WorkflowStepTemplatesService_GetTemplateStep
parameters:
- name: id
in: path
description: Workflow Template Id
required: true
schema:
type: integer
format: int32
- name: stepNum
in: path
description: Workflow Step Number
required: true
schema:
type: integer
format: int32
responses:
'200':
description: A workflow step model
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowStepTemplateDetailModel'
'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:
- WorkflowStepTemplates
summary: Update a Workflow Template Step
description: Updates a single Workflow Template Step by ID
operationId: WorkflowStepTemplatesService_UpdateStepModel
parameters:
- name: id
in: path
description: Workflow Template ID
required: true
schema:
type: integer
format: int32
- name: stepNum
in: path
description: Workflow Step Number
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowStepTemplateUpdateModel'
description: Workflow Template update options
responses:
'200':
description: Workflow Template Step
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowStepTemplateDetailModel'
'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
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
SortDirection:
description: Sort direction
properties: {}
type: string
enum:
- None
- Asc
- Desc
AccessRequestStepConfigurationModel:
description: Configuration
properties:
approverGroups:
description: ApproverGroups
items:
$ref: '#/components/schemas/AccessReviewerModel'
type: array
approveStep:
description: ApproveStep
type: integer
format: int32
expireStep:
description: ExpireStep
type: integer
format: int32
numApprovalsRequired:
description: NumApprovalsRequired
type: integer
format: int32
type: object
WorkflowStepTemplateUpdateModel:
description: WorkflowStepTemplateUpdateModel
properties:
configuration:
$ref: '#/components/schemas/AccessRequestStepConfigurationModel'
expirationMinutes:
description: ExpirationMinutes
type: integer
format: int32
nullable: true
name:
description: Name
type: string
order:
description: Order
type: integer
format: int32
workflowStepTemplateId:
description: WorkflowStepTemplateId
type: integer
format: int32
type: object
WorkflowStepTemplateUpdateArgs:
description: WorkflowStepTemplateUpdateArgs
properties:
workflowStepTemplates:
description: WorkflowStepTemplates
items:
$ref: '#/components/schemas/WorkflowStepTemplateDetailModel'
type: array
type: object
WorkflowStepTemplateCreateArgs:
description: WorkflowStepTemplateCreateArgs
properties:
configuration:
$ref: '#/components/schemas/AccessRequestStepConfigurationModel'
name:
description: Name
type: string
order:
description: Order
type: integer
format: int32
workflowTemplateId:
description: WorkflowTemplateId
type: integer
format: int32
type: object
Severity:
description: Error severity level
properties: {}
type: string
enum:
- None
- Retry
- Warn
- Critical
- Fatal
AccessReviewerModel:
description: ApproverGroups
properties:
accessReviewerId:
description: AccessReviewerId
type: integer
format: int32
displayName:
description: DisplayName
type: string
groupId:
description: GroupId
type: integer
format: int32
nullable: true
isOwner:
description: IsOwner
type: boolean
isUser:
description: IsUser
type: boolean
nullable: true
workflowStepTemplateId:
description: WorkflowStepTemplateId
type: integer
format: int32
workflowTemplateId:
description: WorkflowTemplateId
type: integer
format: int32
nullable: true
type: object
WorkflowType:
description: WorkflowType
properties: {}
type: string
enum:
- AccessRequest
- SecretEraseRequest
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
AuthenticationFailedResponse:
description: Response object for authentication failures
required:
- message
properties:
message:
description: Error message
type: string
type: object
WorkflowStepTemplateDetailModel:
description: Query results
properties:
configuration:
$ref: '#/components/schemas/AccessRequestStepConfigurationModel'
expirationMinutes:
description: ExpirationMinutes
type: integer
format: int32
nullable: true
name:
description: Name
type: string
order:
description: Order
type: integer
format: int32
workflowStepTemplateId:
description: WorkflowStepTemplateId
type: integer
format: int32
workflowTemplateId:
description: WorkflowTemplateId
type: integer
format: int32
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
PagingOfWorkflowStepTemplateDetailModel:
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/WorkflowStepTemplateDetailModel'
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
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