Skip to content

CreateProfileRequest

Source code in docs_src/capo_transfer/types/create_profile_request.py 
16
17
18
19
20
21
22
23
24
class CreateProfileRequest(TypedDict, closed=True):
    as2_id: "capo_transfer.types.as2_id.As2Id"
    """<p>The <code>As2Id</code> is the <i>AS2-name</i>, as defined in the <a href="https://datatracker.ietf.org/doc/html/rfc4130">RFC 4130</a>. For inbound transfers, this is the <code>AS2-From</code> header for the AS2 messages sent from the partner. For outbound connectors, this is the <code>AS2-To</code> header for the AS2 messages sent to the partner using the <code>StartFileTransfer</code> API operation. This ID cannot include spaces.</p>"""
    profile_type: "capo_transfer.types.profile_type.ProfileType"
    """<p>Determines the type of profile to create:</p> <ul> <li> <p>Specify <code>LOCAL</code> to create a local profile. A local profile represents the AS2-enabled Transfer Family server organization or party.</p> </li> <li> <p>Specify <code>PARTNER</code> to create a partner profile. A partner profile represents a remote organization, external to Transfer Family.</p> </li> </ul>"""
    certificate_ids: NotRequired["capo_transfer.types.certificate_ids.CertificateIds"]
    """<p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>"""
    tags: NotRequired["capo_transfer.types.tags.Tags"]
    """<p>Key-value pairs that can be used to group and search for AS2 profiles.</p>"""

as2_id instance-attribute 

as2_id: As2Id

The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.

certificate_ids instance-attribute 

certificate_ids: NotRequired[CertificateIds]

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

profile_type instance-attribute 

profile_type: ProfileType

Determines the type of profile to create:

  • Specify LOCAL to create a local profile. A local profile represents the AS2-enabled Transfer Family server organization or party.

  • Specify PARTNER to create a partner profile. A partner profile represents a remote organization, external to Transfer Family.

tags instance-attribute 

tags: NotRequired[Tags]

Key-value pairs that can be used to group and search for AS2 profiles.