WhiteboardService
Mint Whiteboard Join Token
Resolve caller access and mint a short-lived room admission token.
Request
curl --request POST \ \ --url 'https://api.testnet.polyester.com/v1/collab/whiteboards/123e4567-e89b-42d3-a456-426614174000:mint-join-token' \ --header 'Accept: */*' \ --header 'X-API-KEY-ID: YOUR_API_KEY_ID' \ --header 'X-API-TIMESTAMP: YOUR_API_TIMESTAMP' \ --header 'X-API-SIGNATURE: YOUR_API_SIGNATURE'
Responses
{
"access": {
"permissions": {
"canEdit": false,
"canManage": false,
"canView": false
},
"role": "VIEWER"
},
"accessVersion": "1",
"boardId": "123e4567-e89b-42d3-a456-426614174000",
"connectionId": "connection_01J5EXAMPLE",
"expiresAt": "2025-01-01T00:00:00Z",
"presence": {
"accountId": "3JhbSHqyH1M",
"role": "VIEWER"
},
"roomId": "123e4567-e89b-42d3-a456-426614174000",
"socketPath": "/connection/websocket",
"token": "share_01J5EXAMPLE000000000"
}Board identifier as a UUID string.
Board identifier as a UUID string.
123e4567-e89b-42d3-a456-426614174000Highest resolved role for the caller.
VIEWERWhether the caller may view metadata and join the room.
falseWhether the caller may edit board content in the room.
falseWhether the caller may manage sharing and board settings.
falseToken expiry time in UTC. Join tokens expire 5 minutes after issuance.
2025-01-01T00:00:00ZSigned short-lived room admission token.
share_01J5EXAMPLE000000000Room identifier the client should join. This is the board ID.
123e4567-e89b-42d3-a456-426614174000Unique connection identifier embedded in the token.
connection_01J5EXAMPLERealtime room URL the client should connect to.
/connection/websocketCaller account public ID.
3JhbSHqyH1MResolved board role for this join.
VIEWERAccess version embedded in the token; clients must refresh when the board access version changes.
1| Key | Status | Error | When |
|---|---|---|---|
| unauthenticated | 401 | Unauthenticated | Authentication required. |
| permission-denied | 403 | Permission Denied | Permission denied. |
| invalid-argument | 400 | Invalid Argument | Invalid argument. |
| not-found | 404 | Not Found | Not found. |
| unavailable | 503 | Unavailable | Service unavailable. |