OpenAPI Specification
openapi: 3.0.0
info:
title: Secret Server Rest Activations EventSubscriptions 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: EventSubscriptions
description: EventSubscriptionsController
paths:
/v1/event-subscriptions/stub:
get:
tags:
- EventSubscriptions
summary: Get an empty event subscription
description: Returns the empty event subscription
operationId: EventSubscriptionsService_GetSubscriptionStub
responses:
'200':
description: An empty event subscription
content:
application/json:
schema:
$ref: '#/components/schemas/EventSubscriptionStubViewModel'
'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/event-subscriptions/event-types:
get:
tags:
- EventSubscriptions
summary: Get an Event Subscription Types and Actions
description: Returns the array of Event Subscription Types and Actions
operationId: EventSubscriptionsService_GetSubscriptionEntityTypes
responses:
'200':
description: The Event Subscription Types and Actions View
content:
application/json:
schema:
description: The Event Subscription Types and Actions View
items:
$ref: '#/components/schemas/EntityTypeModel'
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
/v1/event-subscriptions:
get:
tags:
- EventSubscriptions
summary: Search event subscriptions
description: Search, filter, sort, and page event subscriptions
operationId: EventSubscriptionsService_SearchEventSubscriptions
parameters:
- name: filter.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: event subscriptions results
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfEventSubscriptionSummary'
'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:
- EventSubscriptions
summary: Create event subscription
description: Create a new event subscription
operationId: EventSubscriptionsService_CreateEventSubscription
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EventSubscriptionCreateArgs'
description: args
responses:
'200':
description: Details for a specific event subscription
content:
application/json:
schema:
$ref: '#/components/schemas/EventSubscriptionModel'
'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/event-subscriptions/{eventSubscriptionId}:
get:
tags:
- EventSubscriptions
summary: event subscription
description: Details for a specific event subscription
operationId: EventSubscriptionsService_GetEventSubscription
parameters:
- name: eventSubscriptionId
in: path
description: eventSubscriptionId
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Details for a specific event subscription
content:
application/json:
schema:
$ref: '#/components/schemas/EventSubscriptionModel'
'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:
- EventSubscriptions
summary: Update event subscription
description: Update an event subscription
operationId: EventSubscriptionsService_UpdateEventSubscription
parameters:
- name: eventSubscriptionId
in: path
description: eventSubscriptionId
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EventSubscriptionUpdateArgs'
description: args
responses:
'200':
description: Details for a specific event subscription
content:
application/json:
schema:
$ref: '#/components/schemas/EventSubscriptionModel'
'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
EntityTypeModel:
description: EntityTypeModel[]
properties:
actions:
description: The list of actions available for the entity
items:
$ref: '#/components/schemas/EventSubscriptionTypeActionModel'
type: array
conditionTypeOptions:
description: The list of condition type options available for the entity
items:
$ref: '#/components/schemas/EventSubscriptionConditionTypeOptionModel'
type: array
displayName:
description: The localized name of the entity type, such as Secret, IP Address Range, or Folder
type: string
entity:
$ref: '#/components/schemas/EventSubscriptionEntity'
id:
$ref: '#/components/schemas/EventSubscriptionEntity'
type: object
SortDirection:
description: Sort direction
properties: {}
type: string
enum:
- None
- Asc
- Desc
EventSubscriptionUpdateModel:
description: Data
properties:
active:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
entityActions:
$ref: '#/components/schemas/UpdateFieldValueOfEventSubscriptionEntityActionModelArray'
inboxExpiration:
$ref: '#/components/schemas/UpdateFieldValueOfInt32'
subscribers:
$ref: '#/components/schemas/UpdateFieldValueOfInt32Array'
subscriptionName:
$ref: '#/components/schemas/UpdateFieldValueOfString'
type: object
Severity:
description: Error severity level
properties: {}
type: string
enum:
- None
- Retry
- Warn
- Critical
- Fatal
UpdateFieldValueOfInt32Array:
description: FolderIds
properties:
dirty:
description: Dirty
type: boolean
value:
description: Value
items:
type: integer
format: int32
type: array
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
EventSubscriptionConditionTypeOptionModel:
description: The list of condition type options available for the entity
properties:
optionId:
description: OptionId
type: integer
format: int32
optionName:
description: OptionName
type: string
type: object
EventSubscriptionTypeActionModel:
description: The list of actions available for the entity
properties:
conditions:
description: A list of available conditions to apply to the action/entity combination
items:
$ref: '#/components/schemas/EventSubscriptionConditionType'
type: array
displayName:
description: The localized name
type: string
eventActionId:
description: The ID of the event action
type: integer
format: int32
type: object
UpdateFieldValueOfInt32:
description: How many days until the password expires.
properties:
dirty:
description: Dirty
type: boolean
value:
description: Value
type: integer
format: int32
type: object
EventSubscriptionConditionType:
description: A list of available conditions to apply to the action/entity combination
properties: {}
type: string
enum:
- All
- InFolder
- ShowSubfolder
- ThisFolder
- Secret
- User
- Group
- Role
- Permission
- PasswordChanger
- PasswordRequirement
- CharacterSet
EventSubscriptionEntityActionModel:
description: EntityActions
properties:
conditionType:
$ref: '#/components/schemas/EventSubscriptionConditionType'
containerId:
description: ContainerId
type: integer
format: int32
nullable: true
containerName:
description: Indicates the name of the container, only set on a get. Not needed on an update
type: string
eventActionDisplayName:
description: EventActionDisplayName
type: string
eventActionId:
description: EventActionId
type: integer
format: int32
eventEntityType:
$ref: '#/components/schemas/EventSubscriptionEntity'
eventEntityTypeDisplayName:
description: EventEntityTypeDisplayName
type: string
id:
description: Id
type: integer
format: int32
nullable: true
includeSubcontainers:
description: IncludeSubcontainers
type: boolean
itemId:
description: ItemId
type: integer
format: int32
nullable: true
itemName:
description: ItemName
type: string
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
EventSubscriptionCreateModel:
description: Data
properties:
active:
description: Active
type: boolean
entityActions:
description: EntityActions
items:
$ref: '#/components/schemas/EventSubscriptionEntityActionModel'
type: array
sendEmail:
description: SendEmail
type: boolean
sendSlack:
description: SendSlack
type: boolean
subscriptionName:
description: SubscriptionName
type: string
type: object
ViewFieldLink:
description: AdditionalLinks
properties:
isExternal:
description: IsExternal
type: boolean
linkText:
description: LinkText
type: string
url:
description: Url
type: string
type: object
PagingOfEventSubscriptionSummary:
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/EventSubscriptionSummary'
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
EventSubscriptionStubViewModel:
description: EventSubscriptionStubViewModel
properties:
sendEmail:
$ref: '#/components/schemas/ViewFieldValueOfBoolean'
sendSlack:
$ref: '#/components/schemas/ViewFieldValueOfBoolean'
type: object
EventSubscriptionEntity:
description: The type of item that can be monitored. Secret, folder, engine, etc..
properties: {}
type: string
enum:
- User
- Folder
- Role
- RolePermission
- Configuration
- Group
- IpAddressRange
- Secret
- UnlimitedAdmin
- ExportSecrets
- ImportSecrets
- UserAudit
- SecretTemplate
- Licenses
- ScriptPowerShell
- SecretPolicy
- ScriptSsh
- ScriptSql
- Encryption
- Site
- Engine
- SiteConnector
- SecurityAnalyticsConfiguration
- DualControl
- Tls
- PasswordChanger
- CharacterSet
- PasswordRequirement
- Domain
- BackupConfiguration
- SecretServerSettings
- AutoExport
- SshProxy
- RdpProxy
- Node
- DisasterRecovery
- Platform
- Other
UpdateFieldValueOfEventSubscriptionEntityActionModelArray:
description: A list of the entity actions that file the subscription
properties:
dirty:
description: Dirty
type: boolean
value:
description: Value
items:
$ref: '#/components/schemas/EventSubscriptionEntityActionModel'
type: array
type: object
EventSubscriptionSummary:
description: Query results
properties:
active:
description: Active
type: boolean
eventSubscriptionId:
description: EventSubscriptionId
type: integer
format: int32
name:
description: Name
type: string
type: object
ViewFieldValueOfBoolean:
description: When enabled, the log will be able to be viewed online
properties:
additionalLinks:
description: AdditionalLinks
items:
$ref: '#/components/schemas/ViewFieldLink'
type: array
description:
description: Description
type: string
fieldInputType:
description: FieldInputType
type: string
nullable: true
hasHistory:
description: HasHistory
type: boolean
nullable: true
helpLink:
description: HelpLink
type: string
helpLinkText:
description: HelpLinkText
type: string
hidden:
description: Hidden
type: boolean
nullable: true
hideOnView:
description: HideOnView
type: boolean
nullable: true
isRequired:
description: IsRequired
type: boolean
nullable: true
label:
description: Label
type: string
maxLength:
description: MaxLength
type: integer
format: int32
nullable: true
name:
description: Name
type: string
placeholder:
description: Placeholder
type: string
readOnly:
description: ReadOnly
type: boolean
nullable: true
readOnlyReason:
description: ReadOnlyReason
type: string
sortOrder:
description: SortOrder
type: integer
format: int32
nullable: true
value:
description: Value
type: boolean
type: object
EventSubscriptionModel:
description: An event subscription
properties:
active:
description: Is subscription active
type: boolean
entityActions:
description: A list of the entity actions that file the subscription
items:
$ref: '#/components/schemas/EventSubscriptionEntityActionModel'
type: array
eventSeverity:
description: The event severity
type: integer
format: int32
eventSubscriptionId:
description: The ID of the event subscription
type: integer
format: int32
inboxExpiration:
description: Nuber of days for the message to stay in the inbox
type: integer
format: int32
subscribers:
description: A list of the groups subscribed to the event
items:
$ref: '#/components/schemas/EventSubscriptionSubscriberModel'
type: array
subscriptionName:
description: The name of the event subscription
type: string
type: object
AuthenticationFailedResponse:
description: Response object for authentication failures
required:
- message
properties:
message:
description: Error message
type: string
type: object
EventSubscriptionSubscriberModel:
description: A list of the groups subscribed to the event
properties:
displayName:
description: DisplayName
type: string
groupId:
description: GroupId
type: integer
format: int32
isGroup:
description: IsGroup
type: boolean
type: object
EventSubscriptionCreateArgs:
description: EventSubscriptionCreateArgs
properties:
data:
$ref: '#/components/schemas/EventSubscriptionCreateModel'
type: object
EventSubscriptionUpdateArgs:
description: EventSubscriptionUpdateArgs
properties:
data:
$ref: '#/components/schemas/EventSubscriptionUpdateModel'
type: object
UpdateFieldValueOfString:
description: Description
properties:
dirty:
description: Dirty
type: boolean
value:
description: Value
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 <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