# vault

### Vault Library

This module is created to work with VGS Secure Storage via Larky script

### vault.redact(value, storage=None, format=None, tags=\[])

Generates a VGS alias for value.

**Parameters:**

* **value**- string or List\[] – data to redact.
* **storage** – [storage type](https://www.verygoodsecurity.com/docs/getting-started/storage#persistent-and-volatile-storage):
  * persistent (default) - storage allows you to store your data with VGS on a permanent basis.
  * volatile - storage that stores data temporarily. The default holding period for volatile storage is 1 hour. this can be reconfigured with some constraints.
* **format** – [alias format](https://www.verygoodsecurity.com/docs/terminology/nomenclature#alias-formats):
  * `RAW_UUID`
  * `UUID` (default)∂
  * `NUM_LENGTH_PRESERVING`
  * `PFPT`
  * `FPE_SIX_T_FOUR`
  * `FPE_T_FOUR`
  * `NON_LUHN_FPE_ALPHANUMERIC`
  * `FPE_SSN_T_FOUR`
  * `FPE_ACC_NUM_T_FOUR`
  * `FPE_ALPHANUMERIC_ACC_NUM_T_FOUR`
  * `GENERIC_T_FOUR`
  * `ALPHANUMERIC_SIX_T_FOUR`
  * `VGS_FIXED_LEN_GENERIC`
* **tags** – optional list of tags to classify the value with.

*Returns:* alias of a value in VGS Vault in chosen format.

### vault.reveal(value, storage=None)

Reveals aliased value.

**Parameters:**

* **value** String or List\[] – alias(es) to reveal.
* **storage** – [storage type](https://www.verygoodsecurity.com/docs/getting-started/storage#persistent-and-volatile-storage):
  * persistent - storage allows you to store your data with VGS on a permanent basis.
  * volatile - storage that stores data temporarily. The default holding period for volatile storage is 1 hour.
  * (not specified) - reveals any persistent or volatile tokens that match. this can be reconfigured with some constraints.

*Returns:* raw value that corresponds to alias or alias if not found.

### vault.delete(value, storage=None)

Deletes aliased value(s).

**Parameters:**

* **value** String or List\[] – alias(es) to delete
* **storage** – [storage type](https://www.verygoodsecurity.com/docs/getting-started/storage#persistent-and-volatile-storage):
  * persistent - storage allows you to store your data with VGS on a permanent basis.
  * volatile - storage that stores data temporarily. The default holding period for volatile storage is 1 hour.
  * (not specified) - deletes any persistent or volatile tokens that match.

*Returns:* alias.