Skip to Content
LYNKORIADocs
HTTP API reference

Sessions and users

Messaging tokens and user suspension. Generated from the OpenAPI specification.

Messaging tokens and user suspension.

POST /v1/sessions/messaging-token

Mint a 10-minute Lynkoria messaging JWT for a user/device the product has authorized.

Authentication: Service key with scope messaging:write (Authorization: Bearer lynk_…), from your backend only.

Request body (application/json, required)

FieldTypeRequiredNotes
userIdstringYespattern ^[A-Za-z0-9._@-]{1,128}$
deviceIdstringYespattern ^[A-Za-z0-9._@-]{1,128}$
tenantIdstringNopattern ^[A-Za-z0-9._@-]{1,128}$; default "default"

Response 200 OK

FieldTypeRequiredNotes
tokenstringYes
expiresAtstringYes

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

POST /v1/users/{userId}/suspend

Suspend a user: stop token issuance, disconnect sockets, remove from active calls.

Authentication: Service key with scope users:write (Authorization: Bearer lynk_…), from your backend only.

Path parameters

FieldTypeRequiredNotes
userIdstringYespattern ^[A-Za-z0-9._@-]{1,128}$

Response 204 No content

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

DELETE /v1/users/{userId}/suspend

Lift a user suspension.

Authentication: Service key with scope users:write (Authorization: Bearer lynk_…), from your backend only.

Path parameters

FieldTypeRequiredNotes
userIdstringYespattern ^[A-Za-z0-9._@-]{1,128}$

Response 204 No content

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

On this page