Use the GET /dataStores endpoint to retrieve a list of all the data stores.

Status codes

Code Reason
200 Success.

DataStores - A collection of data stores.

Property Type Description
items array[DataStore] The actual list of data stores.

DataStore - The set of attributes used to configure a data store.

Property Type Description
id string The persistent, unique ID for the data store. It can be any combination of [a-zA-Z0-9._-]. This property is system-assigned if not specified.
maskAttributeValues boolean Whether attribute values should be masked in the log.
type * DataStoreType The data store type.

JdbcDataStore : DataStore - A JDBC data store.

Property Type Description
allowMultiValueAttributes boolean Indicates that this data store can select more than one record from a column and return the results as a multi-value attribute.
blockingTimeout integer The amount of time in milliseconds a request waits to get a connection from the connection pool before it fails. Omitting this attribute will set the value to the connection pool default.
connectionUrl string The default location of the JDBC database. This field is required if no mapping for JDBC database location and tags are specified.
connectionUrlTags array[JdbcTagConfig] The set of connection URLs and associated tags for this JDBC data store.
driverClass * string The name of the driver class used to communicate with the source database.
encryptedPassword string The encrypted password needed to access the database. If you do not want to update the stored value, this attribute should be passed back unchanged.
id string The persistent, unique ID for the data store. It can be any combination of [a-zA-Z0-9._-]. This property is system-assigned if not specified.
idleTimeout integer The length of time in minutes the connection can be idle in the pool before it is closed. Omitting this attribute will set the value to the connection pool default.
maskAttributeValues boolean Whether attribute values should be masked in the log.
maxPoolSize integer The largest number of database connections in the connection pool for the given data store. Omitting this attribute will set the value to the connection pool default.
minPoolSize integer The smallest number of database connections in the connection pool for the given data store. Omitting this attribute will set the value to the connection pool default.
name string The data store name with a unique value across all data sources. Omitting this attribute will set the value to a combination of the connection url and the username.
password string The password needed to access the database. GETs will not return this attribute. To update this field, specify the new value in this attribute.
type * DataStoreType The data store type.
userName * string The name that identifies the user when connecting to the database.
validateConnectionSql string A simple SQL statement used by PingFederate at runtime to verify that the database connection is still active and to reconnect if needed.

JdbcTagConfig - A JDBC data store’s connection URLs and tags configuration. This is required if no default JDBC database location is specified.

Property Type Description
tags string Tags associated with this data source.
connectionUrl * string The location of the JDBC database.
defaultSource boolean Whether this is the default connection. Defaults to false if not specified.

LdapDataStore : DataStore - A LDAP data store.

