Skip to main content

Type Alias: ClientIdentity

type ClientIdentity: components["schemas"]["ClientIdentity"];

Properties​

PropertyTypeRequiredDescription
participantIdstringYesCortex participant UUID (the sub claim). (example: "0f4a7c1e-6a5b-4f28-9f7e-2b1d6b3c9a10")
externalUserIdstringYesThe game's own user identifier (the ext claim). (example: "steam:76561198000000000")
projectIdstringYesProject the token is scoped to (the pid claim). (example: "abc123")
displayNamestringNoDisplay name of the participant.
gatheringIdstringNoGathering the token is bound to (the gth claim).
roomIdstringNoODIN room the token is bound to (the rid claim).
scopesstring[]YesCapabilities of the token (the scp claim). (example: ["me","messages.read"])
expiresAtstringYesWhen the token expires (ISO 8601). Fetch a new one from your backend before then. (example: "2026-09-22T12:15:00.000Z")
userDataobjectNoArbitrary user data stored on the participant.

Defined in​

odin-transcription-service/packages/cortex-typescript-sdk/src/resources/client.ts:17