Creating SFTP profile of the DG server type

You must create an SFTP profile of the DG server type by using the PEM Partner Repository APIs. For more information, see PEM Partner Repository REST APIs. This configuration is applicable only for the SFTP Inbound Push and SFTP Outbound Pull direction.

  1. Create the profile configuration for the host identity key.
    1. Create an SG profile for the SSH key by providing the following details:
      Action Description
      Method POST
      URL 
      https://<ip:port>/mdrws/sponsors/<sponsorContext>/profileconfigurations/
      Sample Request 
      <create name="New_test" resourceType="SSH_KEY" 
subResourceType="SSH_KEY" serverType="SG" 
description="creating SG profile for SSH type">
</create>
      Sample Response 
      <success location="https://<ip:port>/mdrws/sponsors/
<sponsorContext>/profileconfigurations/56925906-9a14-469b-a52c-374de2fdfcb5" 
profileConfigurationKey="56925906-9a14-469b-a52c-374de2fdfcb5"/>
    2. Create a DG profile for the corresponding SG profile by providing the following details:
      Action Description
      Method POST
      URL 
      https://<ip:port>/mdrws/sponsors/<sponsorContext>/profileconfigurations/
      Sample Request Enter the value of profileConfigurationKey from the response in step 1(a) in parentProfileKey.
      <create name="New_test_DG" resourceType="SSH_KEY" 
subResourceType="SSH_KEY" parentProfileKey="56925906-9a14-469b-a52c-374de2fdfcb5" 
serverType="DG" description="creating DG profile for SSH type">
</create>
      Sample Response 
      <success location="https://<ip:port>/mdrws/sponsors/
<sponsorContext>/profileconfigurations/8923ea73-1d5f-48cd-9974-992fe079608e" 
profileConfigurationKey="8923ea73-1d5f-48cd-9974-992fe079608e"/>
      Context data parameter specific to the SFTPv2/v3/v4 predefined activity Enter the value of profileConfigurationKey in SponsorServerinfo > HostIdentityKeyProfileConfig.
    3. Create the SSH key type KNOWN_HOST_KEYS for the test and production environments by providing the following details:
      Action Description
      Method POST
      URL 
      https://<ip:port>/mdrws/sponsors/<sponsorContext>/managedsshkeys/
      Sample Request Enter the value of profileConfigurationKey from the response in step 1(c) in configurationId. 
      <create configurationId="8923ea73-1d5f-48cd-9974-992fe079608e">
    <configurationTypes>
        <ManagedSshKeyType 
            content="<managed SSH key type content>" 
            keyType="KNOWN_HOST_KEYS" type="TEST">
        </ManagedSshKeyType>
        <ManagedSshKeyType content="<managed SSH key type content>" 
            keyType="KNOWN_HOST_KEYS" type="PROD">
        </ManagedSshKeyType>
    </configurationTypes>
</create>
      Sample Response 
      <success location=" https://<ip:port>/mdrws/sponsors/
<sponsorContext>/managedsshkeys/4304814d-6178-4224-9f14-db9f6efb8f20" 
managedSshKeyKey="4304814d-6178-4224-9f14-db9f6efb8f20"/>
  2. Create the profile configuration for the user credentials.
    1. Create an SG profile configuration by providing the following details:
      Action Description
      Method POST
      URL 
      https://<ip:port>/mdrws/sponsors/<sponsorContext>/profileconfigurations/
      Sample Request 
      <create name="SG_userCred" resourceType="USER_CRED" 
subResourceType="USER_CRED" serverType="SG" 
description="creating SG profile for user cred type">
</create>
      Sample Response 
      <success location=" https://<ip:port>/mdrws/sponsors/
<sponsorContext>/profileconfigurations/f7470de2-07a9-4cc9-9286-1072d0e29d7d" 
profileConfigurationKey="f7470de2-07a9-4cc9-9286-1072d0e29d7d"/>
    2. Create a DG profile configuration for the corresponding SG profile by providing the following details:
      Action Description
      Method POST
      URL 
      https://<ip:port>/mdrws/sponsors/<sponsorContext>/profileconfigurations/
      Sample Request Enter the value of profileConfigurationKey from the response in step 2(a) in parentProfileKey.
      <create name="DG_userCred" resourceType="USER_CRED" 
subResourceType="USER_CRED" parentProfileKey="f7470de2-07a9-4cc9-9286-1072d0e29d7d" 
serverType="DG" description="creating DG profile for user cred type">
</create>
      Sample Response 
      <success location=" https://<ip:port>/mdrws/sponsors/
<sponsorContext>/profileconfigurations/d1068a48-1240-474b-8742-ee9b9b4b5470" 
profileConfigurationKey="d1068a48-1240-474b-8742-ee9b9b4b5470"/>
    3. Create the user credentials for the test and production environments by providing the following details:
      Action Description
      Method POST
      URL 
      https://<ip:port>/mdrws/sponsors/<sponsorContext>/managedusercredentials/
      Sample Request Enter the value of profileConfigurationKey from the response in step 2(b) in configurationId.
      <create configurationId="d1068a48-1240-474b-8742-ee9b9b4b5470">
    <configurationTypes>
        <ManagedUserCredentialType 
            passphrase="string" username="string" type="TEST"> 
        </ManagedUserCredentialType>
        <ManagedUserCredentialType 
            passphrase="string" username="string" type="PROD"> 
        </ManagedUserCredentialType>
    </configurationTypes>
