@itentialopensource/adapter-hashicorp_vault

{ "id": "@itentialopensource/adapter-hashicorp_vault", "type": "Adapter", "export": "HashiCorpVault", "title": "HashiCorpVault", "src": "adapter.js", "roles": [ "admin" ], "methods": [ { "name": "iapUpdateAdapterConfiguration", "summary": "Updates the adapter configuration", "description": "Updates the adapter configuration file with the provided changes", "input": [ { "name": "configFile", "type": "string", "info": "The name of the file to change", "required": true, "schema": { "title": "configFile", "type": "string" } }, { "name": "changes", "type": "object", "info": "JSON object containing the configuration changes", "required": true, "schema": { "title": "changes", "type": "object" } }, { "name": "entity", "type": "string", "info": "The entity in which the changes are being made", "required": false, "schema": { "title": "entity", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of file to change - action, schema, or mock", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "action", "type": "string", "info": "The action to be changed", "required": false, "schema": { "title": "action", "type": "string" } }, { "name" : "replace", "type": "boolean", "info": "True to replace entire mock data, false to merge/append", "required": false, "schema": { "title": "replace", "type" : "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUpdateAdapterConfiguration" }, "task": true }, { "name": "iapSuspendAdapter", "summary": "Suspends the adapter", "description": "Suspends the adapter", "input": [ { "name": "mode", "type": "enum", "enumerals": [ "pause", "error" ], "info": "How incoming requests are handled. Defaults to 'pause'", "description": "How incoming requests are handled. Defaults to 'pause'", "schema": { "title": "mode", "type": "string" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapSuspendAdapter" }, "task": true }, { "name": "iapUnsuspendAdapter", "summary": "Unsuspends the adapter", "description": "Unsuspends the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUnsuspendAdapter" }, "task": true }, { "name": "iapGetAdapterQueue", "summary": "Return the requests that are waiting in the queue if throttling is enabled", "description": "Return the requests that are waiting in the queue if throttling is enabled", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter queue", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetAdapterQueue" }, "task": true }, { "name": "iapFindAdapterPath", "summary": "Provides the ability to see if a particular API path is supported by the adapter", "description": "Provides the ability to see if a particular API path is supported by the adapter", "input": [ { "name": "apiPath", "type": "string", "info": "The API Path you want to check - make sure to not include base path and version", "description": "The API Path you want to check - make sure to not include base path and version", "schema": { "title": "apiPath", "type": "string" }, "required": true } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapFindAdapterPath" }, "task": true }, { "name": "iapTroubleshootAdapter", "summary": "Runs troubleshoot script for adapter", "description": "Runs troubleshoot script for adapter", "input": [ { "name": "props", "type": "object", "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}", "required": true, "schema": { "title": "props", "type": "object" } }, { "name": "persistFlag", "type": "boolean", "info": "Whether the input properties should be saved", "required": true, "schema": { "title": "persistFlag", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapTroubleshootAdapter" }, "task": true }, { "name": "iapRunAdapterHealthcheck", "summary": "Runs healthcheck script for adapter", "description": "Runs healthcheck script for adapter", "input": [], "output": { "name": "result", "type": "boolean", "description": "Whether healthcheck passed or failed", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterHealthcheck" }, "task": true }, { "name": "iapRunAdapterConnectivity", "summary": "Runs connectivity check script for adapter", "description": "Runs connectivity check script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterConnectivity" }, "task": true }, { "name": "iapRunAdapterBasicGet", "summary": "Runs basicGet script for adapter", "description": "Runs basicGet script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterBasicGet" }, "task": true }, { "name": "iapMoveAdapterEntitiesToDB", "summary": "Moves entities from an adapter into the IAP database", "description": "Moves entities from an adapter into the IAP database", "input": [], "output": { "name": "res", "type": "object", "description": "A JSON Object containing status, code and the response from the mongo transaction", "schema": { "title": "res", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapMoveAdapterEntitiesToDB" }, "task": true }, { "name": "iapDeactivateTasks", "summary": "Deactivate the inputted tasks", "description": "Deactivate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to deactivate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapDeactivateTasks" }, "task": true }, { "name": "iapActivateTasks", "summary": "Activate the inputted tasks", "description": "activate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to activate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapActivateTasks" }, "task": true }, { "name": "iapPopulateEntityCache", "summary": "Populate the cache for the given entities", "description": "Populate the cache for the given entities", "input": [ { "name": "entityTypes", "type": "array", "info": "the entity type(s) to populate", "required": true, "schema": { "title": "entityTypes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapPopulateEntityCache" }, "task": true }, { "name": "iapRetrieveEntitiesCache", "summary": "Retrieves data from cache for specified entity type", "description": "Retrieves data from cache for specified entity type", "input": [ { "name": "entityType", "type": "string", "info": "entity of which to retrieve", "required": true, "schema": { "title": "entityType", "type": "string" } }, { "name": "options", "type": "object", "info": "settings of which data to return and how to return it", "required": false, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRetrieveEntitiesCache" }, "task": true }, { "name": "getDevice", "summary": "Get the Appliance", "description": "Get the Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevice" }, "task": false }, { "name": "getDevicesFiltered", "summary": "Get Appliances that match the filter", "description": "Get Appliances that match the filter", "input": [ { "name": "options", "type": "object", "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }", "required": true, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevicesFiltered" }, "task": false }, { "name": "isAlive", "summary": "Checks the status for the provided Appliance", "description": "Checks the status for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "boolean", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/isAlive" }, "task": false }, { "name": "getConfig", "summary": "Gets a config for the provided Appliance", "description": "Gets a config for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } }, { "name": "format", "type": "string", "info": "The format to be returned - this is ignored as we always return json", "required": false, "schema": { "title": "format", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConfig" }, "task": false }, { "name": "iapGetDeviceCount", "summary": "Gets a device count from the system", "description": "Gets a device count from the system", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetDeviceCount" }, "task": false }, { "name": "iapExpandedGenericAdapterRequest", "summary": "Makes the requested generic call with additional options", "description": "Makes the requested generic call with additional options via metadata", "input": [ { "name": "metadata", "type": "object", "info": "metadata for the call (optional)", "description": "metadata for the call - allows for many enhancements (optional)", "schema": { "title": "metadata", "type": "object" }, "required": false }, { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": false }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": false }, { "name": "pathVars", "type": "object", "info": "the parameters to be put within the url path (optional)", "description": "the parameters to be put within the url path (optional)", "schema": { "title": "pathVars", "type": "object" }, "required": false }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapExpandedGenericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequest", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequestNoBasePath", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequestNoBasePath" }, "task": true }, { "name": "iapRunAdapterLint", "summary": "Run the adapter lint script to return the results", "description": "Run the adapter lint script to return the results", "input": [], "output": { "name": "result", "type": "string", "description": "A string containing the run results", "schema": { "title": "result", "type": "string" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterLint" }, "task": true }, { "name": "iapRunAdapterTests", "summary": "Run the adapter test scripts (baseunit and unit) to return the results", "description": "Run the adapter test scripts (baseunit and unit) to return the results", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterTests" }, "task": true }, { "name": "iapGetAdapterInventory", "summary": "Provide inventory information abbout the adapter", "description": "Provide inventory information abbout the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapGetAdapterInventory" }, "task": true }, { "name": "getKvSecretConfig", "summary": "Retrieves the current configuration for the secrets backend at the given path", "description": "Retrieves the current configuration for the secrets backend at the given path", "input": [ { "name": "namespace", "type": "string", "info": "the namespace within Vault", "description": "the namespace within Vault", "schema": { "title": "namespace", "type": "string" }, "required": false }, { "name": "secretMount", "type": "string", "info": "the secret mount point (default secret)", "description": "the secret mount point (default secret)", "schema": { "title": "secretMount", "type": "string" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getKvSecretConfig" }, "task": true }, { "name": "postKvSecretConfig", "summary": "Configure backend level settings that are applied to every key in the key-value store.", "description": "Configure backend level settings that are applied to every key in the key-value store.", "input": [ { "name": "namespace", "type": "string", "info": "the namespace within Vault", "description": "the namespace within Vault", "schema": { "title": "namespace", "type": "string" }, "required": false }, { "name": "secretMount", "type": "string", "info": "the secret mount point (default secret)", "description": "the secret mount point (default secret)", "schema": { "title": "secretMount", "type": "string" }, "required": false }, { "name": "body", "type": "object", "info": ": {\"cas_required\": \"boolean\", \"delete_version_after\": 123, \"max_versions\": 123}", "required": false, "schema": { "type": "object", "properties": { "cas_required": { "type": "boolean", "description": "If true, the backend will require the cas parameter to be set for each write" }, "delete_version_after": { "type": "integer", "description": "If set, the length of time before a version is deleted. A negative duration disables the use of delete_version_after on all keys. A zero duration clears the current setting. Accepts a Go duration format string." }, "max_versions": { "type": "integer", "description": "The number of versions to keep for each key. Defaults to 10" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postKvSecretConfig" }, "task": true }, { "name": "getKvSecretDataPath", "summary": "Retrieves the secret at the specified location.", "description": "Retrieves the secret at the specified location.", "input": [ { "name": "namespace", "type": "string", "info": "the namespace within Vault", "description": "the namespace within Vault", "schema": { "title": "namespace", "type": "string" }, "required": false }, { "name": "secretMount", "type": "string", "info": "the secret mount point (default secret)", "description": "the secret mount point (default secret)", "schema": { "title": "secretMount", "type": "string" }, "required": false }, { "name": "pathParam", "type": "string", "info": "Location of the secret.: string", "required": true, "schema": { "title": "pathParam", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getKvSecretDataPath" }, "task": true }, { "name": "postKvSecretDataPath", "summary": "Creates a new version of a secret at the specified location", "description": "Creates a new version of a secret at the specified location", "input": [ { "name": "namespace", "type": "string", "info": "the namespace within Vault", "description": "the namespace within Vault", "schema": { "title": "namespace", "type": "string" }, "required": false }, { "name": "secretMount", "type": "string", "info": "the secret mount point (default secret)", "description": "the secret mount point (default secret)", "schema": { "title": "secretMount", "type": "string" }, "required": false }, { "name": "pathParam", "type": "string", "info": "Location of the secret.: string", "required": true, "schema": { "title": "pathParam", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"data\": \"object\", \"options\": \"object\", \"version\": 123}", "required": false, "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "The contents of the data map will be stored and returned on read." }, "options": { "type": "object", "description": "Options for writing a KV entry. Set the \"cas\" value to use a Check-And-Set operation. If not set the write will be allowed. If set to 0 a write will only be allowed if the key doesn’t exist. If the index is non-zero the write will only be allowed if the key’s current version matches the version specified in the cas parameter." }, "version": { "type": "integer", "description": "If provided during a read, the value at the version number will be returned" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postKvSecretDataPath" }, "task": true }, { "name": "deleteKvSecretDataPath", "summary": "Issues a soft delete of the secret's latest version at the specified location.", "description": "Issues a soft delete of the secret's latest version at the specified location.", "input": [ { "name": "namespace", "type": "string", "info": "the namespace within Vault", "description": "the namespace within Vault", "schema": { "title": "namespace", "type": "string" }, "required": false }, { "name": "secretMount", "type": "string", "info": "the secret mount point (default secret)", "description": "the secret mount point (default secret)", "schema": { "title": "secretMount", "type": "string" }, "required": false }, { "name": "pathParam", "type": "string", "info": "Location of the secret.: string", "required": true, "schema": { "title": "pathParam", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteKvSecretDataPath" }, "task": true }, { "name": "postKvSecretDeletePath", "summary": "Issues a soft delete of the specified versions of the secret", "description": "Issues a soft delete of the specified versions of the secret", "input": [ { "name": "namespace", "type": "string", "info": "the namespace within Vault", "description": "the namespace within Vault", "schema": { "title": "namespace", "type": "string" }, "required": false }, { "name": "secretMount", "type": "string", "info": "the secret mount point (default secret)", "description": "the secret mount point (default secret)", "schema": { "title": "secretMount", "type": "string" }, "required": false }, { "name": "pathParam", "type": "string", "info": "Location of the secret.: string", "required": true, "schema": { "title": "pathParam", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"versions\": \"array\"}", "required": false, "schema": { "type": "object", "properties": { "versions": { "type": "array", "description": "The versions to be archived. The versioned data will not be deleted, but it will no longer be returned in normal get requests.", "items": { "type": "integer" } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postKvSecretDeletePath" }, "task": true }, { "name": "postKvSecretDestroyPath", "summary": "Permanently removes the specified version data for the provided key and version numbers from the secret store.", "description": "Permanently removes the specified version data for the provided key and version numbers from the secret store.", "input": [ { "name": "namespace", "type": "string", "info": "the namespace within Vault", "description": "the namespace within Vault", "schema": { "title": "namespace", "type": "string" }, "required": false }, { "name": "secretMount", "type": "string", "info": "the secret mount point (default secret)", "description": "the secret mount point (default secret)", "schema": { "title": "secretMount", "type": "string" }, "required": false }, { "name": "pathParam", "type": "string", "info": "Location of the secret.: string", "required": true, "schema": { "title": "pathParam", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"versions\": \"array\"}", "required": false, "schema": { "type": "object", "properties": { "versions": { "type": "array", "description": "The versions to destroy. Their data will be permanently deleted.", "items": { "type": "integer" } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postKvSecretDestroyPath" }, "task": true }, { "name": "getKvSecretMetadataPath", "summary": "Retrieves the metadata and versions for the secret at the specified path.", "description": "Retrieves the metadata and versions for the secret at the specified path.", "input": [ { "name": "namespace", "type": "string", "info": "the namespace within Vault", "description": "the namespace within Vault", "schema": { "title": "namespace", "type": "string" }, "required": false }, { "name": "secretMount", "type": "string", "info": "the secret mount point (default secret)", "description": "the secret mount point (default secret)", "schema": { "title": "secretMount", "type": "string" }, "required": false }, { "name": "pathParam", "type": "string", "info": "Location of the secret.: string", "required": true, "schema": { "title": "pathParam", "type": "string" } }, { "name": "list", "type": "string", "info": "Return a list if `true`: string", "required": false, "schema": { "title": "list", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getKvSecretMetadataPath" }, "task": true }, { "name": "postKvSecretMetadataPath", "summary": "Creates or updates the metadata of a secret at the specified location.", "description": "Creates or updates the metadata of a secret at the specified location.", "input": [ { "name": "namespace", "type": "string", "info": "the namespace within Vault", "description": "the namespace within Vault", "schema": { "title": "namespace", "type": "string" }, "required": false }, { "name": "secretMount", "type": "string", "info": "the secret mount point (default secret)", "description": "the secret mount point (default secret)", "schema": { "title": "secretMount", "type": "string" }, "required": false }, { "name": "pathParam", "type": "string", "info": "Location of the secret.: string", "required": true, "schema": { "title": "pathParam", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"cas_required\": \"boolean\", \"delete_version_after\": 123, \"max_versions\": 123}", "required": false, "schema": { "type": "object", "properties": { "cas_required": { "type": "boolean", "description": "If true the key will require the cas parameter to be set on all write requests. If false, the backend’s configuration will be used." }, "delete_version_after": { "type": "integer", "description": "The length of time before a version is deleted. If not set, the backend's configured delete_version_after is used. Cannot be greater than the backend's delete_version_after. A zero duration clears the current setting. A negative duration will cause an error." }, "max_versions": { "type": "integer", "description": "The number of versions to keep. If not set, the backend’s configured max version is used." } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postKvSecretMetadataPath" }, "task": true }, { "name": "deleteKvSecretMetadataPath", "summary": "Permanently deletes the key metadata and all version data for the specified key.", "description": "Permanently deletes the key metadata and all version data for the specified key.", "input": [ { "name": "namespace", "type": "string", "info": "the namespace within Vault", "description": "the namespace within Vault", "schema": { "title": "namespace", "type": "string" }, "required": false }, { "name": "secretMount", "type": "string", "info": "the secret mount point (default secret)", "description": "the secret mount point (default secret)", "schema": { "title": "secretMount", "type": "string" }, "required": false }, { "name": "pathParam", "type": "string", "info": "Location of the secret.: string", "required": true, "schema": { "title": "pathParam", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteKvSecretMetadataPath" }, "task": true }, { "name": "postKvSecretUndeletePath", "summary": "Undeletes the data for the provided version and path in the secret store.", "description": "Undeletes the data for the provided version and path in the secret store.", "input": [ { "name": "namespace", "type": "string", "info": "the namespace within Vault", "description": "the namespace within Vault", "schema": { "title": "namespace", "type": "string" }, "required": false }, { "name": "secretMount", "type": "string", "info": "the secret mount point (default secret)", "description": "the secret mount point (default secret)", "schema": { "title": "secretMount", "type": "string" }, "required": false }, { "name": "pathParam", "type": "string", "info": "Location of the secret.: string", "required": true, "schema": { "title": "pathParam", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"versions\": \"array\"}", "required": false, "schema": { "type": "object", "properties": { "versions": { "type": "array", "description": "The versions to unarchive. The versions will be restored and their data will be returned on normal get requests.", "items": { "type": "integer" } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postKvSecretUndeletePath" }, "task": true }, { "name": "getCubbyholeSecretPath", "summary": "Retrieves the secret at the specified location.", "description": "Retrieves the secret at the specified location.", "input": [ { "name": "namespace", "type": "string", "info": "the namespace within Vault", "description": "the namespace within Vault", "schema": { "title": "namespace", "type": "string" }, "required": false }, { "name": "secretMount", "type": "string", "info": "the secret mount point (default secret)", "description": "the secret mount point (default secret)", "schema": { "title": "secretMount", "type": "string" }, "required": false }, { "name": "pathParam", "type": "string", "info": "Specifies the path of the secret.: string", "required": true, "sc