HomeDocumentationAPI Reference
Log In
These docs are for v17. Click to read the latest docs for v33.

Secrets Vault

Users can use PrivX to store and share information securely. Secrets are JSON formatted data, which PrivX stores and handles access to.

PrivX secrets are under the ​Secrets​​ page. On this page you can add, and edit secrets. You can also search secrets by their name.

Required Permissions

The Role permissions that govern secrets are:

  • ​​vault-add​​: Allows the user to add secrets.

  • ​​vault-manage​​: Allows the user to add and delete secrets, modify the secret's metadata, modify the secret's content, list secrets, and view the secret's metadata.

  • ​​read-role​​: Allows the user to access the secret's content, list secrets and view the secret's metadata.

  • ​​write-role​​: Allows the user to modify the secret's content, list secrets and view the secret's metadata.

Adding Secrets

When adding secrets, you must provide the data that PrivX will secure in JSON format.

Accessing Secrets

Secrets can be given read and write accesses with roles. When adding or editing a secret, Add Role to Read Access and/or Write Access to control who gains the wanted type of access to the secret data. Note that if no role is given read access, no user can read the secret, and similarly with write access.

For using secrets vault for scripted access, see API-Client Integration