Documentation Home
MySQL Shell 8.0
Related Documentation Download this Manual
PDF (US Ltr) - 487.2Kb
PDF (A4) - 487.4Kb
HTML Download (TGZ) - 98.0Kb
HTML Download (Zip) - 109.7Kb


MySQL Shell 8.0  /  ...  /  Working with Credentials

4.3.2 Working with Credentials

The following functions enable you to work with the Pluggable Password store. You can list the available Secret Store Helpers, as well as list, store, and retrieve credentials.

var list = shell.listCredentialHelpers();

Returns a list of strings, where each string is a name of a Secret Store Helper available on the current platform. The special values default and <disabled> are not in the list, but are valid values for the credentialStore.helper option.

shell.storeCredential(url[, password]);

Stores given credentials using the current Secret Store Helper (credentialStore.helper). Throws an error if the store operation fails, for example if the current helper is invalid. If the URL is already in the Secret Store, it is overwritten. This method ignores the current value of the credentialStore.savePasswords and credentialStore.excludeFilters options. If a password is not provided, MySQL Shell prompts for one.

shell.deleteCredential(url);

Deletes the credentials for the given URL using the current Secret Store Helper (credentialStore.helper). Throws an error if the delete operation fails, for example the current helper is invalid or there is no credential for the given URL.

shell.deleteAllCredentials();

Deletes all credentials managed by the current Secret Store Helper (credentialStore.helper). Throws an error if the delete operation fails, for example the current Helper is invalid.

var list = shell.listCredentials();

Returns a list of all URLs of credentials stored by the current Secret Store Helper (credentialStore.helper).