Alias

Unique ID that retains all the essential information about the data without compromising its security. A value can have multiple aliases.

Reveal multiple aliases

get
/aliases

Given a list of aliases, retrieves all associated values stored in the vault.

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 [email protected].

NOTE: metadata information fields of the alias classifiers, created_at and format are supported only for PERSISTENT storage, in case of VOLATILE storage these fields will be filled up with default values.

Authorizations
OAuth2clientCredentialsRequired

This api utilizes the OAuth2.0 Client Credentials flow utilizing VGS service account credentials

Token URL:
Available scopes:
  • : This scope will allow the client to read the the entire vault data object using the associated alias in order for this scope to work, the vault must be configured to reveal data by VGS Support.
  • : This scope will allow the client to create new aliases by value. If the value already has an alias in the requested alias format - it will return the current alias already created when fingerprinting is turned on, otherwise it will create a new alias.
  • : This scope will allow the client to delete any alias based upon the alias. This will only delete the alias, if the underlying value has more than one alias, the value is still retained in the vault until all associated aliases are removed.
Query parameters
aliasesstringRequired

Comma-separated list of aliases to reveal.

Example: ["tok_sandbox_5UpnbMvaihRuRwz5QXwBFw,tok_sandbox_9ToiJHedw1nE1Jfx1qYYgz"]
storagestringOptional

PERSISTENT or VOLATILE storage

Example: ["PERSISTENT"]
Responses
200

OK

application/json
get
/aliases
GET /aliases?aliases=text HTTP/1.1
Host: {vault-id}.sandbox.vault-api.verygoodvault.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "data": {
    "tok_sandbox_5UpnbMvaihRuRwz5QXwBFw": {
      "value": "476673481",
      "classifiers": [
        "bank-account"
      ],
      "aliases": [
        {
          "value": "tok_sandbox_5UpnbMvaihRuRwz5QXwBFw",
          "format": "UUID"
        }
      ],
      "created_at": "2019-08-10T11:45:30Z",
      "storage": "VOLATILE"
    },
    "tok_sandbox_9ToiJHedw1nE1Jfx1qYYgz": {
      "value": "750360025",
      "classifiers": [
        "bank-account"
      ],
      "aliases": [
        {
          "value": "tok_sandbox_9ToiJHedw1nE1Jfx1qYYgz",
          "format": "UUID"
        }
      ],
      "created_at": "2019-08-10T11:45:30Z",
      "storage": "VOLATILE"
    }
  }
}

Create aliases

post
/aliases

Stores multiple values at once & returns their aliases. Alternatively, this endpoint may be used to associate additional (i.e. secondary) aliases with the same underlying data as the reference alias specified in the request body.

NOTE: You cannot reference the same alias more than once in a single request.

NOTE: metadata information fields of the alias classifiers, created_at and format are supported only for PERSISTENT storage, in case of VOLATILE storage these fields will be filled up with default values.

Authorizations
OAuth2clientCredentialsRequired

This api utilizes the OAuth2.0 Client Credentials flow utilizing VGS service account credentials

Token URL:
Available scopes:
  • : This scope will allow the client to read the the entire vault data object using the associated alias in order for this scope to work, the vault must be configured to reveal data by VGS Support.
  • : This scope will allow the client to create new aliases by value. If the value already has an alias in the requested alias format - it will return the current alias already created when fingerprinting is turned on, otherwise it will create a new alias.
  • : This scope will allow the client to delete any alias based upon the alias. This will only delete the alias, if the underlying value has more than one alias, the value is still retained in the vault until all associated aliases are removed.
Header parameters
Content-TypestringRequired

The media type of the resource being sent in the request body.

Example: application/json
Body
Responses
post
/aliases
POST /aliases HTTP/1.1
Host: {vault-id}.sandbox.vault-api.verygoodvault.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "data": [
    {
      "value": 122105155,
      "classifiers": [
        "bank-account"
      ],
      "format": "UUID",
      "storage": "PERSISTENT"
    }
  ]
}
{
  "data": [
    {
      "value": 122105155,
      "classifiers": [
        "bank-account"
      ],
      "aliases": [
        {
          "alias": "tok_sandbox_bhtsCwFUzoJMw9rWUfEV5e",
          "format": "UUID"
        }
      ],
      "created_at": "2019-05-15T12:30:45Z",
      "storage": "PERSISTENT"
    }
  ]
}

Batch Delete Aliases

post
/aliases/delete

Deletes multiple aliases.

Authorizations
OAuth2clientCredentialsRequired

This api utilizes the OAuth2.0 Client Credentials flow utilizing VGS service account credentials

Token URL:
Available scopes:
  • : This scope will allow the client to read the the entire vault data object using the associated alias in order for this scope to work, the vault must be configured to reveal data by VGS Support.
  • : This scope will allow the client to create new aliases by value. If the value already has an alias in the requested alias format - it will return the current alias already created when fingerprinting is turned on, otherwise it will create a new alias.
  • : This scope will allow the client to delete any alias based upon the alias. This will only delete the alias, if the underlying value has more than one alias, the value is still retained in the vault until all associated aliases are removed.
