getSecret
Description
getSecret(
retrieves the secret
value with the specified name from your MATLAB® vault. Your MATLAB vault is accessible only from the exact combination of your operating system
account and local machine.secretname
)
v = getSecret(
assigns the secret
value to a variable. Displaying the variable value makes the secret visible.secretname
)
Examples
Retrieve Secret Value from Your MATLAB Vault
Retrieve a secret value from your vault.
getSecret("ExamplePassword")
************
Assign Secret Value to Variable
Retrieve a secret value from your vault and assign it to a variable. Note that assigning a secret value to a variable makes the value visible.
SFTPpassword = getSecret("ExamplePassword")
SFTPpassword = "pass_word123"
Use Secret to Access SFTP Server
Create a secret to store your SFTP server password by initiating the Secret Prompt dialog box with the name of your secret.
setSecret("SFTPpassword")
Use the dialog box to set your secret value and add the secret to your MATLAB vault. Toggle the eye icon in the text box to hide or show the characters in your value.
To provide the SFTP server password, use the secret from your vault containing the password value.
s = sftp("sftp.example.net","adam",Password=getSecret("SFTPpassword"));
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
.
Extended Capabilities
Thread-Based Environment
Run code in the background using MATLAB® backgroundPool
or accelerate code with Parallel Computing Toolbox™ ThreadPool
.
This function fully supports thread-based environments. For more information, see Run MATLAB Functions in Thread-Based Environment.
Version History
Introduced in R2024aR2024b: Use function in thread-based environments
This function supports thread-based environments.
See Also
setSecret
| isSecret
| listSecrets
| removeSecret
| setSecretMetadata
| getSecretMetadata
MATLAB 명령
다음 MATLAB 명령에 해당하는 링크를 클릭했습니다.
명령을 실행하려면 MATLAB 명령 창에 입력하십시오. 웹 브라우저는 MATLAB 명령을 지원하지 않습니다.
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)