Skip to content
mercury framework
GitHub

Principal

Principal = object

Defined in: types/channel-types/index.ts:102

Who is talking, as the channel knows them. The channel builds it; the core turns it into the person (see Directory) every per-person id derives from.

optional claims?: Record<string, unknown>

Defined in: types/channel-types/index.ts:108

Raw claims the provider vouched for, when it has any.


optional displayName?: string

Defined in: types/channel-types/index.ts:106


id: string

Defined in: types/channel-types/index.ts:104

Stable id for this person within provider (Google Chat: users/<id>).


provider: PrincipalProvider

Defined in: types/channel-types/index.ts:105