OpenAPI Specification
openapi: 3.0.0
info:
title: Secret Server Rest Activations ApplicationRequest 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: ApplicationRequest
description: ApplicationRequestController
paths:
/v1/application-access-requests:
get:
tags:
- ApplicationRequest
summary: Get Application Access Requests by Status for Current User.
description: Get Application Access Requests by Status for Current User.
operationId: ApplicationRequestService_SearchRequestsByStatus
parameters:
- 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 Access Model
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfApplicationAccessRequestViewModel'
'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/application-access-request/{deviceId}:
get:
tags:
- ApplicationRequest
summary: Get Application Access Requests by Device Id.
description: Get Application Access Requests by Device Id.
operationId: ApplicationRequestService_GetRequestByDeviceId
parameters:
- name: deviceId
in: path
description: deviceId
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Secret Access Model
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationAccessRequestViewModel'
'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:
- ApplicationRequest
summary: Update Application Access Requests by Device Id.
description: Update Application Access Requests by Device Id.
operationId: ApplicationRequestService_UpdateRequest
parameters:
- name: deviceId
in: path
description: deviceId
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationAccessRequestUpdateArgs'
description: args
responses:
'200':
description: Secret Access Model
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationAccessRequestViewModel'
'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/application-access-request-audits:
get:
tags:
- ApplicationRequest
summary: Get Application Access Request Audits by Device Id.
description: Get Application Access Request Audits by Device Id.
operationId: ApplicationRequestService_GetAudits
parameters:
- name: isExporting
in: query
description: isExporting
required: false
schema:
type: boolean
- name: filter.deviceId
in: query
description: DeviceId
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: Application Access Request Audit View Model
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfApplicationAccessRequestAuditViewModel'
'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
ApplicationAccessStatusRequestType:
description: Status
properties: {}
type: string
enum:
- Approved
- Pending
- Denied
PagingOfApplicationAccessRequestAuditViewModel:
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/ApplicationAccessRequestAuditViewModel'
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
SortDirection:
description: Sort direction
properties: {}
type: string
enum:
- None
- Asc
- Desc
UpdateFieldValueOfApplicationAccessStatusRequestType:
description: Application Access Status
properties:
dirty:
description: Dirty
type: boolean
value:
$ref: '#/components/schemas/ApplicationAccessStatusRequestType'
type: object
ApplicationAccessRequestAuditViewModel:
description: Query results
properties:
action:
description: Action
type: string
databaseName:
description: DatabaseName
type: string
dateRecorded:
description: DateRecorded
type: string
format: date-time
ipAddress:
description: IpAddress
type: string
type: object
Severity:
description: Error severity level
properties: {}
type: string
enum:
- None
- Retry
- Warn
- Critical
- Fatal
PagingOfApplicationAccessRequestViewModel:
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/ApplicationAccessRequestViewModel'
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
ApplicationAccessRequestUpdateModel:
description: Data
properties:
status:
$ref: '#/components/schemas/UpdateFieldValueOfApplicationAccessStatusRequestType'
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
AuthenticationFailedResponse:
description: Response object for authentication failures
required:
- message
properties:
message:
description: Error message
type: string
type: object
ApplicationAccessRequestViewModel:
description: Query results
properties:
createdDate:
description: CreatedDate
type: string
format: date-time
deviceId:
description: DeviceId
type: integer
format: int32
requestingApplicationUsername:
description: RequestingApplicationUsername
type: string
status:
$ref: '#/components/schemas/ApplicationAccessStatusRequestType'
type: object
ApplicationAccessRequestUpdateArgs:
description: ApplicationAccessRequestUpdateArgs
properties:
data:
$ref: '#/components/schemas/ApplicationAccessRequestUpdateModel'
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