Delinea · Example Payload

Secret Templates

Example API requests and responses for secret-templates endpoints in Delinea Secret Server REST API

Privileged Access ManagementPAMSecrets ManagementIdentity SecurityDevOpsCybersecurity

Secret Templates is an example object payload from Delinea, with 3 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

categorydescriptionexamples

Example Payload

Raw ↑ 
{
  "category": "secret-templates",
  "description": "Example API requests and responses for secret-templates endpoints in Delinea Secret Server REST API",
  "examples": [
    {
      "path": "/v1/secret-templates/fields/{templateFieldId}",
      "method": "DELETE",
      "operationId": "SecretTemplatesService_DisableField",
      "summary": "Disable a Secret Template Field For Template",
      "responseExample": {
        "description": "string",
        "displayName": "string",
        "editablePermission": 1,
        "editRequires": {},
        "fieldSlugName": "string",
        "generatePasswordCharacterSet": "string",
        "generatePasswordLength": 1,
        "hideOnView": true
      }
    },
    {
      "path": "/v1/secret-templates/password-requirements/password-dictionaries/{id}",
      "method": "GET",
      "operationId": "SecretTemplatesService_GetPasswordDictionary",
      "summary": "Gets password dictionary items by ID"
    },
    {
      "path": "/v1/secret-templates/password-requirements/password-dictionaries/{id}",
      "method": "DELETE",
      "operationId": "SecretTemplatesService_DeletePasswordDictionary",
      "summary": "Deletes a specific password dictionary by ID",
      "responseExample": true
    },
    {
      "path": "/v1/secret-templates/{secretTemplateId}/extended-mappings/{extendedTypeId}",
      "method": "GET",
      "operationId": "SecretTemplatesService_GetSecretTemplateExtendedMapping",
      "summary": "Get a single Secret Template Extended Mappings",
      "responseExample": {
        "extendedTypeDescription": "string",
        "extendedTypeId": 1,
        "extendedTypeName": "string",
        "fields": [
          {}
        ]
      }
    },
    {
      "path": "/v1/secret-templates/{secretTemplateId}/extended-mappings/{extendedTypeId}",
      "method": "POST",
      "operationId": "SecretTemplatesService_CreateSecretTemplateExtendedMapping",
      "summary": "Create a Secret Template Extended Mapping",
      "requestBody": {
        "data": {}
      },
      "responseExample": {
        "extendedTypeDescription": "string",
        "extendedTypeId": 1,
        "extendedTypeName": "string",
        "fields": [
          {}
        ]
      }
    },
    {
      "path": "/v1/secret-templates/{secretTemplateId}/extended-mappings/{extendedTypeId}",
      "method": "PATCH",
      "operationId": "SecretTemplatesService_UpdateSecretTemplateExtendedMapping",
      "summary": "Update a Secret Template Extended Mapping",
      "requestBody": {
        "data": {}
      },
      "responseExample": {
        "extendedTypeDescription": "string",
        "extendedTypeId": 1,
        "extendedTypeName": "string",
        "fields": [
          {}
        ]
      }
    },
    {
      "path": "/v1/secret-templates/{secretTemplateId}/extended-mappings/{extendedTypeId}",
      "method": "DELETE",
      "operationId": "SecretTemplatesService_DeleteExtendedMapping",
      "summary": "Delete Extended Mapping",
      "responseExample": {
        "success": true
      }
    },
    {
      "path": "/v1/secret-templates/{secretTemplateId}/launchers/{launcherTypeId}",
      "method": "GET",
      "operationId": "SecretTemplatesService_GetSecretTemplateLauncher",
      "summary": "Get a Secret Template Launcher",
      "responseExample": {
        "allowList": 1,
        "connectAsCommand": "string",
        "connectAsCommandResponse": "string",
        "denyList": 1,
        "fields": [
          {}
        ],
        "includeMachinesFromDependencies": true,
        "launcherTypeId": 1,
        "launcherTypeName": "string"
      }
    },
    {
      "path": "/v1/secret-templates/{secretTemplateId}/launchers/{launcherTypeId}",
      "method": "POST",
      "operationId": "SecretTemplatesService_CreateSecretTemplateLauncher",
      "summary": "Create a Secret Template Launcher",
      "requestBody": {
        "data": {}
      },
      "responseExample": {
        "allowList": 1,
        "connectAsCommand": "string",
        "connectAsCommandResponse": "string",
        "denyList": 1,
        "fields": [
          {}
        ],
        "includeMachinesFromDependencies": true,
        "launcherTypeId": 1,
        "launcherTypeName": "string"
      }
    },
    {
      "path": "/v1/secret-templates/{secretTemplateId}/launchers/{launcherTypeId}",
      "method": "PATCH",
      "operationId": "SecretTemplatesService_UpdateSecretTemplateLauncher",
      "summary": "Update a Secret Template Launcher",
      "requestBody": {
        "data": {}
      },
      "responseExample": {
        "allowList": 1,
        "connectAsCommand": "string",
        "connectAsCommandResponse": "string",
        "denyList": 1,
        "fields": [
          {}
        ],
        "includeMachinesFromDependencies": true,
        "launcherTypeId": 1,
        "launcherTypeName": "string"
      }
    },
    {
      "path": "/v1/secret-templates/{secretTemplateId}/launchers/{launcherTypeId}",
      "method": "DELETE",
      "operationId": "SecretTemplatesService_DeleteSecretTemplateLauncher",
      "summary": "Delete Secret Template Launcher",
      "responseExample": {
        "success": true
      }
    },
    {
      "path": "/v1/secret-templates",
      "method": "GET",
      "operationId": "SecretTemplatesService_Search",
      "summary": "Search Secret Templates",
      "responseExample": {
        "batchCount": 1,
        "currentPage": 1,
        "hasNext": true,
        "hasPrev": true,
        "nextSkip": 1,
        "pageCount": 1,
        "prevSkip": 1,
        "records": [
          {}
        ]
      }
    },
    {
      "path": "/v1/secret-templates",
      "method": "POST",
      "operationId": "SecretTemplatesService_CreateTemplate",
      "summary": "Create Secret Template",
      "requestBody": {
        "concurrencyId": "string",
        "fields": [
          {}
        ],
        "name": "string",
        "passwordTypeId": 1
      },
      "responseExample": {
        "concurrencyId": "string",
        "fields": [
          {}
        ],
        "id": 1,
        "name": "string",
        "passwordTypeId": 1
      }
    },
    {
      "path": "/v1/secret-templates/{id}/export",
      "method": "GET",
      "operationId": "SecretTemplatesService_Export",
      "summary": "Export Secret Template",
      "responseExample": {
        "exportFileText": "string",
        "fileName": "string"
      }
    },
    {
      "path": "/v1/secret-templates/password-requirements/password-dictionaries",
      "method": "GET",
      "operationId": "SecretTemplatesService_GetPasswordDictionaries",
      "summary": "Get password dictionaries",
      "responseExample": [
        {
          "id": {},
          "items": {},
          "name": {}
        }
      ]
    },
    {
      "path": "/v1/secret-templates/password-requirements/password-dictionaries",
      "method": "POST",
      "operationId": "SecretTemplatesService_AddPasswordDictionary",
      "summary": "Creates new password dictionary",
      "responseExample": true
    },
    {
      "path": "/v1/secret-templates/password-requirements/password-dictionaries",
      "method": "PUT",
      "operationId": "SecretTemplatesService_UpdatePasswordDictionary",
      "summary": "Updates a new password dictionary",
      "responseExample": true
    },
    {
      "path": "/v1/secret-templates/extended-types",
      "method": "GET",
      "operationId": "SecretTemplatesService_SearchSecretTemplateExtendedTypes",
      "summary": "Get Secret Template Extended Types",
      "responseExample": {
        "batchCount": 1,
        "currentPage": 1,
        "hasNext": true,
        "hasPrev": true,
        "nextSkip": 1,
        "pageCount": 1,
        "prevSkip": 1,
        "records": [
          {}
        ]
      }
    },
    {
      "path": "/v1/secret-templates/extended-mappings",
      "method": "GET",
      "operationId": "SecretTemplatesService_SearchSecretTemplateExtendedMappings",
      "summary": "Get Secret Template Extended Mappings",
      "responseExample": {
        "batchCount": 1,
        "currentPage": 1,
        "hasNext": true,
        "hasPrev": true,
        "nextSkip": 1,
        "pageCount": 1,
        "prevSkip": 1,
        "records": [
          {}
        ]
      }
    },
    {
      "path": "/v1/secret-templates/{secretTemplateId}/extended-mappings/{extendedTypeId}/stub",
      "method": "GET",
      "operationId": "SecretTemplatesService_StubSecretTemplateExtendedMapping",
      "summary": "Stub a Secret Template Extended Mappings",
      "responseExample": {
        "extendedTypeDescription": "string",
        "extendedTypeId": 1,
        "extendedTypeName": "string",
        "fields": [
          {}
        ]
      }
    },
    {
      "path": "/v1/secret-templates/launcher-types",
      "method": "GET",
      "operationId": "SecretTemplatesService_SearchLauncherTypes",
      "summary": "Get Launcher Types",
      "responseExample": {
        "batchCount": 1,
        "currentPage": 1,
        "hasNext": true,
        "hasPrev": true,
        "nextSkip": 1,
        "pageCount": 1,
        "prevSkip": 1,
        "records": [
          {}
        ]
      }
    },
    {
      "path": "/v1/secret-templates/launchers",
      "method": "GET",
      "operationId": "SecretTemplatesService_SearchSecretTemplateLaunchers",
      "summary": "Get Secret Template Launchers",
      "responseExample": {
        "batchCount": 1,
        "currentPage": 1,
        "hasNext": true,
        "hasPrev": true,
        "nextSkip": 1,
        "pageCount": 1,
        "prevSkip": 1,
        "records": [
          {}
        ]
      }
    },
    {
      "path": "/v1/secret-templates/{secretTemplateId}/launchers/{launcherTypeId}/stub",
      "method": "GET",
      "operationId": "SecretTemplatesService_StubSecretTemplateLauncher",
      "summary": "Stub a Secret Template Launchers",
      "responseExample": {
        "allowList": 1,
        "connectAsCommand": "string",
        "connectAsCommandResponse": "string",
        "denyList": 1,
        "fields": [
          {}
        ],
        "includeMachinesFromDependencies": true,
        "launcherTypeId": 1,
        "launcherTypeName": "string"
      }
    },
    {
      "path": "/v1/secret-templates/{secretTemplateId}/password-type",
      "method": "GET",
      "operationId": "SecretTemplatesService_GetSecretTemplatePasswordType",
      "summary": "Get Secret Template Password Changer",
      "responseExample": {
        "defaultPrivilegedSecretId": 1,
        "enableHeartbeat": true,
        "enableRpc": true,
        "fields": [
          {}
        ],
        "heartbeatIntervalDays": 1,
        "heartbeatIntervalDisplay": "string",
        "heartbeatIntervalHours": 1,
        "heartbeatIntervalLabel": "string"
      }
    },
    {
      "path": "/v1/secret-templates/{secretTemplateId}/password-type",
      "method": "PATCH",
      "operationId": "SecretTemplatesService_PatchSecretTemplatePasswordChanger",
      "summary": "Patch Secret Template password type",
      "requestBody": {
        "data": {}
      },
      "responseExample": {
        "defaultPrivilegedSecretId": 1,
        "enableHeartbeat": true,
        "enableRpc": true,
        "fields": [
          {}
        ],
        "heartbeatIntervalDays": 1,
        "heartbeatIntervalDisplay": "string",
        "heartbeatIntervalHours": 1,
        "heartbeatIntervalLabel": "string"
      }
    },
    {
      "path": "/v2/secret-templates/{secretTemplateId}",
      "method": "GET",
      "operationId": "SecretTemplatesService_GetV2",
      "summary": "Get Secret Template Details",
      "responseExample": {
        "active": true,
        "description": "string",
        "expirationChangeRequiredOnFieldId": 1,
        "expirationDays": 1,
        "id": 1,
        "name": "string",
        "namePattern": "string",
        "namePatternErrorMessage": "string"
      }
    },
    {
      "path": "/v2/secret-templates/{secretTemplateId}",
      "method": "PATCH",
      "operationId": "SecretTemplatesService_PatchTemplateV2",
      "summary": "Patch Secret Template V2",
      "requestBody": {
        "data": {}
      },
      "responseExample": {
        "active": true,
        "description": "string",
        "expirationChangeRequiredOnFieldId": 1,
        "expirationDays": 1,
        "id": 1,
        "name": "string",
        "namePattern": "string",
        "namePatternErrorMessage": "string"
      }
    },
    {
      "path": "/v1/secret-templates/fields/search",
      "method": "GET",
      "operationId": "SecretTemplatesService_SearchTemplateFields",
      "summary": "Search Secret Template Fields",
      "responseExample": {
        "batchCount": 1,
        "currentPage": 1,
        "hasNext": true,
        "hasPrev": true,
        "nextSkip": 1,
        "pageCount": 1,
        "prevSkip": 1,
        "records": [
          {}
        ]
      }
    },
    {
      "path": "/v1/secret-templates/fields/stub",
      "method": "GET",
      "operationId": "SecretTemplatesService_StubTemplateField",
      "summary": "Stub Secret Template Field",
      "responseExample": {
        "active": true,
        "dataType": {},
        "description": "string",
        "dropdownOptions": [
          {}
        ],
        "editRequiresPermission": {},
        "exposeForDisplay": true,
        "historyLength": 1,
        "id": 1
      }
    },
    {
      "path": "/v1/secret-templates/fields/{secretFieldId}",
      "method": "GET",
      "operationId": "SecretTemplatesService_GetTemplateField",
      "summary": "Get Secret Template Field",
      "responseExample": {
        "active": true,
        "dataType": {},
        "description": "string",
        "dropdownOptions": [
          {}
        ],
        "editRequiresPermission": {},
        "exposeForDisplay": true,
        "historyLength": 1,
        "id": 1
      }
    },
    {
      "path": "/v1/secret-templates/fields/{secretTemplateFieldId}",
      "method": "PATCH",
      "operationId": "SecretTemplatesService_PatchTemplateField",
      "summary": "Patch Secret Template Field",
      "requestBody": {
        "data": {}
      },
      "responseExample": {
        "active": true,
        "dataType": {},
        "description": "string",
        "dropdownOptions": [
          {}
        ],
        "editRequiresPermission": {},
        "exposeForDisplay": true,
        "historyLength": 1,
        "id": 1
      }
    },
    {
      "path": "/v1/secret-templates/{id}/copy",
      "method": "POST",
      "operationId": "SecretTemplatesService_Copy",
      "summary": "Copy Secret Template",
      "requestBody": {
        "data": {}
      },
      "responseExample": {
        "active": true,
        "description": "string",
        "expirationChangeRequiredOnFieldId": 1,
        "expirationDays": 1,
        "id": 1,
        "name": "string",
        "namePattern": "string",
        "namePatternErrorMessage": "string"
      }
    },
    {
      "path": "/v1/secret-templates/{templateId}",
      "method": "POST",
      "operationId": "SecretTemplatesService_CreateField",
      "summary": "Create Secret Template Field For Template",
      "requestBody": {
        "description": "string",
        "displayName": "string",
        "editablePermission": 1,
        "editRequires": {},
        "fieldSlugName": "string",
        "generatePasswordCharacterSet": "string",
        "generatePasswordLength": 1,
        "hideOnView": true
      },
      "responseExample": {
        "description": "string",
        "displayName": "string",
        "editablePermission": 1,
        "editRequires": {},
        "fieldSlugName": "string",
        "generatePasswordCharacterSet": "string",
        "generatePasswordLength": 1,
        "hideOnView": true
      }
    },
    {
      "path": "/v1/secret-templates/{templateId}",
      "method": "PUT",
      "operationId": "SecretTemplatesService_Put",
      "summary": "Update Secret Template Field",
      "requestBody": {
        "description": "string",
        "displayName": "string",
        "editablePermission": 1,
        "editRequires": {},
        "fieldSlugName": "string",
        "generatePasswordCharacterSet": "string",
        "generatePasswordLength": 1,
        "hideOnView": true
      },
      "responseExample": {
        "description": "string",
        "displayName": "string",
        "editablePermission": 1,
        "editRequires": {},
        "fieldSlugName": "string",
        "generatePasswordCharacterSet": "string",
        "generatePasswordLength": 1,
        "hideOnView": true
      }
    },
    {
      "path": "/v1/secret-templates/generate-password/{secretfieldId}",
      "method": "POST",
      "operationId": "SecretTemplatesService_GeneratePassword",
      "summary": "Generate Password",
      "responseExample": "string"
    },
    {
      "path": "/v1/secret-templates/import",
      "method": "POST",
      "operationId": "SecretTemplatesService_ImportSecretTemplate",
      "summary": "Import Secret Template",
      "requestBody": {
        "data": {}
      },
      "responseExample": {
        "concurrencyId": "string",
        "fields": [
          {}
        ],
        "id": 1,
        "name": "string",
        "passwordTypeId": 1
      }
    },
    {
      "path": "/v1/secret-templates/{secretTemplateId}/fields",
      "method": "POST",
      "operationId": "SecretTemplatesService_CreateTemplateField",
      "summary": "Create Secret Template Field",
      "requestBody": {
        "data": {}
      },
      "responseExample": {
        "active": true,
        "dataType": {},
        "description": "string",
        "dropdownOptions": [
          {}
        ],
        "editRequiresPermission": {},
        "exposeForDisplay": true,
        "historyLength": 1,
        "id": 1
      }
    },
    {
      "path": "/v1/secret-templates/{secretTemplateId}/fields/sort",
      "method": "POST",
      "operationId": "SecretTemplatesService_SortTemplateFields",
      "summary": "Sort Secret Template Fields",
      "requestBody": {
        "data": {}
      },
      "responseExample": {
        "success": true
      }
    },
    {
      "path": "/v1/secret-templates/password-type/{templateId}",
      "method": "PUT",
      "operationId": "SecretTemplatesService_UpdateSecretTemplatePasswordType",
      "summary": "Update Secret Templates Password Type",
      "requestBody": {
        "passwordTypeId": 1,
        "secretFieldPasswordTypeFieldDictionary": {}
      },
      "responseExample": {
        "concurrencyId": "string",
        "fields": [
          {}
        ],
        "id": 1,
        "name": "string",
        "passwordTypeId": 1
      }
    }
  ]
}