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.
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 generate 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.
Description
The email resource returns the email settings that have been configured for an organization. These settings can be used to send out email notifications from ArcGIS Enterprise portal about password policy updates and user type, add-on, or organization capability license expirations, and allow members with built-in account to use an email-based workflow to retrieve forgotten passwords. Email notifications regarding policy changes and expiration notices will be sent to members listed under the organization's administrative contacts.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usage
The following is a sample request URL used to access the email resource:
https://organization.example.com/<context>/portaladmin/system/emailSettings?f=pjsonJSON Response syntax
{
"accountId": "<Organization ID>",
"smtpHost": "<Host information>",
"smtpPort": <Port number>,
"mailFrom": "<Admin email address>",
"mailFromLabel": "<Admin email address apperance>",
"encryptionMethod": "<SSL | TLS | NONE>",
"authRequired": <true | false>,
"smtpUser": "<username for smtp account>", //Only required if authRequired is set to true
"smtpPass": "<password for smtp account>" //Only required if authRequired is set to true
}JSON Response examples
Example one: no authentication
The example below demonstrates a returned response when no authentication is required:
{
"accountId": "0123456789ABCDEF",
"smtpHost": "smtp.myorg.org",
"smtpPort": 25,
"mailFrom": "admin@myorg.org",
"mailFromLabel": "My Org Admin",
"encryptionMethod": "NONE",
"authRequired": false
}Example two: authentication required
The example below demonstrates a returned response when authentication is required. If auth is true, the smtp account username and password are also included in the response:
{
"accountId": "0123456789ABCDEF",
"smtpHost": "smtp.myorg.org",
"smtpPort": 25,
"mailFrom": "admin@myorg.org",
"mailFromLabel": "My Org Admin",
"encryptionMethod": "NONE",
"authRequired": true,
"smtpUser": "admin",
"smtpPass": "test1234"
}