renameSecret

Change name of secret in MATLAB vault

Since R2026a

Syntax

renameSecret(oldsecretname,newsecretname)

Description

renameSecret(oldsecretname,newsecretname) changes the name of an existing secret in your MATLAB^® vault from oldsecretname to newsecretname.

Examples

Rename Secret in MATLAB Vault

Rename a secret in your MATLAB vault.

renameSecret(oldsecretname,newsecretname);

Rename Multiple Secrets

Rename multiple secrets in your MATLAB vault.

wrongNames = ["wrongname2","wrongname3"];
correctNames = ["correctname2","correctname3"];
for i = 1 : wrongNames.length
    renameSecret(wrongNames(i),correctNames(i));
end

Input Arguments

oldsecretname — Text identifier for existing secret

string scalar | character vector

Text identifier for an existing secret, specified as a string scalar or character vector.

newsecretname — New text identifier for secret

string scalar | character vector

New text identifier for the secret, specified as a string scalar or character vector. If you specify the name of an existing secret, the renameSecret function returns an error.

More About

MATLAB Vault

Your secrets are stored in your MATLAB vault. Your vault and secrets 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.

On an installed version of MATLAB, your vault is accessible only from the exact combination of your operating system account and local machine, and your vault and secrets do not leave your local machine. With MATLAB Online™, your vault is accessible with your MathWorks Account, and your vault and secrets are stored on a secure database on MathWorks^® servers. For increased security when you use MATLAB Online, enable two-step verification for your MathWorks Account.

To set an individual secret, use setSecret. The Secret Prompt dialog box, where you enter the secret value, supports copy-paste functionality. To import secrets from a file, use importSecrets.

Extended Capabilities

Thread-Based Environment

Run code in the background using MATLAB® backgroundPool or accelerate code with Parallel Computing Toolbox™ ThreadPool.

The renameSecret function fully supports thread-based environments. For more information, see Run MATLAB Functions in Thread-Based Environment.

Version History

Introduced in R2026a