Skip to main content

Class: Principal

Principal is an authenticated caller identity computed by the server from trusted authentication context.

Properties​

name​

name: string

Identifier within that category (e.g., sub JWT claim, email address).

type​

type: string

Low-cardinality category of the principal (e.g., "jwt", "users").

Methods​

toJSON()​

toJSON(): object

Converts this Principal to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Principal & $Properties

Creates a new Principal instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Principal & $Properties

Principal instance

Call Signature​

static create(properties?): Principal

Creates a new Principal instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Principal

Principal instance

decode()​

static decode(reader, length?): Principal & $Properties

Decodes a Principal message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

Principal & $Properties

Principal

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Principal & $Properties

Decodes a Principal message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Principal & $Properties

Principal

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified Principal message. Does not implicitly temporal.api.common.v1.Principal.verify|verify messages.

Parameters​

message​

$Properties

Principal message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified Principal message, length delimited. Does not implicitly temporal.api.common.v1.Principal.verify|verify messages.

Parameters​

message​

$Properties

Principal message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Principal

Creates a Principal message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

Principal

Principal

toObject()​

static toObject(message, options?): object

Creates a plain object from a Principal message. Also converts values to other types if specified.

Parameters​

message​

Principal

Principal

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object