Update an offline generic vault

Overview

Allows you to update the contents of your offline generic vault. This is a two step process to guard against network failure.
1. update-start
2. update-end
The first step (update-start) will update the contents of your vault and give you the new encryptedData.
You must then acknowledge you received new vault using (update-end). It is only after it has been acknowledged that
the Sanctum system recognises the vault as updated. If the return of the new vault fails due to network issues,
the old update request is ignored and you can restart the update process by calling (update-start) again.
This two step process is identical to the vault read process.

Starting an update process:

Structure

{
application {: The application details
Type: JSON Object
Presence: required
apiKey: The application's api key
Type: string
Values: hexadecimal, dashes
Length: 36
Presence: required
uuid: The application's uuid
Type: string
Values: hexadecimal, dashes
Length: 36
Presence: required
externalRef: Your reference to this operation for audits. FAQ
Type: string
Values: utf8
Min length: 1
Max length: 64
Presence: optional
newVault {: Contains the new vault details for the update
Type: JSON Object
Presence: required
content: The updated content to be stored
Type: string
Value: utf8
Presence: required
vault {: Contains the details of the vault
Type: JSON Object
Presence: required
credentials {: Contains the credentials required for use of the vault
Type: JSON Object
Presence: required
encryptedData: The vault's encryptedData
Type: string
Presence: required
payload: The vault's payload
Type: string
Presence: required
}
{
responseStatus {: Contains details about the response status
Type: JSON Object
Presence: required
code: The response status code
Type: optional
Values: alphanumeric, dashes
Presence: optional
detailedErrors [{: Contains error details if any error(s) occurred
Type: Array of JSON Objects
Presence: optional
errorReasons [: Contains reasons for the parent detailed error
Type: Array of string
Presence: optional
property: The JSON property in the request responsible for the parent detailed error
Type: string
Presence: optional
message: The response message
Type: string
Values: see Sanctum error messages
Presence: optional
status: The response status
Type: string
Values: ERROR, SUCCESS
Presence: required
transactionToken {: Contains transaction token information to be used on acknowledging the response
Type: JSON Object
Presence: required
expiry: The expiry time of the transaction token
Type: string
Format: ISO 8601 time-date
Example: "2018-09-27T06:55:23.045Z"
Presence: required
timeToExpire: The time left until the transaction token expires
Type: integer
Presence: required
token: The transaction token
Type: string
Presence: required
vault {: Contains the details of the vault
Type: JSON Object
Presence: required
credentials {: Contains the credentials required for further use of the vault
Type: JSON Object
Presence: required
encryptedData: The vault's encryptedData
Type: string
Presence: required
payload: The vault's payload
Type: string
Presence: required
uuid: The uuid of the vault
Type: string
Values: hexadecimal, dashes
Length: 36
Presence: required
usesRemaining: Remaining amount of uses that the vault has
Type: long
Min value: 1
Presence: optional
expiryDate: Marks the time when this vault will be deleted
Type: string
Format: ISO 8601 time-date
Example: "2018-09-27T06:55:23.045Z"
Presence: optional
autoLockDate: Marks the time when the vault will be automatically locked FAQ
Type: string
Format: ISO 8601 time-date
Example: "2018-09-27T06:55:23.045Z"
Presence: optional
dateCreated: Marks the time when the vault was created
Type: string
Format: ISO 8601 time-date
Example: "2018-09-27T06:55:23.045Z"
Presence: optional
lastModified: Marks the time when the vault was last updated or read
Type: string
Format: ISO 8601 time-date
Example: "2018-09-27T06:55:23.045Z"
Presence: optional
}

Usage

This endpoint should be called to begin updating a vault.

API used
POST /sanctum/v1-2/vault/generic/offline/{{vaultUuid}}/update-start

Ending the update process:

Structure

{
token: The transaction token from the update-start response
Type: string
Presence: required
}
{
responseStatus {: Contains details about the response status
Type: JSON Object
Presence: required
code: The response status code
Type: optional
Values: alphanumeric, dashes
Presence: optional
detailedErrors [{: Contains error details if any error(s) occurred
Type: Array of JSON Objects
Presence: optional
errorReasons [: Contains reasons for the parent detailed error
Type: Array of string
Presence: optional
property: The JSON property in the request responsible for the parent detailed error
Type: string
Presence: optional
message: The response message
Type: string
Values: see Sanctum error messages
Presence: optional
status: The response status
Type: string
Values: ERROR, SUCCESS
Presence: required
}

Usage

This endpoint should be called to acknowledge the successful update of an offline generic vault.

API used
PUT /sanctum/v1-2/vault/generic/offline/{{vaultUuid}}/update-end