share_secret: Share a secret among some users.

Description Usage Arguments See Also

View source: R/secrets.R


Use this function to extend the set of users that have access to a secret. The calling user must have access to the secret as well.


share_secret(name, users, key = local_key(), vault = NULL)



Name of the secret, a string that can contain alphanumeric characters, underscores, dashes and dots.


addresses of users that will have access to the secret. (See add_user()).


Private key that has access to the secret. (I.e. its corresponding public key is among the vault users.)


Vault location (starting point to find the vault). To create a vault, use create_vault() or create_package_vault(). If this is NULL, then secret tries to find the vault automatically:

  • If the secret.vault option is set to path, that is used as the starting point.

  • Otherwise, if the R_SECRET_VAULT environment variable is set to a path, that is used as a starting point.

  • Otherwise the current working directory is used as the starting point.

If the starting point is a vault, that is used. Otherwise, if the starting point is in a package tree, the inst/vault folder is used within the package. If no vault can be found, an error is thrown.

See Also

unshare_secret(), list_owners() to list users that have access to a secret.

Other secret functions: add_secret, delete_secret, get_secret, list_owners, list_secrets, local_key, unshare_secret, update_secret

secret documentation built on June 20, 2017, 9:13 a.m.