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:
                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/clear-new-message-status:
    post:
      tags:
      - Inbox
      summary: Clear New Message Status
      description: Indicates that the Inbox has been viewed and the new message alert status indicator should clear
      operationId: InboxService_ClearNewMessageStatus
      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
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
    InboxTemplateCopyArgs:
      description: InboxTemplateCopyArgs
      properties:
        data:
          $ref: '#/components/schemas/InboxTemplateCopyModel'
      type: object
    PagingOfInboxTemplateModel:
      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/InboxTemplateModel'
          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
    InboxResourceType:
      description: Resource Image Type
      properties: {}
      type: string
      enum:
      - Jpg
      - Png
    SortDirection:
      description: Sort direction
      properties: {}
      type: string
      enum:
      - None
      - Asc
      - Desc
    PagingOfInboxResourceSummary:
      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/InboxResourceSummary'
          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
    AlertNotificationStatus:
      description: Type
      properties: {}
      type: string
      enum:
      - Normal
      - Critical
      - RequiresInteraction
    InboxResourceUploadArgs:
      description: InboxResourceUploadArgs
      properties:
        blob:
          description: 'Uploaded file (used for file attachment fields with "Content-Type: multipart/form-data")'
          type: string
          format: binary
        fileAttachment:
          description: 'Binary file data (used for file attachment fields with "Content-Type: application/json")'
          type: string
          format: binary
        fileName:
          description: 'File name (used for file attachment fields with "Content-Type: application/json"))'
          type: string
        slug:
          description: The unique resource slug.  Must be lowercase with no spaces or special characters except for hyphens.
          type: string
      type: object
    Severity:
      description: Error severity level
      properties: {}
      type: string
      enum:
      - None
      - Retry
      - Warn
      - Critical
      - Fatal
    AlertNotificationType:
      description: NotificationType
      properties: {}
      type: string
      enum:
      - EventSubscription
      - SecretApproval
      - ApplicationAccessRequest
      - SystemAlert
      - SecretEraseRequest
    InboxTemplateLocaleUpdateArgs:
      description: InboxTemplateLocaleUpdateArgs
      properties:
        data:
          $ref: '#/components/schemas/InboxTemplateLocaleUpdateModel'
      type: object
    InboxTestMessageModel:
      description: Data
      properties:
        groupId:
          description: The group ID to send the message.  If omitted the message is sent to the current user.
          type: integer
          format: int32
          nullable: true
        message:
          description: The actual message
          type: string
        subject:
          description: The subject of the message
          type: string
      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
    InboxTemplateLocaleUpdateModel:
      description: Data
      properties:
        subject:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        templateBody:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
      type: object
    AlertNotificationUnreadEventArgs:
      description: AlertNotificationUnreadEventArgs
      properties:
        notificationId:
          description: NotificationId
          type: string
          format: uuid
      type: object
    InboxTemplateType:
      description: Template Type
      properties: {}
      type: string
      enum:
      - Email
      - Slack
    InboxTemplateLocaleCreateModel:
      description: Data
      properties:
        inboxTemplateId:
          description: InboxTemplateId
          type: integer
          format: int32
        localeCultureId:
          description: LocaleCultureId
          type: integer
          format: int32
        subject:
          description: Subject
          type: string
        templateBody:
          description: TemplateBody
          type: string
      type: object
    NotificationStatusModel:
      description: Inbox notification status
      properties:
        applicationRequestPendingTotal:
          description: The number of pending application requests that are pending approval from the current user.
          type: integer
          format: int32
          nullable: true
        hasAlerts:
          description: Does the current user have any alerts
          type: boolean
        inboxNotificationTotal:
          description: The number of notifications since notifications were last viewed online.  If they have never been viewed then in the last seven days.
          type: integer
          format: int32
          nullable: true
        notificationsLastViewed:
          description: The last time the current user viewed their alerts
          type: string
          format: date-time
          nullable: true
        secretAccessRequestPendingTotal:
          description: The number of pending secret access requests that are pending approval from the current user.
          type: integer
          format: int32
          nullable: true
        secretEraseRequestPendingTotal:
          description: The number of pending secret erase requests that are pending approval from the current user.
          type: integer
          format: int32
          nullable: true
        systemAlertTotal:
          description: The number of system alerts.
          type: integer
          format: int32
          nullable: true
      type: object
    InboxTemplateCreateArgs:
      description: InboxTemplateCreateArgs
      properties:
        data:
          $ref: '#/components/schemas/InboxTemplateCreateModel'
      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
    InboxTemplateCopyModel:
      description: Inbox Template Copy Model
      properties:
        inboxTemplateIdToCopy:
          description: InboxTemplateId To Copy
          type: integer
          format: int32
        name:
          description: Name
          type: string
      type: object
    InboxTestMessageArgs:
      description: InboxTestMessageArgs
      properties:
        data:
          $ref: '#/components/schemas/InboxTestMessageModel'
      type: object
    InboxResourceSummary:
      description: Query results
      properties:
        inboxResourceId:
          description: InboxResourceId
          type: integer
          format: int32
        inboxResourceSlug:
          description: InboxResourceSlug
          type: string
        inboxResourceType:
          $ref: '#/components/schemas/InboxResourceType'
      type: object
    InboxMessageSetMessageReadStatusArgs:
      description: InboxMessageSetMessageReadStatusArgs
      properties:
        data:
          $ref: '#/components/schemas/InboxMessageSetMessageReadStatusModel'
      type: object
    AlertNotificationsWrapper:
      description: AlertNotificationsWrapper
      properties:
        hasNewNotifications:
          description: HasNewNotifications
          type: boolean
        systemAlerts:
          description: SystemAlerts
          items:
            $ref: '#/components/schemas/AlertNotification'
          type: array
      type: object
    AlertNotificationReadEventArgs:
      description: AlertNotificationReadEventArgs
      properties:
        notificationId:
          description: NotificationId
          type: string
          format: uuid
      type: object
    InboxTemplateModel:
      description: Query results
      properties:
        isSystem:
          description: Is System
          type: boolean
        rules:
          description: Rules leveraging this Template
          items:
            $ref: '#/components/schemas/InboxRuleModel'
          type: array
        templateId:
          description: Inbox Template Id
          type: integer
          format: int32
        templateName:
          description: Inbox Template Name
          type: string
        templateType:
          $ref: '#/components/schemas/InboxTemplateType'
      type: object
    UpdateFieldValueOfInboxTemplateType:
      description: TemplateType
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          $ref: '#/components/schemas/InboxTemplateType'
      type: object
    AuthenticationFailedResponse:
      description: Response object for authentication failures
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
      type: object
    PagingOfInboxMessageSummary:
      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/InboxMessageSummary'
          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
    InboxRuleModel:
      description: Rules leveraging this Template
      properties:
        inboxRuleId:
          description: Inbox Rule Id
          type: integer
          format: int32
        inboxRuleName:
          description: The name of the rule
          type: string
      type: object
    InboxTemplateDetailModel:
      description: InboxTemplateDetailModel
      properties:
        isSystem:
          description: IsSystem
          type: boolean
        locale:
          description: Locale
          type: integer
          format: int32
        templateId:
          description: TemplateId
          type: integer
          format: int32
        templateName:
          description: TemplateName
          type: string
        templateType:
          $ref: '#/components/schemas/InboxTemplateType'
      type: object
    InboxMessageSetMessageReadStatusModel:
      description: Data
      properties:
        messageIds:
          description: MessageIds
          items:
            type: integer
            format: int32
          type: array
        read:
          description: Read
          type: boolean
      type: object
    InboxMessageSummary:
      description: Summary of an inbox message
      properties:
        data:
          description: All data fields for this messages
          items:
            $ref: '#/components/schemas/InboxMessageData'
          type: array
        details:
          description: A common data field on all notifications
          type: string
        expirationDate:
          description: Within 24 hours of this date this message and all related history will be removed
          type: string
          format: date-time
        inboxMessageTypeId:
          description: The type of message id
          type: integer
          format: int32
        inboxMessageTypeName:
          description: The message type name
          type: string
        isRead:
          description: Has the current user read this message
          type: boolean
        messageCreatedDate:
          description: When was the message created
          type: string
          format: date-time
        messageId:
          description: Message ID
          type: integer
          format: int32
        recipients:
          description: Who has recieved this message
          items:
            type: string
          type: array
      type: object
    InboxMessageData:
      description: All data fields for this messages
      properties:
        displayValue:
          description: DisplayValue
          type: string
        inboxDataId:
          description: InboxDataId
          type: integer
          format: int32
        inboxDataName:
          description: InboxDataName
          type: string
        valueBool:
          description: ValueBool
          type: boolean
          nullable: true
        valueDateTime:
          description: ValueDateTime
          type: string
          format: date-time
          nullable: true
        valueInt:
          description: ValueInt
          type: integer
          format: int32
          nullable: true
        valueString:
          description: ValueString
          type: string
      type: object
    InboxTemplateUpdateArgs:
      description: InboxTemplateUpdateArgs
      properties:
        data:
          $ref: '#/components/schemas/InboxTemplateUpdateModel'
      type: object
    AlertNotification:
      description: SystemAlerts
      properties:
        action:
          description: Action
          type: string
        alertDate:
          description: AlertDate
          type: string
          format: date-time
          nullable: true
        description:
          description: Description
          type: string
        isRead:
          description: IsRead
          type: boolean
          nullable: true
        name:
          description: Name
          type: string
        notificationId:
          description: NotificationId
          type: string
          format: uuid
          nullable: true
        notificationType:
          $ref: '#/components/schemas/AlertNotificationType'
        type:
          $ref: '#/components/schemas/AlertNotificationStatus'
      type: object
    InboxTestMessageResult:
      description: InboxTestMessageResult
      properties:
        emailConfigured:
          description: EmailConfigured
          type: boolean
        success:
          description: Success
          type: boolean
      type: object
    InboxMessageTypeSummary:
      description: InboxMessageTypeSummary[]
      properties:
        inboxMessageTypeId:
          description: Message Type ID
          type: integer
          format: int32
        inboxMessageTypeName:
          description: The name of the message type
          type: string
        notificationCount:
          description: 'Populated with the number of notifications the current user has of this message type.  Only populated when '
          type: integer
          format: int32
          nullable: true
      type: object
    InboxTemplateLocaleModel:
      description: InboxTemplateLocaleModel
      properties:
        localeCultureId:
          description: LocaleCultureId
          type: integer
          format: int32
        subject:
          description: Subject
          type: string
        templateBody:
          description: TemplateBody
          type: string
        templateId:
          description: TemplateId
          type: integer
          format: int32
        templateLocaleId:
          description: TemplateLocaleId
          type: integer
          format: int32
      type: object
    InboxTemplateLocaleCreateArgs:
      description: InboxTemplateLocaleCreateArgs
      properties:
        data:
          $ref: '#/components/schemas/InboxTemplateLocaleCreateModel'
      type: object
    InboxData:
      description: InboxData[]
      properties:
        createdByUserId:
          description: CreatedByUserId
          type: integer
          format: int32
        createdDate:
          description: CreatedDate
          type: string
          format: date-time
        inboxDataId:
          description: InboxDataId
          type: integer
          format: int32
        inboxDataName:
          description: InboxDataName
          type: string
      type: object
    UpdateFieldValueOfString:
      description: Description
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: string
      type: object
    InboxResourceData:
      description: Inbox Resource Data
      properties:
        imageData:
          description: Resource Image Data as Base64 string
          type: string
          format: binary
        imageType:
          $ref: '#/components/schemas/InboxResourceType'
        inboxResourceId:
          description: Inbox Resource Id
          type: integer
          format: int32
        name:
          description: Inbox Resource Name
          type: string
      type: object
    InboxTemplateUpdateModel:
      description: Data
      properties:
        templateName:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        templateType:
          $ref: '#/components/schemas/UpdateFieldValueOfInboxTemplateType'
      type: object
    InboxTemplateCreateModel:
      description: Data
      properties:
        templateName:
          description: TemplateName
          type: string
        templateType:
          $ref: '#/components/schemas/InboxTemplateType'
      type: object
    InboxResourceDeleteResponse:
      description: Response message when deleting an inbox resource
      properties:
        success:
          description: Did the delete succeed
          type: boolean
      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