OpenAPI Specification
openapi: 3.0.0
info:
title: Secret Server Rest Activations InboxRules 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: InboxRules
description: InboxRulesController
paths:
/v1/inbox-rules/{ruleId}/subscribe:
post:
tags:
- InboxRules
summary: Subscribe Current User
description: Subscribe the current user from the rule
operationId: InboxRulesService_SubscribeCurrentUserToRule
parameters:
- name: ruleId
in: path
description: ruleId
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Response if successful
content:
application/json:
schema:
$ref: '#/components/schemas/InboxRuleSubscriptionUpdateResponse'
'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
delete:
tags:
- InboxRules
summary: Unsubscribe current user
description: Unsubscribe the current user from the rule
operationId: InboxRulesService_UnsubscribeCurrentUserFromRule
parameters:
- name: ruleId
in: path
description: ruleId
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Response if successful
content:
application/json:
schema:
$ref: '#/components/schemas/InboxRuleSubscriptionUpdateResponse'
'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/inbox-rules:
get:
tags:
- InboxRules
summary: Search inbox rules
description: Search, filter, sort, and page inbox rules
operationId: InboxRulesService_SearchInboxRules
parameters:
- name: filter.includeCurrentUserSubscriptionStatus
in: query
description: Return the subscription status of the current user whether subscribed directly or via a group.
required: false
x-nullable: true
schema:
type: boolean
- name: filter.includeInactive
in: query
description: Include inactive rules.
required: false
schema:
type: boolean
- name: filter.isImmediate
in: query
description: Only return rules that run immediately or on a schedule, depending on value.
required: false
x-nullable: true
schema:
type: boolean
- name: filter.messageId
in: query
description: Return all rules that will apply to this message id, does not account for time or schedule.
required: false
x-nullable: true
schema:
type: integer
format: int32
- name: filter.messageTypeId
in: query
description: Only return rules that apply to this message type. If a MessageId is passed then this value will be replaced with that message's MessageTypeId.
required: false
x-nullable: true
schema:
type: integer
format: int32
- name: ruleConditionFilters[0].displayValue
in: query
description: Search specifically display values
required: false
schema:
type: string
- name: ruleConditionFilters[0].inboxDataId
in: query
description: Which field is being searched. This value can be null if InboxDataName is passed instead.
required: false
x-nullable: true
schema:
type: integer
format: int32
- name: ruleConditionFilters[0].inboxDataName
in: query
description: Which field is being searched. If InboxDataId is passed this value is ignored.
required: false
schema:
type: string
- name: ruleConditionFilters[0].valueBool
in: query
description: Search specifically for boolean values
required: false
x-nullable: true
schema:
type: boolean
- name: ruleConditionFilters[0].valueInt
in: query
description: Search specifically for int values
required: false
x-nullable: true
schema:
type: integer
format: int32
- name: ruleConditionFilters[0].valueString
in: query
description: Search specifically for string values with a partial match
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: Inbox Rules results
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfInboxRuleSummary'
'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:
- InboxRules
summary: Create Inbox Rule
description: Create a new inbox rule
operationId: InboxRulesService_CreateInboxRule
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InboxRuleCreateArgs'
description: args
responses:
'200':
description: Inbox Rule
content:
application/json:
schema:
$ref: '#/components/schemas/InboxRuleDetailModel'
'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/inbox-rules/{id}:
get:
tags:
- InboxRules
summary: Get Inbox Rule
description: Retrieve inbox rule by Id
operationId: InboxRulesService_GetInboxRule
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Inbox Rule
content:
application/json:
schema:
$ref: '#/components/schemas/InboxRuleDetailModel'
'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:
- InboxRules
summary: Patch Inbox Rule
description: Change properties of an inbox rule
operationId: InboxRulesService_PatchInboxRule
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InboxRulePatchArgs'
description: args
responses:
'200':
description: Inbox Rule
content:
application/json:
schema:
$ref: '#/components/schemas/InboxRuleDetailModel'
'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/inbox-rules/stub:
get:
tags:
- InboxRules
summary: Get Inbox Rule Stub
description: Retrieve an empty inbox rule
operationId: InboxRulesService_GetInboxRuleStub
responses:
'200':
description: Inbox Rule
content:
application/json:
schema:
$ref: '#/components/schemas/InboxRuleDetailModel'
'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/inbox-rules/conditions/{id}:
get:
tags:
- InboxRules
summary: Get Inbox Rule Condition
description: Retrieve inbox rule condition by Id
operationId: InboxRulesService_GetInboxRuleCondition
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Inbox Rule Condition
content:
application/json:
schema:
$ref: '#/components/schemas/InboxRuleConditionDetailModel'
'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/inbox-rules/{id}/conditions:
get:
tags:
- InboxRules
summary: Search Inbox Rule Conditions
description: Search Inbox Rule Conditions
operationId: InboxRulesService_SearchInboxRuleConditions
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Inbox Rule Conditions
content:
application/json:
schema:
$ref: '#/components/schemas/InboxRuleConditionSummary'
'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/inbox-rules/{inboxRuleId}/subscribers:
get:
tags:
- InboxRules
summary: Search inbox rule subscribers
description: Search, filter, sort, and page inbox subscribers
operationId: InboxRulesService_SearchSubscribers
parameters:
- name: inboxRuleId
in: path
description: inboxRuleId
required: true
schema:
type: integer
format: int32
- name: filter.accountTypes
in: query
description: AccountTypes
required: false
schema:
type: string
- name: filter.onlyIncludeUnsubscribableUsers
in: query
description: This will ignore most other filters and return only User accounts that belong to groups that are subscribed. The results will not include users that are directly subscribed as they must be removed from the subscription, not unsubscribed.
required: false
schema:
type: boolean
- name: filter.searchText
in: query
description: Search text to filter users from the unsubscribable users
required: false
schema:
type: string
- 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: Inbox Rule Subscriber results
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfInboxRuleSubscriberSummary'
'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/inbox-rules/{inboxRuleId}/action-log:
get:
tags:
- InboxRules
summary: Get Inbox Rule Logs By Inbox Rule Id
description: Get Inbox Rule Logs By Inbox Rule Id
operationId: InboxRulesService_SearchLog
parameters:
- name: inboxRuleId
in: path
description: inboxRuleId
required: true
schema:
type: integer
format: int32
- name: filter.endDate
in: query
description: EndDate
required: false
x-nullable: true
schema:
type: string
format: date-time
- name: filter.ruleActionStatus
in: query
description: RuleActionStatus
required: false
x-nullable: true
schema:
type: string
- name: filter.startDate
in: query
description: StartDate
required: false
x-nullable: true
schema:
type: string
format: date-time
- 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: Inbox Rule Log results
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfInboxRuleLogSummary'
'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/inbox-rules/{id}/actions:
patch:
tags:
- InboxRules
summary: Patch Inbox Rule Actions
description: Change Inbox Rule Actions
operationId: InboxRulesService_PatchInboxRuleActions
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InboxRuleActionPatchArgs'
description: args
responses:
'200':
description: Inbox Rule
content:
application/json:
schema:
$ref: '#/components/schemas/InboxRuleDetailModel'
'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/inbox-rules/{ruleId}/subscribers:
patch:
tags:
- InboxRules
summary: Patch Inbox Rule Subscribers
description: Add, Remove, or unsubscribe groups, users, and external emails to a specific rule
operationId: InboxRulesService_PatchInboxRuleSubscribers
parameters:
- name: ruleId
in: path
description: ruleId
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InboxRuleSubscribersPatchArgs'
description: args
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/InboxRuleSubscriberUpdateResponse'
'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/inbox-rules/copy:
post:
tags:
- InboxRules
summary: Copy Inbox Rule
description: Copy an inbox rule
operationId: InboxRulesService_CopyInboxRule
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InboxRuleCopyArgs'
description: args
responses:
'200':
description: Inbox Rule
content:
application/json:
schema:
$ref: '#/components/schemas/InboxRuleDetailModel'
'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/inbox-rules/{inboxRuleId}/conditions:
put:
tags:
- InboxRules
summary: Update Inbox Rule Condition
description: Update inbox rule condition
operationId: InboxRulesService_UpdateInboxRuleCondition
parameters:
- name: inboxRuleId
in: path
description: inboxRuleId
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InboxRuleConditionUpdateArgs'
description: args
responses:
'200':
description: Inbox Rule
content:
application/json:
schema:
$ref: '#/components/schemas/InboxRuleDetailModel'
'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:
- InboxRules
summary: Create Inbox Rule Condition
description: Create a new inbox rule condition
operationId: InboxRulesService_CreateInboxRuleCondition
parameters:
- name: inboxRuleId
in: path
description: inboxRuleId
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InboxRuleConditionCreateArgs'
description: args
responses:
'200':
description: Inbox Rule Condition
content:
application/json:
schema:
$ref: '#/components/schemas/InboxRuleConditionDetailModel'
'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
InboxRuleCopyModel:
description: Inbox Rule Copy Model
properties:
inboxRuleIdToCopy:
description: InboxRuleId To Copy
type: integer
format: int32
name:
description: Name
type: string
type: object
UpdateFieldValueOfBoolean:
description: Active
properties:
dirty:
description: Dirty
type: boolean
value:
description: Value
type: boolean
type: object
InboxRuleCreateArgs:
description: InboxRuleCreateArgs
properties:
data:
$ref: '#/components/schemas/InboxRuleCreateModel'
type: object
InboxRuleConditionCreateModel:
description: InboxRuleConditionCreateModel
properties:
displayValue:
description: Display Value
type: string
inboxDataId:
description: Inbox Data
type: integer
format: int32
inboxRuleId:
description: Inbox Rule
type: integer
format: int32
inboxRuleOperand:
$ref: '#/components/schemas/InboxRuleConditionOperand'
valueBool:
description: Boolean Value
type: boolean
nullable: true
valueDateTime:
description: DateTime Value
type: string
format: date-time
nullable: true
valueInt:
description: Integer Value
type: integer
format: int32
nullable: true
valueString:
description: String Value
type: string
type: object
InboxRuleSubscriberEmailUpdate:
description: Change the subscription for a specific email
properties:
emailAddress:
description: A specific email address to add / remove.
type: string
subscribe:
description: Passing true will subscribe this email address, passing false will remove this email address along with any rule action history
type: boolean
type: object
SortDirection:
description: Sort direction
properties: {}
type: string
enum:
- None
- Asc
- Desc
InboxRuleDetailModel:
description: InboxRuleDetailModel
properties:
active:
description: Active
type: boolean
canEditOwnSubscription:
description: Can Edit Own Subscription
type: boolean
conditions:
description: Conditions
items:
$ref: '#/components/schemas/InboxRuleConditionSummary'
type: array
createdByUserId:
description: Created By User Id
type: integer
format: int32
highPriority:
description: High Priority
type: boolean
inboxEmailTemplateId:
description: Inbox Email Template
type: integer
format: int32
nullable: true
inboxMessageTypes:
description: Inbox Message Types
items:
$ref: '#/components/schemas/InboxMessageTypeSummary'
type: array
inboxRuleId:
description: Inbox Rule Id
type: integer
format: int32
inboxSlackTemplateId:
description: Inbox Slack Template
type: integer
format: int32
nullable: true
isImmediate:
description: Is Immediate
type: boolean
isSystem:
description: Is System
type: boolean
name:
description: Name
type: string
recurringScheduleId:
description: The schedule that indicates when this rule should trigger
type: integer
format: int32
nullable: true
sendEmail:
description: Send Email
type: boolean
sendSlack:
description: Send Slack
type: boolean
type: object
InboxDataType:
description: InboxDataType
properties: {}
type: string
enum:
- Integer
- DateTime
- String
- Boolean
Severity:
description: Error severity level
properties: {}
type: string
enum:
- None
- Retry
- Warn
- Critical
- Fatal
InboxRuleActionPatchArgs:
description: InboxRuleActionPatchArgs
properties:
data:
$ref: '#/components/schemas/InboxRuleActionPatchModel'
type: object
InboxRuleActionPatchModel:
description: InboxRuleActionPatchModel
properties:
inboxEmailTemplateId:
$ref: '#/comp
# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/delinea/refs/heads/main/openapi/delinea-inboxrules-api-openapi.yml