Header parameters
Content-TypestringRequired

The media type of the resource being sent in the request body.

Example: application/json
Body

Format for batch requests (limit 20)

datastring[]Optional
storagestring · enumOptionalPossible values:
Responses
post
/aliases/delete
POST /aliases/delete HTTP/1.1
Host: {vault-id}.sandbox.vault-api.verygoodvault.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60

"{\"data\":[\"123-13123-1232\"],\"storage\":\"PERSISTENT\"}"
No content

Reveal single alias

get
/aliases/{alias}

Retrieves a stored value along with its aliases.

NOTE: metadata information fields of the alias classifiers, created_at and format are supported only for PERSISTENT storage, in case of VOLATILE storage these fields will be filled up with default values.

Authorizations
OAuth2clientCredentialsRequired

This api utilizes the OAuth2.0 Client Credentials flow utilizing VGS service account credentials

Token URL:
Available scopes:
  • : This scope will allow the client to read the the entire vault data object using the associated alias in order for this scope to work, the vault must be configured to reveal data by VGS Support.
  • : This scope will allow the client to create new aliases by value. If the value already has an alias in the requested alias format - it will return the current alias already created when fingerprinting is turned on, otherwise it will create a new alias.
  • : This scope will allow the client to delete any alias based upon the alias. This will only delete the alias, if the underlying value has more than one alias, the value is still retained in the vault until all associated aliases are removed.
Path parameters
aliasstringRequired

Alias to operate on.

Example: tok_sandbox_bhtsCwFUzoJMw9rWUfEV5e
Query parameters
storagestring · enumOptionalDefault: PERSISTENTPossible values:
Responses
200

OK

application/json
get
/aliases/{alias}
GET /aliases/{alias} HTTP/1.1
Host: {vault-id}.sandbox.vault-api.verygoodvault.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "data": [
    {
      "value": 122105155,
      "classifiers": [
        "bank-account"
      ],
      "aliases": [
        {
          "alias": "tok_sandbox_bhtsCwFUzoJMw9rWUfEV5e",
          "format": "UUID"
        }
      ],
      "created_at": "2019-05-15T12:30:45Z",
      "storage": "PERSISTENT"
    }
  ]
}

Update data classifiers

put
/aliases/{alias}

Apply a new set of classifiers to the value that the specified alias is associated with. Note that this will replace existing classifiers.

NOTE: update operation is not supported for VOLATILE aliases.

NOTE: metadata information fields of the alias classifiers, created_at and format are supported only for PERSISTENT storage, in case of VOLATILE storage these fields will be filled up with default values.

Authorizations
OAuth2clientCredentialsRequired

This api utilizes the OAuth2.0 Client Credentials flow utilizing VGS service account credentials

Token URL:
Available scopes:
  • : This scope will allow the client to read the the entire vault data object using the associated alias in order for this scope to work, the vault must be configured to reveal data by VGS Support.
  • : This scope will allow the client to create new aliases by value. If the value already has an alias in the requested alias format - it will return the current alias already created when fingerprinting is turned on, otherwise it will create a new alias.
  • : This scope will allow the client to delete any alias based upon the alias. This will only delete the alias, if the underlying value has more than one alias, the value is still retained in the vault until all associated aliases are removed.
Path parameters
aliasstringRequired

Alias to operate on.

Example: tok_sandbox_bhtsCwFUzoJMw9rWUfEV5e
Body
Responses
put
/aliases/{alias}
PUT /aliases/{alias} HTTP/1.1
Host: {vault-id}.sandbox.vault-api.verygoodvault.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "data": {
    "classifiers": [
      "bank-account"
    ],
    "storage": "PERSISTENT"
  }
}
No content

Delete alias

delete
/aliases/{alias}

Removes a single alias.

Authorizations
OAuth2clientCredentialsRequired

This api utilizes the OAuth2.0 Client Credentials flow utilizing VGS service account credentials

Token URL:
Available scopes:
  • : This scope will allow the client to read the the entire vault data object using the associated alias in order for this scope to work, the vault must be configured to reveal data by VGS Support.
  • : This scope will allow the client to create new aliases by value. If the value already has an alias in the requested alias format - it will return the current alias already created when fingerprinting is turned on, otherwise it will create a new alias.
  • : This scope will allow the client to delete any alias based upon the alias. This will only delete the alias, if the underlying value has more than one alias, the value is still retained in the vault until all associated aliases are removed.
Path parameters
aliasstringRequired

Alias to operate on.

Example: tok_sandbox_bhtsCwFUzoJMw9rWUfEV5e
Query parameters
storagestring · enumOptionalDefault: PERSISTENTPossible values:
Responses
delete
/aliases/{alias}
DELETE /aliases/{alias} HTTP/1.1
Host: {vault-id}.sandbox.vault-api.verygoodvault.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content
PreviousResource LimitsNextVault API v1