openapi: 3.0.0
info:
  title: Secret Server Rest Activations SshCommandBlocklist 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: SshCommandBlocklist
  description: View and maintain SSH Command Blocklists
paths:
  /v1/ssh-command-blocklist/{id}:
    get:
      tags:
      - SshCommandBlocklist
      summary: Get an SSH Command Blocklist
      description: Returns the SSH Command Blocklist for the provided ID
      operationId: SshCommandBlocklistService_GetSshCommandBlocklist
      parameters:
      - name: id
        in: path
        description: SSH Command Blocklist ID
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: The SSH Command Blocklist View
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SshCommandBlocklistModel'
        '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/ssh-command-blocklist/list:
    get:
      tags:
      - SshCommandBlocklist
      summary: Get a list of SSH Command Blocklist
      description: Returns a list of SSH Command Blocklists that meet the paging/searching critera
      operationId: SshCommandBlocklistService_GetSshCommandBlocklists
      parameters:
      - name: filter.includeActive
        in: query
        description: IncludeActive
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.includeInactive
        in: query
        description: IncludeInactive
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.name
        in: query
        description: Name
        required: false
        schema:
          type: string
      - name: skip
        in: query
        description: Number of records to skip before taking results
        required: false
        schema:
          type: integer
          format: int32
      - name: sortBy[0].direction
        in: query
        description: Sort direction
        required: false
        schema:
          type: string
      - name: sortBy[0].name
        in: query
        description: Sort field name
        required: false
        schema:
          type: string
      - name: sortBy[0].priority
        in: query
        description: Priority index. Sorts with lower values are executed earlier
        required: false
        schema:
          type: integer
          format: int32
      - name: take
        in: query
        description: Maximum number of records to include in results
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The list of SSH Command Blocklists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSshCommandBlocklistSummaryModel'
        '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/ssh-command-blocklist/stub:
    get:
      tags:
      - SshCommandBlocklist
      summary: Stub an empty SSH Command Blocklist
      description: Returns an empty SSH Command Blocklist to be filled out.
      operationId: SshCommandBlocklistService_GetSshCommandBlocklistStub
      responses:
        '200':
          description: An empty SSH Command Blocklist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SshCommandBlocklistDto'
        '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/ssh-command-blocklist/policies:
    get:
      tags:
      - SshCommandBlocklist
      summary: Get a list of Secret Policies that use the given blocklist
      description: Returns a list of Secret Policies that meet the paging/searching critera
      operationId: SshCommandBlocklistService_GetSshCommandBlocklistPolicies
      parameters:
      - name: filter.sshCommandBlocklistId
        in: query
        description: Results will be associated to the provided blocklist id
        required: false
        schema:
          type: string
          format: uuid
      - 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: The list of Secret Policies
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfBlocklistSecretPolicySummaryModel'
        '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/ssh-command-blocklist/{sshCommandBlocklistId}:
    patch:
      tags:
      - SshCommandBlocklist
      summary: Update an SSH Command Blocklist
      description: Update an SSH Command Blocklist
      operationId: SshCommandBlocklistService_PatchSshCommandBlocklist
      parameters:
      - name: sshCommandBlocklistId
        in: path
        description: sshCommandBlocklistId
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SshCommandBlocklistPatchArgs'
        description: SSH Command Blocklist Update Options
      responses:
        '200':
          description: SSH Command Blocklist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SshCommandBlocklistModel'
        '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/ssh-command-blocklist:
    post:
      tags:
      - SshCommandBlocklist
      summary: Add an SSH Command Blocklist
      description: Add an SSH Command Blocklist
      operationId: SshCommandBlocklistService_CreateSshCommandBlocklist
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SshCommandBlocklistCreateArgs'
        description: SSH Command Blocklist add options
      responses:
        '200':
          description: SSH Command Blocklist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SshCommandBlocklistModel'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
