OpenAPI Specification
openapi: 3.0.0
info:
title: Secret Server Rest Activations Folders 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: Folders
description: View and maintain secret folders
paths:
/v1/folders/{id}:
get:
tags:
- Folders
summary: Get Folder
description: Get a single folder by ID
operationId: FoldersService_Get
parameters:
- name: getAllChildren
in: query
description: Whether to retrieve all child folders of the requested folder
required: false
schema:
type: boolean
- name: includeAssociatedTemplates
in: query
description: Whether to list associated secret templates
required: false
schema:
type: boolean
- name: folderPath
in: query
description: A full path to a folder including the folder name can be passed as a query string parameter when the folder ID is set to 0. This will lookup the folder ID by path.
required: false
schema:
type: string
- name: id
in: path
description: Folder ID
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Folder object
content:
application/json:
schema:
$ref: '#/components/schemas/FolderModel'
'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:
- Folders
summary: Update Folder
description: Update a single secret folder by ID
operationId: FoldersService_Update
parameters:
- name: id
in: path
description: Folder ID
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FolderUpdateArgs'
description: Folder update options
responses:
'200':
description: Folder object
content:
application/json:
schema:
$ref: '#/components/schemas/FolderModel'
'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:
- Folders
summary: Delete Folder
description: Delete a folder by ID
operationId: FoldersService_Delete
parameters:
- name: id
in: path
description: Folder 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/folders/{id}/templates/{templateId}:
delete:
tags:
- Folders
summary: Disassociate Template from Folder
description: Remove the ability to create secrets based on the template in this folder. If the folder has no associated templates, then any template can be used.
operationId: FoldersService_DissassociateTemplateToFolder
parameters:
- name: id
in: path
description: Folder ID
required: true
schema:
type: integer
format: int32
- name: templateId
in: path
description: Template ID
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Folder object
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/folder/{id}/pinned:
delete:
tags:
- Folders
summary: Unpin Folder
description: Unpin a folder for the current user. This will remove any settings for this user for this pinned folder. If not pinned already it will still return success.
operationId: FoldersService_UnpinFolder
parameters:
- name: id
in: path
description: Folder ID
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Success Status
content:
application/json:
schema:
$ref: '#/components/schemas/UnpinFolderResultModel'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
patch:
tags:
- Folders
summary: Pin Folder
description: Pin a single folder or update settings for the pinned folder for the current user
operationId: FoldersService_PinFolder
parameters:
- name: id
in: path
description: Folder ID
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PinFolderArgs'
description: Pin Folder Args
responses:
'200':
description: Success Status
content:
application/json:
schema:
$ref: '#/components/schemas/PinFolderResultModel'
'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/folders:
get:
tags:
- Folders
summary: Search Folders
description: Search, filter, sort, and page secret folders
operationId: FoldersService_Search
parameters:
- name: filter.folderTypeId
in: query
description: The icon to display for the folder. Depricated in latest UI. Use 1 when setting this value.
required: false
x-nullable: true
schema:
type: integer
format: int32
- name: filter.limitToDirectDescendents
in: query
description: When true and ParentFolderId is not null only return immediate child folders
required: false
x-nullable: true
schema:
type: boolean
- name: filter.onlyIncludeRootFolders
in: query
description: When true only root folders will be returned and ParentFolderId will be ignored
required: false
schema:
type: boolean
- name: filter.parentFolderId
in: query
description: Return folders that are descendants of this folder.
required: false
x-nullable: true
schema:
type: integer
format: int32
- name: filter.permissionRequired
in: query
description: Specify whether to filter by Owner, Edit, AddSecret, View folder permission. Default is View.
required: false
x-nullable: true
schema:
type: string
- name: filter.searchText
in: query
description: Search term to match against folder names. Search returns any folder where the search term is contained in the folder name.
required: false
schema:
type: string
- name: skip
in: query
description: Number of records to skip before taking results
required: false
schema:
type: integer
format: int32
- name: sortBy[0].direction
in: query
description: Sort direction
required: false
schema:
type: string
- name: sortBy[0].name
in: query
description: Sort field name
required: false
schema:
type: string
- name: sortBy[0].priority
in: query
description: Priority index. Sorts with lower values are executed earlier
required: false
schema:
type: integer
format: int32
- name: take
in: query
description: Maximum number of records to include in results
required: false
schema:
type: integer
format: int32
responses:
'200':
description: Folder search result object
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfFolderSummary'
'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:
- Folders
summary: Create Folder
description: Create a new secret folder
operationId: FoldersService_Create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FolderCreateArgs'
description: Folder creation options
responses:
'200':
description: Folder object
content:
application/json:
schema:
$ref: '#/components/schemas/FolderModel'
'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/folders/lookup:
get:
tags:
- Folders
summary: Lookup Folders
description: Search, filter, sort, and page secret folders, returning only folder ID and name
operationId: FoldersService_Lookup
parameters:
- name: filter.folderTypeId
in: query
description: The icon to display for the folder. Depricated in latest UI. Use 1 when setting this value.
required: false
x-nullable: true
schema:
type: integer
format: int32
- name: filter.limitToDirectDescendents
in: query
description: When true and ParentFolderId is not null only return immediate child folders
required: false
x-nullable: true
schema:
type: boolean
- name: filter.onlyIncludeRootFolders
in: query
description: When true only root folders will be returned and ParentFolderId will be ignored
required: false
schema:
type: boolean
- name: filter.parentFolderId
in: query
description: Return folders that are descendants of this folder.
required: false
x-nullable: true
schema:
type: integer
format: int32
- name: filter.permissionRequired
in: query
description: Specify whether to filter by Owner, Edit, AddSecret, View folder permission. Default is View.
required: false
x-nullable: true
schema:
type: string
- name: filter.searchText
in: query
description: Search term to match against folder names. Search returns any folder where the search term is contained in the folder name.
required: false
schema:
type: string
- name: skip
in: query
description: Number of records to skip before taking results
required: false
schema:
type: integer
format: int32
- name: sortBy[0].direction
in: query
description: Sort direction
required: false
schema:
type: string
- name: sortBy[0].name
in: query
description: Sort field name
required: false
schema:
type: string
- name: sortBy[0].priority
in: query
description: Priority index. Sorts with lower values are executed earlier
required: false
schema:
type: integer
format: int32
- name: take
in: query
description: Maximum number of records to include in results
required: false
schema:
type: integer
format: int32
responses:
'200':
description: Folder search result object
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfFolderLookup'
'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/folders/stub:
get:
tags:
- Folders
summary: Get Folder Stub
description: Return the default values for a new secret folder
operationId: FoldersService_Stub
responses:
'200':
description: Folder object
content:
application/json:
schema:
$ref: '#/components/schemas/FolderModel'
'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/folders/{id}/audit:
get:
tags:
- Folders
summary: Folder Audits
description: Retrieve a list of audits for folder by ID.
operationId: FoldersService_GetAudits
parameters:
- name: id
in: path
description: Folder ID
required: true
schema:
type: integer
format: int32
- name: isExporting
in: query
description: isExporting
required: false
schema:
type: boolean
- 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: Specify paging and sorting options for querying records and returning results
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfFolderAuditSummary'
'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/folder-details/{id}:
get:
tags:
- Folders
summary: Get Folder Details
description: Get Folder Details
operationId: FoldersService_GetFolderDetail
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: returnEmptyInsteadOfNoAccessException
in: query
description: returnEmptyInsteadOfNoAccessException
required: false
schema:
type: boolean
responses:
'200':
description: Folder Details
content:
application/json:
schema:
$ref: '#/components/schemas/FolderDetailViewModel'
'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/folders/pinned:
get:
tags:
- Folders
summary: Get Pinned Folders
description: Return a list of folders that the current user has pinned
operationId: FoldersService_GetPinnedFolders
parameters:
- name: skip
in: query
description: Number of records to skip before taking results
required: false
schema:
type: integer
format: int32
- name: sortBy[0].direction
in: query
description: Sort direction
required: false
schema:
type: string
- name: sortBy[0].name
in: query
description: Sort field name
required: false
schema:
type: string
- name: sortBy[0].priority
in: query
description: Priority index. Sorts with lower values are executed earlier
required: false
schema:
type: integer
format: int32
- name: take
in: query
description: Maximum number of records to include in results
required: false
schema:
type: integer
format: int32
responses:
'200':
description: List of pinned folders
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfPinnedFolderModel'
'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/folder/{id}:
patch:
tags:
- Folders
summary: Patch a Folder
description: Patch a single secret folder by ID
operationId: FoldersService_PatchFolder
parameters:
- name: id
in: path
description: Folder ID
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FolderPatchArgs'
description: Folder update options
responses:
'200':
description: Folder object
content:
application/json:
schema:
$ref: '#/components/schemas/FolderBasicModel'
'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/folder/{folderId}/permissions:
patch:
tags:
- Folders
summary: Patch Folder Permissions
description: Add, delete, and update some permissions as opposed to a full replace of all permissions for a folder
operationId: FoldersService_PatchFolderPermissions
parameters:
- name: folderId
in: path
description: Folder ID
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FolderPermissionsPatchArgs'
description: Folder permission update options
responses:
'200':
description: Success result
content:
application/json:
schema:
$ref: '#/components/schemas/FolderPermissionsPatchResultModel'
'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/folders/{id}/templates:
post:
tags:
- Folders
summary: Associate Template to Folder
description: Allow secrets based on the template to be created in the folder. If the folder has no associated templates, then any template can be used.
operationId: FoldersService_AssociateTemplateToFolder
parameters:
- name: id
in: path
description: Folder ID
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FolderTemplateArgs'
description: Folder template association options
responses:
'200':
description: Folder object
content:
application/json:
schema:
$ref: '#/components/schemas/FolderTemplateModel'
'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:
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
UpdateFieldValueOfBoolean:
description: Active
properties:
dirty:
description: Dirty
type: boolean
value:
description: Value
type: boolean
type: object
PinnedFolderModel:
description: A folder that a user has pinned
properties:
activeFilter:
description: Active Filter
type: boolean
nullable: true
createDate:
description: When was this folder pinned
type: string
format: date-time
displayName:
description: The display name to show. This will be the folder name or an overridable user defined name for this pin
type: string
folderId:
description: The pinned folder ID. This folder will be the root of the tree
type: integer
format: int32
includeSubfolders:
description: Include Subfolders
type: boolean
lastViewed:
description: When was this folder last viewed
type: string
format: date-time
nullable: true
searchText:
description: Search Text
type: string
selectedFolderId:
description: Expand this folder in the tree
type: integer
format: int32
nullable: true
showCards:
description: Show Cards
type: boolean
templateFilter:
description: Template Filter
type: integer
format: int32
nullable: true
type: object
SortDirection:
description: Sort direction
properties: {}
type: string
enum:
- None
- Asc
- Desc
FolderSummary:
description: Representation of a secret folder object
properties:
folderName:
description: The name of the folder
type: string
folderPath:
description: The path of all folders and subfolders beginning at the root anterminating at this folder.
type: string
folderTypeId:
description: The icon to display for the folder. Depricated in latest UI. Use 1 when setting this value.
type: integer
format: int32
id:
description: Folder ID
type: integer
format: int32
inheritPermissions:
description: 'Whether the folder should inherit permissions from its parent (default: true)'
type: boolean
inheritSecretPolicy:
description: Whether the folder should inherit the secret policy. Defaults to true unless creating a root folder.
type: boolean
parentFolderId:
description: The ID of this folder's parent folder.
type: integer
format: int32
secretPolicyId:
description: The id of the Secret Policy that sets security and other settings on secrets contained within the folder.
type: integer
format: int32
type: object
FolderPermissionModel:
description: Folder permission
properties:
folderAccessRoleId:
description: Role ID granted on the folder
type: integer
format: int32
folderAccessRoleName:
description: Role name granted on the folder
type: string
folderId:
description: Folder ID
type: integer
format: int32
groupId:
description: Group ID having permissions on the folder
type: integer
format: int32
groupName:
description: Group name having permissions on the folder
type: string
id:
description: Folder permission ID
type: integer
format: int32
knownAs:
description: KnownAs
type: string
secr
# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/delinea/refs/heads/main/openapi/delinea-folders-api-openapi.yml