{ "opencollection": "1.0.0", "info": { "name": "Secret Server Rest Activations SecretTemplates API", "version": "11.7.2" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "SecretTemplates", "type": "folder" }, "items": [ { "info": { "name": "Disable a Secret Template Field For Template", "type": "http" }, "http": { "method": "DELETE", "url": "/SecretServer/api/v1/secret-templates/fields/:templateFieldId", "params": [ { "name": "templateFieldId", "value": "", "type": "path", "description": "Secret Template Field to disable" } ] }, "docs": "Disable a Secret Template Field For Template" }, { "info": { "name": "Gets password dictionary items by ID", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secret-templates/password-requirements/password-dictionaries/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" } ] }, "docs": "Returns a file containing the items of a specific custom password dictionary." }, { "info": { "name": "Deletes a specific password dictionary by ID", "type": "http" }, "http": { "method": "DELETE", "url": "/SecretServer/api/v1/secret-templates/password-requirements/password-dictionaries/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" } ] }, "docs": "Deletes a specific custom password dictionary with the contents." }, { "info": { "name": "Get a single Secret Template Extended Mappings", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secret-templates/:secretTemplateId/extended-mappings/:extendedTypeId", "params": [ { "name": "extendedTypeId", "value": "", "type": "path", "description": "extendedTypeId" }, { "name": "secretTemplateId", "value": "", "type": "path", "description": "secretTemplateId" } ] }, "docs": "Get an extended mapping for a Secret Template" }, { "info": { "name": "Create a Secret Template Extended Mapping", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secret-templates/:secretTemplateId/extended-mappings/:extendedTypeId", "params": [ { "name": "extendedTypeId", "value": "", "type": "path", "description": "extendedTypeId" }, { "name": "secretTemplateId", "value": "", "type": "path", "description": "secretTemplateId" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an extended mappings for a Secret Template" }, { "info": { "name": "Update a Secret Template Extended Mapping", "type": "http" }, "http": { "method": "PATCH", "url": "/SecretServer/api/v1/secret-templates/:secretTemplateId/extended-mappings/:extendedTypeId", "params": [ { "name": "extendedTypeId", "value": "", "type": "path", "description": "extendedTypeId" }, { "name": "secretTemplateId", "value": "", "type": "path", "description": "secretTemplateId" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update extended mappings for a Secret Template" }, { "info": { "name": "Delete Extended Mapping", "type": "http" }, "http": { "method": "DELETE", "url": "/SecretServer/api/v1/secret-templates/:secretTemplateId/extended-mappings/:extendedTypeId", "params": [ { "name": "extendedTypeId", "value": "", "type": "path", "description": "extendedTypeId" }, { "name": "secretTemplateId", "value": "", "type": "path", "description": "secretTemplateId" } ] }, "docs": "Delete an extended mapping" }, { "info": { "name": "Get a Secret Template Launcher", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secret-templates/:secretTemplateId/launchers/:launcherTypeId", "params": [ { "name": "launcherTypeId", "value": "", "type": "path", "description": "launcherTypeId" }, { "name": "secretTemplateId", "value": "", "type": "path", "description": "secretTemplateId" } ] }, "docs": "Get launcher detail for a Secret Template" }, { "info": { "name": "Create a Secret Template Launcher", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secret-templates/:secretTemplateId/launchers/:launcherTypeId", "params": [ { "name": "launcherTypeId", "value": "", "type": "path", "description": "launcherTypeId" }, { "name": "secretTemplateId", "value": "", "type": "path", "description": "secretTemplateId" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Launcher for a Secret Template" }, { "info": { "name": "Update a Secret Template Launcher", "type": "http" }, "http": { "method": "PATCH", "url": "/SecretServer/api/v1/secret-templates/:secretTemplateId/launchers/:launcherTypeId", "params": [ { "name": "launcherTypeId", "value": "", "type": "path", "description": "launcherTypeId" }, { "name": "secretTemplateId", "value": "", "type": "path", "description": "secretTemplateId" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Launchers for a Secret Template" }, { "info": { "name": "Delete Secret Template Launcher", "type": "http" }, "http": { "method": "DELETE", "url": "/SecretServer/api/v1/secret-templates/:secretTemplateId/launchers/:launcherTypeId", "params": [ { "name": "launcherTypeId", "value": "", "type": "path", "description": "launcherTypeId" }, { "name": "secretTemplateId", "value": "", "type": "path", "description": "secretTemplateId" } ] }, "docs": "Delete or remove the mapping of a specific launcher type from a specific Secret template" }, { "info": { "name": "Search Secret Templates", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secret-templates", "params": [ { "name": "filter.heartbeatEnabled", "value": "", "type": "query", "description": "Filter templates that have heartbeat enabled or disabled" }, { "name": "filter.includeInactive", "value": "", "type": "query", "description": "Whether to include inactive secret templates in the results" }, { "name": "filter.includeSecretCount", "value": "", "type": "query", "description": "Whether to populate Secret count in the results" }, { "name": "filter.passwordTypeIds", "value": "", "type": "query", "description": "List of Password Type Ids" }, { "name": "filter.passwordTypeReady", "value": "", "type": "query", "description": "Filter templates that are either password type ready (enabled) or not (disabled)" }, { "name": "filter.scanItemTemplateId", "value": "", "type": "query", "description": "Filter templates that map to " }, { "name": "filter.searchText", "value": "", "type": "query", "description": "Search text" }, { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" } ] }, "docs": "Search, filter, sort, and page secret templates" }, { "info": { "name": "Create Secret Template", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secret-templates", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Secret Template" }, { "info": { "name": "Export Secret Template", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secret-templates/:id/export", "params": [ { "name": "id", "value": "", "type": "path", "description": "Secret template ID" } ] }, "docs": "Export a single secret template by ID" }, { "info": { "name": "Get password dictionaries", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secret-templates/password-requirements/password-dictionaries" }, "docs": "Returns the list of custom password dictionaries." }, { "info": { "name": "Creates new password dictionary", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secret-templates/password-requirements/password-dictionaries", "body": { "type": "multipart-form", "data": [] } }, "docs": "Add new password dictionary" }, { "info": { "name": "Updates a new password dictionary", "type": "http" }, "http": { "method": "PUT", "url": "/SecretServer/api/v1/secret-templates/password-requirements/password-dictionaries", "body": { "type": "multipart-form", "data": [] } }, "docs": "Updates password dictionary" }, { "info": { "name": "Get Secret Template Extended Types", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secret-templates/extended-types", "params": [ { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" } ] }, "docs": "Get all of the extended types" }, { "info": { "name": "Get Secret Template Extended Mappings", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secret-templates/extended-mappings", "params": [ { "name": "filter.secretTemplateId", "value": "", "type": "query", "description": "SecretTemplateId" }, { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" } ] }, "docs": "Get all of the extended mappings for a Secret Template" }, { "info": { "name": "Stub a Secret Template Extended Mappings", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secret-templates/:secretTemplateId/extended-mappings/:extendedTypeId/stub", "params": [ { "name": "extendedTypeId", "value": "", "type": "path", "description": "extendedTypeId" }, { "name": "secretTemplateId", "value": "", "type": "path", "description": "secretTemplateId" } ] }, "docs": "Gets a stub that can be used to create an extended mapping" }, { "info": { "name": "Get Launcher Types", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secret-templates/launcher-types", "params": [ { "name": "filter.applicationName", "value": "", "type": "query", "description": "Application name" }, { "name": "filter.includeInactive", "value": "", "type": "query", "description": "Include inactive launcher types" }, { "name": "filter.includeSystemLaunchers", "value": "", "type": "query", "description": "Include system launcher types" }, { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" } ] }, "docs": "Get a paged list of all of the Launcher Types that exist" }, { "info": { "name": "Get Secret Template Launchers", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secret-templates/launchers", "params": [ { "name": "filter.secretTemplateId", "value": "", "type": "query", "description": "SecretTemplateId" }, { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" } ] }, "docs": "Get all of the Launchers for a Secret Template" }, { "info": { "name": "Stub a Secret Template Launchers", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secret-templates/:secretTemplateId/launchers/:launcherTypeId/stub", "params": [ { "name": "launcherTypeId", "value": "", "type": "path", "description": "launcherTypeId" }, { "name": "secretTemplateId", "value": "", "type": "path", "description": "secretTemplateId" } ] }, "docs": "Gets a stub that can be used to create an launcher" }, { "info": { "name": "Get Secret Template Password Changer", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secret-templates/:secretTemplateId/password-type", "params": [ { "name": "secretTemplateId", "value": "", "type": "path", "description": "secretTemplateId" } ] }, "docs": "Get the password changer for a secret template if defined" }, { "info": { "name": "Patch Secret Template password type", "type": "http" }, "http": { "method": "PATCH", "url": "/SecretServer/api/v1/secret-templates/:secretTemplateId/password-type", "params": [ { "name": "secretTemplateId", "value": "", "type": "path", "description": "secretTemplateId" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create or assign password type settings on a secret template" }, { "info": { "name": "Get Secret Template List", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secret-templates-list", "params": [ { "name": "filter.folderId", "value": "", "type": "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." }, { "name": "filter.onlyIncludeCreatable", "value": "", "type": "query", "description": "When true only templates that the user can create in the FolderId specified will be returned" }, { "name": "filter.onlyIncludeTemplatesWithUrl", "value": "", "type": "query", "description": "When true only templates that contain a URL or URL List field will be returned" }, { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" } ] }, "docs": "Get a list of all Secret Templates. Basic users are able to query and get this list. Only returns active templates." }, { "info": { "name": "Get Secret Template Details", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v2/secret-templates/:secretTemplateId", "params": [ { "name": "secretTemplateId", "value": "", "type": "path", "description": "secretTemplateId" } ] }, "docs": "Get a single secret template details by Id" }, { "info": { "name": "Patch Secret Template V2", "type": "http" }, "http": { "method": "PATCH", "url": "/SecretServer/api/v2/secret-templates/:secretTemplateId", "params": [ { "name": "secretTemplateId", "value": "", "type": "path", "description": "secretTemplateId" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Patch secret template details" }, { "info": { "name": "Search Secret Template Fields", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secret-templates/fields/search", "params": [ { "name": "filter.includeInactive", "value": "", "type": "query", "description": "Whether to include inactive secret template fields in the results" }, { "name": "filter.secretTemplateId", "value": "", "type": "query", "description": "Secret Template Id to filter by" }, { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" } ] }, "docs": "Search, filter, sort, and page secret template fields" }, { "info": { "name": "Stub Secret Template Field", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secret-templates/fields/stub" }, "docs": "Retrieve an empty secret template field" }, { "info": { "name": "Get Secret Template Field", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secret-templates/fields/:secretFieldId", "params": [ { "name": "secretFieldId", "value": "", "type": "path", "description": "secretFieldId" } ] }, "docs": "Retrieve a secret template field" }, { "info": { "name": "Patch Secret Template Field", "type": "http" }, "http": { "method": "PATCH", "url": "/SecretServer/api/v1/secret-templates/fields/:secretTemplateFieldId", "params": [ { "name": "secretTemplateFieldId", "value": "", "type": "path", "description": "secretTemplateFieldId" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Patch a secret template field" }, { "info": { "name": "Copy Secret Template", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secret-templates/:id/copy", "params": [ { "name": "id", "value": "", "type": "path", "description": "Secret template ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Copy a single secret template by ID" }, { "info": { "name": "Create Secret Template Field For Template", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secret-templates/:templateId", "params": [ { "name": "templateId", "value": "", "type": "path", "description": "templateId" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Secret Template Field For Template" }, { "info": { "name": "Update Secret Template Field", "type": "http" }, "http": { "method": "PUT", "url": "/SecretServer/api/v1/secret-templates/:templateId", "params": [ { "name": "templateId", "value": "", "type": "path", "description": "Secret Template ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Secret Template Field" }, { "info": { "name": "Generate Password", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secret-templates/generate-password/:secretfieldId", "params": [ { "name": "secretfieldId", "value": "", "type": "path", "description": "Secret field Id" } ] }, "docs": "Generates a new password matching the Secret Field requirements" }, { "info": { "name": "Import Secret Template", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secret-templates/import", "body": { "type": "json", "data": "{}" } }, "docs": "Imports a secret template from xml" }, { "info": { "name": "Create Secret Template Field", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secret-templates/:secretTemplateId/fields", "params": [ { "name": "secretTemplateId", "value": "", "type": "path", "description": "secretTemplateId" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a secret template field" }, { "info": { "name": "Sort Secret Template Fields", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secret-templates/:secretTemplateId/fields/sort", "params": [ { "name": "secretTemplateId", "value": "", "type": "path", "description": "secretTemplateId" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sort secret template fields for a secret template" }, { "info": { "name": "Update Secret Templates Password Type", "type": "http" }, "http": { "method": "PUT", "url": "/SecretServer/api/v1/secret-templates/password-type/:templateId", "params": [ { "name": "templateId", "value": "", "type": "path", "description": "Secret template ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update A Secret template Password Type Options and Fields" } ] } ], "bundled": true }