openapi: 3.0.0 info: title: Secret Server Rest Activations SecretTemplates 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: SecretTemplates description: View secret templates paths: /v1/secret-templates/fields/{templateFieldId}: delete: tags: - SecretTemplates summary: Disable a Secret Template Field For Template description: Disable a Secret Template Field For Template operationId: SecretTemplatesService_DisableField parameters: - name: templateFieldId in: path description: Secret Template Field to disable required: true schema: type: integer format: int32 responses: '200': description: Secret Template Field object content: application/json: schema: $ref: '#/components/schemas/SecretTemplateField' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates/password-requirements/password-dictionaries/{id}: get: tags: - SecretTemplates summary: Gets password dictionary items by ID description: Returns a file containing the items of a specific custom password dictionary. operationId: SecretTemplatesService_GetPasswordDictionary parameters: - name: id in: path description: id required: true schema: type: integer format: int32 responses: '200': description: Unknown or empty response '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: - SecretTemplates summary: Deletes a specific password dictionary by ID description: Deletes a specific custom password dictionary with the contents. operationId: SecretTemplatesService_DeletePasswordDictionary parameters: - name: id in: path description: id required: true schema: type: integer format: int32 responses: '200': description: 'true' content: application/json: schema: description: Boolean type: boolean '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates/{secretTemplateId}/extended-mappings/{extendedTypeId}: get: tags: - SecretTemplates summary: Get a single Secret Template Extended Mappings description: Get an extended mapping for a Secret Template operationId: SecretTemplatesService_GetSecretTemplateExtendedMapping parameters: - name: extendedTypeId in: path description: extendedTypeId required: true schema: type: integer format: int32 - name: secretTemplateId in: path description: secretTemplateId required: true schema: type: integer format: int32 responses: '200': description: Extended Mapping Detail content: application/json: schema: $ref: '#/components/schemas/SecretTemplateExtendedMappingModel' '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: - SecretTemplates summary: Create a Secret Template Extended Mapping description: Create an extended mappings for a Secret Template operationId: SecretTemplatesService_CreateSecretTemplateExtendedMapping parameters: - name: extendedTypeId in: path description: extendedTypeId required: true schema: type: integer format: int32 - name: secretTemplateId in: path description: secretTemplateId required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SecretTemplateExtendedMappingCreateArgs' description: args responses: '200': description: Created extended mappings content: application/json: schema: $ref: '#/components/schemas/SecretTemplateExtendedMappingModel' '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: - SecretTemplates summary: Delete Extended Mapping description: Delete an extended mapping operationId: SecretTemplatesService_DeleteExtendedMapping parameters: - name: extendedTypeId in: path description: extendedTypeId required: true schema: type: integer format: int32 - name: secretTemplateId in: path description: secretTemplateId required: true schema: type: integer format: int32 responses: '200': description: Success message content: application/json: schema: $ref: '#/components/schemas/SecretTemplateExtendedMappingDeleteResponseModel' '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: - SecretTemplates summary: Update a Secret Template Extended Mapping description: Update extended mappings for a Secret Template operationId: SecretTemplatesService_UpdateSecretTemplateExtendedMapping parameters: - name: extendedTypeId in: path description: extendedTypeId required: true schema: type: integer format: int32 - name: secretTemplateId in: path description: secretTemplateId required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SecretTemplateExtendedMappingUpdateArgs' description: args responses: '200': description: List of extended mappings content: application/json: schema: $ref: '#/components/schemas/SecretTemplateExtendedMappingModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates/{secretTemplateId}/launchers/{launcherTypeId}: get: tags: - SecretTemplates summary: Get a Secret Template Launcher description: Get launcher detail for a Secret Template operationId: SecretTemplatesService_GetSecretTemplateLauncher parameters: - name: launcherTypeId in: path description: launcherTypeId required: true schema: type: integer format: int32 - name: secretTemplateId in: path description: secretTemplateId required: true schema: type: integer format: int32 responses: '200': description: Launcher Detail content: application/json: schema: $ref: '#/components/schemas/SecretTemplateLauncherModel' '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: - SecretTemplates summary: Create a Secret Template Launcher description: Create a Launcher for a Secret Template operationId: SecretTemplatesService_CreateSecretTemplateLauncher parameters: - name: launcherTypeId in: path description: launcherTypeId required: true schema: type: integer format: int32 - name: secretTemplateId in: path description: secretTemplateId required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SecretTemplateLauncherCreateArgs' description: args responses: '200': description: List of Launchers content: application/json: schema: $ref: '#/components/schemas/SecretTemplateLauncherModel' '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: - SecretTemplates summary: Delete Secret Template Launcher description: Delete or remove the mapping of a specific launcher type from a specific Secret template operationId: SecretTemplatesService_DeleteSecretTemplateLauncher parameters: - name: launcherTypeId in: path description: launcherTypeId required: true schema: type: integer format: int32 - name: secretTemplateId in: path description: secretTemplateId required: true schema: type: integer format: int32 responses: '200': description: Delete success content: application/json: schema: $ref: '#/components/schemas/SecretTemplateLauncherDeleteResultModel' '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: - SecretTemplates summary: Update a Secret Template Launcher description: Update a Launchers for a Secret Template operationId: SecretTemplatesService_UpdateSecretTemplateLauncher parameters: - name: launcherTypeId in: path description: launcherTypeId required: true schema: type: integer format: int32 - name: secretTemplateId in: path description: secretTemplateId required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SecretTemplateLauncherUpdateArgs' description: args responses: '200': description: List of Launchers content: application/json: schema: $ref: '#/components/schemas/SecretTemplateLauncherModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates: get: tags: - SecretTemplates summary: Search Secret Templates description: Search, filter, sort, and page secret templates operationId: SecretTemplatesService_Search parameters: - name: filter.heartbeatEnabled in: query description: Filter templates that have heartbeat enabled or disabled required: false x-nullable: true schema: type: string - name: filter.includeInactive in: query description: Whether to include inactive secret templates in the results required: false schema: type: boolean - name: filter.includeSecretCount in: query description: Whether to populate Secret count in the results required: false schema: type: boolean - name: filter.passwordTypeIds in: query description: List of Password Type Ids required: false explode: true schema: type: array items: type: integer - name: filter.passwordTypeReady in: query description: Filter templates that are either password type ready (enabled) or not (disabled) required: false x-nullable: true schema: type: string - name: filter.scanItemTemplateId in: query description: 'Filter templates that map to ' required: false x-nullable: true schema: type: integer format: int32 - name: filter.searchText in: query description: Search text 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: Secret template search result object content: application/json: schema: $ref: '#/components/schemas/PagingOfSecretTemplateSummary' '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: - SecretTemplates summary: Create Secret Template description: Create a new Secret Template operationId: SecretTemplatesService_CreateTemplate requestBody: content: application/json: schema: $ref: '#/components/schemas/SecretTemplateCreateArgs' description: Secret Template creation options responses: '200': description: Secret Template object content: application/json: schema: $ref: '#/components/schemas/SecretTemplateModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates/{id}/export: get: tags: - SecretTemplates summary: Export Secret Template description: Export a single secret template by ID operationId: SecretTemplatesService_Export parameters: - name: id in: path description: Secret template ID required: true schema: type: integer format: int32 responses: '200': description: Secret template export data content: application/json: schema: $ref: '#/components/schemas/SecretTemplateExportModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates/password-requirements/password-dictionaries: get: tags: - SecretTemplates summary: Get password dictionaries description: Returns the list of custom password dictionaries. operationId: SecretTemplatesService_GetPasswordDictionaries responses: '200': description: A list of password dictionary ID and names. content: application/json: schema: description: A list of password dictionary ID and names. items: $ref: '#/components/schemas/PasswordDictionaryModel' 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 put: tags: - SecretTemplates summary: Updates a new password dictionary description: Updates password dictionary operationId: SecretTemplatesService_UpdatePasswordDictionary requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/UpdatePasswordDictionaryArgs' description: The file of words responses: '200': description: 'True' content: application/json: schema: description: Boolean type: boolean '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: - SecretTemplates summary: Creates new password dictionary description: Add new password dictionary operationId: SecretTemplatesService_AddPasswordDictionary requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/AddPasswordDictionaryArgs' description: The file of words responses: '200': description: 'True' content: application/json: schema: description: Boolean type: boolean '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates/extended-types: get: tags: - SecretTemplates summary: Get Secret Template Extended Types description: Get all of the extended types operationId: SecretTemplatesService_SearchSecretTemplateExtendedTypes 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 extended types content: application/json: schema: $ref: '#/components/schemas/PagingOfSecretTemplateExtendedTypeSummary' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates/extended-mappings: get: tags: - SecretTemplates summary: Get Secret Template Extended Mappings description: Get all of the extended mappings for a Secret Template operationId: SecretTemplatesService_SearchSecretTemplateExtendedMappings parameters: - name: filter.secretTemplateId in: query description: SecretTemplateId required: false 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: List of extended mappings content: application/json: schema: $ref: '#/components/schemas/PagingOfSecretTemplateExtendedMappingSummary' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates/{secretTemplateId}/extended-mappings/{extendedTypeId}/stub: get: tags: - SecretTemplates summary: Stub a Secret Template Extended Mappings description: Gets a stub that can be used to create an extended mapping operationId: SecretTemplatesService_StubSecretTemplateExtendedMapping parameters: - name: extendedTypeId in: path description: extendedTypeId required: true schema: type: integer format: int32 - name: secretTemplateId in: path description: secretTemplateId required: true schema: type: integer format: int32 responses: '200': description: Stub of extended mapping content: application/json: schema: $ref: '#/components/schemas/SecretTemplateExtendedMappingModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates/launcher-types: get: tags: - SecretTemplates summary: Get Launcher Types description: Get a paged list of all of the Launcher Types that exist operationId: SecretTemplatesService_SearchLauncherTypes parameters: - name: filter.applicationName in: query description: Application name required: false schema: type: string - name: filter.includeInactive in: query description: Include inactive launcher types required: false x-nullable: true schema: type: boolean - name: filter.includeSystemLaunchers in: query description: Include system launcher types required: false x-nullable: true 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: List of launcher types content: application/json: schema: $ref: '#/components/schemas/PagingOfLauncherTypeSummary' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates/launchers: get: tags: - SecretTemplates summary: Get Secret Template Launchers description: Get all of the Launchers for a Secret Template operationId: SecretTemplatesService_SearchSecretTemplateLaunchers parameters: - name: filter.secretTemplateId in: query description: SecretTemplateId required: false 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: List of Launchers content: application/json: schema: $ref: '#/components/schemas/PagingOfSecretTemplateLauncherSummary' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates/{secretTemplateId}/launchers/{launcherTypeId}/stub: get: tags: - SecretTemplates summary: Stub a Secret Template Launchers description: Gets a stub that can be used to create an launcher operationId: SecretTemplatesService_StubSecretTemplateLauncher parameters: - name: launcherTypeId in: path description: launcherTypeId required: true schema: type: integer format: int32 - name: secretTemplateId in: path description: secretTemplateId required: true schema: type: integer format: int32 responses: '200': description: Stub of template launcher content: application/json: schema: $ref: '#/components/schemas/SecretTemplateLauncherModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates/{secretTemplateId}/password-type: get: tags: - SecretTemplates summary: Get Secret Template Password Changer description: Get the password changer for a secret template if defined operationId: SecretTemplatesService_GetSecretTemplatePasswordType parameters: - name: secretTemplateId in: path description: secretTemplateId required: true schema: type: integer format: int32 responses: '200': description: Secret Template Password Changer content: application/json: schema: $ref: '#/components/schemas/SecretTemplatePasswordTypeModel' '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: - SecretTemplates summary: Patch Secret Template password type description: Create or assign password type settings on a secret template operationId: SecretTemplatesService_PatchSecretTemplatePasswordChanger parameters: - name: secretTemplateId in: path description: secretTemplateId required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SecretTemplatePasswordTypePatchArgs' description: args responses: '200': description: Updated secret template password type content: application/json: schema: $ref: '#/components/schemas/SecretTemplatePasswordTypeModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates-list: get: tags: - SecretTemplates summary: Get Secret Template List description: Get a list of all Secret Templates. Basic users are able to query and get this list. Only returns active templates. operationId: SecretTemplatesService_GetSecretTemplatesList parameters: - name: filter.folderId in: query description: Only return templates that the current user can create in this folder. When null it will only return for creating secrets without a folder. Only applies when OnlyIncludeCreatable is true. required: false x-nullable: true schema: type: integer format: int32 - name: filter.onlyIncludeCreatable in: query description: When true only templates that the user can create in the FolderId specified will be returned required: false schema: type: boolean - name: filter.onlyIncludeTemplatesWithUrl in: query description: When true only templates that contain a URL or URL List field will be returned 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: Secret Templates content: application/json: schema: $ref: '#/components/schemas/PagingOfSecretTemplateListModel' '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 /v2/secret-templates/{secretTemplateId}: get: tags: - SecretTemplates summary: Get Secret Template Details description: Get a single secret template details by Id operationId: SecretTemplatesService_GetV2 parameters: - name: secretTemplateId in: path description: secretTemplateId required: true schema: type: integer format: int32 responses: '200': description: Secret Template Details content: application/json: schema: $ref: '#/components/schemas/SecretTemplateDetailModel' '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: - SecretTemplates summary: Patch Secret Template V2 description: Patch secret template details operationId: SecretTemplatesService_PatchTemplateV2 parameters: - name: secretTemplateId in: path description: secretTemplateId required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SecretTemplateDetailPatchArgs' description: args responses: '200': description: Secret Template Details content: application/json: schema: $ref: '#/components/schemas/SecretTemplateDetailModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates/fields/search: get: tags: - SecretTemplates summary: Search Secret Template Fields description: Search, filter, sort, and page secret template fields operationId: SecretTemplatesService_SearchTemplateFields parameters: - name: filter.includeInactive in: query description: Whether to include inactive secret template fields in the results required: false schema: type: boolean - name: filter.secretTemplateId in: query description: Secret Template Id to filter by required: false 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: Secret template field summary result object content: application/json: schema: $ref: '#/components/schemas/PagingOfSecretTemplateFieldSummaryModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates/fields/stub: get: tags: - SecretTemplates summary: Stub Secret Template Field description: Retrieve an empty secret template field operationId: SecretTemplatesService_StubTemplateField responses: '200': description: Secret Template Field content: application/json: schema: $ref: '#/components/schemas/SecretTemplateFieldModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates/fields/{secretFieldId}: get: tags: - SecretTemplates summary: Get Secret Template Field description: Retrieve a secret template field operationId: SecretTemplatesService_GetTemplateField parameters: - name: secretFieldId in: path description: secretFieldId required: true schema: type: integer format: int32 responses: '200': description: Secret Template Field content: application/json: schema: $ref: '#/components/schemas/SecretTemplateFieldModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates/fields/{secretTemplateFieldId}: patch: tags: - SecretTemplates summary: Patch Secret Template Field description: Patch a secret template field operationId: SecretTemplatesService_PatchTemplateField parameters: - name: secretTemplateFieldId in: path description: secretTemplateFieldId required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SecretFieldPatchArgs' description: args responses: '200': description: Secret Template Field content: application/json: schema: $ref: '#/components/schemas/SecretTemplateFieldModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates/{id}/copy: post: tags: - SecretTemplates summary: Copy Secret Template description: Copy a single secret template by ID operationId: SecretTemplatesService_Copy parameters: - name: id in: path description: Secret template ID required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SecretTemplateCopyArgs' description: args responses: '200': description: Secret template data content: application/json: schema: $ref: '#/components/schemas/SecretTemplateDetailModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates/{templateId}: put: tags: - SecretTemplates summary: Update Secret Template Field description: Update a Secret Template Field operationId: SecretTemplatesService_Put parameters: - name: templateId in: path description: Secret Template ID required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SecretTemplateFieldUpdateArgs' description: Secret Template Options responses: '200': description: Secret Template Field content: application/json: schema: $ref: '#/components/schemas/SecretTemplateField' '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: - SecretTemplates summary: Create Secret Template Field For Template description: Create a new Secret Template Field For Template operationId: SecretTemplatesService_CreateField parameters: - name: templateId in: path description: templateId required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SecretTemplateFieldCreateArgs' description: Secret Template Field creation options responses: '200': description: Secret Template Field object content: application/json: schema: $ref: '#/components/schemas/SecretTemplateField' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates/generate-password/{secretfieldId}: post: tags: - SecretTemplates summary: Generate Password description: Generates a new password matching the Secret Field requirements operationId: SecretTemplatesService_GeneratePassword parameters: - name: secretfieldId in: path description: Secret field Id required: true schema: type: integer format: int32 responses: '200': description: Generate Password result content: application/json: schema: description: String type: string '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates/import: post: tags: - SecretTemplates summary: Import Secret Template description: Imports a secret template from xml operationId: SecretTemplatesService_ImportSecretTemplate requestBody: content: application/json: schema: $ref: '#/components/schemas/SecretTemplateImportArgs' description: args responses: '200': description: The imported template content: application/json: schema: $ref: '#/components/schemas/SecretTemplateModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates/{secretTemplateId}/fields: post: tags: - SecretTemplates summary: Create Secret Template Field description: Create a secret template field operationId: SecretTemplatesService_CreateTemplateField parameters: - name: secretTemplateId in: path description: secretTemplateId required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SecretFieldCreateArgs' description: args responses: '200': description: Secret Template Field content: application/json: schema: $ref: '#/components/schemas/SecretTemplateFieldModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates/{secretTemplateId}/fields/sort: post: tags: - SecretTemplates summary: Sort Secret Template Fields description: Sort secret template fields for a secret template operationId: SecretTemplatesService_SortTemplateFields parameters: - name: secretTemplateId in: path description: secretTemplateId required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SecretTemplateFieldSortArgs' description: args responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SecretTemplateFieldSortResultModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/secret-templates/password-type/{templateId}: put: tags: - SecretTemplates summary: Update Secret Templates Password Type description: Update A Secret template Password Type Options and Fields operationId: SecretTemplatesService_UpdateSecretTemplatePasswordType parameters: - name: templateId in: path description: Secret template ID required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SecretTemplatePasswordTypeUpdateArgs' description: args responses: '200': description: Secret template object content: application/json: schema: $ref: '#/components/schemas/SecretTemplateModel' '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: SortDirection: description: Sort direction properties: {} type: string enum: - None - Asc - Desc FieldDataType: description: Field Data Type properties: {} type: string enum: - Text - Notes - Url - Password - File - List - UrlList SecretTemplateLauncherUpdateArgs: description: SecretTemplateLauncherUpdateArgs properties: data: $ref: '#/components/schemas/SecretTemplateLauncherUpdateModel' type: object PagingOfSecretTemplateFieldSummaryModel: 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/SecretTemplateFieldSummaryModel' 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 SecretTemplateLauncherCreateModel: description: Create a launcher for a template properties: fields: description: Mapping of secret template fields to launcher fields items: $ref: '#/components/schemas/SecretTemplateLauncherCreateFieldModel' type: array type: object UpdateFieldValueOfOptionalInt32: description: The minimum length required for local user passwords properties: dirty: description: Dirty type: boolean value: description: Value type: integer format: int32 nullable: true type: object EditRequiresOptions: description: What option is required to edit this field including Owner, Edit, and Not Editable properties: {} type: string enum: - Edit - Owner - NotEditable SecretTemplateFieldModel: description: Secret Template Field Model properties: active: description: Is this field active type: boolean dataType: $ref: '#/components/schemas/FieldDataType' description: description: Description of Field type: string dropdownOptions: description: These values will appear as a drop down for text fields. items: $ref: '#/components/schemas/SecretTemplateFieldOptionModel' type: array editRequiresPermission: $ref: '#/components/schemas/FieldPermissionType' exposeForDisplay: description: Is this field is exposed for display type: boolean historyLength: description: Number of changes stored in history. If SaveAllHistory is true, this will return null. type: integer format: int32 nullable: true id: description: Field Id type: integer format: int32 name: description: Name of Field type: string passwordRequirement: description: The Id of the Password Requirement if the data type is Password defaulting to the default Password Requirement if not set. type: integer format: int32 nullable: true required: description: Is this field required type: boolean saveAllHistory: description: Indicates that all history will be saved. This will be reset if the HistoryLength is updated. type: boolean searchable: description: Is this field searchable type: boolean slugName: description: A unique identifier used in api calls and other interactions. The slug allows the display name to change without breaking interfaces to fields. type: string sortOrder: description: Sort Order of the field used for display type: integer format: int32 viewingRequiresEdit: description: Is edit permission required for viewing this field type: boolean type: object PagingOfSecretTemplateExtendedTypeSummary: 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/SecretTemplateExtendedTypeSummary' 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 SecretTemplateExportModel: description: Secret Template Export Model properties: exportFileText: description: ExportFileText type: string fileName: description: FileName type: string type: object SecretTemplateExtendedMappingModel: description: Secret Template Extended Mapping Model properties: extendedTypeDescription: description: A localizaed description for this extended type type: string extendedTypeId: description: Extended Type ID type: integer format: int32 extendedTypeName: description: A localizaed name for this extended type type: string fields: description: Array of extended fields for the extended mapping items: $ref: '#/components/schemas/SecretTemplateExtendedMappingFieldModel' type: array type: object UpdateFieldValueOfFieldDataType: description: The type that this field of the secret will represent. properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/FieldDataType' type: object SecretTemplateLauncherModel: description: Secret Template Launcher Model properties: allowList: description: User can select from values in this list type: integer format: int32 nullable: true connectAsCommand: description: This command is used after a PuTTy session is launched on a Secret that has SSH Proxy enabled and has a Secret set under 'Connect As' in the Launcher tab. The default su command is 'su - $USERNAME'. $USERNAME is the token used to retrieve the username field from the Secret. Sudo can also be used by specifying 'sudo -u $USERNAME /bin/bash'. type: string connectAsCommandResponse: description: The Connect As Command Response is the response from the server prompting for a password. This is used so $productName knows when to send the password to the system. If the response from the server after typing 'su - root' is 'Password:' then the Connect As Command Response needs to contain 'Password:$PASSWORD'. The $CONNECTASPASSWORD token will use the credentials from the Secret set under 'Connect As' when prompted. type: string denyList: description: User cannot enter these values. If used with an Allow List, the Deny List will take precedence. type: integer format: int32 nullable: true fields: description: Fields that can be mapped to this launcher items: $ref: '#/components/schemas/SecretTemplateLauncherFieldValueModel' type: array includeMachinesFromDependencies: description: This will add the list of machine names from the secret dependencies to either the allow list or block list. type: boolean launcherTypeId: description: Unique ID for Launcher Type type: integer format: int32 launcherTypeName: description: Name for Launcher Type type: string lineEnding: description: The line ending that will be append to the end of the Connect As Command. This needs to match the type of line ending required by the system being proxied to. type: string nullable: true restrictAs: description: Restrict what can be selected to come from a list, only allow certain fields, or only deny certain fields. type: integer format: int32 nullable: true restrictBySecretField: description: Select a field that will contain the list of items that will restrict the input. type: integer format: int32 nullable: true restrictUserInput: description: 'You may specify a field of comma separated hosts or IP addresses that the user will be restricted to. The allow list will allow only these values, while the block list will allow all values except the hosts on the Secret Field. Example: 192.168.1.2, MACHINE.EXAMPLE.COM, 192.168.1.60' type: boolean type: object SecretTemplateFieldOptionUpdateModel: description: Secret Template Field Option Update Model properties: id: description: Option Id to update type: integer format: int32 value: description: 'Option Value ' type: string type: object SecretTemplateLauncherSummary: description: Summary model describing template to launcher mappings properties: allowListSecretFieldId: description: The ID of the list to allow type: integer format: int32 nullable: true connectAsCommand: description: Connect as command type: string connectAsCommandResponse: description: The expected response to get from the host on connect as type: string connectAsTimeoutInSeconds: description: The amount of time, in seconds, that must elapse before a timeout occurs. type: integer format: int32 nullable: true denyListSecretFieldId: description: The ID of the list to deny type: integer format: int32 nullable: true expectedPromptEnding: description: The character used to mark the end of a prompt on a server, such as '$', '#', '%', and etc type: string fields: description: Mapping of secret template fields to launch fields items: $ref: '#/components/schemas/SecretTemplateLauncherFieldSummary' type: array launcherTypeDescription: description: Detailed description of this launcher type: string launcherTypeId: description: ID of this launcher type: integer format: int32 launcherTypeName: description: Name of this launcher type type: string lineEnding: description: Connect as command line ending to be sent type: string nullable: true restrictHostDependencyMachines: description: Use dependency hosts for restrictions type: boolean restrictHostSecretFieldId: description: Restrict user input on a launcher mapping to values in this secret field type: integer format: int32 nullable: true restrictHostType: description: Restrict host type type: integer format: int32 nullable: true restrictUserInput: description: User input has restrictions to allow or deny specific entries type: boolean secretTypeId: description: Secret Template ID type: integer format: int32 type: object SecretFieldCreateArgs: description: Secret Field Create Args properties: data: $ref: '#/components/schemas/SecretTemplateFieldCreateModel' type: object SecretTemplateLauncherFieldSummary: description: Includes both launcher field definition and mapped / values assigned for this secret template and launcher association properties: allowDefault: description: Does this field allow a default value to be configured type: boolean defaultType: description: 'Is AllowDefault is set, what is the type: string or int' type: string defaultTypeIntMax: description: If DefaultType is int then what is the maximum int accepted type: integer format: int32 nullable: true defaultTypeIntMin: description: If DefaultType is int then what is the minimum int accepted type: integer format: int32 nullable: true launcherTypeFieldId: description: Unique ID for this launcher field mapping type: integer format: int32 launcherTypeId: description: The launcher type ID type: integer format: int32 name: description: Name of the launcher field type: string promptableField: description: Is this field one that can be prompted for user input type: boolean secretFieldDisplayName: description: The secret field display name or if SecretFieldId is null this can be user input, blank, or a default value type: string secretFieldId: description: The secret field ID that will be passed to the launcher type: integer format: int32 nullable: true type: object PagingOfSecretTemplateExtendedMappingSummary: 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/SecretTemplateExtendedMappingSummary' 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 SecretTemplateFieldSortModel: description: Secret Template Field Sort Model properties: fieldIds: description: Array of Field Ids used to update the sort order in the order that they are received items: type: integer format: int32 type: array type: object SecretFieldPatchArgs: description: Secret Field Patch Args properties: data: $ref: '#/components/schemas/SecretTemplateFieldPatchModel' type: object ListType: description: What type of contents does this list field contain properties: {} type: string enum: - None - Generic - URL UpdateFieldValueOfPasswordHashType: description: Hash to be used when generating the One Time Password, updated when one time password is enabled properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/PasswordHashType' type: object SecretTemplateLauncherCreateFieldModel: description: Mapping of launcher field to secret template field properties: defaultValue: description: 'The default value to use for this field. Note: This is only an option if the launcher field allows default options.' type: string launcherTypeFieldId: description: The launcher field id that is being mapped type: integer format: int32 secretFieldId: description: Which secret field this should map to type: integer format: int32 type: object SecretTemplateField: description: Secret template field properties: description: description: Field description type: string displayName: description: Field display name type: string editablePermission: description: Who has editing rights type: integer format: int32 editRequires: $ref: '#/components/schemas/EditRequiresOptions' fieldSlugName: description: Field Slug Name type: string generatePasswordCharacterSet: description: Generate password character set. Only returned if user can manage secret templates type: string generatePasswordLength: description: Generate password length. Only returned if user can manage secret templates type: integer format: int32 nullable: true hideOnView: description: Hide this field when viewing type: boolean historyLength: description: History length type: integer format: int32 isExpirationField: description: Is expiration field type: boolean isFile: description: Is this field a file type type: boolean isIndexable: description: Is able to be indexed type: boolean isList: description: Is this field a list field type type: boolean isNotes: description: Is this field a notes field type type: boolean isPassword: description: Is this field a password field type type: boolean isRequired: description: Is this field required type: boolean isUrl: description: Is this field a url field type type: boolean listType: $ref: '#/components/schemas/ListType' mustEncrypt: description: Must encrypt. Only returned if user can manage secret templates type: boolean nullable: true name: description: Field name type: string passwordRequirementId: description: ID For Password Requirement assigned to field type: integer format: int32 passwordTypeFieldId: description: Type of password field type: integer format: int32 secretTemplateFieldId: description: Field Id type: integer format: int32 sortOrder: description: Sort Order for Field type: integer format: int32 type: object 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 UpdateFieldValueOfSecretTemplateFieldOptionUpdateModelArray: description: Dropdown Options to update. properties: dirty: description: Dirty type: boolean value: description: Value items: $ref: '#/components/schemas/SecretTemplateFieldOptionUpdateModel' type: array 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 SecretTemplatePasswordTypeFieldMappingModel: description: Fields properties: passwordTypeFieldId: description: PasswordTypeFieldId type: integer format: int32 passwordTypeFieldName: description: PasswordTypeFieldName type: string passwordTypeFieldRaw: description: PasswordTypeFieldRaw type: string secretFieldId: description: SecretFieldId type: integer format: int32 nullable: true secretFieldName: description: SecretFieldName type: string type: object SecretTemplateFieldOptionRemoveModel: description: Secret Template Field Option Remove Model properties: id: description: Option Id to Remove. Will take precedence over value. type: integer format: int32 nullable: true value: description: Option Value to Remove. If Id is populated, this will be ignored type: string type: object LauncherTypeSummary: description: An available type of launcher properties: active: description: Indicates if the launcher type is active or not type: boolean launcherTypeDescription: description: Name of the launcher type type: string launcherTypeId: description: Unique ID for a launcher type: integer format: int32 launcherTypeName: description: Name of the launcher type type: string type: object SecretTemplateExtendedMappingUpdateArgs: description: SecretTemplateExtendedMappingUpdateArgs properties: data: $ref: '#/components/schemas/SecretTemplateExtendedMappingUpdateModel' type: object FieldPermissionType: description: Field Permission Type properties: {} type: string enum: - Edit - Owner - NotEditable SecretTemplatePasswordTypePatchModel: description: Data properties: defaultPrivilegedSecretId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' enableHeartbeat: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' enableRpc: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' fields: $ref: '#/components/schemas/UpdateFieldValueOfSecretTemplatePasswordTypeFieldMappingUpdateModelArray' heartbeatIntervalDays: $ref: '#/components/schemas/UpdateFieldValueOfInt32' heartbeatIntervalHours: $ref: '#/components/schemas/UpdateFieldValueOfInt32' heartbeatIntervalMinutes: $ref: '#/components/schemas/UpdateFieldValueOfInt32' passwordTypeId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' rpcIntervalDays: $ref: '#/components/schemas/UpdateFieldValueOfInt32' rpcIntervalHours: $ref: '#/components/schemas/UpdateFieldValueOfInt32' rpcIntervalMinutes: $ref: '#/components/schemas/UpdateFieldValueOfInt32' rpcMaxAttempts: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' 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 SecretTemplateExtendedTypeSummary: description: Extended types can be mapped to secret templates for functionality that requires universal mapping of fields properties: extendedTypeDescription: description: Description of extended type already localized for the current user type: string extendedTypeId: description: Unique ID for extended type type: integer format: int32 extendedTypeName: description: Name of extended type already localized for the current user type: string type: object AddPasswordDictionaryArgs: description: AddPasswordDictionaryArgs properties: dictionaryName: description: Dictionary Name type: string file: description: Uploaded file type: string format: binary type: object UpdateFieldValueOfSecretTemplateFieldOptionRemoveModelArray: description: Dropdown Options to remove properties: dirty: description: Dirty type: boolean value: description: Value items: $ref: '#/components/schemas/SecretTemplateFieldOptionRemoveModel' type: array type: object SecretTemplateSummary: description: Secret template summary properties: active: description: Is Secret template active type: boolean heartbeatEnabled: description: Is heartbeat enabled for this template type: boolean id: description: Secret template ID type: integer format: int32 name: description: Secret template name type: string passwordTypeId: description: Password Type that the secret template uses for password change type: integer format: int32 nullable: true passwordTypeReady: description: Is the template password type ready type: boolean secretCount: description: Number of Secrets associated to the template. Only populated when IncludeCount is set to true. type: integer format: int32 nullable: true type: object SecretTemplateExtendedMappingCreateFieldModel: description: Fields properties: extendedFieldId: description: ExtendedFieldId type: integer format: int32 secretFieldId: description: SecretFieldId type: integer format: int32 type: object SecretTemplateExtendedMappingFieldModel: description: Secret Template Extended Mapping Field Model properties: extendedFieldId: description: Id of the Extended Field type: integer format: int32 secretFieldId: description: Id of the Secret Template Field type: integer format: int32 nullable: true secretFieldName: description: Secret Field Name of the mapped Secret Template Extended Field type: string type: object SecretTemplatePasswordTypeUpdateArgs: description: Secret Template Password Type Update Args properties: passwordTypeId: description: Password Type Id type: integer format: int32 nullable: true secretFieldPasswordTypeFieldDictionary: $ref: '#/components/schemas/DictionaryOfInt32AndInt32' type: object SecretTemplatePasswordTypeFieldMappingUpdateModel: description: Value properties: passwordTypeFieldId: description: PasswordTypeFieldId type: integer format: int32 secretFieldId: description: SecretFieldId type: integer format: int32 nullable: true type: object UpdateFieldValueOfOptionalLauncherConnectAsLineEnding: description: The line ending that will be append to the end of the Connect As Command. This needs to match the type of line ending required by the system being proxied to. properties: dirty: description: Dirty type: boolean value: description: Value type: string nullable: true type: object SshKeySizeType: description: SSH Key Size Type properties: {} type: string enum: - Key1024 - Key2048 - Key4096 SecretTemplateLauncherDeleteResultModel: description: Delete result message properties: success: description: True if process has succeeded type: boolean type: object SecretTemplateCopyArgs: description: Secret Template Copy Args properties: data: $ref: '#/components/schemas/SecretTemplateCopyModel' type: object SecretTemplateListModel: description: Template View Model properties: canCreate: description: Can the current user create this template in the current context type: boolean id: description: Template Id type: integer format: int32 name: description: Template Name type: string type: object AuthenticationFailedResponse: description: Response object for authentication failures required: - message properties: message: description: Error message type: string type: object SecretTemplateFieldSummaryModel: description: Secret Template Field Summary Model properties: active: description: Is this field active type: boolean description: description: Description of Field type: string editRequiresPermission: description: Type of permission required in order to edit this field type: string exposeForDisplay: description: Is this field is exposed for display type: boolean historyLength: description: Number of changes stored in history type: integer format: int32 id: description: Field Id type: integer format: int32 name: description: Name of Field type: string required: description: Is this field required type: boolean searchable: description: Is this field searchable type: boolean slugName: description: Slug Name of Field. type: string sortOrder: description: Sort Order of the field used for display type: integer format: int32 type: description: Type of Field type: string viewingRequiresEdit: description: Is edit permission required for viewing this field type: boolean type: object SecretTemplateFieldSortResultModel: description: The result of the sort properties: success: description: Did the sort succeed type: boolean type: object SecretTemplateDetailPatchModel: description: Data properties: active: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' description: $ref: '#/components/schemas/UpdateFieldValueOfString' expirationChangeRequiredOnFieldId: $ref: '#/components/schemas/UpdateFieldValueOfInt32' expirationDays: $ref: '#/components/schemas/UpdateFieldValueOfInt32' expirationEnabled: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' name: $ref: '#/components/schemas/UpdateFieldValueOfString' namePattern: $ref: '#/components/schemas/UpdateFieldValueOfString' namePatternErrorMessage: $ref: '#/components/schemas/UpdateFieldValueOfString' oneTimePasswordDuration: $ref: '#/components/schemas/UpdateFieldValueOfInt32' oneTimePasswordEnabled: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' oneTimePasswordHash: $ref: '#/components/schemas/UpdateFieldValueOfPasswordHashType' oneTimePasswordLength: $ref: '#/components/schemas/UpdateFieldValueOfInt32' permissionRequiredToEditPasswordChangeConfiguration: $ref: '#/components/schemas/UpdateFieldValueOfString' saveAllNameHistory: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' secretNameHistoryLength: $ref: '#/components/schemas/UpdateFieldValueOfInt32' sshKeyAlgorithm: $ref: '#/components/schemas/UpdateFieldValueOfString' sshKeyFormat: $ref: '#/components/schemas/UpdateFieldValueOfString' sshKeySize: $ref: '#/components/schemas/UpdateFieldValueOfSshKeySizeType' ticketSystemScriptArgs: $ref: '#/components/schemas/UpdateFieldValueOfString' validatePasswordRequirementsOnCreate: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' validatePasswordRequirementsOnEdit: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' type: object UpdateFieldValueOfSecretTemplatePasswordTypeFieldMappingUpdateModelArray: description: Fields properties: dirty: description: Dirty type: boolean value: description: Value items: $ref: '#/components/schemas/SecretTemplatePasswordTypeFieldMappingUpdateModel' type: array type: object PagingOfSecretTemplateLauncherSummary: 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/SecretTemplateLauncherSummary' 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 UpdateFieldValueOfString: description: Description properties: dirty: description: Dirty type: boolean value: description: Value type: string type: object SecretTemplateLauncherFieldValueModel: description: Values for a launcher that is associated to a secret template properties: defaultType: description: What is the default type if allowed type: string defaultTypeIntMax: description: If the default type is int then a maximum number that can be entered type: integer format: int32 nullable: true defaultTypeIntMin: description: If the default type is int then a minimum number that can be entered type: integer format: int32 nullable: true defaultValue: description: Default value for this field on a specific template type: string launcherTypeFieldId: description: Launcher Field Id type: integer format: int32 launcherTypeFieldName: description: Launcher Field Name type: string promptableField: description: Whether or not this field can be prompted for input type: boolean secretFieldId: description: Id of the Secret Template Field type: integer format: int32 secretFieldName: description: Secret Field Name of the mapped Secret Template Extended Field type: string type: object SecretTemplateExtendedMappingUpdateFieldModel: description: Value properties: extendedFieldId: description: ExtendedFieldId type: integer format: int32 secretFieldId: description: SecretFieldId type: integer format: int32 type: object SecretTemplateExtendedMappingUpdateModel: description: Data properties: fields: $ref: '#/components/schemas/UpdateFieldValueOfSecretTemplateExtendedMappingUpdateFieldModelArray' type: object Severity: description: Error severity level properties: {} type: string enum: - None - Retry - Warn - Critical - Fatal PasswordDictionaryModel: description: PasswordDictionaryModel[] properties: id: description: The dictionary ID type: integer format: int32 items: description: A list of dictionary entries items: type: string type: array name: description: The name of the dictionary type: string type: object SecretTemplateFieldCreateArgs: description: Secret Template Field Create Args properties: description: description: Field description type: string displayName: description: Field display name type: string editablePermission: description: Who has editing rights type: integer format: int32 editRequires: $ref: '#/components/schemas/EditRequiresOptions' fieldSlugName: description: Field Slug Name type: string generatePasswordCharacterSet: description: Generate password character set. Only returned if user can manage secret templates type: string generatePasswordLength: description: Generate password length. Only returned if user can manage secret templates type: integer format: int32 nullable: true hideOnView: description: Hide this field when viewing type: boolean historyLength: description: History length type: integer format: int32 isExpirationField: description: Is expiration field type: boolean isFile: description: Is this field a file type type: boolean isIndexable: description: Is able to be indexed type: boolean isNotes: description: Is this field a notes field type type: boolean isPassword: description: Is this field a password field type type: boolean isRequired: description: Is this field required type: boolean isUrl: description: Is this field a url field type type: boolean listType: $ref: '#/components/schemas/ListType' mustEncrypt: description: Must encrypt. Only returned if user can manage secret templates type: boolean nullable: true name: description: Field name type: string passwordRequirementId: description: ID For Password Requirement assigned to field type: integer format: int32 passwordTypeFieldId: description: Type of password field type: integer format: int32 sortOrder: description: Sort Order for Field type: integer format: int32 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 PagingOfLauncherTypeSummary: 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/LauncherTypeSummary' 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 SecretTemplateExtendedMappingDeleteResponseModel: description: SecretTemplateExtendedMappingDeleteResponseModel properties: success: description: Success type: boolean type: object SecretTemplateDetailPatchArgs: description: SecretTemplateDetailPatchArgs properties: data: $ref: '#/components/schemas/SecretTemplateDetailPatchModel' type: object UpdateFieldValueOfSecretTemplateLauncherFieldValueModelArray: description: Fields that can be mapped to this launcher properties: dirty: description: Dirty type: boolean value: description: Value items: $ref: '#/components/schemas/SecretTemplateLauncherFieldValueModel' type: array type: object SecretTemplateFieldUpdateArgs: description: Secret Template Field Update Args properties: description: description: Field description type: string displayName: description: Field display name type: string editablePermission: description: Who has editing rights type: integer format: int32 editRequires: $ref: '#/components/schemas/EditRequiresOptions' fieldSlugName: description: Field Slug Name type: string generatePasswordCharacterSet: description: When this is set to true, the field data will be obfuscated during export type: string generatePasswordLength: description: Generate password length. Only returned if user can manage secret templates type: integer format: int32 nullable: true hideOnView: description: Hide this field when viewing type: boolean historyLength: description: History length type: integer format: int32 isExpirationField: description: Is expiration field type: boolean isFile: description: Is this field a file type type: boolean isIndexable: description: Is able to be indexed type: boolean isNotes: description: Is this field a notes field type type: boolean isPassword: description: Is this field a password field type type: boolean isRequired: description: Is this field required type: boolean isUrl: description: Is this field a url field type type: boolean listType: $ref: '#/components/schemas/ListType' mustEncrypt: description: Must encrypt. Only returned if user can manage secret templates type: boolean nullable: true name: description: Field name type: string passwordRequirementId: description: ID For Password Requirement assigned to field type: integer format: int32 passwordTypeFieldId: description: Type of password field type: integer format: int32 secretTemplateFieldId: description: Field Id type: integer format: int32 sortOrder: description: Sort Order for Field type: integer format: int32 type: object SecretTemplatePasswordTypeModel: description: SecretTemplatePasswordTypeModel properties: defaultPrivilegedSecretId: description: DefaultPrivilegedSecretId type: integer format: int32 nullable: true enableHeartbeat: description: EnableHeartbeat type: boolean enableRpc: description: EnableRpc type: boolean fields: description: Fields items: $ref: '#/components/schemas/SecretTemplatePasswordTypeFieldMappingModel' type: array heartbeatIntervalDays: description: HeartbeatIntervalDays type: integer format: int32 heartbeatIntervalDisplay: description: HeartbeatIntervalDisplay type: string heartbeatIntervalHours: description: HeartbeatIntervalHours type: integer format: int32 heartbeatIntervalLabel: description: HeartbeatIntervalLabel type: string heartbeatIntervalMinutes: description: HeartbeatIntervalMinutes type: integer format: int32 heartbeatNote: description: HeartbeatNote type: string passwordTypeFields: description: PasswordTypeFields items: $ref: '#/components/schemas/ViewFieldDropDownOption' type: array passwordTypeId: description: PasswordTypeId type: integer format: int32 nullable: true rpcIntervalDays: description: RpcIntervalDays type: integer format: int32 rpcIntervalDisplay: description: RpcIntervalDisplay type: string rpcIntervalHours: description: RpcIntervalHours type: integer format: int32 rpcIntervalLabel: description: RpcIntervalLabel type: string rpcIntervalMinutes: description: RpcIntervalMinutes type: integer format: int32 rpcMaxAttempts: description: RpcMaxAttempts type: integer format: int32 nullable: true rpcNote: description: RpcNote type: string secretTypeFields: description: SecretTypeFields items: $ref: '#/components/schemas/ViewFieldDropDownOption' type: array type: object ViewFieldDropDownOption: description: DropDownOptions properties: fieldDisplay: description: FieldDisplay type: string fieldValue: description: FieldValue type: string type: object SecretTemplateExtendedMappingSummary: description: Extended Type Mapping Summary properties: extendedTypeDescription: description: A brief description of this extended type type: string extendedTypeId: description: ID for this extended type type: integer format: int32 extendedTypeName: description: The name of this extended type type: string fields: description: The fields that are mapped from the extended type to the secret template field items: $ref: '#/components/schemas/SecretTemplateExtendedMappingFieldSummary' type: array secretTypeExtendedMapId: description: A unique ID representing this mapping of Secret Template to Extended Type type: integer format: int32 secretTypeId: description: Secret type / template ID type: integer format: int32 type: object SecretTemplateModel: description: Secret template properties: concurrencyId: description: Global unique identifier type: string fields: description: Secret template fields items: $ref: '#/components/schemas/SecretTemplateField' type: array id: description: Secret template Id type: integer format: int32 name: description: Secret template name type: string passwordTypeId: description: Password Type Id type: integer format: int32 nullable: true type: object SecretTemplateDetailModel: description: Secret template detail properties: active: description: Is Secret Template active type: boolean description: description: Secret Template Description type: string expirationChangeRequiredOnFieldId: description: Secret Template Field Id that will require change on Expiration type: integer format: int32 nullable: true expirationDays: description: Expiration days, populated when ExpirationChangeRequiredOnFieldId is populated type: integer format: int32 nullable: true id: description: Secret Template Id type: integer format: int32 name: description: Secret Template Name type: string namePattern: description: Secret Template Name Pattern type: string namePatternErrorMessage: description: Secret Template Name Pattern Error Message type: string oneTimePasswordDuration: description: Duration in seconds that the One Time Password is valid, populated when one time password is enabled type: integer format: int32 nullable: true oneTimePasswordEnabled: description: One time password enabled type: boolean oneTimePasswordHash: description: Hash to be used when generating the One Time Password, populated when one time password is enabled type: string nullable: true oneTimePasswordLength: description: Length of the generated One Time Password, populated when one time password is enabled type: integer format: int32 nullable: true permissionRequiredToEditPasswordChangeConfiguration: description: Permission Required to Edit Password Change Configuration type: string saveAllNameHistory: description: Indicates that all Secret Name history will be saved. This will be reset if the SecretNameHistoryLength is updated. type: boolean secretCount: description: The number of Secrets that use this template type: integer format: int32 secretNameHistoryLength: description: The number of Secret Names to be saved. If SaveAllNameHistory is true, this will return null. type: integer format: int32 nullable: true sshKeyAlgorithm: description: Algorithm of the SSH Key, populated when the template contains a private SSH Key type: string sshKeyFormat: description: Format of the SSH Key, populated when the template contains a private SSH Key type: string sshKeySize: description: Size of the SSH Key in bits, populated when the template contains a private SSH Key type: string nullable: true ticketSystemScriptArgs: description: A list of field slugs that will be passed as parameters to a PowerShell ticket system. type: string validatePasswordRequirementsOnCreate: description: Validate password requirements on create type: boolean validatePasswordRequirementsOnEdit: description: Validate password requirements on edit type: boolean type: object PagingOfSecretTemplateSummary: 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/SecretTemplateSummary' 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 SecretTemplateLauncherCreateArgs: description: SecretTemplateLauncherCreateArgs properties: data: $ref: '#/components/schemas/SecretTemplateLauncherCreateModel' type: object SecretTemplateCopyModel: description: Secret Template Copy Model properties: name: description: Secret Template Name type: string type: object UpdateFieldValueOfFieldPermissionType: description: Type of permission required in order to edit this field properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/FieldPermissionType' type: object DictionaryOfInt32AndInt32: description: Secret Field Password Type Field Dictionary properties: {} type: object SecretTemplateFieldCreateModel: description: Secret Template Field Create Model properties: dataType: $ref: '#/components/schemas/FieldDataType' description: description: Description of Field type: string fieldSlugName: description: A unique identifier used in api calls and other interactions. The slug allows the display name to change without breaking interfaces to fields. type: string name: description: Name of Field type: string 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 PasswordHashType: description: Password Hash Type properties: {} type: string enum: - SHA1 - SHA256 - SHA512 SecretTemplateExtendedMappingCreateModel: description: Data properties: fields: description: Fields items: $ref: '#/components/schemas/SecretTemplateExtendedMappingCreateFieldModel' type: array type: object UpdateFieldValueOfSshKeySizeType: description: Size of the SSH Key in bits, updated when the template contains a private SSH Key properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/SshKeySizeType' type: object SecretTemplateExtendedMappingCreateArgs: description: SecretTemplateExtendedMappingCreateArgs properties: data: $ref: '#/components/schemas/SecretTemplateExtendedMappingCreateModel' type: object SecretTemplateLauncherUpdateModel: description: Update mapping values between secret template and launcher properties: allowList: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' connectAsCommand: $ref: '#/components/schemas/UpdateFieldValueOfString' connectAsCommandResponse: $ref: '#/components/schemas/UpdateFieldValueOfString' connectAsTimeoutInSeconds: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' denyList: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' expectedPromptEnding: $ref: '#/components/schemas/UpdateFieldValueOfString' fields: $ref: '#/components/schemas/UpdateFieldValueOfSecretTemplateLauncherFieldValueModelArray' includeMachinesFromDependencies: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' lineEnding: $ref: '#/components/schemas/UpdateFieldValueOfOptionalLauncherConnectAsLineEnding' restrictAs: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' restrictBySecretField: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' restrictUserInput: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' type: object SecretTemplateImportArgs: description: Secret Template Import Args properties: data: $ref: '#/components/schemas/SecretTemplateImportModel' type: object UpdateFieldValueOfSecretTemplateExtendedMappingUpdateFieldModelArray: description: Fields properties: dirty: description: Dirty type: boolean value: description: Value items: $ref: '#/components/schemas/SecretTemplateExtendedMappingUpdateFieldModel' type: array type: object PagingOfSecretTemplateListModel: 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/SecretTemplateListModel' 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 SecretTemplateFieldPatchModel: description: Secret Template Field Patch Model properties: active: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' dataType: $ref: '#/components/schemas/UpdateFieldValueOfFieldDataType' description: $ref: '#/components/schemas/UpdateFieldValueOfString' dropdownOptionsToAdd: $ref: '#/components/schemas/UpdateFieldValueOfStringArray' dropdownOptionsToRemove: $ref: '#/components/schemas/UpdateFieldValueOfSecretTemplateFieldOptionRemoveModelArray' dropdownOptionsToUpdate: $ref: '#/components/schemas/UpdateFieldValueOfSecretTemplateFieldOptionUpdateModelArray' editRequiresPermission: $ref: '#/components/schemas/UpdateFieldValueOfFieldPermissionType' exposeForDisplay: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' historyLength: $ref: '#/components/schemas/UpdateFieldValueOfInt32' name: $ref: '#/components/schemas/UpdateFieldValueOfString' passwordRequirement: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' required: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' saveAllHistory: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' searchable: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' slugName: $ref: '#/components/schemas/UpdateFieldValueOfString' sortOrder: $ref: '#/components/schemas/UpdateFieldValueOfInt32' viewingRequiresEdit: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' type: object SecretTemplateCreateArgs: description: SecretTemplateCreateArgs properties: concurrencyId: description: 'Optional: Globally unigue identifier' type: string fields: description: Secret Template Fields items: $ref: '#/components/schemas/SecretTemplateFieldCreateArgs' type: array name: description: Secret Template Name type: string passwordTypeId: description: 'Optional: Password Changer Id to automatically wire up Heartbeat and remote password rotation.' type: integer format: int32 nullable: true type: object SecretTemplatePasswordTypePatchArgs: description: SecretTemplatePasswordTypePatchArgs properties: data: $ref: '#/components/schemas/SecretTemplatePasswordTypePatchModel' type: object SecretTemplateFieldOptionModel: description: Secret Template Option Model properties: id: description: Option Id type: integer format: int32 value: description: Option Value type: string type: object SecretTemplateFieldSortArgs: description: Secret Template Field Sort Args properties: data: $ref: '#/components/schemas/SecretTemplateFieldSortModel' type: object SecretTemplateImportModel: description: Secret Template Import Model properties: templateXml: description: Secret Template XML type: string type: object SecretTemplateExtendedMappingFieldSummary: description: The fields that are mapped from the extended type to the secret template field properties: extendedFieldId: description: ExtendedFieldId type: integer format: int32 extendedFieldName: description: ExtendedFieldName type: string extendedTypeId: description: ExtendedTypeId type: integer format: int32 secretFieldExtendedMapId: description: SecretFieldExtendedMapId type: integer format: int32 secretFieldId: description: SecretFieldId type: integer format: int32 secretFieldName: description: SecretFieldName type: string type: object UpdatePasswordDictionaryArgs: description: Update Password Dictionary Args properties: dictionaryId: description: Dictionary ID to Update type: integer format: int32 dictionaryName: description: Dictionary Name type: string file: description: Uploaded file type: string format: binary 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