{ "opencollection": "1.0.0", "info": { "name": "Downloads About Credentials API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Credentials", "type": "folder" }, "items": [ { "info": { "name": "List managed credentials", "type": "http" }, "http": { "method": "GET", "url": "https://www.tenable.com/downloads/api/v2/credentials", "params": [ { "name": "f", "value": "", "type": "query", "description": "A filter condition in the following format: `field:operator:value`. For managed credentials, you can only filter on the `name` field, using the following operators: \n* eq—The name of the returned credential is equal to the text you specify. \n* neq—The returned list of managed credentials excludes the credential object where the name is equal to the text you specify. \n* match—The returned list includes managed credentials where the name contains the text you specify at least partially.\n\nYou can specify multiple `f` parameters, separated by ampersand (&) characters. If you specify multiple `f` parameters, use the `ft` parameter to specify how Tenable Vulnerability Management applies the multiple filter conditions." }, { "name": "ft", "value": "", "type": "query", "description": "The operator that Tenable Vulnerability Management applies if multiple \\`f\\` parameters are present. The `OR` and `AND` operators are supported. If you omit this parameter and multiple `f` parameters are present, Tenable Vulnerability Management applies the `AND` operator by default." }, { "name": "referrer_owner_uuid", "value": "", "type": "query", "description": "The UUID of a scan owner. This parameter limits the returned data to managed credentials assigned to scans owned by the specified user." }, { "name": "limit", "value": "", "type": "query", "description": "The number of records to retrieve. If this parameter is omitted, Tenable Vulnerability Management uses the default value of `50`. This parameter has a minimum value of `1` and a maximum value of `300`." }, { "name": "offset", "value": "", "type": "query", "description": "The starting record to retrieve. If this parameter is omitted, Tenable Vulnerability Management uses the default value of `0`." }, { "name": "sort", "value": "", "type": "query", "description": "The field you want to use to sort the results by along with the sort order. The field is specified first, followed by a colon, and the order is specified second (`asc` or `desc`). For example, `name:asc` would sort results by the `name` field in ascending order." } ] }, "docs": "Lists managed credentials where you have been assigned at least CAN USE (32) permissions. \n\n**Note:** This endpoint does not list scan-specific or policy-specific credentials (that is, credentials stored in either a scan or a policy). To view a list of scan-specific or policy-specific credentials, use the editor details endpoint (GET /editor/{type}/{id}).
Requires the Can Use [32] credential permission or the `VM.VM_SCAN.VM_SCAN_MANAGED_CREDENTIAL.READ` custom role p" }, { "info": { "name": "Create managed credential", "type": "http" }, "http": { "method": "POST", "url": "https://www.tenable.com/downloads/api/v2/credentials", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a managed credential object that you can use when configuring and running scans. You can grant other users the permission to use the managed credential object in scans and to edit the managed credential configuration.
Requires the Basic [16] user role or the `VM.VM_SCAN.VM_SCAN_MANAGED_CREDENTIAL.CREATE` custom role privilege. See [Roles](doc:roles).
" }, { "info": { "name": "Get managed credential details", "type": "http" }, "http": { "method": "GET", "url": "https://www.tenable.com/downloads/api/v2/credentials/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "The UUID of the managed credential for which you want to view details." } ] }, "docs": "Returns details of the specified managed credential object.
Requires the Can Use [32] credential permission or the `VM.VM_SCAN.VM_SCAN_MANAGED_CREDENTIAL.READ` custom role privilege. See [Roles](doc:roles) and [Permissions](doc:permissions).
" }, { "info": { "name": "Update managed credential", "type": "http" }, "http": { "method": "PUT", "url": "https://www.tenable.com/downloads/api/v2/credentials/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "The UUID of the managed credential object you want to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a managed credential object. \n\n**Note:** You cannot use this endpoint to update the credential type. If you create a managed credential with the incorrect type, create a new managed credential with the correct credential type, and delete the incorrect managed credential.
Requires the Can Edit [64] credential permission or the `VM.VM_SCAN.VM_SCAN_MANAGED_CREDENTIAL.EDIT` custom role privilege. See [Roles](doc:roles) and [Permissions](doc:permissions).
" }, { "info": { "name": "Delete managed credential", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.tenable.com/downloads/api/v2/credentials/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "The UUID for the managed credential object you want to delete." } ] }, "docs": "Deletes the specified managed credential object. When you delete a managed credential object, Tenable Vulnerability Management also removes the credential from any scan that uses the credential.
Requires the Can Edit [64] credential permission or the `VM.VM_SCAN.VM_SCAN_MANAGED_CREDENTIAL.DELETE` custom role privilege. See [Roles](doc:roles) and [Permissions](doc:permissions).
" }, { "info": { "name": "List credential types", "type": "http" }, "http": { "method": "GET", "url": "https://www.tenable.com/downloads/api/v2/credentials/types" }, "docs": "Lists all credential types supported for managed credentials in Tenable Vulnerability Management. For more information about using the data returned by this endpoint to create managed credentials, see [Determine Settings for a Credential Type](doc:determine-settings-for-credential-type).
Requires the Basic [16] user role or the `VM.VM_SCAN.VM_SCAN_MANAGED_CREDENTIAL.READ` custom role privilege. See [Roles](doc:roles).
" }, { "info": { "name": "Upload credentials file", "type": "http" }, "http": { "method": "POST", "url": "https://www.tenable.com/downloads/api/v2/credentials/files", "params": [ { "name": "fileType", "value": "", "type": "query", "description": "The type of the file being uploaded." } ], "body": { "type": "multipart-form", "data": [ { "name": "Filedata", "type": "text", "value": "" } ] } }, "docs": "Uploads a file for use with a managed credential (for example, as a private key file for an SSH credential).\n\n Tenable Vulnerability Management validates this request with the required `fileType` query parameter. The supported `fileTypes` are: `pem`, `json`, `csv`, `x.509`, `p12`, `cookie`, `ssh` (only RSA and DSA OpenSSH keys/certificates are supported). To pass validation, `cookie` files must adhere to the Netscape cookies file format. Additionally, `csv` files must adhere to one of the follow" } ] } ], "bundled": true }