Type Alias: ClientIdentity
Properties
| Property | Type | Required | Description |
|---|---|---|---|
participantId | string | Yes | Cortex participant UUID (the sub claim). (example: "0f4a7c1e-6a5b-4f28-9f7e-2b1d6b3c9a10") |
externalUserId | string | Yes | The game's own user identifier (the ext claim). (example: "steam:76561198000000000") |
projectId | string | Yes | Project the token is scoped to (the pid claim). (example: "abc123") |
displayName | string | No | Display name of the participant. |
gatheringId | string | No | Gathering the token is bound to (the gth claim). |
roomId | string | No | ODIN room the token is bound to (the rid claim). |
scopes | string[] | Yes | Capabilities of the token (the scp claim). (example: ["me","messages.read"]) |
expiresAt | string | Yes | When the token expires (ISO 8601). Fetch a new one from your backend before then. (example: "2026-09-22T12:15:00.000Z") |
userData | object | No | Arbitrary user data stored on the participant. |
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/client.ts:17