Property Type Description
binaryAttributes array[string] The list of LDAP attributes to be handled as binary data.
bindAnonymously boolean Whether username and password are required. The default value is false.
connectionTimeout integer The maximum number of milliseconds that a connection attempt should be allowed to continue before returning an error. A value of -1 causes the pool to wait indefinitely. Omitting this attribute will set the value to the default value.
createIfNecessary boolean Indicates whether temporary connections can be created when the Maximum Connections threshold is reached.
dnsTtl integer The maximum time in milliseconds that DNS information are cached. Omitting this attribute will set the value to the default value.
encryptedPassword string The encrypted password credential required to access the data store. If you do not want to update the stored value, this attribute should be passed back unchanged.
followLDAPReferrals boolean Follow LDAP Referrals in the domain tree. The default value is false. This property does not apply to PingDirectory as this functionality is configured in PingDirectory.
hostnames array[string] The default LDAP host names. This field is required if no mapping for host names and tags are specified.
hostnamesTags array[LdapTagConfig] The set of host names and associated tags for this LDAP data store.
id string The persistent, unique ID for the data store. It can be any combination of [a-zA-Z0-9._-]. This property is system-assigned if not specified.
ldapDnsSrvPrefix string The prefix value used to discover LDAP DNS SRV record. Omitting this attribute will set the value to the default value.
ldapType * LdapType A type that allows PingFederate to configure many provisioning settings automatically. The ‘UNBOUNDID_DS’ type has been deprecated, please use the ‘PING_DIRECTORY’ type instead.
ldapsDnsSrvPrefix string The prefix value used to discover LDAPs DNS SRV record. Omitting this attribute will set the value to the default value.
maskAttributeValues boolean Whether attribute values should be masked in the log.
maxConnections integer The largest number of active connections that can remain in each pool without releasing extra ones. Omitting this attribute will set the value to the default value.
maxWait integer The maximum number of milliseconds the pool waits for a connection to become available when trying to obtain a connection from the pool. Omitting this attribute or setting a value of -1 causes the pool not to wait at all and to either create a new connection or produce an error (when no connections are available).
minConnections integer The smallest number of connections that can remain in each pool, without creating extra ones. Omitting this attribute will set the value to the default value.
name string The data store name with a unique value across all data sources. Omitting this attribute will set the value to a combination of the hostname(s) and the principal.
password string The password credential required to access the data store. GETs will not return this attribute. To update this field, specify the new value in this attribute.
readTimeout integer The maximum number of milliseconds a connection waits for a response to be returned before producing an error. A value of -1 causes the connection to wait indefinitely. Omitting this attribute will set the value to the default value.
testOnBorrow boolean Indicates whether objects are validated before being borrowed from the pool.
testOnReturn boolean Indicates whether objects are validated before being returned to the pool.
timeBetweenEvictions integer The frequency, in milliseconds, that the evictor cleans up the connections in the pool. A value of -1 disables the evictor. Omitting this attribute will set the value to the default value.
type * DataStoreType The data store type.
useDnsSrvRecords boolean Use DNS SRV Records to discover LDAP server information. The default value is false.
useSsl boolean Connects to the LDAP data store using secure SSL/TLS encryption (LDAPS). The default value is false.
userDN string The username credential required to access the data store.
verifyHost boolean Verifies that the presented server certificate includes the address to which the client intended to establish a connection. Omitting this attribute will set the value to true.

LdapTagConfig - An LDAP data store’s hostnames and tags configuration. This is required if no default hostname is specified.

Property Type Description
tags string Tags associated with this data source.
defaultSource boolean Whether this is the default connection. Defaults to false if not specified.
hostnames * array[string] The LDAP host names.

CustomDataStore : DataStore - A custom data store.

Property Type Description
configuration * PluginConfiguration Plugin instance configuration.
id string The persistent, unique ID for the data store. It can be any combination of [a-zA-Z0-9._-]. This property is system-assigned if not specified.
maskAttributeValues boolean Whether attribute values should be masked in the log.
name * string The plugin instance name.
parentRef ResourceLink The reference to this plugin’s parent instance. The parent reference is only accepted if the plugin type supports parent instances.
Note: This parent reference is required if this plugin instance is used as an overriding plugin (e.g. connection adapter overrides)
pluginDescriptorRef * ResourceLink Reference to the plugin descriptor for this instance. The plugin descriptor cannot be modified once the instance is created.
Note: Ignored when specifying a connection’s adapter override.
type * DataStoreType The data store type.

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.

PluginConfiguration - Configuration settings for a plugin instance.

Property Type Description
fields array[ConfigField] List of configuration fields.
tables array[ConfigTable] List of configuration tables.

ConfigTable - A plugin configuration table populated with values.

Property Type Description
inherited boolean Whether this table is inherited from its parent instance. If true, the rows become read-only. The default value is false.
name * string The name of the table.
rows array[ConfigRow] List of table rows.

ConfigRow - A row of configuration values for a plugin configuration table.

Property Type Description
defaultRow boolean Whether this row is the default.
fields * array[ConfigField] The configuration fields in the row.

ConfigField - A plugin configuration field value.

Property Type Description
encryptedValue string For encrypted or hashed fields, this attribute contains the encrypted representation of the field’s value, if a value is defined. If you do not want to update the stored value, this attribute should be passed back unchanged.
inherited boolean Whether this field is inherited from its parent instance. If true, the value/encrypted value properties become read-only. The default value is false.
name * string The name of the configuration field.
value string The value for the configuration field. For encrypted or hashed fields, GETs will not return this attribute. To update an encrypted or hashed field, specify the new value in this attribute.