Update - Email Settings

URL:: https://<root>/system/emailSettings/update
Methods:: POST
Version Introduced:: 10.8.1

Access requirements

Required privileges

The Portal Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.

Security and Infrastructure

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Portal Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.

Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generateToken operation in the Portal Directory API. For security reasons, all POST requests made to the Portal Administrator API must include a token in the request body.

Learn how to generate a token

Description

The update operation configures an organization's email settings. These settings will be used to send out email notifications from ArcGIS Enterprise portal regarding password policy updates and license expirations. Email notifications will be sent to your administrative contacts.

Request parameters

Parameter	Details
`smtpServer`	The IP address, or the fully qualified domain name (FDQN), of the SMTP Server. Example Use dark colors for code blocksCopy `1 smtpServer=smtp.myorg.org`
`fromEmailAddress`	The email address that will be used to send emails from the ArcGIS Enterprise portal. It is recommended that the user associated with this email address is listed under the Administrative Contacts for your organization. Example Example Use dark colors for code blocksCopy `1 fromEmailAddress=admin@myorg.org`
`fromEmailAddressLabel`	The label, or person, associated with the `fromEmailAddress`. This information will be displayed as the sender in the "From" line for all email notifications. Example Use dark colors for code blocksCopy `1 fromEmailAddressLabel=My Org Admin`
`authRequired`	Specifies if authentication is required (`true`) to connect with SMTP server specified above. Only basic authentication (`username` and `password`) is supported. The default is `false`. Values: `true` \| `false`
`username`	If `authRequired` is `true`, the `username` parameter specifies the username of a user who is authorized to access the SMTP server. The `username` parameter cannot be defined if `authRequired` is `false`. Example Example Use dark colors for code blocksCopy `1 username=smtpadmin`
`password`	If `authRequired` is `true`, the `password` parameter specifies the password associated the authorized user listed as the value for the `username` parameter. The `password` parameter cannot be defined if `authRequired` is `false`. Example Use dark colors for code blocksCopy `1 password=test1234`
`smtpPort`	The port the SMTP Server will communicate over. Some of the most common communication ports are 25, 465, and 587. The default value is 25. Example Use dark colors for code blocksCopy `1 smtpPort=25`
`encryptionMethod`	The encryption method for email messages sent from ArcGIS Enterprise portal. Values: `SSL` \| `TLS` \| `NONE`
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

Example usages

Example one: no authentication

The following is a sample POST request for the update operation that demonstrates configuring email settings without authentication:

Use dark colors for code blocksCopy
POST /<context>/portaladmin/system/emailSettings/update HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

smtpServer=smtp.myorg.org&fromEmailAddress=admin@myorg.org&fromEmailAddressLabel=My Org Admin&authRequired=false&smtpPort=25&encryptionMethod=NONE&f=pjson

Example two: authentication required

The following is a sample POST request for the update operation that demonstrates configuring email settings with authentication:

Use dark colors for code blocksCopy
POST /<example>/portaladmin/system/emailSettings/update HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

smtpServer=smtp.myorg.org&fromEmailAddress=admin@myorg.org&fromEmailAddressLabel=My Org Admin&authRequired=true&username=smtpadmin&password=test1234&smtpPort=25&encryptionMethod=NONE&f=pjson

JSON Response example

Use dark colors for code blocksCopy
{
  "status": "success",
  "recheckAfterSeconds": 10
}