api.yaml in vgs_api_client-0.0.1.alpha202306021846 vs api.yaml in vgs_api_client-0.0.1.alpha202306061541
- old
+ new
@@ -199,18 +199,26 @@
**NOTE:** This endpoint may expose sensitive data. Therefore, it is
disabled by default. To enable it, please contact your VGS account
manager or drop us a line at
[support@verygoodsecurity.com](mailto:support@verygoodsecurity.com).
parameters:
- - name: q
+ - name: aliases
in: query
required: true
description: Comma-separated list of aliases to reveal.
example:
- "tok_sandbox_5UpnbMvaihRuRwz5QXwBFw,tok_sandbox_9ToiJHedw1nE1Jfx1qYYgz"
schema:
type: string
+ - name: storage
+ in: query
+ required: false
+ description: PERSISTENT or VOLATILE storage
+ example:
+ - "PERSISTENT"
+ schema:
+ type: string
responses:
'200':
description: OK
content:
application/json:
@@ -245,16 +253,41 @@
$ref: '#/components/responses/ApiErrorsResponse'
x-codeSamples:
- lang: Shell
label: cURL
source: |
- curl https://api.sandbox.verygoodvault.com/aliases?q={{alias1}},{{alias2}} \
+ curl https://api.sandbox.verygoodvault.com/aliases?aliases={{alias1}},{{alias2}}?storage=PERSISTENT \
-u "$USERNAME:$PASSWORD"
+ /aliases/delete:
+ post:
+ summary: "POST aliases/delete"
+ operationId: "deleteAliases"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/BatchAliasesRequest"
+ required: true
+ responses:
+ "204":
+ description: "No Content"
+ "404":
+ description: "Not Found"
+ x-codeSamples:
+ - lang: Shell
+ label: cURL
+ source: |
+ curl -v https://api.sandbox.verygoodvault.com/aliases/delete -d \
+ '{"storage":"VOLATILE","data":["tok_whjuj6F8r3f2KeCpY7RPCE"]}' \
+ -H 'Content-Type: application/json' \
+ -u "$USERNAME:$PASSWORD"
+
/aliases/{alias}:
parameters:
- $ref: '#/components/parameters/alias'
+ - $ref: '#/components/parameters/storage'
get:
operationId: revealAlias
tags:
- aliases
summary: Reveal single alias
@@ -265,10 +298,11 @@
disabled by default. To enable it, please contact your VGS account
manager or drop us a line at
[support@verygoodsecurity.com](mailto:support@verygoodsecurity.com).
parameters:
- $ref: '#/components/parameters/alias'
+ - $ref: '#/components/parameters/storage'
responses:
'200':
description: OK
content:
application/json:
@@ -286,11 +320,11 @@
$ref: '#/components/responses/ApiErrorsResponse'
x-codeSamples:
- lang: Shell
label: cURL
source: |
- curl https://api.sandbox.verygoodvault.com/aliases/{{alias}} \
+ curl https://api.sandbox.verygoodvault.com/aliases/{{alias}}?storage=PERSISTENT \
-u "$USERNAME:$PASSWORD"
put:
operationId: updateAlias
tags:
- aliases
@@ -330,20 +364,21 @@
summary: Delete alias
description: |
Removes a single alias.
parameters:
- $ref: '#/components/parameters/alias'
+ - $ref: '#/components/parameters/storage'
responses:
'204':
description: No Content
default:
$ref: '#/components/responses/ApiErrorsResponse'
x-codeSamples:
- lang: Shell
label: cURL
source: |
- curl https://api.sandbox.verygoodvault.com/aliases/{{alias}} \
+ curl https://api.sandbox.verygoodvault.com/aliases/{{alias}}?storage=PERSISTENT \
-X DELETE \
-u "$USERNAME:$PASSWORD"
components:
@@ -363,10 +398,20 @@
required: true
description: Alias to operate on.
schema:
type: string
example: tok_sandbox_bhtsCwFUzoJMw9rWUfEV5e
+ storage:
+ name: "storage"
+ in: "query"
+ required: false
+ schema:
+ type: "string"
+ enum:
+ - "PERSISTENT"
+ - "VOLATILE"
+ default: "PERSISTENT"
responses:
ApiErrorsResponse:
description: Something went wrong
content:
@@ -412,17 +457,18 @@
example: bank-account
description: List of tags the value is classified with.
aliases:
type: "array"
items:
- $ref: '#/components/schemas/Alias'
+ $ref: '#/components/schemas/AliasDto'
description: List of aliases associated with the value.
created_at:
type: "string"
format: "date-time"
description: Creation time, in UTC.
example: "2019-05-15T12:30:45Z"
+ nullable: true
storage:
type: string
enum:
- PERSISTENT
- VOLATILE
@@ -430,49 +476,68 @@
description: |
Storage medium to use.
VOLATILE results in data being persisted into an in-memory data store for one hour which is required for PCI compliant storage of card security code data.
- Alias:
+ AliasDto:
type: "object"
properties:
alias:
type: "string"
example: tok_sandbox_bhtsCwFUzoJMw9rWUfEV5e
description: Opaque string used to substitute the raw value.
format:
$ref: '#/components/schemas/AliasFormat'
+ nullable: true
AliasFormat:
type: string
enum:
- - FPE_ACC_NUM_T_FOUR
- - FPE_ALPHANUMERIC_ACC_NUM_T_FOUR
- - FPE_SIX_T_FOUR
- - FPE_SSN_T_FOUR
- - FPE_T_FOUR
- - GENERIC_T_FOUR
- - NON_LUHN_FPE_ALPHANUMERIC
- - NUM_LENGTH_PRESERVING
- - PFPT
- - RAW_UUID
- - UUID
- - VGS_FIXED_LEN_GENERIC
+ - "ALPHANUMERIC_SIX_T_FOUR"
+ - "CUSTOM"
+ - "FPE_ACC_NUM_T_FOUR"
+ - "FPE_ALPHANUMERIC_ACC_NUM_T_FOUR"
+ - "FPE_SIX_T_FOUR"
+ - "FPE_SSN_T_FOUR"
+ - "FPE_T_FOUR"
+ - "GENERIC_T_FOUR"
+ - "JS"
+ - "NON_LUHN_FPE_ALPHANUMERIC"
+ - "NUM_LENGTH_PRESERVING"
+ - "PFPT"
+ - "RAW_UUID"
+ - "UUID"
+ - "VGS_FIXED_LEN_GENERIC"
description: |
Format of the generated alias string.
See [Alias Formats](#section/Introduction/Alias-Formats) for details.
example: UUID
+ nullable: true
+ BatchAliasesRequest:
+ type: "object"
+ properties:
+ data:
+ type: "array"
+ items:
+ type: "string"
+ storage:
+ type: "string"
+ enum:
+ - "PERSISTENT"
+ - "VOLATILE"
+ description: |
+ Format for batch requests (limit 20)
+ example: '{"data":["123-13123-1232"],"storage":"PERSISTENT"}'
+
CreateAliasesRequest:
type: object
properties:
data:
type: array
items:
- oneOf:
- - $ref: '#/components/schemas/CreateAliasesRequestNew'
- - $ref: '#/components/schemas/CreateAliasesRequestReference'
+ $ref: "#/components/schemas/CreateAliasesRequestNew"
minItems: 1
maxItems: 20
required:
- data