PingOne Platform APIs

Notifications Settings (SMTP)

The SMTP notifications settings endpoints provide the ability to configure the organization’s own SMTP service to send email notifications for each environment, instead of the built-in email service of PingOne. These endpoints implement operations to read, update and reset the SMTP notification settings for the environment.

  • You need the Environment Admin role to perform operations on SMTP notifications settings resources.

  • You can configure only one SMTP server per environment.

Notifications settings (SMTP) properties

Property Type Mutability Description

host

String

Mutable

The organization’s SMTP server.

port

String

Mutable

The port used by the organization’s SMTP server to send emails. The default port is 465.

protocol

String

Read-only

The SMTP protocol used by the organization. Ports 25, 2525, and 587 use SMTP. All other ports use SMTPS.

username

String

Mutable

The organization’s SMTP server username.

password

String

Write-only

The organization’s SMTP server password. Encrypted.

environment.id

String

Read-only

The environment resource’s unique identifier.

from.name

String

Mutable

The email’s "from" name .

from.address

String

Mutable

The email’s "from" address.

replyTo.name

String

Mutable

The email’s "reply to" name.

replyTo.address

String

Mutable

The email’s "reply to" address.

Notifications settings (SMTP) events generated

Refer to Audit Reporting Events for the events generated.