Skip to main content
POST
Create User Token

Headers

x-sumvin-agent-key
string
required
x-sumvin-agent-id
string
required
X-Timestamp-Format
string

Controls how timestamp fields are serialized in JSON response bodies.

Default (header omitted or any other value): epoch milliseconds as integers. iso8601: UTC ISO 8601 strings of the form YYYY-MM-DDTHH:MM:SSZ.

Example: with X-Timestamp-Format: iso8601, the field value 1704067200000 becomes "2024-01-01T00:00:00Z".

Affected fields (recursively, in dicts and arrays): any field whose name ends in _at, plus the literal field names timestamp, period_start, and period_end. All other fields are passed through unchanged.

Only iso8601 is recognized. Any other value (or omitting the header) yields the default epoch-ms representation; the server does not reject unknown values, so this is documented as an example rather than an enum to keep generated clients permissive.

Example:

"iso8601"

Body

application/json
user_id
string
required

The ID of the user to scope the token to

Minimum string length: 1

Response

Successful Response

HAL-style hypermedia links for navigation and available actions.

token
string
required

The agent token (only returned once)

expires_at
integer
required

Token expiration timestamp in milliseconds