Use the PUT /serverSettings endpoint to update the server settings.

Status codes

Code Reason
200 Server Settings updated.
400 The request was improperly formatted or contained invalid fields.
404 Resource not found.
422 Validation error(s) occurred.

ServerSettings - Server configuration settings.

Property Type Description
captchaSettings CaptchaSettings Captcha Settings.
contactInfo ContactInfo Information that identifies the server.
emailServer EmailServerSettings Email Server Settings.
federationInfo FederationInfo Federation Info.
notifications NotificationSettings Notification settings for license and certificate expiration events.
rolesAndProtocols RolesAndProtocols Configure roles and protocols.

ContactInfo - Contact information.

Property Type Description
company string Company name.
email string Contact email address.
firstName string Contact first name.
lastName string Contact last name.
phone string Contact phone number.

NotificationSettings - Settings for notifications relating to licensing and certificate expiration.

Property Type Description
accountChangesNotificationPublisherRef ResourceLink Reference to the associated notification publisher for admin user account changes.
certificateExpirations CertificateExpirationNotificationSettings Settings for certificate expiration notifications.
licenseEvents LicenseEventNotificationSettings Settings for license event notifications.
metadataNotificationSettings MetadataEventNotificationSettings Settings for metadata update event notifications.
notifyAdminUserPasswordChanges boolean Determines whether admin users are notified through email when their account is changed.

LicenseEventNotificationSettings - Notification settings for licensing events.

Property Type Description
emailAddress * string The email address where notifications are sent.
notificationPublisherRef ResourceLink Reference to the associated notification publisher.

ResourceLink - A reference to a resource.

Property Type Description
id * string The ID of the resource.
location string A read-only URL that references the resource. If the resource is not currently URL-accessible, this property will be null.

CertificateExpirationNotificationSettings - Notification settings for certificate expiration events.

Property Type Description
emailAddress * string Email address where notifications are sent.
finalWarningPeriod * integer Time before certificate expiration when final warning is sent (in days).
initialWarningPeriod integer Time before certificate expiration when initial warning is sent (in days).
notificationPublisherRef ResourceLink Reference to the associated notification publisher.

MetadataEventNotificationSettings - Notification settings for metadata update events.

Property Type Description
emailAddress * string The email address where metadata update notifications are sent.
notificationPublisherRef ResourceLink Reference to the associated notification publisher.

RolesAndProtocols - Roles and protocols settings.

Property Type Description
enableIdpDiscovery boolean Enable IdP Discovery.
idpRole IdpRole Identity Provider (IdP) settings.
oauthRole OAuthRole OAuth role settings.
spRole SpRole Service Provider (SP) settings.

OAuthRole - OAuth role settings.

Property Type Description
enableOauth boolean Enable OAuth 2.0 Authorization Server (AS) Role.
enableOpenIdConnect boolean Enable Open ID Connect.

IdpRole : BaseProviderRole - Identity Provider (IdP) role settings.

Property Type Description
enable boolean Enable Identity Provider Role.
enableOutboundProvisioning boolean Enable Outbound Provisioning.
enableSaml10 boolean Enable SAML 1.0.
enableSaml11 boolean Enable SAML 1.1.
enableWsFed boolean Enable WS Federation.
enableWsTrust boolean Enable WS Trust.
saml20Profile SAML20Profile SAML 2.0 Profile settings.

SAML20Profile - SAML 2.0 Profile.

Property Type Description
enable boolean Enable SAML2.0 profile.
enableAutoConnect boolean This property has been deprecated and no longer used

SpSAML20Profile : SAML20Profile - SP SAML 2.0 Profile.

Property Type Description
enable boolean Enable SAML2.0 profile.
enableAutoConnect boolean This property has been deprecated and no longer used
enableXASP boolean Enable Attribute Requester Mapping for X.509 Attribute Sharing Profile (XASP)

SpRole : BaseProviderRole - Service Provider (SP) role settings.

Property Type Description
enable boolean Enable Service Provider Role.
enableInboundProvisioning boolean Enable Inbound Provisioning.
enableOpenIDConnect boolean Enable OpenID Connect.
enableSaml10 boolean Enable SAML 1.0.
enableSaml11 boolean Enable SAML 1.1.
enableWsFed boolean Enable WS Federation.
enableWsTrust boolean Enable WS Trust.
saml20Profile SpSAML20Profile SAML 2.0 Profile settings.

FederationInfo - Federation Info.

Property Type Description
autoConnectEntityId string This property has been deprecated and no longer used
baseUrl string The fully qualified host name, port, and path (if applicable) on which the PingFederate server runs.
saml1xIssuerId string This ID identifies your federation server for SAML 1.x transactions. As with SAML 2.0, it is usually defined as an organization’s URL or a DNS address. The SourceID used for artifact resolution is derived from this ID using SHA1.
saml1xSourceId string If supplied, the Source ID value entered here is used for SAML 1.x, instead of being derived from the SAML 1.x Issuer/Audience.
saml2EntityId string This ID defines your organization as the entity operating the server for SAML 2.0 transactions. It is usually defined as an organization’s URL or a DNS address; for example: pingidentity.com. The SAML SourceID used for artifact resolution is derived from this ID using SHA1.
wsfedRealm string The URI of the realm associated with the PingFederate server. A realm represents a single unit of security administration or trust.

EmailServerSettings - Email server configuration settings.

Property Type Description
emailServer * string The IP address or hostname of your email server.
encryptedPassword string For GET requests, this field contains the encrypted password, if one exists. For POST and PUT requests, if you wish to reuse the existing password, this field should be passed back unchanged.
password string User password. To update the password, specify the plaintext value in this field. This field will not be populated for GET requests.
port * integer The SMTP port on your email server. Allowable values: 1 - 65535. The default value is 25.
retryAttempts integer The number of times PingFederate tries to resend an email upon unsuccessful delivery. The default value is 2.
retryDelay integer The number of minutes PingFederate waits before the next retry attempt. The default value is 2.
sourceAddr * string The email address that appears in the ‘From’ header line in email messages generated by PingFederate. The address must be in valid format but need not be set up on your system.
sslPort integer The secure SMTP port on your email server. This field is not active unless Use SSL is enabled. Allowable values: 1 - 65535. The default value is 465.
timeout integer The amount of time in seconds that PingFederate will wait before it times out connecting to the SMTP server. Allowable values: 0 - 3600. The default value is 30.
useDebugging boolean Turns on detailed error messages for the PingFederate server log to help troubleshoot any problems.
useSSL boolean Requires the use of SSL/TLS on the port specified by ‘sslPort’. If this option is enabled, it overrides the ‘useTLS’ option.
useTLS boolean Requires the use of the STARTTLS protocol on the port specified by ‘port’.
username string Authorized email username. Required if the password is provided.
verifyHostname boolean If useSSL or useTLS is enabled, this flag determines whether the email server hostname is verified against the server’s SMTPS certificate.

CaptchaSettings - Settings for CAPTCHA.

Property Type Description
encryptedSecretKey string The encrypted secret key for reCAPTCHA. If you do not want to update the stored value, this attribute should be passed back unchanged.
secretKey string Secret key for reCAPTCHA. GETs will not return this attribute. To update this field, specify the new value in this attribute.
siteKey string Site key for reCAPTCHA.