Open Source API Gateway

partner

Version

A trading partner, identified by its AS2 ID and its certificate. An as2Receiver accepts messages from it; an as2Sender sends messages to it.

Syntax

partner:
'$ref': <string>
as2Id: <string>
certificate: {}
partner:
  '$ref': <string>
  as2Id: <string>
  certificate: {}

Attributes

NameRequiredDefaultDescriptionExamples
$reffalse-Reference a component defined under components.-
as2Idfalse-AS2 ID of the partner. An as2Receiver assigns incoming messages to the partner by their AS2-From header; an as2Sender sends it as AS2-To. 1 to 128 printable ASCII characters, compared case-sensitively.ACME

Child Structure

ElementCardinalityDescription
certificate0..1Certificate of the partner in PEM format. The partner signs its messages and MDNs with it, and an as2Sender encrypts messages for it. Signatures are verified only against this certificate; certificates embedded in a message are never trusted.

Can be used in