Access Tokens

Get token info

Returns stored information about a single access token. The token value itself is never returned - it is only shown once, when the token is created.

get/v1/tokens/{token}

Request

  • Base URL: https://your-emailengine-host
  • URL: https://your-emailengine-host/v1/tokens/{token}
  • Auth: HTTP bearer

Path parameters

tokenstring required

The token id, as reported by POST /v1/tokens and the token listing

Example:1bc12baf7f0d5e51fe0a4e0eda06e1be5b8d6cc2c66b95dc0fbe4d2e9f5d5e1a

Headers

x-ee-timeoutinteger

Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect

Example:30000

Response

Returns the stored token record. The token value is not included.

accountstring nullable

Account this token is bound to, or null for an instance-wide token

descriptionstring

Token description

metadatastring

Related metadata in JSON format

ipstring

IP address of the requester

remoteAddressstring

IP address of the client that created the token

scopesstring[]

Scopes this token is valid for

createdstring date-time

The time this token was created

expiresstring date-time

The time this token stops working. Absent for tokens that never expire

idstring

Token identifier (SHA-256 hash of the token)

Example response

{
  "account": "user123",
  "description": "Token description",
  "metadata": "{\"example\": \"value\"}",
  "ip": "127.0.0.1",
  "remoteAddress": "127.0.0.1",
  "scopes": [
    "api"
  ],
  "restrictions": {
    "referrers": [
      "*web.domain.org/*",
      "*.domain.org/*",
      "https://domain.org/*"
    ],
    "addresses": [
      "1.2.3.4",
      "5.6.7.8",
      "127.0.0.0/8"
    ],
    "rateLimit": {
      "maxRequests": 20,
      "timeWindow": 2
    }
  },
  "permissions": {
    "actions": [
      "read"
    ],
    "groups": [
      "message",
      "mailbox"
    ]
  },
  "created": "2021-02-17T13:43:18.860Z",
  "expires": "2021-02-17T14:43:18.860Z",
  "access": {
    "time": "2021-02-17T13:43:18.860Z",
    "ip": "127.0.0.1"
  },
  "id": "1bc12baf7f0d5e51fe0a4e0eda06e1be5b8d6cc2c66b95dc0fbe4d2e9f5d5e1a"
}

Changes

No recorded changes to this operation across all 1 revision of this API.