Class: Principal
Principal is an authenticated caller identity computed by the server from trusted authentication context.
Implements
Constructors
constructor
• new Principal(properties?): Principal
Constructs a new Principal.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPrincipal | Properties to set |
Returns
Properties
name
• name: string
Identifier within that category (e.g., sub JWT claim, email address).
Implementation of
type
• type: string
Low-cardinality category of the principal (e.g., "jwt", "users").
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Principal to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Principal
Creates a new Principal instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPrincipal | Properties to set |
Returns
Principal instance
decode
▸ decode(reader, length?): Principal
Decodes a Principal message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
Principal
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Principal
Decodes a Principal message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Principal
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified Principal message. Does not implicitly temporal.api.common.v1.Principal.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IPrincipal | Principal message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Principal message, length delimited. Does not implicitly temporal.api.common.v1.Principal.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IPrincipal | Principal message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Principal
Creates a Principal message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Principal
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Principal
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a Principal message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Principal | Principal |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object