Delinea SecretTemplates API

openapi: 3.0.0
info:
  title: Secret Server Rest Activations SecretTemplates 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: SecretTemplates
  description: View secret templates
paths:
  /v1/secret-templates/fields/{templateFieldId}:
    delete:
      tags:
      - SecretTemplates
      summary: Disable a Secret Template Field For Template
      description: Disable a Secret Template Field For Template
      operationId: SecretTemplatesService_DisableField
      parameters:
      - name: templateFieldId
        in: path
        description: Secret Template Field to disable
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Secret Template Field object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretTemplateField'
        '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/secret-templates/password-requirements/password-dictionaries/{id}:
    get:
      tags:
      - SecretTemplates
      summary: Gets password dictionary items by ID
      description: Returns a file containing the items of a specific custom password dictionary.
      operationId: SecretTemplatesService_GetPasswordDictionary
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Unknown or empty response
        '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:
      - SecretTemplates
      summary: Deletes a specific password dictionary by ID
      description: Deletes a specific custom password dictionary with the contents.
      operationId: SecretTemplatesService_DeletePasswordDictionary
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: 'true'
          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/secret-templates/{secretTemplateId}/extended-mappings/{extendedTypeId}:
    get:
      tags:
      - SecretTemplates
      summary: Get a single Secret Template Extended Mappings
      description: Get an extended mapping for a Secret Template
      operationId: SecretTemplatesService_GetSecretTemplateExtendedMapping
      parameters:
      - name: extendedTypeId
        in: path
        description: extendedTypeId
        required: true
        schema:
          type: integer
          format: int32
      - name: secretTemplateId
        in: path
        description: secretTemplateId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Extended Mapping Detail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretTemplateExtendedMappingModel'
        '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:
      - SecretTemplates
      summary: Create a Secret Template Extended Mapping
      description: Create an extended mappings for a Secret Template
      operationId: SecretTemplatesService_CreateSecretTemplateExtendedMapping
      parameters:
      - name: extendedTypeId
        in: path
        description: extendedTypeId
        required: true
        schema:
          type: integer
          format: int32
      - name: secretTemplateId
        in: path
        description: secretTemplateId
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretTemplateExtendedMappingCreateArgs'
        description: args
      responses:
        '200':
          description: Created extended mappings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretTemplateExtendedMappingModel'
        '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:
      - SecretTemplates
      summary: Delete Extended Mapping
      description: Delete an extended mapping
      operationId: SecretTemplatesService_DeleteExtendedMapping
      parameters:
      - name: extendedTypeId
        in: path
        description: extendedTypeId
        required: true
        schema:
          type: integer
          format: int32
      - name: secretTemplateId
        in: path
        description: secretTemplateId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success message
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretTemplateExtendedMappingDeleteResponseModel'
        '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:
      - SecretTemplates
      summary: Update a Secret Template Extended Mapping
      description: Update extended mappings for a Secret Template
      operationId: SecretTemplatesService_UpdateSecretTemplateExtendedMapping
      parameters:
      - name: extendedTypeId
        in: path
        description: extendedTypeId
        required: true
        schema:
          type: integer
          format: int32
      - name: secretTemplateId
        in: path
        description: secretTemplateId
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretTemplateExtendedMappingUpdateArgs'
        description: args
      responses:
        '200':
          description: List of extended mappings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretTemplateExtendedMappingModel'
        '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/secret-templates/{secretTemplateId}/launchers/{launcherTypeId}:
    get:
      tags:
      - SecretTemplates
      summary: Get a Secret Template Launcher
      description: Get launcher detail for a Secret Template
      operationId: SecretTemplatesService_GetSecretTemplateLauncher
      parameters:
      - name: launcherTypeId
        in: path
        description: launcherTypeId
        required: true
        schema:
          type: integer
          format: int32
      - name: secretTemplateId
        in: path
        description: secretTemplateId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Launcher Detail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretTemplateLauncherModel'
        '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:
      - SecretTemplates
      summary: Create a Secret Template Launcher
      description: Create a Launcher for a Secret Template
      operationId: SecretTemplatesService_CreateSecretTemplateLauncher
      parameters:
      - name: launcherTypeId
        in: path
        description: launcherTypeId
        required: true
        schema:
          type: integer
          format: int32
      - name: secretTemplateId
        in: path
        description: secretTemplateId
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretTemplateLauncherCreateArgs'
        description: args
      responses:
        '200':
          description: List of Launchers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretTemplateLauncherModel'
        '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:
      - SecretTemplates
      summary: Delete Secret Template Launcher
      description: Delete or remove the mapping of a specific launcher type from a specific Secret template
      operationId: SecretTemplatesService_DeleteSecretTemplateLauncher
      parameters:
      - name: launcherTypeId
        in: path
        description: launcherTypeId
        required: true
        schema:
          type: integer
          format: int32
      - name: secretTemplateId
        in: path
        description: secretTemplateId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Delete success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretTemplateLauncherDeleteResultModel'
        '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:
      - SecretTemplates
      summary: Update a Secret Template Launcher
      description: Update a Launchers for a Secret Template
      operationId: SecretTemplatesService_UpdateSecretTemplateLauncher
      parameters:
      - name: launcherTypeId
        in: path
        description: launcherTypeId
        required: true
        schema:
          type: integer
          format: int32
      - name: secretTemplateId
        in: path
        description: secretTemplateId
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretTemplateLauncherUpdateArgs'
        description: args
      responses:
        '200':
          description: List of Launchers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretTemplateLauncherModel'
        '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/secret-templates:
    get:
      tags:
      - SecretTemplates
      summary: Search Secret Templates
      description: Search, filter, sort, and page secret templates
      operationId: SecretTemplatesService_Search
      parameters:
      - name: filter.heartbeatEnabled
        in: query
        description: Filter templates that have heartbeat enabled or disabled
        required: false
        x-nullable: true
        schema:
          type: string
      - name: filter.includeInactive
        in: query
        description: Whether to include inactive secret templates in the results
        required: false
        schema:
          type: boolean
      - name: filter.includeSecretCount
        in: query
        description: Whether to populate Secret count in the results
        required: false
        schema:
          type: boolean
      - name: filter.passwordTypeIds
        in: query
        description: List of Password Type Ids
        required: false
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: filter.passwordTypeReady
        in: query
        description: Filter templates that are either password type ready (enabled) or not (disabled)
        required: false
        x-nullable: true
        schema:
          type: string
      - name: filter.scanItemTemplateId
        in: query
        description: 'Filter templates that map to '
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.searchText
        in: query
        description: Search text
        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: Secret template search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSecretTemplateSummary'
        '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:
      - SecretTemplates
      summary: Create Secret Template
      description: Create a new Secret Template
      operationId: SecretTemplatesService_CreateTemplate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretTemplateCreateArgs'
        description: Secret Template creation options
      responses:
        '200':
          description: Secret Template object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretTemplateModel'
        '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/secret-templates/{id}/export:
    get:
      tags:
      - SecretTemplates
      summary: Export Secret Template
      description: Export a single secret template by ID
      operationId: SecretTemplatesService_Export
      parameters:
      - name: id
        in: path
        description: Secret template ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Secret template export data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretTemplateExportModel'
        '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/secret-templates/password-requirements/password-dictionaries:
    get:
      tags:
      - SecretTemplates
      summary: Get password dictionaries
      description: Returns the list of custom password dictionaries.
      operationId: SecretTemplatesService_GetPasswordDictionaries
      responses:
        '200':
          description: A list of password dictionary ID and names.
          content:
            application/json:
              schema:
                description: A list of password dictionary ID and names.
                items:
                  $ref: '#/components/schemas/PasswordDictionaryModel'
                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
    put:
      tags:
      - SecretTemplates
      summary: Updates a new password dictionary
      description: Updates password dictionary
      operationId: SecretTemplatesService_UpdatePasswordDictionary
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UpdatePasswordDictionaryArgs'
        description: The file of words
      responses:
        '200':
          description: 'True'
          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
    post:
      tags:
      - SecretTemplates
      summary: Creates new password dictionary
      description: Add new password dictionary
      operationId: SecretTemplatesService_AddPasswordDictionary
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AddPasswordDictionaryArgs'
        description: The file of words
      responses:
        '200':
          description: 'True'
          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/secret-templates/extended-types:
    get:
      tags:
      - SecretTemplates
      summary: Get Secret Template Extended Types
      description: Get all of the extended types
      operationId: SecretTemplatesService_SearchSecretTemplateExtendedTypes
      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: List of extended types
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSecretTemplateExtendedTypeSummary'
        '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/secret-templates/extended-mappings:
    get:
      tags:
      - SecretTemplates
      summary: Get Secret Template Extended Mappings
      description: Get all of the extended mappings for a Secret Template
      operationId: SecretTemplatesService_SearchSecretTemplateExtendedMappings
      parameters:
      - name: filter.secretTemplateId
        in: query
        description: SecretTemplateId
        required: false
        schema:
          type: integer
          format: int32
      - 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: List of extended mappings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSecretTemplateExtendedMappingSummary'
        '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/secret-templates/{secretTemplateId}/extended-mappings/{extendedTypeId}/stub:
    get:
      tags:
      - SecretTemplates
      summary: Stub a Secret Template Extended Mappings
      description: Gets a stub that can be used to create an extended mapping
      operationId: SecretTemplatesService_StubSecretTemplateExtendedMapping
      parameters:
      - name: extendedTypeId
        in: path
        description: extendedTypeId
        required: true
        schema:
          type: integer
          format: int32
      - name: secretTemplateId
        in: path
        description: secretTemplateId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Stub of extended mapping
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretTemplateExtendedMappingModel'
        '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/secret-templates/launcher-types:
    get:
      tags:
      - SecretTemplates
      summary: Get Launcher Types
      description: Get a paged list of all of the Launcher Types that exist
      operationId: SecretTemplatesService_SearchLauncherTypes
      parameters:
      - name: filter.applicationName
        in: query
        description: Application name
        required: false
        schema:
          type: string
      - 

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