Appearance
Interface: MintOptions
Properties
| Property | Type | Description |
|---|---|---|
apiKey | string | - |
apiSecret | string | - |
grants | Grants | - |
identity | string | Who the token is for: your string, such as app:user:123. Keep it to 200 characters, the most the control API's routes take for an identity. |
jti? | string | - |
metadata? | Record<string, unknown> | Your JSON, at most 4 096 bytes as UTF-8, kept with the session and never read. |
name? | string | The display name others in a room see. Keep it to 120 characters: POST /v1/tokens refuses a longer one, and a token minted here is not checked, so a longer one reaches every participant whole. |
now? | () => number | Test seam. Never set in production. |
ref? | string | Your own reference for the person, at most 120 characters, kept with the session and never read. |
ttlSec? | number | Seconds, 1–600. Default 300. A connect needs only a moment, and the session it opens outlives the token. |