Default settings

The API Publish configuration file (apipublish.properties) is located in the /pingidentity/apipublish/config/ directory. The following table explains the parameters and provides recommended values. You can change the default values based on your requirements.

Parameter Description

pi.apipublish.ssl.enabled-protocols

The supported SSL protocols. The default value is TLSv1.2.

pi.apipublish.ssl.ciphers

The supported .ssl ciphers. For the list of valid cipher names, see .oracle.com/en/java/javase/11/docs/specs/security/standard-names.html//[]. For multiple cipher names, use a comma to separate names in the list. For example: TLS_DHE_RSA_WITH_AES_256_GCM_SHA384,TLS_DHE_RSA_WITH_AES_256_CBC_SHA256.

pi.apipublish.ssl.key-store

The directory path of the key store. The default value is config/ssl/apipublish.jks.

pi.apipublish.ssl.key-store-type

The key store type. The default value is JKS.

pi.apipublish.ssl.key-store-password

The password of the JKS key store. PingIntelligence ships with a default obfuscated password. You can reset the password and obfuscate it.

pi.apipublish.ssl.key-alias

Alias for the SSL key. The default value is pingidentity.

pi.apipublish.server.port

Port for the API Publish Service and PingIntelligence Dashboard communication. The default value is 8050.

pi.apipublish.server.timezone

Set the time zone to utc or local. The default timezone is utc.

pi.apipublish.server.deployment_type

The API Publish Service deployment mode. Valid values are cloud or onprem. The default value is onprem.

pi.apipublish.datasource.data_dbname

The MongoDB data database name. The default value is abs_data.

pi.apipublish.datasource.metadata_dbname

The MongoDB metadata database name.The default value is abs_metadata.

pi.apipublish.datasource.mongo_rs

Comma separated MongoDB replica set URI.

pi.apipublish.datasource.mongo_ssl

Set to true if MongoDB is configured to use SSL connections. The default value is false.

pi.apipublish.datasource.mongo_auth_mechanism

Defines the method in which MongoDB authenticates. The possible values are:

NONE: Set to NONE if authentication is not configured in MongoDB.
DEFAULT: Set to DEFAULT if you want to use a native MongoDB username and password. Provide the values in the next two variables.
PLAIN: Set to PLAIN if you want to use LDAP authentication. In this case, provide the LDAP username and password in the next two variables.

pi.apipublish.datasource.mongo_certificate

Set to true if you want to verify MongoDB SSL server certificate when the API Publish Service connects to MongoDB. The default value is false.

Make sure pi.apipublishservice.datasource.mongo_ssl is set to true before setting pi.apipublishservice.datasource.mongo_certificate to true.

pi.apipublish.datasource.username

MongoDB username. The default value is absuser.

pi.apipublish.datasource.password

MongoDB password. The default value is abs123.