Endpoint: /sites/{siteid}/users/{userid}/as2outbound

Returns and updates user outbound AS2 parameters

Method & URL

GET https://[server URL]:[port]/admin/v2/sites/{siteId}/users/{userid}/as2outbound

GET Body Sample

Copy 
# @name usersList
GET https://{{host}}/admin/v2/sites/{{Siteid}}/users HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}
###

@Usersid = {{usersList.response.body.$.data[0].id}}
###
GET https://{{host}}/admin/v2/sites/{{Siteid}}/users/{{Usersid}}/as2outbound HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}
###

GET Response Body Sample

Copy 
{ "data": { "attributes": { }, "relationships": { }, "type": "AS2Outbound" } }

GET PowerShell Sample

Copy 
Write-Output "Users specific as2outbound information"
Write-Output "-----"
$as2outList = Invoke-RestMethod -Uri "$baseURL/v2/sites/$siteID/users/$userid/as2outbound" 
-Method 'GET' -Headers $authHeader
Write-Output $as2outList | ConvertTo-Json
foreach ($user in $as2outList.data)
{
    Write-Output ("User $($user.id): $($user.attributes.loginName)")
}

Method & URL

PATCH https://[server URL]:[port]/admin/v2/sites/{siteId}/users/{userid}/as2outbound

PATCH Body Sample

Copy 
###
PATCH https://{{host}}/admin/v2/sites/{{Siteid}}/users/{{Usersid}}/as2outbound HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}

{
  "data": {
    "type": "AS2outbound",
    "attributes": {
      "myId": "AS2_1",
      "partnerId": "AS2_4",
    "hotFolderPath": "C:\\Users\\DYelacic1951\\Desktop\\HOTBOX\\"
    }
  }
}
###

PATCH Response Body Sample

Copy 
{ "data": { "attributes": { }, "relationships": { }, "type": "AS2Outbound" } }

PATCH PowerShell Sample

Copy 
$update =
'{
  "data": {
    "type": "AS2outbound",
    "attributes": {
      "myId": "AS2_1",
      "partnerId": "AS2_4",
      "hotFolderPath": "C:\\Users\\DYelacic1951\\Desktop\\HOTBOX\\"
    }
  }
}'
$update = $update | ConvertFrom-Json
$update = $update | ConvertTo-Json -Depth 10
# update / patch
Write-Output "Update User specific as2outbound information"
Write-Output "-----"
$as2outboundList = Invoke-RestMethod -Uri "$baseURL/v2/sites/$siteID/users/$userid/as2outbound" 
-Method 'PATCH' -Headers $authHeader -Body $update
Write-Output $as2outboundList | ConvertTo-Json
foreach ($user in $as2outboundList.data)
{
    Write-Output ("User $($user.id): $($user.attributes.loginName)")
}