components:
  schemas:
    Sort:
      description: Sort options. Multiple sort options can be provided in the query string.
      required:
      - name
      - direction
      properties:
        direction:
          $ref: '#/components/schemas/SortDirection'
        name:
          description: Sort field name
          type: string
        priority:
          description: Priority index. Sorts with lower values are executed earlier
          type: integer
          format: int32
      type: object
    UpdateFieldValueOfBoolean:
      description: Active
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: boolean
      type: object
    PagingOfSshCommandBlocklistSummaryModel:
      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/SshCommandBlocklistSummaryModel'
          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
    SshCommandBlocklistDto:
      description: SshCommandBlocklistDto
      properties:
        active:
          description: Active
          type: boolean
        description:
          description: Description
          type: string
        name:
          description: Name
          type: string
        sshCommandBlocklistId:
          description: SshCommandBlocklistId
          type: string
          format: uuid
      type: object
    SortDirection:
      description: Sort direction
      properties: {}
      type: string
      enum:
      - None
      - Asc
      - Desc
    Severity:
      description: Error severity level
      properties: {}
      type: string
      enum:
      - None
      - Retry
      - Warn
      - Critical
      - Fatal
    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
    BlocklistSecretPolicySummaryModel:
      description: Query results
      properties:
        secretPolicyId:
          description: The Id of the Secret Policy
          type: integer
          format: int32
        secretPolicyName:
          description: The Name of the Secret Policy
          type: string
      type: object
    SshCommandBlocklistSummaryModel:
      description: SSH command Blocklist
      properties:
        active:
          description: If the Command Blocklist is enabled
          type: boolean
        description:
          description: A description of the Command Blocklist
          type: string
        name:
          description: Name the Command Blocklist
          type: string
        sshCommandBlocklistId:
          description: ID of the Command Blocklist
          type: string
          format: uuid
      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
    PagingOfBlocklistSecretPolicySummaryModel:
      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/BlocklistSecretPolicySummaryModel'
          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
    SshCommandBlocklistCreateArgs:
      description: Options to create SSH Command Blocklist
      properties:
        data:
          $ref: '#/components/schemas/SshCommandBlocklistCreateModel'
      type: object
    SshCommandBlocklistModel:
      description: SSH command Blocklist
      properties:
        active:
          description: Active / inactive
          type: boolean
        description:
          description: SSH command Blocklist description
          type: string
        name:
          description: SSH command Blocklist name
          type: string
        sshCommandBlocklistId:
          description: SSH command Blocklist ID
          type: string
          format: uuid
        sshCommands:
          description: SSH commands in Blocklist
          items:
            $ref: '#/components/schemas/SshCommandModel'
          type: array
      type: object
    UpdateFieldValueOfGuidArray:
      description: SshCommandIds
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          items:
            type: string
            format: uuid
          type: array
      type: object
    AuthenticationFailedResponse:
      description: Response object for authentication failures
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
      type: object
    SshCommandBlocklistPatchArgs:
      description: SshCommandBlocklistPatchArgs
      properties:
        data:
          $ref: '#/components/schemas/SshCommandBlocklistPatchModel'
      type: object
    SshCommandBlocklistPatchModel:
      description: SshCommandBlocklists
      properties:
        active:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        description:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        name:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        sshCommandBlocklistId:
          description: SshCommandBlocklistId
          type: string
          format: uuid
        sshCommandIds:
          $ref: '#/components/schemas/UpdateFieldValueOfGuidArray'
      type: object
    CommandPermissionType:
      description: Allowed or Blocked
      properties: {}
      type: string
      enum:
      - Allowed
      - Blocked
    SshCommandModel:
      description: SSH Command
      properties:
        command:
          description: SSH command
          type: string
        commandPermissionType:
          $ref: '#/components/schemas/CommandPermissionType'
        name:
          description: SSH command name
          type: string
        sortOrder:
          description: Sort order
          type: integer
          format: int32
          nullable: true
        sshCommandGuid:
          description: SSH command Guid
          type: string
          format: uuid
        sshCommandId:
          description: SSH command ID
          type: integer
          format: int32
      type: object
    SshCommandBlocklistCreateModel:
      description: SSH Command Blocklist to create
      properties:
        active:
          description: Active
          type: boolean
        description:
          description: Description
          type: string
        name:
          description: Name
          type: string
        sshCommandBlocklistId:
          description: SshCommandBlocklistId
          type: string
          format: uuid
          nullable: true
        sshCommandIds:
          description: SshCommandIds
          items:
            type: string
            format: uuid
          type: array
      type: object
    UpdateFieldValueOfString:
      description: Description
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: string
      type: object
  securitySchemes:
    BearerToken:
      type: apiKey
      description: 'Perform a POST request to `/oauth2/token`. It should include three form data parameters - `username`, `password`, and `grant_type`.The `grant_type` parameter should always have the value `password`.The access token returned should be included in the header of subsequent requests, like ''Authorization: Bearer <em>token</em>''. The token remains valid for a time period returned in the ''expires_in'' property (in seconds). For details, see the <a href="../OAuth/">token request documentation</a>.'
      name: Authorization
      in: header