OpenAPI Specification
openapi: 3.0.0
info:
title: Secret Server Rest Activations SecretEraseRequests 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: SecretEraseRequests
description: SecretEraseRequestsController
paths:
/v1/secret-erase-requests/{id}/history:
get:
tags:
- SecretEraseRequests
summary: Get Secret Erase History by Secret Erase Request ID
description: Get Secret Erase History by Secret Erase Request ID
operationId: SecretEraseRequestsService_GetHistory
parameters:
- name: id
in: path
description: Secret Erase Request 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: Secret Erase Request Model
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfSecretEraseRequestHistoryModel'
'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-erase-requests/{id}:
get:
tags:
- SecretEraseRequests
summary: Get Secret Erase Request by ID
description: Get Secret Erase Request by ID
operationId: SecretEraseRequestsService_GetRequest
parameters:
- name: id
in: path
description: Secret Erase Request ID
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Secret Erase Request Model
content:
application/json:
schema:
$ref: '#/components/schemas/SecretEraseRequestModel'
'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-erase-requests/secrets:
get:
tags:
- SecretEraseRequests
summary: Get Secret Erase Request Secrets by Secret Erase Request ID
description: Get Secret Erase Request Secrets by Secret Erase Request ID
operationId: SecretEraseRequestsService_GetRequestSecrets
parameters:
- name: filter.erased
in: query
description: Erased
required: false
x-nullable: true
schema:
type: boolean
- name: filter.secretEraseRequestId
in: query
description: SecretEraseRequestId
required: false
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: Secret Erase Request Secret Model
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfSecretEraseRequestSecretModel'
'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-erase-requests/inbox:
get:
tags:
- SecretEraseRequests
summary: Get Secret Erase Requests by Status for Current User.
description: Get Secret Erase Requests by Status for Current User.
operationId: SecretEraseRequestsService_InboxSearch
parameters:
- name: filter.isMyRequest
in: query
description: IsMyRequest
required: false
schema:
type: boolean
- name: filter.status
in: query
description: Status
required: false
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: Secret Erase Request Model
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfSecretEraseRequestModel'
'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-erase-requests/search:
get:
tags:
- SecretEraseRequests
summary: Search Secret Erase Requests by Status for Current User.
description: Search Secret Erase Requests by Status for Current User.
operationId: SecretEraseRequestsService_Search
parameters:
- name: filter.isMyRequest
in: query
description: IsMyRequest
required: false
x-nullable: true
schema:
type: boolean
- name: filter.secretId
in: query
description: SecretId
required: false
x-nullable: true
schema:
type: integer
format: int32
- name: filter.status
in: query
description: Status
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: Secret Erase Request Model
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfSecretEraseRequestModel'
'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-erase-requests/run-now:
get:
tags:
- SecretEraseRequests
summary: Process approved SecretEraseRequests whose EraseAfter time has passed.
description: Process approved SecretEraseRequests whose EraseAfter time has passed.
operationId: SecretEraseRequestsService_ProcessNow
responses:
'200':
description: Attempt to process ready requests.
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-erase-requests:
put:
tags:
- SecretEraseRequests
summary: Update a Secret Erase Request
description: Update a Secret Erase Request
operationId: SecretEraseRequestsService_UpdateRequest
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SecretEraseRequestUpdateArgs'
description: args
responses:
'200':
description: Secret Erase Request Model
content:
application/json:
schema:
$ref: '#/components/schemas/SecretEraseRequestActionResultModel'
'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:
- SecretEraseRequests
summary: Create a new Secret Erase Request
description: Create a new Secret Erase Request
operationId: SecretEraseRequestsService_CreateRequest
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SecretEraseRequestCreateArgs'
description: args
responses:
'200':
description: Secret Erase Request Model
content:
application/json:
schema:
$ref: '#/components/schemas/SecretEraseRequestActionResultModel'
'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
SecretEraseRequestSecretModel:
description: Query results
properties:
id:
description: Id
type: integer
format: int32
requestId:
description: RequestId
type: integer
format: int32
secretId:
description: SecretId
type: integer
format: int32
secretName:
description: SecretName
type: string
timeErased:
description: TimeErased
type: string
format: date-time
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
SecretEraseRequestActionResultModel:
description: SecretEraseRequestActionResultModel
properties:
actionResultMessage:
description: ActionResultMessage
type: string
request:
$ref: '#/components/schemas/SecretEraseRequestModel'
type: object
SecretEraseRequestUpdateArgs:
description: SecretEraseRequestUpdateArgs
properties:
eraseAfter:
$ref: '#/components/schemas/OptionalDateTimeOffset'
responseComment:
description: Response Comment
type: string
secretEraseRequestId:
description: Secret Erase Request Id
type: integer
format: int32
status:
$ref: '#/components/schemas/SecretEraseRequestModelStatus'
type: object
DayOfWeek:
description: DayOfWeek
properties: {}
type: string
enum:
- Sunday
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
SecretEraseRequestHistoryModel:
description: Query results
properties:
action:
description: Action
type: string
dateRecorded:
description: DateRecorded
type: string
format: date-time
details:
description: Details
type: string
fullName:
description: FullName
type: string
type: object
SortDirection:
description: Sort direction
properties: {}
type: string
enum:
- None
- Asc
- Desc
SecretEraseRequestCreateArgs:
description: SecretEraseRequestCreateArgs
properties:
eraseAfter:
description: Erase After Date
type: string
format: date-time
requestComment:
description: Request Comment
type: string
secretIds:
description: Ids of Secrets to Erase
items:
type: integer
format: int32
type: array
type: object
PagingOfSecretEraseRequestSecretModel:
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/SecretEraseRequestSecretModel'
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
PagingOfSecretEraseRequestHistoryModel:
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/SecretEraseRequestHistoryModel'
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
SecretEraseRequestModel:
description: SecretEraseRequestModel
properties:
canApproveOrDeny:
description: CanApproveOrDeny
type: boolean
canCancel:
description: CanCancel
type: boolean
eraseAfter:
description: EraseAfter
type: string
format: date-time
nullable: true
id:
description: Id
type: integer
format: int32
requestComment:
description: RequestComment
type: string
requestDate:
description: RequestDate
type: string
format: date-time
requestUserId:
description: RequestUserId
type: integer
format: int32
requestUserName:
description: RequestUserName
type: string
responseComment:
description: ResponseComment
type: string
reviewStatusMessage:
description: ReviewStatusMessage
type: string
secretCount:
description: SecretCount
type: integer
format: int32
status:
description: Status
type: integer
format: int32
statusDescription:
description: StatusDescription
type: string
timeErased:
description: TimeErased
type: string
format: date-time
nullable: true
workflowInstanceId:
description: WorkflowInstanceId
type: integer
format: int32
nullable: true
type: object
OptionalDateTimeOffset:
description: CreationDate
properties:
date:
description: Date
type: string
format: date-time
dateTime:
description: DateTime
type: string
format: date-time
day:
description: Day
type: integer
format: int32
dayOfWeek:
$ref: '#/components/schemas/DayOfWeek'
dayOfYear:
description: DayOfYear
type: integer
format: int32
hour:
description: Hour
type: integer
format: int32
localDateTime:
description: LocalDateTime
type: string
format: date-time
millisecond:
description: Millisecond
type: integer
format: int32
minute:
description: Minute
type: integer
format: int32
month:
description: Month
type: integer
format: int32
offset:
description: Offset
type: string
format: time-span
second:
description: Second
type: integer
format: int32
ticks:
description: Ticks
type: integer
format: int64
timeOfDay:
description: TimeOfDay
type: string
format: time-span
utcDateTime:
description: UtcDateTime
type: string
format: date-time
utcTicks:
description: UtcTicks
type: integer
format: int64
year:
description: Year
type: integer
format: int32
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
PagingOfSecretEraseRequestModel:
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/SecretEraseRequestModel'
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
SecretEraseRequestModelStatus:
description: 'New status for the request: Pending, Approved, Denied, Canceled, Completed'
properties: {}
type: string
enum:
- Pending
- Approved
- Denied
- Canceled
- Completed
- CompletedWithErrors
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