Delinea Inbox API

openapi: 3.0.0
info:
  title: Secret Server Rest Activations Inbox 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: Inbox
  description: InboxController
paths:
  /v1/inbox/templates/resources/{id}:
    get:
      tags:
      - Inbox
      summary: Get inbox resource
      description: Get inbox resource
      operationId: InboxService_GetResource
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Inbox Resource Data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboxResourceData'
        '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:
      - Inbox
      summary: Delete inbox resource
      description: Delete inbox resource
      operationId: InboxService_DeleteResource
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success message
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboxResourceDeleteResponse'
        '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/messages/{messageTypeId?}:
    get:
      tags:
      - Inbox
      summary: Search inbox messages
      description: Search, filter, sort, and page inbox messages
      operationId: InboxService_SearchInboxMessages
      parameters:
      - name: messageTypeId
        in: query
        description: messageTypeId
        required: false
        x-nullable: 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: messageDataFilters[0].displayValue
        in: query
        description: Search specifically display values
        required: false
        schema:
          type: string
      - name: messageDataFilters[0].inboxDataName
        in: query
        description: Which field is being searched
        required: false
        schema:
          type: string
      - name: messageDataFilters[0].valueBool
        in: query
        description: Search specifically for boolean values
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: messageDataFilters[0].valueDateTimeEnd
        in: query
        description: Search specifically for date values less than this date
        required: false
        x-nullable: true
        schema:
          type: string
          format: date-time
      - name: messageDataFilters[0].valueDateTimeStart
        in: query
        description: Search specifically for date values greater than this date
        required: false
        x-nullable: true
        schema:
          type: string
          format: date-time
      - name: messageDataFilters[0].valueInt
        in: query
        description: Search specifically for int values
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: messageDataFilters[0].valueString
        in: query
        description: Search specifically for string values
        required: false
        schema:
          type: string
      - name: filter.messageTypeIds
        in: query
        description: MessageTypeIds
        required: false
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: filter.readStatusFilter
        in: query
        description: ReadStatusFilter
        required: false
        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 Message results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfInboxMessageSummary'
        '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/message/{messageId}:
    get:
      tags:
      - Inbox
      summary: Get Inbox Message by Id
      description: Gets the message summary by id
      operationId: InboxService_GetInboxMessage
      parameters:
      - name: messageId
        in: path
        description: messageId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Inbox Message
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboxMessageSummary'
        '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/data-names:
    get:
      tags:
      - Inbox
      summary: Inbox Message Type Data Names
      description: Get the data names by type for inbox messages
      operationId: InboxService_GetInboxMessageDataNames
      parameters:
      - name: messageTypeIds
        in: query
        description: messageTypeIds
        required: false
        explode: true
        schema:
          type: array
          items:
            type: integer
      responses:
        '200':
          description: Inbox Message results
          content:
            application/json:
              schema:
                description: Inbox Message results
                items:
                  $ref: '#/components/schemas/InboxData'
                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/inbox/templates:
    get:
      tags:
      - Inbox
      summary: Get inbox templates
      description: Get, sort, and page inbox templates
      operationId: InboxService_GetInboxTemplates
      parameters:
      - name: filter.templateType
        in: query
        description: Only return templates of this type.  When null returns all types
        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: Inbox Template results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfInboxTemplateModel'
        '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:
      - Inbox
      summary: Create inbox template
      description: Create inbox template
      operationId: InboxService_CreateInboxTemplate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboxTemplateCreateArgs'
        description: args
      responses:
        '200':
          description: Inbox Template Details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboxTemplateDetailModel'
        '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/templates/{templateId}:
    get:
      tags:
      - Inbox
      summary: Get inbox template
      description: Get inbox template
      operationId: InboxService_GetInboxTemplate
      parameters:
      - name: templateId
        in: path
        description: templateId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Inbox Template Details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboxTemplateDetailModel'
        '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:
      - Inbox
      summary: Patch inbox template
      description: Patch inbox template
      operationId: InboxService_PatchInboxTemplate
      parameters:
      - name: templateId
        in: path
        description: templateId
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboxTemplateUpdateArgs'
        description: args
      responses:
        '200':
          description: Inbox Template Details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboxTemplateDetailModel'
        '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/templates/{templateId}/locales/{localeId}:
    get:
      tags:
      - Inbox
      summary: Get inbox template locale
      description: Get inbox template locale
      operationId: InboxService_GetInboxTemplateLocale
      parameters:
      - name: localeId
        in: path
        description: localeId
        required: true
        schema:
          type: integer
          format: int32
      - name: templateId
        in: path
        description: templateId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Inbox Template Locale
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboxTemplateLocaleModel'
        '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:
      - Inbox
      summary: Patch inbox template locale
      description: Patch inbox template locale
      operationId: InboxService_PatchInboxTemplateLocale
      parameters:
      - name: localeId
        in: path
        description: localeId
        required: true
        schema:
          type: integer
          format: int32
      - name: templateId
        in: path
        description: templateId
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboxTemplateLocaleUpdateArgs'
        description: args
      responses:
        '200':
          description: Inbox Template Locale
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboxTemplateLocaleModel'
        '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/message-types:
    get:
      tags:
      - Inbox
      summary: Get inbox message types
      description: Get inbox message types
      operationId: InboxService_GetInboxMessageTypes
      parameters:
      - name: includeCurrentUserMessageCounts
        in: query
        description: When true the number of each message type the current user has will be added to the response and only message types with a count > 0 will be returned.
        required: false
        x-nullable: true
        schema:
          type: boolean
      responses:
        '200':
          description: Message Types
          content:
            application/json:
              schema:
                description: Message Types
                items:
                  $ref: '#/components/schemas/InboxMessageTypeSummary'
                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/inbox/templates/resources:
    get:
      tags:
      - Inbox
      summary: Get inbox resources
      description: Get, sort, and page inbox resources
      operationId: InboxService_SearchResources
      parameters:
      - 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 Resource Results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfInboxResourceSummary'
        '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
    put:
      tags:
      - Inbox
      summary: Upload an embedded resource
      description: Upload an embedded resource
      operationId: InboxService_UploadResource
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboxResourceUploadArgs'
        description: args
      responses:
        '200':
          description: True or an error
          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/notifications:
    get:
      tags:
      - Inbox
      summary: Get inbox notifications
      description: Get inbox notifications
      operationId: InboxService_GetNotifications
      parameters:
      - name: includeArchived
        in: query
        description: includeArchived
        required: false
        schema:
          type: boolean
      - name: markAlertsAsViewed
        in: query
        description: markAlertsAsViewed
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: Notifications with returned count and indication of new notifications
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertNotificationsWrapper'
        '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/notifications/status:
    get:
      tags:
      - Inbox
      summary: Notification Status
      description: Get the notification status
      operationId: InboxService_GetNotificationsStatus
      responses:
        '200':
          description: Indication of whether the system has alerts and the last checked time
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationStatusModel'
        '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/send-test-message:
    post:
      tags:
      - Inbox
      summary: Send Test Inbox Message
      description: Send a test message to another user that will appear in their inbox.
      operationId: InboxService_SendTestMessage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboxTestMessageArgs'
        description: args
      responses:
        '200':
          description: Success if the message was published for processing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboxTestMessageResult'
        '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/templates/copy:
    post:
      tags:
      - Inbox
      summary: Copy an  inbox template
      description: Create a copy of an inbox template
      operationId: InboxService_CopyInboxTemplate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboxTemplateCopyArgs'
        description: args
      responses:
        '200':
          description: Inbox Template Details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboxTemplateDetailModel'
        '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/templates/template-locale:
    post:
      tags:
      - Inbox
      summary: Create inbox template locale
      description: Create inbox template locale
      operationId: InboxService_CreateInboxTemplateLocale
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboxTemplateLocaleCreateArgs'
        description: args
      responses:
        '200':
          description: Inbox Template Locale
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboxTemplateLocaleModel'
        '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/update-read:
    post:
      tags:
      - Inbox
      summary: Mark messages read or unread
      description: Mark messages read or unread
      operationId: InboxService_UpdateMessageReadStatus
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboxMessageSetMessageReadStatusArgs'
        description: args
      responses:
        '200':
          description: True or an error
          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/notifications/notification-read:
    post:
      tags:
      - Inbox
      summary: Mark alert notification as read
      description: Mark alert notification as read
      operationId: InboxService_MarkAlertNotificationRead
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertNotificationReadEventArgs'
        description: model
      responses:
        '200':
          description: Success
          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/notifications/notification-unread:
    post:
      tags:
      - Inbox
      summary: Mark alert notification as unread
      description: Mark alert notification as unread
      operationId: InboxService_MarkAlertNotificationUnread
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertNotificationUnreadEventArgs'
        description: model
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
   

# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/delinea/refs/heads/main/openapi/delinea-inbox-api-openapi.yml