removeSecret
Syntax
Description
removeSecret(
permanently removes
all data associated with the specified secret name from your MATLAB® vault. Your MATLAB vault is accessible only from the exact combination of your operating system
account and local machine.secretname
)
Examples
Remove Secret from MATLAB Vault
View the secrets in your vault.
listSecrets
SecretName SecretMetadata ________________ _______________________________________________ "PDFpassword" {[dictionary (string ⟼ cell) with 2 entries ]} "AWS_access_key" {[dictionary (string ⟼ cell) with 3 entries ]} "Azure_WASB_KEY" {[dictionary (string ⟼ cell) with 2 entries ]} "OAuth_token" {[dictionary (string ⟼ cell) with 3 entries ]} "certificate3" {[dictionary (string ⟼ cell) with no entries]} "SFTPpassword" {[dictionary (string ⟼ cell) with 4 entries ]}
Remove a secret from your vault. When calling removeSecret
, you
can type the secret name or select its name through tab completion. Then view the
contents of your updated vault.
removeSecret("PDFpassword")
listSecrets
SecretName SecretMetadata ________________ _______________________________________________ "AWS_access_key" {[dictionary (string ⟼ cell) with 3 entries ]} "Azure_WASB_KEY" {[dictionary (string ⟼ cell) with 2 entries ]} "OAuth_token" {[dictionary (string ⟼ cell) with 3 entries ]} "certificate3" {[dictionary (string ⟼ cell) with no entries]} "SFTPpassword" {[dictionary (string ⟼ cell) with 4 entries ]}
Input Arguments
secretname
— Unique case-sensitive text identifier for secret
string scalar | character vector
Unique case-sensitive text identifier for the secret, specified as a string scalar or character vector. You can use a secret to hold sensitive information, such as passwords, certificates, credentials, OAuth tokens, and other configuration data for:
SFTP and FTP servers
Password-protected files, such as PDFs
Password-protected archives, such as zip files
Cloud providers, such as Amazon S3™ and Windows Azure® Blob Storage
API keys, SSH keys, and encryption keys
Databases and applications
The forward slash character (/
) is not supported in
secretname
.
More About
MATLAB Vault
Your secrets are stored in your MATLAB vault, which is accessible only from the exact combination of your operating system account and local machine. Your vault and secrets, which do not leave your local machine, persist across MATLAB sessions. Each secret consists of a name, value, and optional metadata.
Secret name – A unique case-sensitive text identifier for the secret. The secret name is stored unencrypted in your vault as a string scalar.
Secret value – A text value associated with the secret. The Secret Prompt dialog box, where you enter the secret value, supports copy-paste functionality. The secret value is stored encrypted in your vault using industry standard AES-256 encryption. The secret value is returned as a string scalar.
Secret metadata – A dictionary containing additional information associated with the secret. The optional secret metadata is stored unencrypted in your vault.
To set a secret, use setSecret
.
Version History
Introduced in R2024a
See Also
setSecret
| getSecret
| isSecret
| listSecrets
| setSecretMetadata
| getSecretMetadata
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)