unshare_secret: Unshare a secret among some users.

Description Usage Arguments See Also

View source: R/secrets.R


Use this function to restrict the set of users that have access to a secret. Note that users may still have access to the secret, through version control history, or if they have a copy of the project. They will not have access to future values of the secret, though.


unshare_secret(name, users, vault = NULL)



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


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


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


Other secret functions: add_secret(), delete_secret(), get_secret(), list_owners(), list_secrets(), local_key(), share_secret(), update_secret()

secret documentation built on July 2, 2020, 1:49 a.m.