openapi: 3.0.0
info:
title: Secret Server Rest Activations BulkSecretOperations 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 authentication document for more information. The Swagger specification 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: BulkSecretOperations
description: Create Bulk Secret Operations
paths:
/v1/bulk-secret-operations/add-share:
post:
tags:
- BulkSecretOperations
summary: Add share
description: Add share to each Secret with supplied Permissions.
operationId: BulkSecretOperationsService_AddSharePermissionsToSecrets
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddSharePermissionArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/assign-site:
post:
tags:
- BulkSecretOperations
summary: Assign site
description: Assign each Secret to the supplied site.
operationId: BulkSecretOperationsService_AssignSecretsToSite
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AssignSecretsToSiteArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/assign-jumpbox-route:
post:
tags:
- BulkSecretOperations
summary: Assign Jumpbox Route
description: Assign each Secret to the supplied Jumpbox route.
operationId: BulkSecretOperationsService_AssignSecretsToJumpboxRoute
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AssignSecretsToJumpboxRouteArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/assign-secret-policy:
post:
tags:
- BulkSecretOperations
summary: Assign Secret Policy
description: Assign each Secret to the supplied Secret Policy.
operationId: BulkSecretOperationsService_AssignSecretsToSecretPolicy
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AssignSecretsToSecretPolicyArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/change-password-remotely:
post:
tags:
- BulkSecretOperations
summary: Change Password Remotely
description: Change the password remotely of each Secret.
operationId: BulkSecretOperationsService_ChangeSecretsPasswordsRemotely
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeSecretsPasswordsRemotelyArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/convert-type:
post:
tags:
- BulkSecretOperations
summary: Convert Type
description: Convert each Secret to the supplied type.
operationId: BulkSecretOperationsService_ConvertSecretsToSecretType
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConvertSecretsSecretTypeArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/deactivate:
post:
tags:
- BulkSecretOperations
summary: Deactivate
description: Deactivate each Secret.
operationId: BulkSecretOperationsService_DeactivateSecrets
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeactivateSecretsArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/disable-autochange:
post:
tags:
- BulkSecretOperations
summary: Disable AutoChange
description: Disable AutoChange for each Secret.
operationId: BulkSecretOperationsService_DisableAutoChangeSecrets
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DisableAutoChangeSecretsArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/disable-checkout:
post:
tags:
- BulkSecretOperations
summary: Disable Checkout
description: Disable Checkout for each Secret.
operationId: BulkSecretOperationsService_DisableCheckoutSecrets
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DisableCheckoutSecretsArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/disable-heartbeat:
post:
tags:
- BulkSecretOperations
summary: Disable Heartbeat
description: Disable Heartbeat for each Secret.
operationId: BulkSecretOperationsService_DisableHeartbeatSecrets
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DisableHeartbeatSecretsArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/disable-require-view-comment:
post:
tags:
- BulkSecretOperations
summary: Disable Require View Comment
description: Disable Require View Comment for each Secret.
operationId: BulkSecretOperationsService_DisableRequireViewCommentSecrets
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DisableRequireViewCommentSecretsArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/enable-autochange:
post:
tags:
- BulkSecretOperations
summary: Enable AutoChange
description: Enable AutoChange for each Secret.
operationId: BulkSecretOperationsService_EnableAutoChangeSecrets
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EnableAutoChangeSecretsArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/enable-checkout:
post:
tags:
- BulkSecretOperations
summary: Enable Checkout
description: Enable Checkout for each Secret.
operationId: BulkSecretOperationsService_EnableCheckoutSecrets
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EnableCheckoutSecretsArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/request-erase:
post:
tags:
- BulkSecretOperations
summary: Request Erase
description: Request Erase for each Secret.
operationId: BulkSecretOperationsService_RequestEraseSecrets
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestEraseSecretsArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/change-security-options:
post:
tags:
- BulkSecretOperations
summary: Change Security Options
description: Change Security Options for each Secret.
operationId: BulkSecretOperationsService_ChangeSecurityOptionsSecrets
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeSecurityOptionsSecretsArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/enable-require-view-comment:
post:
tags:
- BulkSecretOperations
summary: Enable Require View Comment
description: Enable Require View Comment for each Secret.
operationId: BulkSecretOperationsService_EnableRequireViewCommentSecrets
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EnableRequireViewCommentSecretsArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/enable-heartbeat:
post:
tags:
- BulkSecretOperations
summary: Enable Heartbeat
description: Enable Heartbeat for each Secret.
operationId: BulkSecretOperationsService_EnableHeartbeatSecrets
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EnableHeartbeatSecretsArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/edit-share:
post:
tags:
- BulkSecretOperations
summary: Edit Share
description: Edit each Secret and apply the supplied share Permissions.
operationId: BulkSecretOperationsService_EditSharePermissionsSecrets
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EditSharePermissionsSecretsArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/enable-hide-launcher-password:
post:
tags:
- BulkSecretOperations
summary: Enable Hide Launcher Password
description: Enable Hide Launcher Password for each Secret.
operationId: BulkSecretOperationsService_EnableHideLauncherPasswordSecrets
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EnableHideLauncherPasswordSecretsArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/enable-inherit-permissions:
post:
tags:
- BulkSecretOperations
summary: Enable Inherit Permissions
description: Enable Inherit Permissions for each Secret.
operationId: BulkSecretOperationsService_EnableInheritPermissionsSecrets
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EnableInheritPermissionsSecretsArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/move-to-folder:
post:
tags:
- BulkSecretOperations
summary: Move To Folder
description: Move selected Secrets to a specified Folder.
operationId: BulkSecretOperationsService_MoveSecretsToFolder
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MoveSecretsToFolderArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/run-heartbeat:
post:
tags:
- BulkSecretOperations
summary: Run Heartbeat
description: Run Heartbeat for selected Secrets.
operationId: BulkSecretOperationsService_RunHeartbeatForSecrets
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RunHeartbeatForSecretsArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/update-password-requirement:
post:
tags:
- BulkSecretOperations
summary: Set Password Requirement
description: Set a Password Requirement for selected Secrets.
operationId: BulkSecretOperationsService_UpdatePasswordRequirementForSecrets
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePasswordRequirementForSecretsArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/set-privileged-account:
post:
tags:
- BulkSecretOperations
summary: Set Privileged Account
description: Set a Privileged Account for selected Secrets.
operationId: BulkSecretOperationsService_SetPrivilegedAccountForSecrets
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SetPrivilegedAccountForSecretsArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/update-associated-secrets:
post:
tags:
- BulkSecretOperations
summary: Update Associated Secrets
description: Associate each Secret in a list with every Secret in a second list.
operationId: BulkSecretOperationsService_UpdateAssociatedSecrets
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAssociatedSecretsArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/set-dependencies-password:
post:
tags:
- BulkSecretOperations
summary: Set Dependencies Password
description: Set Password dependencies for each Secret.
operationId: BulkSecretOperationsService_SetDependenciesPassword
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SetDependencyPasswordArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/enable-dependencies:
post:
tags:
- BulkSecretOperations
summary: Enable Dependencies
description: Enable Dependencies for each Secret.
operationId: BulkSecretOperationsService_EnableDependencies
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EnableDependenciesArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/delete-dependencies:
post:
tags:
- BulkSecretOperations
summary: Delete Dependencies
description: Delete Dependencies for each Secret.
operationId: BulkSecretOperationsService_DeleteDependencies
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteDependenciesArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/disable-dependencies:
post:
tags:
- BulkSecretOperations
summary: Disable Dependencies
description: Disable Dependencies for each Secret.
operationId: BulkSecretOperationsService_DisableDependencies
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DisableDependenciesArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/activate:
post:
tags:
- BulkSecretOperations
summary: Activate
description: Activate each Secret.
operationId: BulkSecretOperationsService_ActivateSecrets
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ActivateSecretsArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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/bulk-secret-operations/disable-hide-launcher-password:
post:
tags:
- BulkSecretOperations
summary: Disable Hide Launcher Password
description: Disable Hide Launcher Password for each Secret.
operationId: BulkSecretOperationsService_DisableHideLauncherPasswordForSecrets
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DisableHideLauncherPasswordForSecretsArgs'
description: args
responses:
'200':
description: BulkOperationResponseMessage containing the Id of the created Bulk Operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponseMessage'
'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:
DisableAutoChangeSecretsModel:
description: Data
properties:
secretIds:
description: Ids of Secrets to set AutoChange to disabled.
items:
type: integer
format: int32
type: array
type: object
DisableHideLauncherPasswordForSecretsArgs:
description: DisableHideLauncherPasswordForSecretsArgs
properties:
data:
$ref: '#/components/schemas/DisableHideLauncherPasswordForSecretsModel'
type: object
BulkOperationResponseMessage:
description: BulkOperationResponseMessage
properties:
bulkOperationId:
description: BulkOperationId
type: string
type: object
ActivateSecretsModel:
description: Data
properties:
secretIds:
description: Ids of Secrets to activate.
items:
type: integer
format: int32
type: array
type: object
AssignSecretsToSiteModel:
description: Data
properties:
secretIds:
description: Ids of Secrets to assign to supplied site.
items:
type: integer
format: int32
type: array
siteId:
description: Site Id to assign secrets to.
type: integer
format: int32
type: object
EnableDependenciesModel:
description: Data
properties:
dependencyIds:
description: Dependecy Ids to be enabled for each Secret.
items:
type: integer
format: int32
type: array
secretIds:
description: Ids of Secrets to enable dependencies on.
items:
type: integer
format: int32
type: array
type: object
AddSharePermissionModel:
description: Data
properties:
permissions:
description: Permissions to add for each shared Secret.
items:
$ref: '#/components/schemas/BulkOperationPermissionModel'
type: array
secretIds:
description: Ids of Secrets to add share permissions to.
items:
type: integer
format: int32
type: array
type: object
DisableHeartbeatSecretsArgs:
description: DisableHeartbeatSecretsArgs
properties:
data:
$ref: '#/components/schemas/DisableHeartbeatSecretsModel'
type: object
UpdateAssociatedSecretsArgs:
description: UpdateAssociatedSecretsArgs
properties:
data:
$ref: '#/components/schemas/UpdateAssociatedSecretsModel'
type: object
AssignSecretsToSecretPolicyArgs:
description: AssignSecretsToSecretPolicyArgs
properties:
data:
$ref: '#/components/schemas/AssignSecretsToSecretPolicyModel'
type: object
ConvertSecretsSecretTypeArgs:
description: ConvertSecretsSecretTypeArgs
properties:
data:
$ref: '#/components/schemas/ConvertSecretsSecretTypeModel'
type: object
AssignSecretsToSiteArgs:
description: AssignSecretsToSiteArgs
properties:
data:
$ref: '#/components/schemas/AssignSecretsToSiteModel'
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
DisableDependenciesArgs:
description: DisableDependenciesArgs
properties:
data:
$ref: '#/components/schemas/DisableDependenciesModel'
type: object
BulkOperationPermissionModel:
description: Permissions to add for each shared Secret.
properties:
groupId:
description: GroupId
type: integer
format: int32
isPersonal:
description: IsPersonal
type: boolean
secretAccessRoleId:
description: SecretAccessRoleId
type: integer
format: int32
type: object
ConvertSecretsSecretTypeModel:
description: Data
properties:
destinationSecretFieldsIds:
description: Destination Type Secret Field Ids to map to Source Field Ids. Nulls indicate the corresponding Source Fields should be removed.
items:
type: integer
format: int32
nullable: true
type: array
destinationSecretTypeId:
description: Secret Type Id to convert to.
type: integer
format: int32
secretIds:
description: Ids of Secrets to convert to supplied Secret Type.
items:
type: integer
format: int32
type: array
sourceSecretFieldsIds:
description: Secret Field Ids from the source type to map to the destination fields.
items:
type: integer
format: int32
type: array
sourceSecretTypeId:
description: Secret Type Id to convert from.
type: integer
format: int32
type: object
DeactivateSecretsArgs:
description: DeactivateSecretsArgs
properties:
data:
$ref: '#/components/schemas/DeactivateSecretsModel'
type: object
EnableHeartbeatSecretsArgs:
description: EnableHeartbeatSecretsArgs
properties:
data:
$ref: '#/components/schemas/EnableHeartbeatSecretsModel'
type: object
ActivateSecretsArgs:
description: ActivateSecretsArgs
properties:
data:
$ref: '#/components/schemas/ActivateSecretsModel'
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
RequestEraseSecretsModel:
description: Data
properties:
eraseAfter:
description: The date and time after which the Erase Request should take effect.
type: string
format: date-time
requestComment:
description: Comment to include as part of the Erase Request.
type: string
secretIds:
description: Ids of Secrets to request erase for.
items:
type: integer
format: int32
type: array
type: object
SetDependencyPasswordModel:
description: Data
properties:
dependencyIds:
description: Dependency Ids for password to set for each Secret.
items:
type: integer
format: int32
type: array
secretIds:
description: Ids of Secrets to set password dependencies on.
items:
type: integer
format: int32
type: array
type: object
ChangeSecurityOptionsSecretsArgs:
description: ChangeSecurityOptionsSecretsArgs
properties:
data:
$ref: '#/components/schemas/ChangeSecurityOptionsSecretsModel'
type: object
DisableAutoChangeSecretsArgs:
description: DisableAutoChangeSecretsArgs
properties:
data:
$ref: '#/components/schemas/DisableAutoChangeSecretsModel'
type: object
DisableCheckoutSecretsModel:
description: Data
properties:
secretIds:
description: Ids of Secrets to set Checkout to disabled.
items:
type: integer
format: int32
type: array
type: object
SetPrivilegedAccountForSecretsModel:
description: Data
properties:
privilegedAccountSecretId:
description: Id of the Secret that contains the privileged account information. Set to null to use the credentials on the secret.
type: integer
format: int32
nullable: true
secretIds:
description: Ids of Secrets to set the privileged account on.
items:
type: integer
format: int32
type: array
type: object
EnableHideLauncherPasswordSecretsModel:
description: Data
properties:
secretIds:
description: Ids of Secrets to set Hide Launcher Password to enabled.
items:
type: integer
format: int32
type: array
type: object
EnableCheckoutSecretsModel:
description: Data
properties:
secretIds:
description: Ids of Secrets to set Checkout to enabled.
items:
type: integer
format: int32
type: array
type: object
EditSharePermissionsSecretsModel:
description: Data
properties:
permissions:
description: Permissions to apply for each shared Secret.
items:
$ref: '#/components/schemas/BulkOperationPermissionModel'
type: array
secretIds:
description: Ids of Secrets to edit share permissions on.
items:
type: integer
format: int32
type: array
type: object
DeactivateSecretsModel:
description: Data
properties:
secretIds:
description: Ids of Secrets to deactivate.
items:
type: integer
format: int32
type: array
type: object
EditSharePermissionsSecretsArgs:
description: EditSharePermissionsSecretsArgs
properties:
data:
$ref: '#/components/schemas/EditSharePermissionsSecretsModel'
type: object
EnableInheritPermissionsSecretsModel:
description: Data
properties:
secretIds:
description: Ids of Secrets to set Inherit Permissions to enabled.
items:
type: integer
format: int32
type: array
type: object
AssignSecretsToJumpboxRouteArgs:
description: AssignSecretsToJumpboxRouteArgs
properties:
data:
$ref: '#/components/schemas/AssignSecretsToJumpboxRouteModel'
type: object
AddSharePermissionArgs:
description: AddSharePermissionArgs
properties:
data:
$ref: '#/components/schemas/AddSharePermissionModel'
type: object
EnableInheritPermissionsSecretsArgs:
description: EnableInheritPermissionsSecretsArgs
properties:
data:
$ref: '#/components/schemas/EnableInheritPermissionsSecretsModel'
type: object
DeleteDependenciesModel:
description: Data
properties:
dependencyIds:
description: Dependecy Ids to be deleted for each Secret.
items:
type: integer
format: int32
type: array
secretIds:
description: Ids of Secrets to delete dependencies on.
items:
type: integer
format: int32
type: array
type: object
EnableCheckoutSecretsArgs:
description: EnableCheckoutSecretsArgs
properties:
data:
$ref: '#/components/schemas/EnableCheckoutSecretsModel'
type: object
EnableRequireViewCommentSecretsArgs:
description: EnableRequireViewCommentSecretsArgs
properties:
data:
$ref: '#/components/schemas/EnableRequireViewCommentSecretsModel'
type: object
AssignSecretsToSecretPolicyModel:
description: Data
properties:
inheritSecretPolicy:
description: Set if Secrets should inherit from the Secret Policy.
type: boolean
secretIds:
description: Ids of Secrets to assign to the supplied Secret Policy.
items:
type: integer
format: int32
type: array
secretPolicyId:
description: Secret Policy Id to assign secrets to.
type: integer
format: int32
type: object
UpdatePasswordRequirementForSecretsModel:
description: Data
properties:
passwordRequirementId:
description: Password Requirement Id to be set for each Secret.
type: integer
format: int32
nullable: true
secretIds:
description: Ids of Secrets to update Password Requirement on.
items:
type: integer
format: int32
type: array
type: object
RunHeartbeatForSecretsModel:
description: Data
properties:
secretIds:
description: Ids of Secrets to run Heartbeat for.
items:
type: integer
format: int32
type: array
type: object
DeleteDependenciesArgs:
description: DeleteDependenciesArgs
properties:
data:
$ref: '#/components/schemas/DeleteDependenciesModel'
type: object
EnableRequireViewCommentSecretsModel:
description: Data
properties:
secretIds:
description: Ids of Secrets to set Require View Comment to enabled.
items:
type: integer
format: int32
type: array
type: object
ChangeSecurityOptionsSecretsModel:
description: Data
properties:
enableCheckout:
description: Set if Checkout is enabled.
type: boolean
nullable: true
enableMultifactorAuthentication:
description: Set if Require Multifactor Authentication is enabled.
type: boolean
nullable: true
hidePassword:
description: Set if Hide Password is enabled.
type: boolean
nullable: true
requireViewComment:
description: Set if Require View Comment is enabled.
type: boolean
nullable: true
secretIds:
description: Ids of Secrets to apply security changes to.
items:
type: integer
format: int32
type: array
type: object
AssignSecretsToJumpboxRouteModel:
description: Data
properties:
jumpboxRouteId:
description: JumpboxRoute Id to assign secrets to.
type: string
format: uuid
nullable: true
secretIds:
description: Ids of Secrets to assign to the supplied Jumpbox Route.
items:
type: integer
format: int32
type: array
type: object
RunHeartbeatForSecretsArgs:
description: RunHeartbeatForSecretsArgs
properties:
data:
$ref: '#/components/schemas/RunHeartbeatForSecretsModel'
type: object
DisableRequireViewCommentSecretsModel:
description: Data
properties:
secretIds:
description: Ids of Secrets to set Require View Comment to disabled.
items:
type: integer
format: int32
type: array
type: object
EnableDependenciesArgs:
description: EnableDependenciesArgs
properties:
data:
$ref: '#/components/schemas/EnableDependenciesModel'
type: object
MoveSecretsToFolderModel:
description: Data
properties:
folderId:
description: Folder Id to move selected secrets to.
type: integer
format: int32
secretIds:
description: Ids of Secrets to move to selected Folder.
items:
type: integer
format: int32
type: array
type: object
EnableHeartbeatSecretsModel:
description: Data
properties:
secretIds:
description: Ids of Secrets to set Heartbeat to enabled.
items:
type: integer
format: int32
type: array
type: object
EnableAutoChangeSecretsModel:
description: Data
properties:
secretIds:
description: Ids of Secrets to set AutoChange to enabled.
items:
type: integer
format: int32
type: array
type: object
AuthenticationFailedResponse:
description: Response object for authentication failures
required:
- message
properties:
message:
description: Error message
type: string
type: object
EnableAutoChangeSecretsArgs:
description: EnableAutoChangeSecretsArgs
properties:
data:
$ref: '#/components/schemas/EnableAutoChangeSecretsModel'
type: object
ChangeSecretsPasswordsRemotelyArgs:
description: ChangeSecretsPasswordsRemotelyArgs
properties:
data:
$ref: '#/components/schemas/ChangeSecretsPasswordsRemotelyModel'
type: object
DisableRequireViewCommentSecretsArgs:
description: DisableRequireViewCommentSecretsArgs
properties:
data:
$ref: '#/components/schemas/DisableRequireViewCommentSecretsModel'
type: object
SetDependencyPasswordArgs:
description: SetDependencyPasswordArgs
properties:
data:
$ref: '#/components/schemas/SetDependencyPasswordModel'
type: object
EnableHideLauncherPasswordSecretsArgs:
description: EnableHideLauncherPasswordSecretsArgs
properties:
data:
$ref: '#/components/schemas/EnableHideLauncherPasswordSecretsModel'
type: object
DisableDependenciesModel:
description: Data
properties:
dependencyIds:
description: Dependecy Ids to be disabled for each Secret.
items:
type: integer
format: int32
type: array
secretIds:
description: Ids of Secrets to disable dependencies on.
items:
type: integer
format: int32
type: array
type: object
SetPrivilegedAccountForSecretsArgs:
description: SetPrivilegedAccountForSecretsArgs
properties:
data:
$ref: '#/components/schemas/SetPrivilegedAccountForSecretsModel'
type: object
UpdatePasswordRequirementForSecretsArgs:
description: UpdatePasswordRequirementForSecretsArgs
properties:
data:
$ref: '#/components/schemas/UpdatePasswordRequirementForSecretsModel'
type: object
MoveSecretsToFolderArgs:
description: MoveSecretsToFolderArgs
properties:
data:
$ref: '#/components/schemas/MoveSecretsToFolderModel'
type: object
DisableHeartbeatSecretsModel:
description: Data
properties:
secretIds:
description: Ids of Secrets to set Heartbeat to disabled.
items:
type: integer
format: int32
type: array
type: object
DisableHideLauncherPasswordForSecretsModel:
description: Data
properties:
secretIds:
description: Ids of Secrets to set Hide Launcher Password to disabled.
items:
type: integer
format: int32
type: array
type: object
DisableCheckoutSecretsArgs:
description: DisableCheckoutSecretsArgs
properties:
data:
$ref: '#/components/schemas/DisableCheckoutSecretsModel'
type: object
UpdateAssociatedSecretsModel:
description: Data
properties:
associatedSecretIds:
description: Ids of Secrets to associate with each Secret.
items:
type: integer
format: int32
type: array
secretIds:
description: Ids of Secrets to update associations.
items:
type: integer
format: int32
type: array
type: object
ChangeSecretsPasswordsRemotelyModel:
description: Data
properties:
doNotGeneratePassphrase:
description: When SshType is Random this will not assign a passphrase allowing it to remain blank and only randomize the key
type: boolean
nullable: true
forceNextKeyReset:
description: Set if the next key reset is forced.
type: boolean
generateSSHKey:
description: Set if a SSH Key should be generated.
type: boolean
nullable: true
nextPassphrase:
description: Next passphrase to change secrets to.
type: string
nextPassword:
description: Next password to change secrets to.
type: string
nextPrivateKey:
description: Next private key to change secrets to.
type: string
secretIds:
description: Ids of Secrets to change password remotely.
items:
type: integer
format: int32
type: array
type: object
RequestEraseSecretsArgs:
description: RequestEraseSecretsArgs
properties:
data:
$ref: '#/components/schemas/RequestEraseSecretsModel'
type: object
securitySchemes:
BearerToken:
type: apiKey
description: 'Perform a POST request to `/oauth2/token`. It should include three form data parameters - `username`, `password`, and `grant_type`.The `grant_type` parameter should always have the value `password`.The access token returned should be included in the header of subsequent requests, like ''Authorization: Bearer token''. The token remains valid for a time period returned in the ''expires_in'' property (in seconds). For details, see the token request documentation.'
name: Authorization
in: header