openapi: 3.0.0
info:
  title: Secret Server Rest Activations SecretExtensions 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: SecretExtensions
  description: "Specialized calls for Thycotic Secret Server Extensions. \r\n                   Thycotic may change the functionality or signatures under the secret-extensions route.\r\n                   Use at your own risk."
paths:
  /v1/secret-extensions/web-secret-templates:
    get:
      tags:
      - SecretExtensions
      summary: Get Secret Templates
      description: Get Secret Templates valid for web passwords
      operationId: SecretExtensionsService_GetWebSecretTemplates
      responses:
        '200':
          description: List of Secret Templates
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ILogicResultOfSecretTemplateModelArray'
        '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-extensions/search-by-url:
    post:
      tags:
      - SecretExtensions
      summary: Search Secrets by Url
      description: Search for Secrets that match a URL
      operationId: SecretExtensionsService_Search
      requestBody:
        content:
          application/json:
            schema:
              description: String
              type: string
        description: url
      responses:
        '200':
          description: Secret search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ILogicResultOfSecretSearchByUrlSummaryArray'
        '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-extensions/search-ad-secrets-by-domain:
    post:
      tags:
      - SecretExtensions
      summary: Search Secrets by Domain
      description: Search for Secrets that match a domain
      operationId: SecretExtensionsService_SearchActiveDirectorySecrets
      requestBody:
        content:
          application/json:
            schema:
              description: String
              type: string
        description: domain
      responses:
        '200':
          description: Secret search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ILogicResultOfSecretExtensionSearchSummaryArray'
        '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-extensions/search-windows-account-secrets-by-computer-name:
    post:
      tags:
      - SecretExtensions
      summary: Search Secrets by Computer Name
      description: Search for Secrets that match a computer name
      operationId: SecretExtensionsService_SearchWindowsAccountSecrets
      requestBody:
        content:
          application/json:
            schema:
              description: String
              type: string
        description: computerName
      responses:
        '200':
          description: Secret search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ILogicResultOfSecretExtensionSearchSummaryArray'
        '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-extensions/autofill-values:
    post:
      tags:
      - SecretExtensions
      summary: Get AutoFill values for Url by SecretId
      description: Get AutoFill values (username and password) for Url by SecretId
      operationId: SecretExtensionsService_GetAutoFillValues
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExtensionAutoFillValueArgs'
        description: args
      responses:
        '200':
          description: Autofill values result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretExtensionAutoFillResult'
        '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:
    ExtensionAutoFillValueArgs:
      description: ExtensionAutoFillValueArgs
      properties:
        secretId:
          description: The SecretId for the Secret to retrieve the auto-fill values from.
          type: integer
          format: int32
        url:
          description: The URL for which the auto-fill values are being retrieved.  Must be the same origin as the URL on the Secret.
          type: string
      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
    SecretSearchByUrlSummary:
      description: Model
      properties:
        hasOwnerOrEditAccess:
          description: HasOwnerOrEditAccess
          type: boolean
        id:
          description: Id
          type: integer
          format: int32
        isButtonBound:
          description: IsButtonBound
          type: boolean
        isFavoriteSecret:
          description: IsFavoriteSecret
          type: boolean
        isSystemFolder:
          description: IsSystemFolder
          type: boolean
        matchOrderType:
          $ref: '#/components/schemas/MatchType'
        name:
          description: Name
          type: string
        redirectUrl:
          description: RedirectUrl
          type: string
        requireComment:
          description: RequireComment
          type: boolean
        resultPriority:
          description: ResultPriority
          type: integer
          format: int32
        secretTypeId:
          description: SecretTypeId
          type: integer
          format: int32
        secretUrl:
          description: SecretUrl
          type: string
        shouldRedirect:
          description: ShouldRedirect
          type: boolean
      type: object
    ILogicResultOfSecretTemplateModelArray:
      description: ILogicResultOfSecretTemplateModel[]
      properties:
        model:
          description: Model
          items:
            $ref: '#/components/schemas/SecretTemplateModel'
          type: array
      type: object
    SecretExtensionSearchSummary:
      description: Model
      properties:
        hasOwnerOrEditAccess:
          description: HasOwnerOrEditAccess
          type: boolean
        id:
          description: Id
          type: integer
          format: int32
        isButtonBound:
          description: IsButtonBound
          type: boolean
        isFavoriteSecret:
          description: IsFavoriteSecret
          type: boolean
        isSystemFolder:
          description: IsSystemFolder
          type: boolean
        matchOrderType:
          $ref: '#/components/schemas/MatchType'
        name:
          description: Name
          type: string
        redirectUrl:
          description: RedirectUrl
          type: string
        requireComment:
          description: RequireComment
          type: boolean
        resultPriority:
          description: ResultPriority
          type: integer
          format: int32
        secretTypeId:
          description: SecretTypeId
          type: integer
          format: int32
        shouldRedirect:
          description: ShouldRedirect
          type: boolean
      type: object
    MatchType:
      description: MatchOrderType
      properties: {}
      type: string
      enum:
      - Loose
      - Partial
      - Exact
    ILogicResultOfSecretSearchByUrlSummaryArray:
      description: ILogicResultOfSecretSearchByUrlSummary[]
      properties:
        model:
          description: Model
          items:
            $ref: '#/components/schemas/SecretSearchByUrlSummary'
          type: array
      type: object
    SecretTemplateModel:
      description: Secret template
      properties:
        concurrencyId:
          description: Global unique identifier
          type: string
        fields:
          description: Secret template fields
          items:
            $ref: '#/components/schemas/SecretTemplateField'
          type: array
        id:
          description: Secret template Id
          type: integer
          format: int32
        name:
          description: Secret template name
          type: string
        passwordTypeId:
          description: Password Type Id
          type: integer
          format: int32
          nullable: true
      type: object
    ILogicResultOfSecretExtensionSearchSummaryArray:
      description: ILogicResultOfSecretExtensionSearchSummary[]
      properties:
        model:
          description: Model
          items:
            $ref: '#/components/schemas/SecretExtensionSearchSummary'
          type: array
      type: object
    ListType:
      description: What type of contents does this list field contain
      properties: {}
      type: string
      enum:
      - None
      - Generic
      - URL
    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
    SecretTemplateField:
      description: Secret template field
      properties:
        description:
          description: Field description
          type: string
        displayName:
          description: Field display name
          type: string
        editablePermission:
          description: Who has editing rights
          type: integer
          format: int32
        editRequires:
          $ref: '#/components/schemas/EditRequiresOptions'
        fieldSlugName:
          description: Field Slug Name
          type: string
        generatePasswordCharacterSet:
          description: Generate password character set. Only returned if user can manage secret templates
          type: string
        generatePasswordLength:
          description: Generate password length.  Only returned if user can manage secret templates
          type: integer
          format: int32
          nullable: true
        hideOnView:
          description: Hide this field when viewing
          type: boolean
        historyLength:
          description: History length
          type: integer
          format: int32
        isExpirationField:
          description: Is expiration field
          type: boolean
        isFile:
          description: Is this field a file type
          type: boolean
        isIndexable:
          description: Is able to be indexed
          type: boolean
        isList:
          description: Is this field a list field type
          type: boolean
        isNotes:
          description: Is this field a notes field type
          type: boolean
        isPassword:
          description: Is this field a password field type
          type: boolean
        isRequired:
          description: Is this field required
          type: boolean
        isUrl:
          description: Is this field a url field type
          type: boolean
        listType:
          $ref: '#/components/schemas/ListType'
        mustEncrypt:
          description: Must encrypt.  Only returned if user can manage secret templates
          type: boolean
          nullable: true
        name:
          description: Field name
          type: string
        passwordRequirementId:
          description: ID For Password Requirement assigned to field
          type: integer
          format: int32
        passwordTypeFieldId:
          description: Type of password field
          type: integer
          format: int32
        secretTemplateFieldId:
          description: Field Id
          type: integer
          format: int32
        sortOrder:
          description: Sort Order for Field
          type: integer
          format: int32
      type: object
    AuthenticationFailedResponse:
      description: Response object for authentication failures
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
      type: object
    SecretExtensionAutoFillResult:
      description: SecretExtensionAutoFillResult
      properties:
        password:
          description: Password
          type: string
        username:
          description: Username
          type: string
        useSessionRecording:
          description: UseSessionRecording
          type: boolean
        webLauncherRequiresIncognitoMode:
          description: WebLauncherRequiresIncognitoMode
          type: boolean
      type: object
    EditRequiresOptions:
      description: What option is required to edit this field including Owner, Edit, and Not Editable
      properties: {}
      type: string
      enum:
      - Edit
      - Owner
      - NotEditable
  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