</create>
      Sample Response 
      <success location="https://<ip:port>/mdrws/sponsors/
<sponsorContext>/managedusercredentials/417ad46a-8de6-4a44-b907-d561a27af9a8" 
managedUserCredentialKey="417ad46a-8de6-4a44-b907-d561a27af9a8"/>
  3. Create an SG profile for SFTP Inbound Push by providing the following details:
    Action Description
    Method POST
    URL 
    https://<ip:port>/mdrws/sponsors/<sponsorContext>/profileconfigurations/
    Sample Request 
    <create name="New_SG_SFTP" resourceType="SFTP" 
subResourceType="SFTP_INB_PUSH" serverType="SG" 
description="creating SG profile for SFTP Inbound Push">
</create>
    Sample Response 
    <success location="https://<ip:port>/mdrws/sponsors/
<sponsorContext>/profileconfigurations/21caefe0-e4cd-4353-97dc-902d6d32d7fd" 
profileConfigurationKey="21caefe0-e4cd-4353-97dc-902d6d32d7fd"/>
  4. Create a DG profile for the corresponding SG profile for SFTP Inbound Push by providing the following details:
    Action Description
    Method POST
    URL 
    https://<ip:port>/mdrws/sponsors/<sponsorContext>/profileconfigurations/
    Sample Request Enter the value of profileConfigurationKey from the response in step 3 in parentProfileKey.
    <create name="New_DG_SFTP" resourceType="SFTP" 
subResourceType="SFTP_INB_PUSH" parentProfileKey="21caefe0-e4cd-4353-97dc-902d6d32d7fd" 
serverType="DG" description="creating DG profile for SFTP Inbound Push">
</create>
    Sample Response 
    <success location="https://<ip:port>/mdrws/sponsors/
<sponsorContext>/profileconfigurations/0447a2a7-2eb9-4fce-83db-9407dc9f151c" 
profileConfigurationKey="0447a2a7-2eb9-4fce-83db-9407dc9f151c"/>
    Context data parameter specific to SFTPv2/v3/v4 predefined activity Enter the value of profileConfigurationKey in SponsorServerinfo > SFTPIBPushProfileConfig.
  5. Create an SFTP Inbound Push configuration for the DG profile by providing the following details:
    Action Description
    Method POST
    URL 
    https://<ip:port>/mdrws/sponsors/<sponsorContext>/sftpinboundpushs/
    Sample Request
    • Enter the value of DG profileConfigurationKey from the response in step 4 in configurationId.
    • Enter the value of DG profileConfigurationKey from the response in step 2(b) in userCredential.
    • Enter the value of DG profileConfigurationKey from the response in step 1(b) in sshKey.
    <create configurationId="0447a2a7-2eb9-4fce-83db-9407dc9f151c">
    <configurationTypes>
       <SftpInboundPushType type="TEST" host="string" port="17222"    
        preferredAuthenticationType="PASSWORD" userCredential="d1068a48-1240-474b-8742-ee9b9b4b5470">
            <sshKeys>
                <SftpInboundPushTypeKey keyType="KNOWN_HOST_KEYS" sshKey="8923ea73-1d5f-48cd-9974-992fe079608e ">
                </SftpInboundPushTypeKey>
            </sshKeys>
        </SftpInboundPushType>
    </configurationTypes>
    <configurationTypes>
        <SftpInboundPushType type="PROD" host="string" port="17222" 
        preferredAuthenticationType="PASSWORD" userCredential="d1068a48-1240-474b-8742-ee9b9b4b5470">
            <sshKeys>
                <SftpInboundPushTypeKey keyType="KNOWN_HOST_KEYS" sshKey="8923ea73-1d5f-48cd-9974-992fe079608e ">
                </SftpInboundPushTypeKey>
            </sshKeys>
        </SftpInboundPushType>
    </configurationTypes>
</create>
    Sample Response 
    <success configurationId="0447a2a7-2eb9-4fce-83db-9407dc9f151c" 
location="https://<ip:port>/mdrws/sponsors/<sponsorContext>/
sftpinboundpushs/916671af-c064-4aca-b88d-37719166bfc5" 
sftpInboundPushKey="916671af-c064-4aca-b88d-37719166bfc5"/>
  6. [Optional] Create the SSH Host identity key and user credentials for SFTP Outbound Pull.
    1. If the SFTP server for Inbound Push and Outbound Pull are the same:
      1. Enter the value of profileConfigurationKey from the response in step 1(b) in sshKey.
      2. Enter the value of profileConfigurationKey from the response in step 2(b) in userCredential.
    2. If the SFTP server for Inbound Push and Outbound Pull are different:
      1. Repeat steps 1 to 2.
      2. Enter the corresponding values of DG profileConfigurationKey in sshKey and userCredential.
  7. To create the SFTP Outbound Pull configuration, repeat steps 3 to 5.