WOLFRAM

Wolfram Language & System Documentation Center

SystemCredential["keyname"]

gives the expression stored under "keyname" in secure storage.

Details
Details and Options Details and Options
Examples  
Basic Examples  
Applications  
Properties & Relations  
Possible Issues  
See Also
Related Guides
History
Cite this Page

SystemCredential

SystemCredential["keyname"]

gives the expression stored under "keyname" in secure storage.

Details

  • Expressions can be stored with SystemCredential["keyname"]=expr.
  • Expressions that can be stored in SystemCredential include:
  • "string"secret string such as password
    SystemCredentialDatageneral-purpose key-value pairs
    SecuredAuthenticationKeycredentials for an external service
  • Expressions stored under "keyname" can be removed with Unset[SystemCredential["keyname"]].
  • SystemCredential uses the operating system's keychain, if possible. If no secure storage is available, it stores its secrets in an encrypted local file.
  • Under Windows and macOS, the data is by default stored in the default keychain provided.
  • Under Linux, one of the supported wallet systems can be used.

Examples

open all close all

Basic Examples  (3)

Store a secret string under the key name "mykey":

Wolfram Language code: SystemCredential["mykey"] = "123"

Read the string from secure storage:

Wolfram Language code: SystemCredential["mykey"]

Remove the stored data:

Wolfram Language code: SystemCredential["mykey"]=.

Securely store an authentication key:

Wolfram Language code: SystemCredential["MyAuthKey"] = SecuredAuthenticationKey[Association["Name" -> "MyAuthKey", "OAuthType" -> "AuthorizationCode", "OAuthVersion" -> "2.0", "ClientID" -> "myID", "ClientSecret" -> "mySecret", "AccessTokenURL" -> "https://mytestexampleurl.com/oauth/access_token", "UserAuthorizationURL" -> "https://www.mytestexampleurl.com/api/v1/authorize", "VerifierInputFunction" -> "WolframConnectorChannel", "TransmissionMethod" -> "Headers", "RedirectURI" -> Automatic, "UUID" -> "71fa7a3a-eb96-4881-b230-17f0d24a710c"]]

Securely store a record of key-value pairs, with the "Password" field being encrypted:

Wolfram Language code: SystemCredential["example.com"] = SystemCredentialData[<| "Username" -> "myname", "Email" -> "user@example.com", "Password" -> "secret value" |>, "Password"]

Retrieve the stored information:

Wolfram Language code: SystemCredential["example.com"]

Applications  (1)

Create a SecuredAuthenticationKey with credentials from an external service, the "AuthorizationCode" OAuth 2.0 workflow:

Wolfram Language code: mykey = SecuredAuthenticationKey[<|"Name" -> "MyAuthKey", "OAuthType" -> "AuthorizationCode", "OAuthVersion" -> "2.0", "ClientID" -> "myID", "ClientSecret" -> "mySecret", "AccessTokenURL" -> "https://mytestexampleurl.com/oauth/access_token", "UserAuthorizationURL" -> "https://www.mytestexampleurl.com/api/v1/authorize", "RedirectURI" -> "https://www.mytestexampleurl.com/api/v1/landing", "VerifierInputFunction" -> "WolframConnectorChannel"|>]

Store the key in secure storage:

Wolfram Language code: SystemCredential["mytestexampleurl.com"] = mykey

Use the stored key to send signed requests to the service:

Wolfram Language code: URLRead[HTTPRequest["https://mytestexampleurl.com/api"], Authentication -> SystemCredential["mytestexampleurl.com"]]

Properties & Relations  (3)

List all names of securely stored data:

Wolfram Language code: SystemCredentialKeys[All]

Remove stored data for a given key name:

Wolfram Language code: Unset[SystemCredential["abc"]]

Remove all stored data:

Wolfram Language code: Unset @* SystemCredential /@ SystemCredentialKeys[All];

Use SystemCredentialKey"keyname" to securely store authentication dialog fields between sessions:

Wolfram Language code: AuthenticationDialog[{"Public key", "Private key" -> "12345" -> "Masked"}, SystemCredentialKey -> "Example1"]

The data is remembered in secure storage under the given name:

Wolfram Language code: SystemCredential["Example1"]

Possible Issues  (1)

Numbers are not accepted by SystemCredential:

Wolfram Language code: SystemCredential["Example2"] = 123

Key names must be strings:

Wolfram Language code: SystemCredential[a] = "123"
Wolfram Research (2020), SystemCredential, Wolfram Language function, https://reference.wolfram.com/language/ref/SystemCredential.html.

Text

Wolfram Research (2020), SystemCredential, Wolfram Language function, https://reference.wolfram.com/language/ref/SystemCredential.html.

CMS

Wolfram Language. 2020. "SystemCredential." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/SystemCredential.html.

APA

Wolfram Language. (2020). SystemCredential. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/SystemCredential.html

BibTeX

@misc{reference.wolfram_2026_systemcredential, author="Wolfram Research", title="{SystemCredential}", year="2020", howpublished="\url{https://reference.wolfram.com/language/ref/SystemCredential.html}", note=[Accessed: 13-June-2026]}

BibLaTeX

@online{reference.wolfram_2026_systemcredential, organization={Wolfram Research}, title={SystemCredential}, year={2020}, url={https://reference.wolfram.com/language/ref/SystemCredential.html}, note=[Accessed: 13-June-2026]}