WOLFRAM

SystemCredentialStoreObject
SystemCredentialStoreObject

Unsupported in Public Cloud[Experimental]

represents a credential store.

Details

  • Credential stores are also called keychains or keyrings, depending on the operating system used.
  • assoc is an Association containing the details needed to use a specific credential store.
  • The keys used in assoc include:
  • "Backend"the store back end to use
    "Keyring"the keyring to use
    "EncryptedFileBase"location of the "EncryptedFile"
  • "Backend" specifies which of the available credential store implementations to use.
  • On Windows, the default back end is "System", which represents Windows Credential Manager.
  • On macOS, the default back end is "System", which represents Apple's Keychain Access password management system.
  • On Linux, the default back end is "EncryptedFile". Linux can also use "KWallet" or "LibSecret" backends if they are available.
  • The "EncryptedFile" back end is available on all platforms and the Wolfram Cloud.
  • For the "EncryptedFile" back end, an optional "EncryptedFileBase" key may be used to specify the location of the encrypted file. The default location is in $UserBaseDirectory/ApplicationData/Credentials.
  • A specific back end may support one or several separate keyrings that store secrets. "Keyring" specifies which of the keyrings is to be used.
  • Depending on the back end used, a specific keyring may need to be unlocked to be used. The system will prompt for a password to unlock the keyring if needed.
  • On Windows, the "System" keyring is the only keyring supported by the Windows Credential Manager.
  • On macOS and Linux, it is possible to create multiple keyrings. To manage keyrings, operating systemspecific tools must be used.
  • For the "EncryptedFile" back end, the name of the encrypted file is based on the "Keyring" value.
  • With the setting "Keyring"Automatic, on macOS, the keyring set by the operating system is used.

Examples

open allclose all

Basic Examples  (1)Summary of the most common use cases

Give the current SystemCredentialStoreObject:

Out[1]=1

Change the credential store:

Out[2]=2

Reset the credential store to the default:

Out[3]=3

Scope  (2)Survey of the scope of standard use cases

A typical default setting for macOS:

Out[1]=1

A typical default setting for Windows:

Out[2]=2

A possible setting for Linux:

Out[3]=3

If no suitable OS-provided keychain is available, an "EncryptedFile" store is used by default:

Out[1]=1

Generalizations & Extensions  (2)Generalized and extended use cases

Give the current SystemCredentialStoreObject:

Out[1]=1

Set a secret:

List all stored key names:

Out[5]=5

Temporarily use another credential store without setting it as a default:

Retrieve the value from the default credential store:

Out[2]=2

Retrieve the value from the alternative credential store:

Out[3]=3
Wolfram Research (2020), SystemCredentialStoreObject, Wolfram Language function, https://reference.wolfram.com/language/ref/SystemCredentialStoreObject.html.
Wolfram Research (2020), SystemCredentialStoreObject, Wolfram Language function, https://reference.wolfram.com/language/ref/SystemCredentialStoreObject.html.

Text

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

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

CMS

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

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

APA

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

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

BibTeX

@misc{reference.wolfram_2025_systemcredentialstoreobject, author="Wolfram Research", title="{SystemCredentialStoreObject}", year="2020", howpublished="\url{https://reference.wolfram.com/language/ref/SystemCredentialStoreObject.html}", note=[Accessed: 21-April-2025 ]}

@misc{reference.wolfram_2025_systemcredentialstoreobject, author="Wolfram Research", title="{SystemCredentialStoreObject}", year="2020", howpublished="\url{https://reference.wolfram.com/language/ref/SystemCredentialStoreObject.html}", note=[Accessed: 21-April-2025 ]}

BibLaTeX

@online{reference.wolfram_2025_systemcredentialstoreobject, organization={Wolfram Research}, title={SystemCredentialStoreObject}, year={2020}, url={https://reference.wolfram.com/language/ref/SystemCredentialStoreObject.html}, note=[Accessed: 21-April-2025 ]}

@online{reference.wolfram_2025_systemcredentialstoreobject, organization={Wolfram Research}, title={SystemCredentialStoreObject}, year={2020}, url={https://reference.wolfram.com/language/ref/SystemCredentialStoreObject.html}, note=[Accessed: 21-April-2025 ]}