Delinea SecretDependencies API

openapi: 3.2.0
info:
  title: Secret Server Rest Activations Secret Dependencies 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: SecretDependencies
  description: View and maintain Secret Dependencies
paths:
  /v1/secret-dependencies/{id}:
    put:
      tags:
      - SecretDependencies
      summary: Update Secret Dependency
      description: Updates a Secret Dependency and returns the model
      operationId: SecretDependenciesService_UpdateDependency
      parameters:
      - name: id
        in: path
        description: Secret Dependency ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretDependencyUpdateArgs'
        description: Secret Dependency update options
      responses:
        '200':
          description: SecretDependencyModel object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDependencyUpdateArgs'
        '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:
      - SecretDependencies
      summary: Delete Secret Dependency
      description: Delete a Secret Dependency by ID
      operationId: SecretDependenciesService_Delete
      parameters:
      - name: id
        in: path
        description: Secret Dependency ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Object deletion result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletedModel'
        '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-dependencies/groups/{secretId}:
    get:
      tags:
      - SecretDependencies
      summary: Get Secret Dependency Groups for a Secret
      description: Get Secret Dependency Groups for a Secret
      operationId: SecretDependenciesService_GetGroups
      parameters:
      - name: secretId
        in: path
        description: Secret ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Secret Dependency Group array
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ILogicResultOfSecretDependencyGroupArray'
        '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:
      - SecretDependencies
      summary: Update Secret Dependency Group
      description: Update a Secret Dependency Group
      operationId: SecretDependenciesService_UpdateSecretDependencyGroup
      parameters:
      - name: secretId
        in: path
        description: Id of Secret to assign to Dependency Group.
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSecretDependencyGroupArgs'
        description: args
      responses:
        '200':
          description: SecretDependencyGroupModel object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDependencyGroupModel'
        '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:
      - SecretDependencies
      summary: Create Secret Dependency Group
      description: Creates a new Secret Dependency Group and returns the model
      operationId: SecretDependenciesService_CreateDependencyGroup
      parameters:
      - name: secretId
        in: path
        description: Secret ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretDependencyGroupCreateArgs'
        description: Secret Dependency create options
      responses:
        '200':
          description: Secret Dependency Group object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDependencyGroup'
        '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-dependencies/scripts:
    get:
      tags:
      - SecretDependencies
      summary: Get Scripts that are possible to use for Dependencies
      description: Get Scripts that are possible to use for Dependencies
      operationId: SecretDependenciesService_GetScripts
      responses:
        '200':
          description: Dependency Script array
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ILogicResultOfDependencyScriptArray'
        '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-dependencies/templates:
    get:
      tags:
      - SecretDependencies
      summary: Get Dependency Templates
      description: Get Dependency Templates
      operationId: SecretDependenciesService_GetTemplates
      responses:
        '200':
          description: Dependency Template array
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ILogicResultOfDependencyTemplateArray'
        '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-dependencies/{secretDependencyId}:
    get:
      tags:
      - SecretDependencies
      summary: Get Secret Dependency
      description: Gets a Secret Dependency and returns the Secret Dependency Model
      operationId: SecretDependenciesService_GetDependency
      parameters:
      - name: secretDependencyId
        in: path
        description: Secret Dependency ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Secret Dependency object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDependencyModel'
        '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-dependencies:
    get:
      tags:
      - SecretDependencies
      summary: Search Secret Dependencies
      description: Search, filter, sort, and page Secret Dependencies on a Secret
      operationId: SecretDependenciesService_SearchDependencySummary
      parameters:
      - name: filter.groupId
        in: query
        description: Filter by group id
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.includeInactive
        in: query
        description: Whether or not to include inactive Secret Depenencies
        required: false
        schema:
          type: boolean
      - name: filter.lastRunStatus
        in: query
        description: Filter by last dependency result status
        required: false
        x-nullable: true
        schema:
          type: string
      - name: filter.searchText
        in: query
        description: Search in the title / name and machine fields
        required: false
        schema:
          type: string
      - name: filter.secretId
        in: query
        description: The Secret Id to filter on
        required: true
        schema:
          type: integer
          format: int32
      - name: filter.templateId
        in: query
        description: Filter by dependency template id
        required: false
        x-nullable: true
        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: SecretDependency search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSecretDependencySummary'
        '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:
      - SecretDependencies
      summary: Create Secret Dependency
      description: Creates a new Secret Dependency and returns the model
      operationId: SecretDependenciesService_CreateDependency
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretDependencyCreateArgs'
        description: Secret Dependency create options
      responses:
        '200':
          description: Secret Dependency object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDependencyModel'
        '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-dependencies/run/{identifier}:
    get:
      tags:
      - SecretDependencies
      summary: Get Secret Dependency run task status
      description: Gets a Secret Dependency run task status
      operationId: SecretDependenciesService_GetDependencyRunTaskStatus
      parameters:
      - name: identifier
        in: path
        description: Task identifier
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Task Status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskProgress'
        '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-dependencies/stub:
    get:
      tags:
      - SecretDependencies
      summary: Get Secret Dependency Stub
      description: Return the default values for a new Secret Dependency
      operationId: SecretDependenciesService_Stub
      parameters:
      - name: scriptId
        in: query
        description: The Id of the Script that this Dependency will Run.  Only provide this value if the Dependency is running a script directly, and ensure that the type of the script matches the TypeId value passed in.
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: secretId
        in: query
        description: The Id of the Secret that this Dependency will appear on
        required: false
        schema:
          type: integer
          format: int32
      - name: templateId
        in: query
        description: The Id of the Dependency Template that this Dependecy will be modeled on. Only provide this value if the Dependency is based on a Template.
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: typeId
        in: query
        description: 'The Id of the Dependency Type that this Dependecy will be modeled on. Only provide this value if the Dependency is a running a script directly and is NOT based on a Dependency Template.  Valid Values: PowershellScript = 7, SshScript = 8, SqlScript = 9'
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: SecretDependencyModel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretDependencyModel'
        '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-dependencies/run:
    post:
      tags:
      - SecretDependencies
      summary: Run Dependencies
      description: Runs the list of dependencies and retruns an identifier that can be used to collect the status.
      operationId: SecretDependenciesService_Execute
      requestBody:
        content:
          application/json:
            schema:
              description: Int32[]
              items:
                type: integer
                format: int32
              type: array
        description: Dependency Id array
      responses:
        '200':
          description: Identifier of the task
          content:
            application/json:
              schema:
                description: String
                type: string
        '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:
    TaskError:
      description: A description of an error for a task
      properties:
        errorMessage:
          description: The error message
          type: string
        itemName:
          description: The name of the item that had the error
          type: string
      type: object
    Severity:
      description: Error severity level
      properties: {}
      type: string
      enum:
      - None
      - Retry
      - Warn
      - Critical
      - Fatal
    SecretDependencySettingMapForDisplay:
      description: Settings used by Secret Dependency Templates
      properties:
        changerSettingValue:
          description: The default read-only setting value on the changer that will be used if no setting value has been given.
          type: string
        setting:
          $ref: '#/components/schemas/SecretDependencySetting'
        settingId:
          description: The Setting Id
          type: integer
          format: int32
        settingName:
          description: The Setting Name
          type: string
        settingValue:
          description: The value for the setting that will be stored in the database.  This value should be set when editing or creating a Dependency. If not set the default value will be calculated by looking at the Changer or Script.
          type: string
      type: object
    SecretDependencyTemplate:
      description: Object filled and used for Secret Dependencies that refer to a Dependency Template
      properties:
        changerScriptId:
          description: The id of the script (if any) used by the Dependency Template
          type:
          - integer
          - 'null'
          format: int32
        dependencyScanItemFields:
          description: The Scan Item Fields used by the Dependency Template
          items:
            $ref: '#/components/schemas/SecretDependencyScanItemField'
          type: array
        scriptName:
          description: The name of the script (if any) used by the Dependency Template
          type: string
        secretDependencyChangerId:
          description: The id of the Dependency Changer used by the Dependency Template
          type:
          - integer
          - 'null'
          format: int32
        secretDependencyTemplateId:
          description: The id of the Dependency Template
          type:
          - integer
          - 'null'
          format: int32
      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
    ILogicResultOfSecretDependencyGroupArray:
      description: ILogicResultOfSecretDependencyGroup[]
      properties:
        model:
          description: Model
          items:
            $ref: '#/components/schemas/SecretDependencyGroup'
          type: array
      type: object
    AuthenticationFailedResponse:
      description: Response object for authentication failures
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
      type: object
    ILogicResultOfDependencyTemplateArray:
      description: ILogicResultOfDependencyTemplate[]
      properties:
        model:
          description: Model
          items:
            $ref: '#/components/schemas/DependencyTemplate'
          type: array
      type: object
    UpdateSecretDependencyGroupModel:
      description: Update Secret Dependency Group Options
      properties:
        secretDependencyGroupId:
          description: Id of the Secret Dependency Group to update.
          type: integer
          format: int32
        secretDependencyGroupName:
          description: Name for the Secret Dependency Group.
          type: string
        siteId:
          description: Id of the Site to assign to the Dependency Group.
          type:
          - integer
          - 'null'
          format: int32
      type: object
    DependencyScript:
      description: Dependency Script Object, used for Secret Dependencies
      properties:
        arguments:
          description: The Settings of the script used for arguments
          items:
            $ref: '#/components/schemas/SecretDependencyUniversalScriptArgument'
          type: array
        id:
          description: The Script Id
          type: integer
          format: int32
        name:
          description: The name of the script
          type: string
        odbcConnectionArguments:
          description: The connection arguments of the script if it is a SQL based script
          items:
            $ref: '#/components/schemas/SecretDependencyOdbcConnectionArg'
          type: array
      type: object
    DependencyTemplate:
      description: Dependency Template Object, used for Secret Dependencies
      properties:
        active:
          description: Whether or not the Depenency Template is Active
          type: boolean
        dependencyChangerId:
          description: The Depenency Template Changer Id
          type:
          - integer
          - 'null'
          format: int32
        dependencyTypeId:
          description: The Dependency Template Type Id
          type: integer
          format: int32
        id:
          description: The Dependency Template Id
          type: integer
          format: int32
        name:
          description: The Dependency Template Name
          type: string
      type: object
    SecretDependencyGroupCreateArgs:
      description: A Secret Dependency Group Object. A container for a logical collection of Secret Dependencies that use the same site.
      properties:
        secretDependencyGroupName:
          description: The name of the Secret Dependency Group
          type: string
        siteId:
          description: The Id of the Site that all dependencies in this group use
          type:
          - integer
          - 'null'
          format: int32
      type: object
    SecretDependencyOdbcConnectionArg:
      description: Connection arguments used for ODBC connections
      properties:
        name:
          description: Name of the argument
          type: string
        value:
          description: Value for the argument
          type: string
      type: object
    UpdateSecretDependencyGroupArgs:
      description: UpdateSecretDependencyGroupArgs
      properties:
        data:
          $ref: '#/components/schemas/UpdateSecretDependencyGroupModel'
      type: object
    SecretDependencySetting:
      description: Secret Dependency Settings - Mostly used internally
      properties:
        active:
          description: Indicates the setting is active.
          type: boolean
        canEdit:
          description: Indicates the setting details may be editted.
          type: boolean
        canEditValue:
          description: Indicates the setting value may be editted.
          type: boolean
        childSettings:
          description: The Child Settings that would be used  for list of options.
          items:
            $ref: '#/components/schemas/SecretDependencySetting'
          type: array
        defaultValue:
          description: Default value if the setting is not given a value
          type: string
        displayName:
          description: Setting Display Name
          type: string
        id:
          description: Id of the setting
          type: integer
          format: int32
        isVisibile:
          description: Indicates the setting is visible on the UI.
          type: boolean
        parentSettingId:
          description: Parent Setting Id used when a setting has child options.
          type:
          - integer
          - 'null'
          format: int32
        regexValidation:
          description: Regex used to validate the input
          type: string
        settingName:
          description: Name of the setting
          type: string
        settingSectionId:
          description: Section Id of the setting
          type: integer
          format: int32
        settingType:
          description: Type of Setting (Default (string) = 0, Integer = 1, String = 2, Boolean = 3, StringArray = 4, DropDown = 5,DropDownItem = 6
          type: integer
          format: int32
        subSettingSectionId:
          description: Subsetting Section Id
          type:
          - integer
          - 'null'
          format: int32
      type: object
    SecretDependencyCreateArgs:
      description: The Secret Dependency Create Arguments object
      properties:
        active:
          description: Whether or not the Secret Dependency is active.
          type: boolean
        conditionDependencyId:
          description: The Id of the dependency that will be looked at when  Condition Mode is set to 'DEPENDENCYPASS', 'DEPENDENCYFAIL'. The Dependency must have a SortOrder lower than the current one.
          type:
          - integer
          - 'null'
          format: int32
        conditionMode:
          description: Condition Mode governs if this dependency's run relies on the result of other dependencies above it. The Default is ALWAYSRUN. Other values maybe 'All Pass', 'Any Fail', 'DEPENDENCYPASS', 'DEPENDENCYFAIL'.
          type: string
        dependencyTemplate:
          $ref: '#/components/schemas/SecretDependencyTemplate'
        description:
          description: A description for the Secret Dependency.
          type: string
        groupId:
          description: The Id of the Dependency Group that contains the Secret Dependency. If set to default value of 0, it will be added to the first group on the secret.
          type: integer
          format: int32
        machineName:
          description: The machine name that the Secret Dependency runs on.
          type: string
        privilegedAccountSecretId:
          description: The Id of the Privileged Secret that the Secret Dependency will use to run.
          type:
          - integer
          - 'null'
          format: int32
        runScript:
          $ref: '#/components/schemas/SecretDependencyRunScript'
        secretId:
          description: The Id of the Secret that the Secret Dependency is assigned to.
          type: integer
          format: int32
        secretName:
          description: Read Only. The Name of the Secret that the Secret Dependency is assigned to.
          type: string
        serviceName:
          description: The service name of the Secret Dependency.
          type: string
        settings:
          description: 'The Settings used by the Secret Dependency. (Ex: WaitBeforeSeconds, Database, Port, SSHKeyDigest)'
          items:
            $ref: '#/components/schemas/SecretDependencySettingMapForDisplay'
          type: array
        sortOrder:
          description: The sort order of the Secret Dependency in the group.  Determines the order of execution of the dependencies within a group. If set to the default value of 0, the dependency will be added at the end of the group. If less than zero the dependency will be added as the first dependency in the group and all other dependencies in the group will be adjusted.
          type: integer
          format: int32
        sshKeySecretId:
          description: The Id of the Secret containing the SSH key. (If dependency is tied to SSH key Secret)
          type:
          - integer
          - 'null'
          format: int32
        typeId:
          description: The Id of the type of Secret Dependency.
          type: integer
          format: int32
        typeName:
          description: Read Only. The name of the type of Secret Dependency.
          type: string
      type: object
    SecretDependencyGroup:
     

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