PingOne Platform APIs

Update Notifications Settings (SMTP)

 

PUT {{apiPath}}/environments/{{envID}}/notificationsSettings/emailDeliverySettings

The PUT {{apiPath}}/environments/{{envID}}/notificationsSettings/emailDeliverySettings endpoint updates the SMTP notifications settings for the specified environment.

Prerequisites

Request Model
Property Type Required?

from.address

String

Optional

from.name

String

Optional

host

String

Required

password

String

Required

port

String

Optional

replyTo.address

String

Optional

replyTo.name

String

Optional

username

String

Required

Refer to the Notifications settings (SMTP) data model for full property descriptions.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "host": "email-smtp.amazonaws.com",
    "port": 465,
    "username": "smtp_username",
    "password": "{{password}}",
    "from": {
        "name": "from_name",
        "address": "from@pingidentity.com"
    },
    "replyTo": {
        "name": "reply_name",
        "address": "reply@pingidentity.com"
    }
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff --request PUT '{{apiPath}}/environments/{{envID}}/notificationsSettings/emailDeliverySettings' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data-raw '{
    "host": "email-smtp.amazonaws.com",
    "port": 465,
    "username": "smtp_username",
    "password": "{{password}}",
    "from": {
        "name": "from_name",
        "address": "from@pingidentity.com"
    },
    "replyTo": {
        "name": "reply_name",
        "address": "reply@pingidentity.com"
    }
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/notificationsSettings/emailDeliverySettings")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Put);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"    ""host"": ""email-smtp.amazonaws.com""," + "\n" +
@"    ""port"": 465," + "\n" +
@"    ""username"": ""smtp_username""," + "\n" +
@"    ""password"": ""{{password}}""," + "\n" +
@"    ""from"": {" + "\n" +
@"        ""name"": ""from_name""," + "\n" +
@"        ""address"": ""from@pingidentity.com""" + "\n" +
@"    }," + "\n" +
@"    ""replyTo"": {" + "\n" +
@"        ""name"": ""reply_name""," + "\n" +
@"        ""address"": ""reply@pingidentity.com""" + "\n" +
@"    }" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "{{apiPath}}/environments/{{envID}}/notificationsSettings/emailDeliverySettings"
  method := "PUT"

  payload := strings.NewReader(`{
    "host": "email-smtp.amazonaws.com",
    "port": 465,
    "username": "smtp_username",
    "password": "{{password}}",
    "from": {
        "name": "from_name",
        "address": "from@pingidentity.com"
    },
    "replyTo": {
        "name": "reply_name",
        "address": "reply@pingidentity.com"
    }
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Authorization", "Bearer {{accessToken}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
PUT /environments/{{envID}}/notificationsSettings/emailDeliverySettings HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "host": "email-smtp.amazonaws.com",
    "port": 465,
    "username": "smtp_username",
    "password": "{{password}}",
    "from": {
        "name": "from_name",
        "address": "from@pingidentity.com"
    },
    "replyTo": {
        "name": "reply_name",
        "address": "reply@pingidentity.com"
    }
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"host\": \"email-smtp.amazonaws.com\",\n    \"port\": 465,\n    \"username\": \"smtp_username\",\n    \"password\": \"{{password}}\",\n    \"from\": {\n        \"name\": \"from_name\",\n        \"address\": \"from@pingidentity.com\"\n    },\n    \"replyTo\": {\n        \"name\": \"reply_name\",\n        \"address\": \"reply@pingidentity.com\"\n    }\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/notificationsSettings/emailDeliverySettings")
  .method("PUT", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/notificationsSettings/emailDeliverySettings",
  "method": "PUT",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "host": "email-smtp.amazonaws.com",
    "port": 465,
    "username": "smtp_username",
    "password": "{{password}}",
    "from": {
      "name": "from_name",
      "address": "from@pingidentity.com"
    },
    "replyTo": {
      "name": "reply_name",
      "address": "reply@pingidentity.com"
    }
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'PUT',
  'url': '{{apiPath}}/environments/{{envID}}/notificationsSettings/emailDeliverySettings',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "host": "email-smtp.amazonaws.com",
    "port": 465,
    "username": "smtp_username",
    "password": "{{password}}",
    "from": {
      "name": "from_name",
      "address": "from@pingidentity.com"
    },
    "replyTo": {
      "name": "reply_name",
      "address": "reply@pingidentity.com"
    }
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests
import json

url = "{{apiPath}}/environments/{{envID}}/notificationsSettings/emailDeliverySettings"

payload = json.dumps({
  "host": "email-smtp.amazonaws.com",
  "port": 465,
  "username": "smtp_username",
  "password": "{{password}}",
  "from": {
    "name": "from_name",
    "address": "from@pingidentity.com"
  },
  "replyTo": {
    "name": "reply_name",
    "address": "reply@pingidentity.com"
  }
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/notificationsSettings/emailDeliverySettings');
$request->setMethod(HTTP_Request2::METHOD_PUT);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n    "host": "email-smtp.amazonaws.com",\n    "port": 465,\n    "username": "smtp_username",\n    "password": "{{password}}",\n    "from": {\n        "name": "from_name",\n        "address": "from@pingidentity.com"\n    },\n    "replyTo": {\n        "name": "reply_name",\n        "address": "reply@pingidentity.com"\n    }\n}');
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}
require "uri"
require "json"
require "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/notificationsSettings/emailDeliverySettings")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Put.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "host": "email-smtp.amazonaws.com",
  "port": 465,
  "username": "smtp_username",
  "password": "{{password}}",
  "from": {
    "name": "from_name",
    "address": "from@pingidentity.com"
  },
  "replyTo": {
    "name": "reply_name",
    "address": "reply@pingidentity.com"
  }
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"host\": \"email-smtp.amazonaws.com\",\n    \"port\": 465,\n    \"username\": \"smtp_username\",\n    \"password\": \"{{password}}\",\n    \"from\": {\n        \"name\": \"from_name\",\n        \"address\": \"from@pingidentity.com\"\n    },\n    \"replyTo\": {\n        \"name\": \"reply_name\",\n        \"address\": \"reply@pingidentity.com\"\n    }\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/notificationsSettings/emailDeliverySettings")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "PUT"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

200 OK

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/notificationsSettings/emailDeliverySettings"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        }
    },
    "host": "email-smtp.amazonaws.com",
    "port": 465,
    "protocol": "SMTPS",
    "username": "smtp_username",
    "from": {
        "name": "from_name",
        "address": "from@pingidentity.com"
    },
    "replyTo": {
        "name": "reply_name",
        "address": "reply@pingidentity.com"
    },
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "updatedAt": "2022-05-02T18:55:47.461Z"
}