Create an offline generic vault
Overview
This endpoint is used to create vaults that store any data that does not represent a credit card.
An offline vault can be created as a PERPETUAL, TIME_EXPIRY or LIMITED vault:
Vault Type | Description | How to create |
---|---|---|
PERPETUAL | This is the default vault type. This allows you to read and update the vault as many times as required without restrictions | Don't specify the maxUsage or expiryDate field in the vault object |
TIME_EXPIRY | Allows you to read or update a vault as many times as required up until the ISO 8601 specified expiry date | Specify the expiryDate field in the vault object |
LIMITED | Allows you to read the vault maxUsage amount of times. Updates do not count as a vault usage | Specify the maxUsage field in the vault object |
Details on valid time expiry and limited fields::
Determines the maximum amount
of times the vault may be read.
Determines the period of
time you may read/update this vault before it is deleted
Type: string
Format: ISO 8601 time-date
Example: "2018-09-27T06:55:23.045Z"
Presence: optional
Format: ISO 8601 time-date
Example: "2018-09-27T06:55:23.045Z"
Presence: optional
No auto-expiry mechanism will be applied to generic vaults even if they are not used for a year or longer.
For more information about offline vaults see
here.
Additionally the user may create metadata tags for their vault.
FAQ
Format: <key>: <value>
Presence: optional
Max Key/Value pairs: 50
The key of the metadata tag.
The value of the metadata tag.
Add metadata tags to the vault. This JSON Object contains key/value pairs, with each pair representing a metadata tag.
Type: JSON ObjectFormat: <key>: <value>
Presence: optional
Max Key/Value pairs: 50
Type: string
Values: utf8 (alphanumeric, dashes, underscores, spaces)
Presence: required
Min length: 1
Max length: 32
Values: utf8 (alphanumeric, dashes, underscores, spaces)
Presence: required
Min length: 1
Max length: 32
Type: string
Values: utf8 (alphanumeric, dashes, underscores, spaces)
Presence: optional
Min length: 0
Max length: 255
Values: utf8 (alphanumeric, dashes, underscores, spaces)
Presence: optional
Min length: 0
Max length: 255
Structure
{
The
application's api key
The
application's uuid
The
content for the vault to store
Determines
the maximum amount of times the vault may be read.
Determines
the period of time you may read/update this vault before it is deleted
The
name of the vault
The
vault to create } The
application details
Type: JSON Object
Presence: required
Presence: required
Type: string
Values: hexadecimal, dashes
Length: 36
Presence: required
Values: hexadecimal, dashes
Length: 36
Presence: required
Type: string
Values: hexadecimal, dashes
Length: 36
Presence: required
Values: hexadecimal, dashes
Length: 36
Presence: required
FAQ
The
username that this vault is associated with.
Your
reference to this operation for audits.
Type: string
Values: alphanumeric, dashes, spaces, underscores
Min length: 1
Max length: 64
Presence: required
Values: alphanumeric, dashes, spaces, underscores
Min length: 1
Max length: 64
Presence: required
Type: JSON Object
Presence: required
Presence: required
Type: string
Value: utf8
Presence: required
Value: utf8
Presence: required
Type: string
Format: ISO 8601 time-date
Example: "2018-09-27T06:55:23.045Z"
Presence: optional
Format: ISO 8601 time-date
Example: "2018-09-27T06:55:23.045Z"
Presence: optional
Type: string
Values: utf8
Min length: 1
Max length: 64
Presence: required
Values: utf8
Min length: 1
Max length: 64
Presence: required
FAQ
Format: <key>: <value>
Presence: optional
Max Key/Value pairs: 50
The
key of the metadata tag.
The value of the metadata tag.
Add metadata tags to the vault. This JSON Object contains key/value pairs, with each pair representing a metadata tag.
Type: JSON ObjectFormat: <key>: <value>
Presence: optional
Max Key/Value pairs: 50
Type: string
Values: utf8 (alphanumeric, dashes, underscores, spaces)
Presence: required
Min length: 1
Max length: 32
Values: utf8 (alphanumeric, dashes, underscores, spaces)
Presence: required
Min length: 1
Max length: 32
Type: string
Values: utf8 (alphanumeric, dashes, underscores, spaces)
Presence: optional
Min length: 0
Max length: 255
Values: utf8 (alphanumeric, dashes, underscores, spaces)
Presence: optional
Min length: 0
Max length: 255
{
The response status code
Contains reasons for the parent detailed error
The JSON property in the request responsible for the parent detailed error
Contains error details if any error(s) occurred
The response message
The response status
The vault's encryptedData
The vault's payload
Contains the credentials required for further use of the created vault
The uuid of the created vault
Contains the details of the created vault }
Contains details about the response status
Type: JSON Object
Presence: required
Presence: required
Type: optional
Values: alphanumeric, dashes
Presence: optional
Values: alphanumeric, dashes
Presence: optional
Type: Array of JSON Objects
Presence: optional
Presence: optional
Type: Array of string
Presence: optional
Presence: optional
Type: string
Presence: optional
Presence: optional
Type: string
Values: ERROR, SUCCESS
Presence: required
Values: ERROR, SUCCESS
Presence: required
Type: JSON Object
Presence: required
Presence: required
Type: JSON Object
Presence: required
Presence: required
Type: string
Presence: required
Presence: required
Type: string
Presence: required
Presence: required
Type: string
Values: hexadecimal, dashes
Length: 36
Presence: required
Values: hexadecimal, dashes
Length: 36
Presence: required
Usage
API used |
POST /sanctum/v1-2/vault/generic/offline |