openapi: 3.0.0
info:
  title: Secret Server Rest Activations Slack 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: Slack
  description: SlackController
paths:
  /v3/slack-configuration:
    get:
      tags:
      - Slack
      summary: Get Slack Configuration
      description: Fetches the Slack configuration
      operationId: SlackService_GetConfigurationV3
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SlackConfigurationModelV2'
        '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:
      - Slack
      summary: Slack Configuration
      description: Updates the Slack configuration
      operationId: SlackService_UpdateConfigurationV3
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SlackConfigurationUpdateArgsV2'
        description: Slack Configuration Update Options
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SlackConfigurationModelV2'
        '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
  /v2/slack-test:
    get:
      tags:
      - Slack
      summary: Test Slack Configuration
      description: Sends a test Slack message to test the Slack configuration
      operationId: SlackService_SendTestSlackMessage
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SlackConfigurationTestResultModel'
        '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/slack/event:
    post:
      tags:
      - Slack
      summary: Slack Event
      description: Slack event endpoint that only Slack can call, does source validation
      operationId: SlackService_HandleEvent
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SlackResponse'
        '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/slack/interaction:
    post:
      tags:
      - Slack
      summary: Slack Interaction
      description: Slack interation endpoint that only Slack can call, does source validation
      operationId: SlackService_HandleInteraction
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SlackResponse'
        '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:
    UpdateFieldValueOfBoolean:
      description: Active
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: boolean
      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
    SlackConfigurationUpdateModelV2:
      description: Data
      properties:
        appId:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        botToken:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        inboxNotificationsEnabled:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        secretInteractionsEnabled:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        signatureKey:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
      type: object
    SlackConfigurationModelV2:
      description: Slack Configuration
      properties:
        appId:
          description: Id of App
          type: string
        botToken:
          description: Bot Token
          type: string
        currentUserHasSlackId:
          description: CurrentUserHasSlackId
          type: boolean
        inboxNotificationsEnabled:
          description: Enable inbox notifications in Slack
          type: boolean
        secretInteractionsEnabled:
          description: Enable secret notifications and interactions with Slack
          type: boolean
        signatureKey:
          description: Signature Key
          type: string
      type: object
    SlackResponse:
      description: SlackResponse
      properties:
        error:
          description: error
          type: string
        ok:
          description: ok
          type: boolean
        response_metadata:
          $ref: '#/components/schemas/SlackResponseMetadata'
        warning:
          description: warning
          type: string
      type: object
    UpdateFieldValueOfString:
      description: Description
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: string
      type: object
    SlackConfigurationUpdateArgsV2:
      description: SlackConfigurationUpdateArgsV2
      properties:
        data:
          $ref: '#/components/schemas/SlackConfigurationUpdateModelV2'
      type: object
    InternalServerErrorResponse:
      description: Response object for internal server errors
      required:
      - message
      - exceptionMessage
      - exceptionType
      - stackTrace
      properties:
        message:
          description: Error message
          type: string
        exceptionMessage:
          description: Error message from exception
          type: string
        exceptionType:
          description: Exception type
          type: string
        stackTrace:
          description: Exception stack trace
          type: string
      type: object
    AuthenticationFailedResponse:
      description: Response object for authentication failures
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
      type: object
    SlackResponseMetadata:
      description: response_metadata
      properties:
        messages:
          description: messages
          items:
            type: string
          type: array
        warnings:
          description: warnings
          items:
            type: string
          type: array
      type: object
    SlackConfigurationTestResultModel:
      description: SlackConfigurationTestResultModel
      properties:
        success:
          description: Success
          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