Class: MtlsAuthSpec

namespace.v1.MtlsAuthSpec

Represents a MtlsAuthSpec.

Implements

• IMtlsAuthSpec

Constructors

constructor

• new MtlsAuthSpec(properties?): MtlsAuthSpec

Constructs a new MtlsAuthSpec.

Parameters

Name	Type	Description
properties?	IMtlsAuthSpec	Properties to set

Returns

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

Implementation of

IMtlsAuthSpec.acceptedClientCa

---

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

Implementation of

IMtlsAuthSpec.acceptedClientCaDeprecated

---

certificateFilters

• certificateFilters: ICertificateFilterSpec[]

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.

Implementation of

IMtlsAuthSpec.certificateFilters

---

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

Implementation of

IMtlsAuthSpec.enabled

Methods

toJSON

▸ toJSON(): Object

Converts this MtlsAuthSpec to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): MtlsAuthSpec

Creates a new MtlsAuthSpec instance using the specified properties.

Parameters

Name	Type	Description
properties?	IMtlsAuthSpec	Properties to set

Returns

MtlsAuthSpec

MtlsAuthSpec instance

---

decode

▸ decode(reader, length?): MtlsAuthSpec

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

MtlsAuthSpec

MtlsAuthSpec

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): MtlsAuthSpec

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

MtlsAuthSpec

MtlsAuthSpec

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

Parameters

Name	Type	Description
message	IMtlsAuthSpec	MtlsAuthSpec message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IMtlsAuthSpec	MtlsAuthSpec message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): MtlsAuthSpec

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

MtlsAuthSpec

MtlsAuthSpec

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for MtlsAuthSpec

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 MtlsAuthSpec message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	MtlsAuthSpec	MtlsAuthSpec
options?	IConversionOptions	Conversion options

Returns

Object

Plain object