Class: MtlsAuthSpec

Represents a MtlsAuthSpec.

Properties

acceptedClientCa

acceptedClientCa: Uint8Array

The ca cert(s) in PEM format that the clients can use for authentication and authorization. This must only be one value, but the CA can have a chain. temporal:versioning:min_version=v0.2.0

---

acceptedClientCaDeprecated

acceptedClientCaDeprecated: string

The base64 encoded ca cert(s) in PEM format that the clients can use for authentication and authorization. This must only be one value, but the CA can have a chain.

(-- api-linter: core::0140::base64=disabled --) Deprecated: Not supported after v0.2.0 api version. Use accepted_client_ca instead. temporal:versioning:max_version=v0.2.0

---

certificateFilters

certificateFilters: $Properties[]

Certificate filters which, if specified, only allow connections from client certificates whose distinguished name properties match at least one of the filters. This allows limiting access to specific end-entity certificates. Optional, default is empty.

---

enabled

enabled: boolean

Flag to enable mTLS auth (default: disabled). Note: disabling mTLS auth will cause existing mTLS connections to fail. temporal:versioning:min_version=v0.2.0

Methods

toJSON()

toJSON(): object

Converts this MtlsAuthSpec to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): MtlsAuthSpec & $Properties

Creates a new MtlsAuthSpec instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

MtlsAuthSpec & $Properties

MtlsAuthSpec instance

Call Signature

static create(properties?): MtlsAuthSpec

Creates a new MtlsAuthSpec instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

MtlsAuthSpec

MtlsAuthSpec instance

---

decode()

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

Decodes a MtlsAuthSpec 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

MtlsAuthSpec & $Properties

MtlsAuthSpec

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): MtlsAuthSpec & $Properties

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

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

MtlsAuthSpec & $Properties

MtlsAuthSpec

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 MtlsAuthSpec message. Does not implicitly temporal.api.cloud.namespace.v1.MtlsAuthSpec.verify|verify messages.

Parameters

message

$Properties

MtlsAuthSpec message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

Encodes the specified MtlsAuthSpec message, length delimited. Does not implicitly temporal.api.cloud.namespace.v1.MtlsAuthSpec.verify|verify messages.

Parameters

message

$Properties

MtlsAuthSpec message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): MtlsAuthSpec

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

Parameters

object

{[k: string]: any; }

Plain object

Returns

MtlsAuthSpec

MtlsAuthSpec

---

toObject()

static toObject(message, options?): object

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

Parameters

message

MtlsAuthSpec

MtlsAuthSpec

options?

IConversionOptions

Conversion options

Returns

object

Plain object