- URL:
- https://<root>/system/emailSettings/update
- Methods:
POST
- Required Capability:
- Access allowed with the "Security and Infrastructure" privilege
- Version Introduced:
- 10.8.1
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 |
---|---|
| The IP address, or the fully qualified domain name (FDQN), of the SMTP Server. Example
|
| 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
|
| The label, or person, associated with the Example
|
| Specifies if authentication is required ( Values: |
| If Example Example
|
| If Example
|
| 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
|
| The encryption method for email messages sent from ArcGIS Enterprise portal. Values: |
| The response format. The default format is Values: |
Example usages
Example one: no authentication
The following is a sample POST request for the update
operation that demonstrates configuring email settings without authentication:
POST /webadaptor/portaladmin/system/emailSettings/update HTTP/1.1
Host: machine.domain.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:
POST /webadaptor/portaladmin/system/emailSettings/update HTTP/1.1
Host: machine.domain.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
{
"status": "success",
"recheckAfterSeconds": 10
}