Theme switcher

Record a user activity log entry against a token.

Header Parameters

Acceptstring

Media type the client can parse. Always application/json for this API.

Default value
application/json
Enum values:
application/json
Authorizationstring

Body Parameters

userIDinteger Required

Numeric user ID. Used for audit context only; the canonical user lookup is via token.

tokenstring Required

User's SSO login token. Identifies which end-user this log entry belongs to.

messagestring Required

Free-form activity message, stored verbatim.

Response

200
Object

Log entry recorded.

Response Attributes

usersobject

Show child attributes

401
Object

Authentication failed. Common causes: missing Authorization header, malformed bearer token, token expired (tokens live 10 hours), or — on getToken itself — HMAC signature mismatch due to clock drift or wrong secret.

Response Attributes

messagestring

Human-readable failure reason. Safe to surface to integrators but not end-users.

errorstring

Alternative error message field used by a subset of endpoints (notably getToken and authentication failures). Integrators should check for both message and error when parsing failure responses.

responseinteger

Numeric status code echoing the HTTP status (e.g. 400, 401). Populated on most error paths; a few auth-layer failures omit it.

429
Object

Rate limit exceeded. The POST /getToken endpoint is rate-limited to five requests per minute per source IP; other endpoints may be throttled at the reverse-proxy layer in response to abusive traffic. Wait and retry with exponential backoff; the Retry-After header tells you the minimum wait in seconds.

Response Attributes

messagestring

Human-readable failure reason. Safe to surface to integrators but not end-users.

errorstring

Alternative error message field used by a subset of endpoints (notably getToken and authentication failures). Integrators should check for both message and error when parsing failure responses.

responseinteger

Numeric status code echoing the HTTP status (e.g. 400, 401). Populated on most error paths; a few auth-layer failures omit it.

Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot