Delinea DevOpsSecretsVaultSync API

openapi: 3.2.0
info:
  title: Secret Server Rest Activations Dev Ops Secrets Vault Sync 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: DevOpsSecretsVaultSync
  description: Manage secrets that are synced to DSV Tenants.
paths:
  /v1/devops-secrets-vault/sync/status:
    get:
      tags:
      - DevOpsSecretsVaultSync
      summary: Information about secrets syncing.
      description: Get which tenants the secrets are syncing to, the current status of the sync, and the last sync time.
      operationId: DevOpsSecretsVaultSyncService_GetSyncStatuses
      parameters:
      - name: filter.includeInactive
        in: query
        description: If inactive sync maps should be returned.
        required: false
        schema:
          type: boolean
      - name: filter.secretId
        in: query
        description: Search by the secret being synced.
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.tenantId
        in: query
        description: Search by the tenant being pushed to.
        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: A list of statuses for secret syncing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfDevOpsSecretsVaultSyncStatusSummary'
        '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/devops-secrets-vault/sync/status/{syncMapId}:
    get:
      tags:
      - DevOpsSecretsVaultSync
      summary: Information about secret syncing.
      description: Get which tenants a secret is syncing to, the current status of the sync, and the last sync time.
      operationId: DevOpsSecretsVaultSyncService_GetSyncStatus
      parameters:
      - name: syncMapId
        in: path
        description: syncMapId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The status of a secret syncing to a tenant.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DevOpsSecretsVaultSyncStatusModel'
        '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/devops-secrets-vault/add-sync:
    post:
      tags:
      - DevOpsSecretsVaultSync
      summary: Create a DevOps sync for a secret.
      description: Create a sync between a secret and a DevOps Secrets Vault tenant.
      operationId: DevOpsSecretsVaultSyncService_CreateSync
      requestBody:
        $ref: '#/components/requestBodies/DevOpsSecretsVaultCreateSyncArgs'
      responses:
        '200':
          description: The status of the secret's sync.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DevOpsSecretsVaultSyncStatusModel'
        '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/devops-secrets-vault/sync:
    post:
      tags:
      - DevOpsSecretsVaultSync
      summary: Sync a secret.
      description: Sync a secret to a DevOps Secrets Vault tenant.
      operationId: DevOpsSecretsVaultSyncService_SyncSecret
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DevOpsSecretsVaultSyncSecretsArgs'
        description: args
      responses:
        '200':
          description: The status of the secret's sync.
          content:
            application/json:
              schema:
                description: The status of the secret's sync.
                items:
                  $ref: '#/components/schemas/DevOpsSecretsVaultSyncStatusViewModel'
                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
  /v1/devops-secrets-vault/sync/{syncSecretMapId}:
    put:
      tags:
      - DevOpsSecretsVaultSync
      summary: Update a secret sync.
      description: Update a sync between a secret and a DevOps Secrets Vault tenant.
      operationId: DevOpsSecretsVaultSyncService_UpdateSync
      parameters:
      - name: syncSecretMapId
        in: path
        description: syncSecretMapId
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        $ref: '#/components/requestBodies/DevOpsSecretsVaultCreateSyncArgs'
      responses:
        '200':
          description: The status of the secret's sync.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DevOpsSecretsVaultSyncStatusModel'
        '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:
    ViewFieldValueReadOnlyOfInt32:
      description: ID of the mapping between the Tenant and Secret.
      properties:
        additionalLinks:
          description: AdditionalLinks
          items:
            $ref: '#/components/schemas/ViewFieldLink'
          type: array
        description:
          description: Description
          type: string
        fieldInputType:
          description: FieldInputType
          type:
          - string
          - 'null'
        hasHistory:
          description: HasHistory
          type:
          - boolean
          - 'null'
        helpLink:
          description: HelpLink
          type: string
        helpLinkText:
          description: HelpLinkText
          type: string
        hidden:
          description: Hidden
          type:
          - boolean
          - 'null'
        hideOnView:
          description: HideOnView
          type:
          - boolean
          - 'null'
        isRequired:
          description: IsRequired
          type:
          - boolean
          - 'null'
        label:
          description: Label
          type: string
        maxLength:
          description: MaxLength
          type:
          - integer
          - 'null'
          format: int32
        name:
          description: Name
          type: string
        placeholder:
          description: Placeholder
          type: string
        readOnly:
          description: ReadOnly
          type:
          - boolean
          - 'null'
        readOnlyReason:
          description: ReadOnlyReason
          type: string
        sortOrder:
          description: SortOrder
          type:
          - integer
          - 'null'
          format: int32
        value:
          description: Value
          type: integer
          format: int32
      type: object
    DevOpsSecretsVaultCreateSyncArgs:
      description: DevOpsSecretsVaultCreateSyncArgs
      properties:
        data:
          $ref: '#/components/schemas/DevOpsSecretVaultSyncUpdateModel'
      type: object
    DevOpsSecretsVaultSyncStatusViewModel:
      description: DevOpsSecretsVaultSyncStatusViewModel[]
      properties:
        active:
          $ref: '#/components/schemas/ViewFieldValueOfBoolean'
        dateAdded:
          $ref: '#/components/schemas/ViewFieldValueReadOnlyOfDateTime'
        devOpsSecretVaultPath:
          $ref: '#/components/schemas/ViewFieldValueOfString'
        devOpsSyncMapId:
          $ref: '#/components/schemas/ViewFieldValueReadOnlyOfInt32'
        lastSyncTime:
          $ref: '#/components/schemas/ViewFieldValueReadOnlyOfOptionalDateTime'
        nextSyncTime:
          $ref: '#/components/schemas/ViewFieldValueReadOnlyOfOptionalDateTime'
        secretId:
          $ref: '#/components/schemas/ViewFieldValueOfInt32'
        secretName:
          $ref: '#/components/schemas/ViewFieldValueReadOnlyOfString'
        status:
          $ref: '#/components/schemas/ViewFieldValueReadOnlyOfString'
        tenantId:
          $ref: '#/components/schemas/ViewFieldValueOfInt32'
      type: object
    DevOpsSecretVaultSyncUpdateModel:
      description: Data
      properties:
        active:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        dsvTenantId:
          $ref: '#/components/schemas/UpdateFieldValueOfInt32'
        fieldNamesPath:
          $ref: '#/components/schemas/UpdateFieldValueOfStringArray'
        secretId:
          $ref: '#/components/schemas/UpdateFieldValueOfInt32'
      type: object
    DevOpsSecretsVaultSyncStatusModel:
      description: DevOps Secrets Vault Synchronization Status
      properties:
        active:
          description: Active
          type: boolean
        dateAdded:
          description: Date Added
          type: string
          format: date-time
        devOpsSecretVaultPath:
          description: DevOps Secrets Vault Path
          type: string
        devOpsSyncMapId:
          description: DevOps Synchronization Map Id
          type: integer
          format: int32
        lastSyncTime:
          description: Last Sync Time
          type:
          - string
          - 'null'
          format: date-time
        nextSyncTime:
          description: Next Sync Time
          type:
          - string
          - 'null'
          format: date-time
        secretId:
          description: Secret Id
          type: integer
          format: int32
        secretName:
          description: Secret Name
          type: string
        status:
          description: Status
          type: string
        tenantId:
          description: Tenant Id
          type: integer
          format: int32
      type: object
    ViewFieldValueReadOnlyOfDateTime:
      description: When the Secret was originally mapped to the Tenant.
      properties:
        additionalLinks:
          description: AdditionalLinks
          items:
            $ref: '#/components/schemas/ViewFieldLink'
          type: array
        description:
          description: Description
          type: string
        fieldInputType:
          description: FieldInputType
          type:
          - string
          - 'null'
        hasHistory:
          description: HasHistory
          type:
          - boolean
          - 'null'
        helpLink:
          description: HelpLink
          type: string
        helpLinkText:
          description: HelpLinkText
          type: string
        hidden:
          description: Hidden
          type:
          - boolean
          - 'null'
        hideOnView:
          description: HideOnView
          type:
          - boolean
          - 'null'
        isRequired:
          description: IsRequired
          type:
          - boolean
          - 'null'
        label:
          description: Label
          type: string
        maxLength:
          description: MaxLength
          type:
          - integer
          - 'null'
          format: int32
        name:
          description: Name
          type: string
        placeholder:
          description: Placeholder
          type: string
        readOnly:
          description: ReadOnly
          type:
          - boolean
          - 'null'
        readOnlyReason:
          description: ReadOnlyReason
          type: string
        sortOrder:
          description: SortOrder
          type:
          - integer
          - 'null'
          format: int32
        value:
          description: Value
          type: string
          format: date-time
      type: object
    Severity:
      description: Error severity level
      properties: {}
      type: string
      enum:
      - None
      - Retry
      - Warn
      - Critical
      - Fatal
    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
    UpdateFieldValueOfInt32:
      description: How many days until the password expires.
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: integer
          format: int32
      type: object
    ViewFieldValueOfInt32:
      description: OrganizationId
      properties:
        additionalLinks:
          description: AdditionalLinks
          items:
            $ref: '#/components/schemas/ViewFieldLink'
          type: array
        description:
          description: Description
          type: string
        fieldInputType:
          description: FieldInputType
          type:
          - string
          - 'null'
        hasHistory:
          description: HasHistory
          type:
          - boolean
          - 'null'
        helpLink:
          description: HelpLink
          type: string
        helpLinkText:
          description: HelpLinkText
          type: string
        hidden:
          description: Hidden
          type:
          - boolean
          - 'null'
        hideOnView:
          description: HideOnView
          type:
          - boolean
          - 'null'
        isRequired:
          description: IsRequired
          type:
          - boolean
          - 'null'
        label:
          description: Label
          type: string
        maxLength:
          description: MaxLength
          type:
          - integer
          - 'null'
          format: int32
        name:
          description: Name
          type: string
        placeholder:
          description: Placeholder
          type: string
        readOnly:
          description: ReadOnly
          type:
          - boolean
          - 'null'
        readOnlyReason:
          description: ReadOnlyReason
          type: string
        sortOrder:
          description: SortOrder
          type:
          - integer
          - 'null'
          format: int32
        value:
          description: Value
          type: integer
          format: int32
      type: object
    AuthenticationFailedResponse:
      description: Response object for authentication failures
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
      type: object
    ViewFieldValueReadOnlyOfOptionalDateTime:
      description: When the Secret was last pushed.
      properties:
        additionalLinks:
          description: AdditionalLinks
          items:
            $ref: '#/components/schemas/ViewFieldLink'
          type: array
        description:
          description: Description
          type: string
        fieldInputType:
          description: FieldInputType
          type:
          - string
          - 'null'
        hasHistory:
          description: HasHistory
          type:
          - boolean
          - 'null'
        helpLink:
          description: HelpLink
          type: string
        helpLinkText:
          description: HelpLinkText
          type: string
        hidden:
          description: Hidden
          type:
          - boolean
          - 'null'
        hideOnView:
          description: HideOnView
          type:
          - boolean
          - 'null'
        isRequired:
          description: IsRequired
          type:
          - boolean
          - 'null'
        label:
          description: Label
          type: string
        maxLength:
          description: MaxLength
          type:
          - integer
          - 'null'
          format: int32
        name:
          description: Name
          type: string
        placeholder:
          description: Placeholder
          type: string
        readOnly:
          description: ReadOnly
          type:
          - boolean
          - 'null'
        readOnlyReason:
          description: ReadOnlyReason
          type: string
        sortOrder:
          description: SortOrder
          type:
          - integer
          - 'null'
          format: int32
        value:
          description: Value
          type:
          - string
          - 'null'
          format: date-time
      type: object
    DevOpsSecretsVaultSyncStatusSummary:
      description: Query results
      properties:
        active:
          description: If the mapping is active.
          type: boolean
        dateAdded:
          description: When the Secret will be pushed next.
          type: string
          format: date-time
        devOpsSecretVaultPath:
          description: Where to push the Secret to in the Tenant.
          type: string
        devOpsSyncMapId:
          description: ID of the mapping between the Tenant and Secret.
          type: integer
          format: int32
        lastSyncTime:
          description: When the Secret was last pushed.
          type:
          - string
          - 'null'
          format: date-time
        secretName:
          description: Name of the Secret.
          type: string
        status:
          description: Status of syncing progress.
          type: string
      type: object
    ViewFieldValueOfString:
      description: GeneratedToken
      properties:
        additionalLinks:
          description: AdditionalLinks
          items:
            $ref: '#/components/schemas/ViewFieldLink'
          type: array
        description:
          description: Description
          type: string
        fieldInputType:
          description: FieldInputType
          type:
          - string
          - 'null'
        hasHistory:
          description: HasHistory
          type:
          - boolean
          - 'null'
        helpLink:
          description: HelpLink
          type: string
        helpLinkText:
          description: HelpLinkText
          type: string
        hidden:
          description: Hidden
          type:
          - boolean
          - 'null'
        hideOnView:
          description: HideOnView
          type:
          - boolean
          - 'null'
        isRequired:
          description: IsRequired
          type:
          - boolean
          - 'null'
        label:
          description: Label
          type: string
        maxLength:
          description: MaxLength
          type:
          - integer
          - 'null'
          format: int32
        name:
          description: Name
          type: string
        placeholder:
          description: Placeholder
          type: string
        readOnly:
          description: ReadOnly
          type:
          - boolean
          - 'null'
        readOnlyReason:
          description: ReadOnlyReason
          type: string
        sortOrder:
          description: SortOrder
          type:
          - integer
          - 'null'
          format: int32
        value:
          description: Value
          type: string
      type: object
    UpdateFieldValueOfStringArray:
      description: Characters that split keys to be indexed
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          items:
            type: string
          type: array
      type: object
    DevOpsSecretsVaultSyncSecretsArgs:
      description: DevOpsSecretsVaultSyncSecretsArgs
      properties:
        data:
          description: Data
          items:
            type: integer
            format: int32
          type: array
      type: object
    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
    ViewFieldValueReadOnlyOfString:
      description: Name of the Secret.
      properties:
        additionalLinks:
          description: AdditionalLinks
          items:
            $ref: '#/components/schemas/ViewFieldLink'
          type: array
        description:
          description: Description
          type: string
        fieldInputType:
          description: FieldInputType
          type:
          - string
          - 'null'
        hasHistory:
          description: HasHistory
          type:
          - boolean
          - 'null'
        helpLink:
          description: HelpLink
          type: string
        helpLinkText:
          description: HelpLinkText
          type: string
        hidden:
          description: Hidden
          type:
          - boolean
          - 'null'
        hideOnView:
          description: HideOnView
          type:
          - boolean
          - 'null'
        isRequired:
          description: IsRequired
          type:
          - boolean
          - 'null'
        label:
          description: Label
          type: string
        maxLength:
          description: MaxLength
          type:
          - integer
          - 'null'
          format: int32
        name:
          description: Name
          type: string
        placeholder:
          description: Placeholder
          type: string
        readOnly:
          description: ReadOnly
          type:
          - boolean
          - 'null'
        readOnlyReason:
          description: ReadOnlyReason
          type: string
        sortOrder:
          description: SortOrder
          type:
          - integer
          - 'null'
          format: int32
        value:
          description: Value
          type: string
      type: object
    PagingOfDevOpsSecretsVaultSyncStatusSummary:
      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/DevOpsSecretsVaultSyncStatusSummary'
          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
    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
    UpdateFieldValueOfBoolean:
      description: Active
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: boolean
      type: object
    SortDirection:
      description: Sort direction
      properties: {}
      type: string
      enum:
      - None
      - Asc
      - Desc
    ViewFieldLink:
      description: AdditionalLinks
      properties:
        isExternal:
          description: IsExternal
          type: boolean
        linkText:
          description: LinkText
          type: string
        url:
          description: Url
          type: string
      type: object
    ViewFieldValueOfBoolean:
      description: When enabled, the log will be able to be viewed online
      properties:
        additionalLinks:
          description: AdditionalLinks
          items:
            $ref: '#/components/schemas/ViewFieldLink'
          type: array
        description:
          description: Description
          type: string
        fieldInputType:
          description: FieldInputType
          type:
          - string
          - 'null'
        hasHistory:
          description: HasHistory
          type:
          - boolean
          - 'null'
        helpLink:
          description: HelpLink
          type: string
        helpLinkText:
          description: HelpLinkText
          type: string
        hidden:
          description: Hidden
          type:
          - boolean
          - 'null'
        hideOnView:
          description: HideOnView
          type:
          - boolean
          - 'null'
        isRequired:
          description: IsRequired
          type:
          - boolean
          - 'null'
        label:
          description: Label
          type: string
        maxLength:
          description: MaxLength
          type:
          - integer
          - 'null'
          format: int32
        name:
          description: Name
          type: string
        placeholder:
          description: Placeholder
          type: string
        readOnly:
          description: ReadOnly
          type:
          - boolean
          - 'null'
        readOnlyReason:
          description: ReadOnlyReason
          type: string
        sortOrder:
          description: SortOrder
          type:
          - integer
          - 'null'
          format: int32
        value:
          description: Value
          type: boolean
      type: object
  requestBodies:
    DevOpsSecretsVaultCreateSyncArgs:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DevOpsSecretsVaultCreateSyncArgs'
      description: args
  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