openapi: 3.0.0 info: title: Secret Server Rest Activations TicketSystems 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 authentication document for more information. The Swagger specification 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: TicketSystems description: TicketSystemsController paths: /v1/ticket-systems: get: tags: - TicketSystems summary: Gets all ticket systems description: Gets all ticket systems. operationId: TicketSystemsService_GetTicketSystems parameters: - name: includeInactive in: query description: includeInactive required: false schema: type: boolean responses: '200': description: Ticket System Models content: application/json: schema: description: Ticket System Models items: $ref: '#/components/schemas/TicketSystemModel' 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: - TicketSystems summary: Creates a Ticket System description: Creates a Ticket System operationId: TicketSystemsService_CreateTicketSystem requestBody: content: application/json: schema: $ref: '#/components/schemas/TicketSystemCreateArgs' description: Ticket System Create Args responses: '200': description: Ticket System Model content: application/json: schema: $ref: '#/components/schemas/TicketSystemModelV2' '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/ticket-systems/{id}: get: tags: - TicketSystems summary: Gets a ticket system by ID description: Gets a ticket system by ID. operationId: TicketSystemsService_GetTicketSystem parameters: - name: id in: path description: Ticket System ID required: true schema: type: integer format: int32 responses: '200': description: Ticket System Model content: application/json: schema: $ref: '#/components/schemas/TicketSystemModel' '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: - TicketSystems summary: Updates a Ticket System description: Updates a Ticket System operationId: TicketSystemsService_UpdateTicketSystem parameters: - name: id in: path description: id required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/TicketSystemPatchArgs' description: Ticket System Patch Args responses: '200': description: Ticket System Model content: application/json: schema: $ref: '#/components/schemas/TicketSystemModelV2' '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/ticket-systems: get: tags: - TicketSystems summary: Gets all ticket systems description: Gets all ticket systems. operationId: TicketSystemsService_GetTicketSystemsV2 parameters: - name: includeInactive in: query description: includeInactive 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: Ticket System Summaries content: application/json: schema: $ref: '#/components/schemas/PagingOfTicketSystemSummary' '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/ticket-systems/{id}: get: tags: - TicketSystems summary: Gets a ticket system by ID description: Gets a ticket system by ID. operationId: TicketSystemsService_GetTicketSystemV2 parameters: - name: id in: path description: Ticket System ID required: true schema: type: integer format: int32 responses: '200': description: Ticket System Model content: application/json: schema: $ref: '#/components/schemas/TicketSystemModelV2' '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/ticket-systems/{ticketSystemId}/test: post: tags: - TicketSystems summary: Test Ticket System description: Test the ticket system validation. operationId: TicketSystemsService_TestTicketSystem parameters: - name: ticketSystemId in: path description: ticketSystemId required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/TicketSystemTestArgs' description: args responses: '200': description: Test status content: application/json: schema: $ref: '#/components/schemas/TicketSystemTestResultModel' '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 UpdateFieldValueOfOptionalBmcChangeManagementCommentWorkType: description: BMC Remedy Change Management integration only. Select work type for comments added. properties: dirty: description: Dirty type: boolean value: description: Value type: string nullable: true type: object SortDirection: description: Sort direction properties: {} type: string enum: - None - Asc - Desc Severity: description: Error severity level properties: {} type: string enum: - None - Retry - Warn - Critical - Fatal TicketSystemSummary: description: Ticket system integration for use with approvals and secret workflow properties: active: description: Indicates if this ticket system is enabled and able to be selected type: boolean description: description: Ticket system description type: string displayMessage: description: The message to display when a ticket is invalid type: string forceRequireTicketNumber: description: Indicates if a ticket number is required when selecting this ticket system type: integer format: int32 hideComment: description: Hide comment box on secret access request. type: boolean isDefault: description: Only one ticket system will be the default and will be selected by default type: boolean name: description: Name of the ticket system that shows when creating secret access requests type: string siteId: description: Site ID type: integer format: int32 nullable: true siteName: description: Site Name type: string ticketSystemId: description: Unique ID for a ticket system type: integer format: int32 ticketSystemTypeId: description: The ID type of the ticket system type: integer format: int32 ticketSystemTypeName: description: The type of ticket system integration type: string viewTicketUrl: description: The URL pattern to view a ticket that has been created 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 TicketSystemTestData: description: Data properties: ticketNumber: description: TicketNumber type: string type: object TicketSystemTypes: description: Value properties: {} type: string enum: - TicketNumberValidation - BmcRemedyIncidentManagement - BmcRemedyChangeManagement - PowerShell - ServiceNowChangeManagement - ServiceNowIncidentManagement TicketSystemTestArgs: description: TicketSystemTestArgs properties: data: $ref: '#/components/schemas/TicketSystemTestData' 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 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 ForceRequireTicketSystemOptions: description: Value properties: {} type: string enum: - ReasonOnlyRequired - BothRequired - TicketNumberOrReasonRequired - TicketNumberOnlyRequired TicketSystemModelV2: description: List of Ticket Systems properties: active: description: Ticket System Active status type: boolean addCommentsToTicket: description: Send comment to your integrated Ticket System and add it to the incident or change request. type: boolean bmcChangeManagementCommentWorkType: description: BMC Remedy Incident Management integration only. Select work type for comments added. type: string nullable: true bmcIncidentManagementCommentWorkType: description: BMC Remedy Incident Management integration only. Select work type for comments added. type: string nullable: true bmcRemedyAuthentication: description: BMC Remedy integration only. Authentication value that usually represents a login server. type: string bmcRemedyUrlEndpoint: description: BMC Remedy integration only. The SOAP URL endpoint for the BMC Remedy Incident or Change Management. Should be the CHG_ChangeInterface_WS or HPD_IncidentInterface_WS endpoint. type: string description: description: Ticket System Description type: string displayMessage: description: Ticket System Ticket Title type: string forceRequireTicketNumber: $ref: '#/components/schemas/ForceRequireTicketSystemOptions' hideComment: description: Hide comment box on secret access request. type: boolean isDefault: description: Indicates the Ticket System is the default choice. type: boolean name: description: Ticket System Name type: string organizationId: description: Ticket System Organization Id type: integer format: int32 nullable: true powerShellAddCommentScriptArguments: description: PowerShell integration only. Optional arguments for the comment script. Arguemnts are separated by a space. type: string powerShellAddCommentScriptId: description: PowerShell integration only. Custom PowerSHell script to add a comment to a ticket system. type: integer format: int32 nullable: true powerShellAddTicketCommentScriptArguments: description: PowerShell integration only. Optional arguments for the ticket comment script. Arguemnts are separated by a space. type: string powerShellAddTicketCommentScriptId: description: PowerShell integration only. Custom PowerSHell script to add a comment to a ticket in a ticket system. type: integer format: int32 nullable: true powerShellRunAsAccountSecretId: description: PowerShell integration only. Secret Id for credentials to use to run the Powershell. type: integer format: int32 nullable: true powerShellRunAsAccountSecretName: description: 'PowerShell integration only. Secret Name for credentials to use to run the Powershell. ' type: string powerShellTicketStatusScriptArguments: description: PowerShell integration only. Optional arguments for the ticket status script. Arguemnts are separated by a space. type: string powerShellTicketStatusScriptId: description: Powreshell Integration only. Custom PowerShell script to get the ticket status. type: integer format: int32 nullable: true serviceNowAllowedStatuses: description: ServiceNow integration only. Statuses to accept from ServiceNow separated by commas. type: string serviceNowDomainName: description: ServiceNow integration only. The domain name that hosts the RESTful web services for Ticket System integration. type: string siteId: description: Ticket System Site type: integer format: int32 nullable: true systemCredentialSecretId: description: Privilged Secret Id for credentials to connect to integrated Ticket Systems. type: integer format: int32 nullable: true systemCredentialSecretName: description: Privilged Secret name for credentials to connect to integrated Ticket Systems. type: string ticketNumberErrorMessage: description: Ticket Number Validation Error Message type: string ticketNumberValidation: description: Ticket Number Validation Regex type: string ticketSystemId: description: The unique Id of the ticket system. type: integer format: int32 ticketSystemType: $ref: '#/components/schemas/TicketSystemTypes' viewTicketUrl: description: Ticket System URL pattern type: string type: object PagingOfTicketSystemSummary: 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/TicketSystemSummary' 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 TicketSystemPatchArgs: description: TicketSystemPatchArgs properties: data: $ref: '#/components/schemas/TicketSystemPatchModel' type: object UpdateFieldValueOfForceRequireTicketSystemOptions: description: Ticket System Comment and/or Number Requirement properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/ForceRequireTicketSystemOptions' type: object TicketSystemPatchModel: description: Data properties: active: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' addCommentsToTicket: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' bmcChangeManagementCommentWorkType: $ref: '#/components/schemas/UpdateFieldValueOfOptionalBmcChangeManagementCommentWorkType' bmcIncidentManagementCommentWorkType: $ref: '#/components/schemas/UpdateFieldValueOfOptionalBmcIncidentManagementCommentWorkType' bmcRemedyAuthentication: $ref: '#/components/schemas/UpdateFieldValueOfString' bmcRemedyUrlEndpoint: $ref: '#/components/schemas/UpdateFieldValueOfString' description: $ref: '#/components/schemas/UpdateFieldValueOfString' displayMessage: $ref: '#/components/schemas/UpdateFieldValueOfString' forceRequireTicketNumber: $ref: '#/components/schemas/UpdateFieldValueOfForceRequireTicketSystemOptions' hideComment: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' isDefault: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' name: $ref: '#/components/schemas/UpdateFieldValueOfString' powerShellAddCommentScriptArguments: $ref: '#/components/schemas/UpdateFieldValueOfString' powerShellAddCommentScriptId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' powerShellAddTicketCommentScriptArguments: $ref: '#/components/schemas/UpdateFieldValueOfString' powerShellAddTicketCommentScriptId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' powerShellRunAsAccountSecretId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' powerShellTicketStatusScriptArguments: $ref: '#/components/schemas/UpdateFieldValueOfString' powerShellTicketStatusScriptId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' serviceNowAllowedStatuses: $ref: '#/components/schemas/UpdateFieldValueOfString' serviceNowDomainName: $ref: '#/components/schemas/UpdateFieldValueOfString' siteId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' systemCredentialSecretId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' ticketNumberErrorMessage: $ref: '#/components/schemas/UpdateFieldValueOfString' ticketNumberValidation: $ref: '#/components/schemas/UpdateFieldValueOfString' ticketSystemId: description: TicketSystemId type: integer format: int32 ticketSystemType: $ref: '#/components/schemas/UpdateFieldValueOfTicketSystemTypes' viewTicketUrl: $ref: '#/components/schemas/UpdateFieldValueOfString' type: object TicketSystemCreateModel: description: Data used to create the new ticket system. properties: active: description: Ticket System Active status type: boolean addCommentsToTicket: description: Send comment to your integrated Ticket System and add it to the incident or change request. type: boolean bmcChangeManagementCommentWorkType: description: BMC Remedy Change Management integration only. Select work type for comments added. type: string nullable: true bmcIncidentManagementCommentWorkType: description: BMC Remedy Incident Management integration only. Select work type for comments added. type: string nullable: true bmcRemedyAuthentication: description: BMC Remedy integration only. Authentication value that usually represents a login server. type: string bmcRemedyUrlEndpoint: description: BMC Remedy integration only. The SOAP URL endpoint for the BMC Remedy Incident or Change Management. Should be the CHG_ChangeInterface_WS or HPD_IncidentInterface_WS endpoint. type: string description: description: Ticket System Dexcription type: string displayMessage: description: Ticket System Ticket Title type: string forceRequireTicketNumber: $ref: '#/components/schemas/ForceRequireTicketSystemOptions' hideComment: description: Hide comment box on secret access request. type: boolean isDefault: description: Indicates the Ticket System is the default choice. type: boolean name: description: Ticket System Name type: string powerShellAddCommentScriptArguments: description: PowerShell integration only. Optional arguments for the comment script. Arguemnts are separated by a space. type: string powerShellAddCommentScriptId: description: PowerShell integration only. Custom PowerSHell script to add a comment to a ticket system. type: integer format: int32 nullable: true powerShellAddTicketCommentScriptArguments: description: PowerShell integration only. Optional arguments for the ticket comment script. Arguemnts are separated by a space. type: string powerShellAddTicketCommentScriptId: description: PowerShell integration only. Custom PowerSHell script to add a comment to a ticket in a ticket system. type: integer format: int32 nullable: true powerShellRunAsAccountSecretId: description: PowerShell integration only. Secret Id for credentials to use to run the Powershell. type: integer format: int32 nullable: true powerShellTicketStatusScriptArguments: description: PowerShell integration only. Optional arguments for the ticket status script. Arguemnts are separated by a space. type: string powerShellTicketStatusScriptId: description: Powreshell Integration only. Custom PowerShell script to get the ticket status. type: integer format: int32 nullable: true serviceNowAllowedStatuses: description: ServiceNow integration only. Statuses to accept from ServiceNow, separated by commas. type: string serviceNowDomainName: description: ServiceNow integration only. The domain name that hosts the RESTful web services for Ticket System integration. type: string siteId: description: Ticket System Site type: integer format: int32 nullable: true systemCredentialSecretId: description: Privilged Secret Id for credentials to connect to integrated Ticket Systems. type: integer format: int32 nullable: true ticketNumberErrorMessage: description: Ticket Number Validation Error Message type: string ticketNumberValidation: description: Ticket Number Validation Regex type: string ticketSystemType: $ref: '#/components/schemas/TicketSystemTypes' viewTicketUrl: description: Ticket System URL pattern type: string type: object AuthenticationFailedResponse: description: Response object for authentication failures required: - message properties: message: description: Error message type: string type: object UpdateFieldValueOfOptionalBmcIncidentManagementCommentWorkType: description: BMC Remedy Incident Management integration only. Select work type for comments added. properties: dirty: description: Dirty type: boolean value: description: Value type: string nullable: true type: object TicketSystemCreateArgs: description: TicketSystemCreateArgs properties: data: $ref: '#/components/schemas/TicketSystemCreateModel' type: object TicketSystemTestResultModel: description: TicketSystemTestResultModel properties: errorMessage: description: ErrorMessage type: string success: description: Success type: boolean type: object UpdateFieldValueOfTicketSystemTypes: description: Ticket System Type properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/TicketSystemTypes' type: object UpdateFieldValueOfString: description: Description properties: dirty: description: Dirty type: boolean value: description: Value type: string type: object TicketSystemModel: description: TicketSystemModel[] properties: active: description: Active type: boolean description: description: Description type: string displayMessage: description: DisplayMessage type: string forceRequireTicketNumber: description: ForceRequireTicketNumber type: integer format: int32 isDefault: description: IsDefault type: boolean name: description: Name type: string ticketSystemId: description: TicketSystemId type: integer format: int32 ticketSystemTypeId: description: TicketSystemTypeId type: integer format: int32 viewTicketUrl: description: ViewTicketUrl 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 token''. The token remains valid for a time period returned in the ''expires_in'' property (in seconds). For details, see the token request documentation.' name: Authorization in: header