Core
Browser Tokens

Create Browser Tokens

Changed on

Creates format-preserving Browser Tokens for a browser automation session, along with the credentials for Evervault's browser proxy.

Pass the token values to your agent or browser instead of the sensitive values. When the browser sends a token value through the browser proxy to a hostname allowed by permissions, Evervault replaces it with the plaintext over the wire. Requests to any other hostname receive the token value.

Tokens can be reused until the ttl expires. Evervault doesn't store the mapping between token values and plaintext values.

Browser Tokens are in preview. Contact support@evervault.com for access.

post/browser-tokens

Request

Request body

ttlinteger

How long the tokens and proxy credentials remain valid, in seconds. Must be at least 1.

Use the shortest ttl that covers the expected session, including login, MFA, or human takeover.

externalCustomerReferencestring

An optional reference of your choice, such as a correlation ID, that is attached to the request. The reference will be visible in your logs. Must be between 1 and 255 characters.

Example request

{
  "data": [
    {
      "category": "card.number",
      "value": "ev:Tk9D:...:$",
      "id": "user-5577e072-primary-card-pan"
    }
  ],
  "permissions": [
    {
      "action": "decrypt",
      "target": "payments.example-merchant.com"
    }
  ],
  "ttl": 300,
  "proxySettings": {
    "type": "custom",
    "scheme": "https",
    "hostname": "egress-proxy.example.com",
    "port": 443,
    "username": "egress-proxy-user-1ef0172b",
    "password": "egress-proxy-password"
  },
  "externalCustomerReference": "00-4bf92f3577b34da6a3ce929d3e0e4736-00f067aa0ba902b7-01"
}

Response

The Browser Tokens have been created

sessionIdstring required

The unique identifier for the browser session. Activity for the session is logged under this ID.

Example response

{
  "sessionId": "browser_3eecefc9ac41",
  "data": [
    {
      "category": "card.number",
      "value": "4242424242424242",
      "id": "user-5577e072-primary-card-pan"
    }
  ],
  "proxyConfiguration": {
    "hostname": "us-va.browser.relay.evervault.app",
    "port": 443,
    "username": "app_6abed35d76b9",
    "password": "eyJ..."
  }
}

Changes