openidConnectProvider - OpenID Connect Server Provider (openidConnectProvider)

OpenID Connect server provider

NameTypeDefaultDescription
idstringA unique configuration ID.
oauthProviderRefA reference to top level oauthProvider element (string).A reference to the ID of an OAuth provider.
issuerIdentifierstringSpecify an issuer identifier for the issuer of the response.
allowDefaultSsoCookieNamebooleanfalseWhen this property is set to true, the default SSO cookie name, ltpaToken2, is used if a custom SSO cookie name is not configured. If a custom cookie name is configured for SSO, that cookie name is used. If a custom cookie name is not configured and this property is set to false, an auto-generated SSO cookie name will be used.
jwkEnabledbooleanfalseEnables or disables JWK.
idTokenCacheEnabledbooleantrueEnable caching to save ID tokens in the database and in-memory cache.
jwkRotationTimeA period of time with minute precision720mAmount of time after which a new JWK will be generated. Specify a positive integer followed by a unit of time, which can be hours (h) or minutes (m). For example, specify 30 minutes as 30m. You can include multiple values in a single entry. For example, 1h30m is equivalent to 90 minutes.
jwkSigningKeySize
  • 4096
  • 2048
  • 1024
2048Size measured in bits of the signing key.
4096
4096 bits
2048
2048 bits
1024
1024 bits
signatureAlgorithm
  • HS256
  • RS256
  • none
HS256Specify the signature algorithm that will be used to sign the ID token.
HS256
HMAC using SHA-256 hash
RS256
RSASSA-PKCS-v1_5 using SHA-256 hash
none
No signature
keyStoreRefA reference to top level keyStore element (string).opKeyStoreA keystore containing the private key necessary for signing with an asymmetric algorithm.
keyAliasNamestringKey alias name to locate the private key for signing with an asymmetric algorithm.
trustStoreRefA reference to top level keyStore element (string).A keystore containing the public key necessary for verifying a signature of the JWT token.
sessionManagedbooleanfalseIndicate by true or false whether session management is supported. Default is false.
idTokenLifetimeA period of time with second precision2hTime that ID token is valid (seconds). Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

oauthProvider

A reference to the ID of an OAuth provider.

NameTypeDefaultDescription
httpsRequiredbooleantrueSSL communication between the OAuth client and provider is required.
authorizationGrantLifetimeA period of time with second precision604800Authorization grant lifetime (seconds). The equivalent provider parameter in the full application server profile is oauth20.max.authorization.grant.lifetime.seconds. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
authorizationCodeLifetimeA period of time with second precision60Authorization code lifetime (seconds). The equivalent provider parameter in the full application server profile is oauth20.code.lifetime.seconds. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
authorizationCodeLengthlong30Length of the generated authorization code. The equivalent provider parameter in the full application server profile is oauth20.code.length.
accessTokenLifetimeA period of time with second precision7200Time that access token is valid (seconds). The equivalent provider parameter in the full application server profile is oauth20.token.lifetime.seconds. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
accessTokenLengthlong40Length of the generated OAuth access token. The equivalent provider parameter in the full application server profile is oauth20.access.token.length.
issueRefreshTokenbooleantrueA value of false disables generation and the use of refresh tokens. The equivalent provider parameter in the full application server profile is oauth20.issue.refresh.token.
refreshTokenLengthlong50Length of generated refresh token. The equivalent provider parameter in the full application server profile is oauth20.refresh.token.length.
revokeAccessTokensWithRefreshTokensbooleantrueA value of false disables revocation of associated access tokens when a refresh token is revoked. The default value is true.
libraryRefA reference to top level library element (string).Reference to shared library containing the mediator plugin class.
allowPublicClientsbooleanfalseA value of false disables the access of public clients as detailed in the OAuth specification. The equivalent provider parameter in the full application server profile is oauth20.allow.public.clients.
authorizationFormTemplatestringtemplate.htmlURL of a custom authorization page template. The equivalent provider parameter in the full application server profile is oauth20.authorization.form.template.
authorizationErrorTemplatestringURL of a custom authorization error page template. The equivalent provider parameter in the full application server profile is oauth20.authorization.error.template.
customLoginURLstringlogin.jspURL of a custom login page. The equivalent provider parameter in the full application server profile is oauth20.authorization.loginURL.
autoAuthorizeParamstringautoauthzTo use auto authorization, append the autoAuthorize parameter to requests with a value of true. The equivalent provider parameter in the full application server profile is oauth20.autoauthorize.param.
autoAuthorizebooleanfalseTo use auto authorization, append the autoAuthorize parameter to requests with a value of true. The equivalent provider parameter in the full application server profile is oauth20.autoauthorize.param.
clientURISubstitutionsstringOptional value to replace client URI strings for dynamic hostnames. The equivalent provider parameter in the full application server profile is oauth20.client.uri.substitutions.
clientTokenCacheSizelongMaximum number of entries in the client token cache.
userClientTokenLimitlongToken limit for each user and client combination.
filterstringURI filter selects requests to be authorized by this provider. The equivalent provider parameter in the full application server profile is Filter.
characterEncodingstringSet request character encoding to this value. The equivalent provider parameter in the full application server profile is characterEncoding.
oauthOnlybooleantrueIf the value is true, then requests matching the filter must have an access token or they will be failed. If false, then matching requests will be checked for other authentication data if no access token is present. The equivalent provider parameter in the full application server profile is oauthOnly.
includeTokenInSubjectbooleantrueIf the value is true, add the com.ibm.wsspi.security.oauth20.token.WSOAuth20Token as a private credential. The equivalent provider parameter in the full application server profile is includeToken.
consentCacheEntryLifetimeA period of time with second precision1800Time that an entry in the consent cache is valid (seconds). Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
consentCacheSizelong
Min: 0
1000Maximum number of entries allowed in the consent cache.
accessTokenCacheEnabledbooleantrueEnable caching to save access tokens in the database and in-memory cache.
certAuthenticationbooleanfalseEnable the authentication of client certificate in the https request.
jwtAccessTokenbooleanfalseGenerate the Json Web Token, serialize it as a string and put in the place of the access token.
coverageMapSessionMaxAgeA period of time with second precision600The max-age value (seconds) for the cache-control header of the coverage map service. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
skipResourceOwnerValidationbooleanfalseIf the value is true, skip validation of resource owner.
logoutRedirectURLstringOptional URL that the client is redirected to after successfully invoking the logout endpoint. If a URL is not supplied, then a minimal default logout page is used.

oauthProvider > localStore

Clients are defined in server.xml and tokens are cached in the server.

NameTypeDefaultDescription
tokenStoreSizelong2000Token store size

oauthProvider > localStore > client

A unique configuration ID.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringName of the client (sometimes referred to as the Id).
secretReversably encoded password (string)Secret key of the client.
displaynamestringDisplay name of the client.
tokenEndpointAuthMethod
  • client_secret_post
  • none
  • client_secret_basic
client_secret_basicThe requested authentication method for the token endpoint of the client.
client_secret_post
client_secret_post
none
none
client_secret_basic
client_secret_basic
scopestringSpecify by spaces the list of scopes of the client.
applicationType
  • native
  • web
webThe type of application best describing the client.
native
native
web
web
subjectType
  • public
Subject type requested for response to this client.
public
public
sessionManagedbooleanfalseBoolean indicating whether the client participates in OpenID session management.
preAuthorizedScopestringSpace separated list of scope values that the client can use when requesting access tokens that are deemed to have been pre-approved by the resource owner and therefore does not require the resource owner's consent.
introspectTokensbooleanfalseBoolean value specifying whether the client is allowed to access the introspection endpoint to introspect tokens issued by the authorization server.
allowRegexpRedirectsbooleanfalseAllow redirect URLs to contain regular expressions. The default is false.
functionalUserIdstringA user identifier to be associated with access tokens obtained by this client using the client credentials grant type. When this client parameter is specified, the value is returned in the functional_user_id response parameter from the introspect endpoint.
enabledbooleantrueClient is enabled if true, disabled if false.

oauthProvider > localStore > client > redirect

Array of redirect URIs for use in redirect-based flows such as the authorization code and implicit grant types of the client. The first redirect URI is used as a default, when none is specified in a request.

oauthProvider > localStore > client > grantTypes

Grant types the client may use.

oauthProvider > localStore > client > responseTypes

Response types the client may use.

oauthProvider > localStore > client > postLogoutRedirectUris

Array of URLs supplied by the RP to which it may request that the end-user's user agent be redirected using the post_logout_redirect_uri parameter after a logout has been performed.

oauthProvider > localStore > client > resourceIds

The resource identifiers which are the audiences of the Json Web Token.

oauthProvider > localStore > client > functionalUserGroupIds

A list of group ids to be to be associated with access tokens obtained by this client using the client credentials grant type. When this client parameter is specified, the value is returned in the functional_user_groupIds response parameter from the introspect endpoint.

oauthProvider > databaseStore

Clients are defined and tokens are cached in the database.

NameTypeDefaultDescription
dataSourceRefA reference to top level dataSource element (string).Reference to the data source for the store.
cleanupExpiredTokenIntervalA period of time with second precision3600Expired token cleanup interval (seconds). The equivalent provider parameter in the full application server profile is oauthjdbc.CleanupInterval. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
userstringUser
passwordReversably encoded password (string)Password used to access the database.
schemastringOAuthDBSchemaSchema

oauthProvider > databaseStore > dataSource

Reference to the data source for the store.

NameTypeDefaultDescription
enableConnectionCastingbooleanfalseIndicates that connections obtained from the data source should be castable to interface classes that the JDBC vendor connection implementation implements. Enabling this option incurs additional overhead on each getConnection operation. If vendor JDBC interfaces are needed less frequently, it might be more efficient to leave this option disabled and use Connection.unwrap(interface) only where it is needed. If updated while the server is running, the update is applied with new connection requests; in-use connections are not impacted.
jndiNamestringJNDI name for a data source. If updated while the server is running, existing connections are destroyed.
jdbcDriverRefA reference to top level jdbcDriver element (string).JDBC driver for a data source. If updated while the server is running, existing connections are destroyed.
connectionManagerRefA reference to top level connectionManager element (string).Connection manager for a data source. If updated while the server is running, existing connections are destroyed.
type
  • javax.sql.DataSource
  • javax.sql.ConnectionPoolDataSource
  • javax.sql.XADataSource
Type of data source. If updated while the server is running, existing connections are destroyed.
javax.sql.DataSource
javax.sql.DataSource
javax.sql.ConnectionPoolDataSource
javax.sql.ConnectionPoolDataSource
javax.sql.XADataSource
javax.sql.XADataSource
connectionSharing
  • MatchOriginalRequest
  • MatchCurrentState
MatchOriginalRequestSpecifies how connections are matched for sharing.
MatchOriginalRequest
When sharing connections, match based on the original connection request.
MatchCurrentState
When sharing connections, match based on the current state of the connection. If updated while the server is running, the update is applied with each first connection handle in a transaction.
containerAuthDataRefA reference to top level authData element (string).Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER. If updated while the server is running, the change is applied with new connection requests; in-use connections are not impacted.
jaasLoginContextEntryRefA reference to top level jaasLoginContextEntry element (string).JAAS login context entry for authentication. If updated while the server is running, the update is applied with new connection requests; in-use connections are not impacted.
isolationLevel
  • TRANSACTION_SNAPSHOT
  • TRANSACTION_READ_UNCOMMITTED
  • TRANSACTION_READ_COMMITTED
  • TRANSACTION_SERIALIZABLE
  • TRANSACTION_REPEATABLE_READ
Default transaction isolation level. If unspecified and the database is identified as DB2, Derby, Informix, Microsoft SQL Server or Sybase, TRANSACTION_REPEATABLE_READ is used. If unspecified for other databases, TRANSACTION_READ_COMMITTED is used. If updated while the server is running, the update is applied with new connection requests; in-use connections are not impacted.
TRANSACTION_SNAPSHOT
Snapshot isolation for Microsoft SQL Server JDBC Driver and DataDirect Connect for JDBC driver.
TRANSACTION_READ_UNCOMMITTED
Dirty reads, non-repeatable reads and phantom reads can occur.
TRANSACTION_READ_COMMITTED
Dirty reads are prevented; non-repeatable reads and phantom reads can occur.
TRANSACTION_SERIALIZABLE
Dirty reads, non-repeatable reads and phantom reads are prevented.
TRANSACTION_REPEATABLE_READ
Dirty reads and non-repeatable reads are prevented; phantom reads can occur.
statementCacheSizeint
Min: 0
10Maximum number of cached statements per connection. If updated while the server is running, the statement cache is resized upon next use.
transactionalbooleantrueEnable participation in transactions that are managed by the application server. If updated while the server is running, existing connections are destroyed.
beginTranForResultSetScrollingAPIsbooleantrueAttempt transaction enlistment when result set scrolling interfaces are used.
beginTranForVendorAPIsbooleantrueAttempt transaction enlistment when vendor interfaces are used.
commitOrRollbackOnCleanup
  • rollback
  • commit
Determines how to clean up connections that might be in a database unit of work (AutoCommit=false) when the connection is closed or returned to the pool.
rollback
Clean up the connection by rolling back.
commit
Clean up the connection by committing.
queryTimeoutA period of time with second precisionDefault query timeout for SQL statements. In a JTA transaction, syncQueryTimeoutWithTransactionTimeout can override this default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
recoveryAuthDataRefA reference to top level authData element (string).Authentication data for transaction recovery.
syncQueryTimeoutWithTransactionTimeoutbooleanfalseUse the time remaining (if any) in a JTA transaction as the default query timeout for SQL statements.
supplementalJDBCTracebooleanSupplements the JDBC driver trace that is logged when JDBC driver trace is enabled in bootstrap.properties. JDBC driver trace specifications include: com.ibm.ws.database.logwriter, com.ibm.ws.db2.logwriter, com.ibm.ws.derby.logwriter, com.ibm.ws.informix.logwriter, com.ibm.ws.oracle.logwriter, com.ibm.ws.sqlserver.logwriter, com.ibm.ws.sybase.logwriter. If updated while the server is running, existing connections are destroyed.
validationTimeoutA period of time with second precisionSpecifies a timeout for validation of pooled connections. When specified, pooled connections are validated before being reused from the connection pool. The validation timeout is also used when the connection manager validates connections in response to a stale connection for PurgePolicy=ValidateAllConnections. A value of 0 means that connections are validated without applying any timeout. Validation timeout requires a JDBC driver that complies with the JDBC 4.0 specification or higher. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

oauthProvider > databaseStore > dataSource > jdbcDriver

JDBC driver for a data source. If updated while the server is running, existing connections are destroyed.

NameTypeDefaultDescription
libraryRefA reference to top level library element (string).Identifies JDBC driver JARs and native files.
javax.sql.XADataSourcestringJDBC driver implementation of javax.sql.XADataSource.
javax.sql.ConnectionPoolDataSourcestringJDBC driver implementation of javax.sql.ConnectionPoolDataSource.
javax.sql.DataSourcestringJDBC driver implementation of javax.sql.DataSource.

oauthProvider > databaseStore > dataSource > jdbcDriver > library

Identifies JDBC driver JARs and native files.

NameTypeDefaultDescription
namestringName of shared library for administrators
descriptionstringDescription of shared library for administrators
filesetRefList of references to top level fileset elements (comma-separated string).Id of referenced Fileset
apiTypeVisibilitystringspec,ibm-api,api,stableThe types of API packages that this class loader supports. This value is a comma-separated list of any combination of the following API packages: spec, ibm-api, api, stable, third-party.

oauthProvider > databaseStore > dataSource > jdbcDriver > library > fileset

Id of referenced Fileset

NameTypeDefaultDescription
idstringA unique configuration ID.
dirPath to a directory${server.config.dir}The base directory to search for files.
caseSensitivebooleantrueBoolean to indicate whether or not the search should be case sensitive (default: true).
includesstring*The comma or space separated list of file name patterns to include in the search results (default: *).
excludesstringThe comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded.
scanIntervalA period of time with millisecond precision0Scanning interval to check the fileset for changes as a long with a time unit suffix h-hour, m-minute, s-second, ms-millisecond (e.g. 2ms or 5s). Disabled (scanInterval=0) by default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

oauthProvider > databaseStore > dataSource > jdbcDriver > library > folder

Id of referenced folder

NameTypeDefaultDescription
idstringA unique configuration ID.
dirPath to a directoryDirectory or folder to be included in the library classpath for locating resource files

oauthProvider > databaseStore > dataSource > jdbcDriver > library > file

Id of referenced File

NameTypeDefaultDescription
idstringA unique configuration ID.
namePath to a fileFully qualified filename

oauthProvider > databaseStore > dataSource > connectionManager

Connection manager for a data source. If updated while the server is running, existing connections are destroyed.

NameTypeDefaultDescription
agedTimeoutA period of time with second precision-1Amount of time before a connection can be discarded by pool maintenance. A value of -1 disables this timeout. A value of 0 discards every connection, which disables connection pooling. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
connectionTimeoutA period of time with second precision30sAmount of time after which a connection request times out. A value of -1 disables this timeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
maxIdleTimeA period of time with second precision30mAmount of time a connection can be unused or idle until it can be discarded during pool maintenance, if doing so does not reduce the pool below the minimum size. A value of -1 disables this timeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
maxPoolSizeint
Min: 0
50Maximum number of physical connections for a pool. A value of 0 means unlimited.
minPoolSizeint
Min: 0
Minimum number of physical connections to maintain in the pool. The pool is not pre-populated. Aged timeout can override the minimum.
purgePolicy
  • FailingConnectionOnly
  • ValidateAllConnections
  • EntirePool
EntirePoolSpecifies which connections to destroy when a stale connection is detected in a pool.
FailingConnectionOnly
When a stale connection is detected, only the connection which was found to be bad is closed.
ValidateAllConnections
When a stale connection is detected, connections are tested and those found to be bad are closed.
EntirePool
When a stale connection is detected, all connections in the pool are marked stale, and when no longer in use, are closed.
reapTimeA period of time with second precision3mAmount of time between runs of the pool maintenance thread. A value of -1 disables pool maintenance. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
maxConnectionsPerThreadint
Min: 0
Limits the number of open connections on each thread.
numConnectionsPerThreadLocalint
Min: 0
Caches the specified number of connections for each thread.
enableSharingForDirectLookupsbooleantrueIf set to true, connections are shared. If set to false, connections are unshared.

oauthProvider > databaseStore > dataSource > properties.informix

Data source properties for the Informix JDBC driver.

NameTypeDefaultDescription
databaseNamestringJDBC driver property: databaseName.
ifxIFXHOSTstringlocalhostJDBC driver property: ifxIFXHOST.
serverNamestringServer where the database is running.
portNumberint1526Port on which to obtain database connections.
ifxCLIENT_LOCALEstringJDBC driver property: ifxCLIENT_LOCALE.
ifxCPMAgeLimitA period of time with second precisionJDBC driver property: ifxCPMAgeLimit. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
ifxCPMInitPoolSizeintJDBC driver property: ifxCPMInitPoolSize.
ifxCPMMaxConnectionsintJDBC driver property: ifxCPMMaxConnections.
ifxCPMMaxPoolSizeintJDBC driver property: ifxCPMMaxPoolSize.
ifxCPMMinAgeLimitA period of time with second precisionJDBC driver property: ifxCPMMinAgeLimit. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
ifxCPMMinPoolSizeintJDBC driver property: ifxCPMMinPoolSize.
ifxCPMServiceIntervalA period of time with millisecond precisionJDBC driver property: ifxCPMServiceInterval. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
ifxDBANSIWARNbooleanJDBC driver property: ifxDBANSIWARN.
ifxDBCENTURYstringJDBC driver property: ifxDBCENTURY.
ifxDBDATEstringJDBC driver property: ifxDBDATE.
ifxDBSPACETEMPstringJDBC driver property: ifxDBSPACETEMP.
ifxDBTEMPstringJDBC driver property: ifxDBTEMP.
ifxDBTIMEstringJDBC driver property: ifxDBTIME.
ifxDBUPSPACEstringJDBC driver property: ifxDBUPSPACE.
ifxDB_LOCALEstringJDBC driver property: ifxDB_LOCALE.
ifxDELIMIDENTbooleanJDBC driver property: ifxDELIMIDENT.
ifxENABLE_TYPE_CACHEbooleanJDBC driver property: ifxENABLE_TYPE_CACHE.
ifxFET_BUF_SIZEintJDBC driver property: ifxFET_BUF_SIZE.
ifxGL_DATEstringJDBC driver property: ifxGL_DATE.
ifxGL_DATETIMEstringJDBC driver property: ifxGL_DATETIME.
ifxIFX_AUTOFREEbooleanJDBC driver property: ifxIFX_AUTOFREE.
ifxIFX_DIRECTIVESstringJDBC driver property: ifxIFX_DIRECTIVES.
ifxIFX_LOCK_MODE_WAITA period of time with second precision2sJDBC driver property: ifxIFX_LOCK_MODE_WAIT. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
ifxIFX_SOC_TIMEOUTA period of time with millisecond precisionJDBC driver property: ifxIFX_SOC_TIMEOUT. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
ifxIFX_USEPUTbooleanJDBC driver property: ifxIFX_USEPUT.
ifxIFX_USE_STRENCbooleanJDBC driver property: ifxIFX_USE_STRENC.
ifxIFX_XASPECstringyJDBC driver property: ifxIFX_XASPEC.
ifxINFORMIXCONRETRYintJDBC driver property: ifxINFORMIXCONRETRY.
ifxINFORMIXCONTIMEA period of time with second precisionJDBC driver property: ifxINFORMIXCONTIME. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
ifxINFORMIXOPCACHEstringJDBC driver property: ifxINFORMIXOPCACHE.
ifxINFORMIXSTACKSIZEintJDBC driver property: ifxINFORMIXSTACKSIZE.
ifxJDBCTEMPstringJDBC driver property: ifxJDBCTEMP.
ifxLDAP_IFXBASEstringJDBC driver property: ifxLDAP_IFXBASE.
ifxLDAP_PASSWDstringJDBC driver property: ifxLDAP_PASSWD.
ifxLDAP_URLstringJDBC driver property: ifxLDAP_URL.
ifxLDAP_USERstringJDBC driver property: ifxLDAP_USER.
ifxLOBCACHEintJDBC driver property: ifxLOBCACHE.
ifxNEWCODESETstringJDBC driver property: ifxNEWCODESET.
ifxNEWLOCALEstringJDBC driver property: ifxNEWLOCALE.
ifxNODEFDACstringJDBC driver property: ifxNODEFDAC.
ifxOPTCOMPINDstringJDBC driver property: ifxOPTCOMPIND.
ifxOPTOFCstringJDBC driver property: ifxOPTOFC.
ifxOPT_GOALstringJDBC driver property: ifxOPT_GOAL.
ifxPATHstringJDBC driver property: ifxPATH.
ifxPDQPRIORITYstringJDBC driver property: ifxPDQPRIORITY.
ifxPLCONFIGstringJDBC driver property: ifxPLCONFIG.
ifxPLOAD_LO_PATHstringJDBC driver property: ifxPLOAD_LO_PATH.
ifxPROTOCOLTRACEintJDBC driver property: ifxPROTOCOLTRACE.
ifxPROTOCOLTRACEFILEstringJDBC driver property: ifxPROTOCOLTRACEFILE.
ifxPROXYstringJDBC driver property: ifxPROXY.
ifxPSORT_DBTEMPstringJDBC driver property: ifxPSORT_DBTEMP.
ifxPSORT_NPROCSbooleanJDBC driver property: ifxPSORT_NPROCS.
ifxSECURITYstringJDBC driver property: ifxSECURITY.
ifxSQLH_FILEstringJDBC driver property: ifxSQLH_FILE.
ifxSQLH_LOCstringJDBC driver property: ifxSQLH_LOC.
ifxSQLH_TYPEstringJDBC driver property: ifxSQLH_TYPE.
ifxSSLCONNECTIONstringJDBC driver property: ifxSSLCONNECTION.
ifxSTMT_CACHEstringJDBC driver property: ifxSTMT_CACHE.
ifxTRACEintJDBC driver property: ifxTRACE.
ifxTRACEFILEstringJDBC driver property: ifxTRACEFILE.
ifxTRUSTED_CONTEXTstringJDBC driver property: ifxTRUSTED_CONTEXT.
ifxUSEV5SERVERbooleanJDBC driver property: ifxUSEV5SERVER.
ifxUSE_DTENVbooleanJDBC driver property: ifxUSE_DTENV.
loginTimeoutA period of time with second precisionJDBC driver property: loginTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
passwordReversably encoded password (string)It is recommended to use a container managed authentication alias instead of configuring this property.
roleNamestringJDBC driver property: roleName.
userstringIt is recommended to use a container managed authentication alias instead of configuring this property.

oauthProvider > databaseStore > dataSource > properties.db2.i.native

Data source properties for the IBM DB2 for i Native JDBC driver.

NameTypeDefaultDescription
databaseNamestring*LOCALJDBC driver property: databaseName.
access
  • all
  • read call
  • read only
allJDBC driver property: access.
all
all
read call
read call
read only
read only
autoCommitbooleantrueJDBC driver property: autoCommit.
batchStyle
  • 2.0
  • 2.1
2.0JDBC driver property: batchStyle.
2.0
2.0
2.1
2.1
behaviorOverrideintJDBC driver property: behaviorOverride.
blockSize
  • 0
  • 256
  • 16
  • 512
  • 128
  • 8
  • 64
  • 32
32JDBC driver property: blockSize.
0
0
256
256
16
16
512
512
128
128
8
8
64
64
32
32
cursorHoldbooleanfalseJDBC driver property: cursorHold.
cursorSensitivity
  • asensitive
  • sensitive
asensitiveJDBC driver property: cursorSensitivity. Values are: 0 (TYPE_SCROLL_SENSITIVE_STATIC), 1 (TYPE_SCROLL_SENSITIVE_DYNAMIC), 2 (TYPE_SCROLL_ASENSITIVE).
asensitive
asensitive
sensitive
sensitive
dataTruncationstringtrueJDBC driver property: dataTruncation.
dateFormat
  • julian
  • dmy
  • ymd
  • usa
  • eur
  • mdy
  • iso
  • jis
JDBC driver property: dateFormat.
julian
julian
dmy
dmy
ymd
ymd
usa
usa
eur
eur
mdy
mdy
iso
iso
jis
jis
dateSeparator
  • \,
  • b
  • -
  • .
  • /
JDBC driver property: dateSeparator.
\,
The comma character (,).
b
The character b
-
The dash character (-).
.
The period character (.).
/
The forward slash character (/).
decimalSeparator
  • \,
  • .
JDBC driver property: decimalSeparator.
\,
The comma character (,).
.
The period character (.).
directMapbooleantrueJDBC driver property: directMap.
doEscapeProcessingbooleantrueJDBC driver property: doEscapeProcessing.
fullErrorsbooleanJDBC driver property: fullErrors.
librariesstringJDBC driver property: libraries.
lobThresholdint
Max: 500000
0JDBC driver property: lobThreshold.
lockTimeoutA period of time with second precision0JDBC driver property: lockTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
loginTimeoutA period of time with second precisionJDBC driver property: loginTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
maximumPrecision
  • 63
  • 31
31JDBC driver property: maximumPrecision.
63
63
31
31
maximumScaleint
Min: 0

Max: 63
31JDBC driver property: maximumScale.
minimumDivideScaleint
Min: 0

Max: 9
0JDBC driver property: minimumDivideScale.
networkProtocolintJDBC driver property: networkProtocol.
passwordReversably encoded password (string)It is recommended to use a container managed authentication alias instead of configuring this property.
portNumberintPort on which to obtain database connections.
prefetchbooleantrueJDBC driver property: prefetch.
queryOptimizeGoal
  • 1
  • 2
2JDBC driver property: queryOptimizeGoal. Values are: 1 (*FIRSTIO) or 2 (*ALLIO).
1
*FIRSTIO
2
*ALLIO
reuseObjectsbooleantrueJDBC driver property: reuseObjects.
serverNamestringServer where the database is running.
serverTraceCategoriesint0JDBC driver property: serverTraceCategories.
systemNamingbooleanfalseJDBC driver property: systemNaming.
timeFormat
  • usa
  • eur
  • iso
  • jis
  • hms
JDBC driver property: timeFormat.
usa
usa
eur
eur
iso
iso
jis
jis
hms
hms
timeSeparator
  • \,
  • b
  • :
  • .
JDBC driver property: timeSeparator.
\,
The comma character (,).
b
The character b
:
The colon character (:).
.
The period character (.).
tracebooleanJDBC driver property: trace.
transactionTimeoutA period of time with second precision0JDBC driver property: transactionTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
translateBinarybooleanfalseJDBC driver property: translateBinary.
translateHex
  • character
  • binary
characterJDBC driver property: translateHex.
character
character
binary
binary
useBlockInsertbooleanfalseJDBC driver property: useBlockInsert.
userstringIt is recommended to use a container managed authentication alias instead of configuring this property.

oauthProvider > databaseStore > dataSource > properties.derby.embedded

Data source properties for Derby Embedded JDBC driver.

NameTypeDefaultDescription
createDatabase
  • false
  • create
JDBC driver property: createDatabase.
false
Do not automatically create the database.
create
When the first connection is established, automatically create the database if it doesn't exist.
databaseNamestringJDBC driver property: databaseName.
connectionAttributesstringJDBC driver property: connectionAttributes.
loginTimeoutA period of time with second precisionJDBC driver property: loginTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
passwordReversably encoded password (string)It is recommended to use a container managed authentication alias instead of configuring this property.
shutdownDatabase
  • false
  • shutdown
JDBC driver property: shutdownDatabase.
false
Do not shut down the database.
shutdown
Shut down the database when a connection is attempted.
userstringIt is recommended to use a container managed authentication alias instead of configuring this property.

oauthProvider > databaseStore > dataSource > properties

List of JDBC vendor properties for the data source. For example, databaseName="dbname" serverName="localhost" portNumber="50000".

NameTypeDefaultDescription
databaseNamestringJDBC driver property: databaseName.
serverNamestringServer where the database is running.
portNumberintPort on which to obtain database connections.
URLstringURL for connecting to the database.
userstringIt is recommended to use a container managed authentication alias instead of configuring this property.
passwordReversably encoded password (string)It is recommended to use a container managed authentication alias instead of configuring this property.

oauthProvider > databaseStore > dataSource > properties.microsoft.sqlserver

Data source properties for Microsoft SQL Server JDBC Driver.

NameTypeDefaultDescription
databaseNamestringJDBC driver property: databaseName.
instanceNamestringJDBC driver property: instanceName.
serverNamestringlocalhostServer where the database is running.
portNumberintPort on which to obtain database connections.
accessTokenstringJDBC driver property: accessToken.
applicationIntent
  • ReadOnly
  • ReadWrite
JDBC driver property: applicationIntent.
ReadOnly
ReadOnly
ReadWrite
ReadWrite
applicationNamestringJDBC driver property: applicationName.
authentication
  • ActiveDirectoryPassword
  • ActiveDirectoryIntegrated
  • SqlPassword
  • NotSpecified
JDBC driver property: authentication.
ActiveDirectoryPassword
ActiveDirectoryPassword
ActiveDirectoryIntegrated
ActiveDirectoryIntegrated
SqlPassword
SqlPassword
NotSpecified
NotSpecified
authenticationScheme
  • JavaKerberos
  • NativeAuthentication
JDBC driver property: authenticationScheme.
JavaKerberos
JavaKerberos
NativeAuthentication
NativeAuthentication
columnEncryptionSetting
  • Enabled
  • Disabled
JDBC driver property: columnEncryptionSetting.
Enabled
Enabled
Disabled
Disabled
encryptbooleanJDBC driver property: encrypt.
failoverPartnerstringJDBC driver property: failoverPartner.
hostNameInCertificatestringJDBC driver property: hostNameInCertificate.
integratedSecuritybooleanJDBC driver property: integratedSecurity.
keyStoreAuthentication
  • JavaKeyStorePassword
JDBC driver property: keyStoreAuthentication.
JavaKeyStorePassword
JavaKeyStorePassword
keyStoreLocationPath to a fileJDBC driver property: keyStoreLocation.
keyStoreSecretReversably encoded password (string)JDBC driver property: keyStoreSecret.
lastUpdateCountbooleanJDBC driver property: lastUpdateCount.
lockTimeoutA period of time with millisecond precisionJDBC driver property: lockTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
loginTimeoutA period of time with second precisionJDBC driver property: loginTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
multiSubnetFailoverbooleanJDBC driver property: multiSubnetFailover.
packetSizeint
Min: -1

Max: 32767
JDBC driver property: packetSize.
passwordReversably encoded password (string)It is recommended to use a container managed authentication alias instead of configuring this property.
responseBuffering
  • adaptive
  • full
JDBC driver property: responseBuffering.
adaptive
adaptive
full
full
selectMethod
  • cursor
  • direct
JDBC driver property: selectMethod.
cursor
cursor
direct
direct
sendStringParametersAsUnicodebooleanfalseJDBC driver property: sendStringParametersAsUnicode.
sendTimeAsDatetimebooleanJDBC driver property: sendTimeAsDatetime.
serverNameAsACEbooleanJDBC driver property: serverNameAsACE.
serverSpnstringJDBC driver property: serverSpn.
transparentNetworkIPResolutionbooleanJDBC driver property: transparentNetworkIPResolution.
trustServerCertificatebooleanJDBC driver property: trustServerCertificate.
trustStorestringJDBC driver property: trustStore.
trustStorePasswordReversably encoded password (string)JDBC driver property: trustStorePassword.
URLstringURL for connecting to the database. Example: jdbc:sqlserver://localhost:1433;databaseName=myDB.
userstringIt is recommended to use a container managed authentication alias instead of configuring this property.
workstationIDstringJDBC driver property: workstationID.
xopenStatesbooleanJDBC driver property: xopenStates.

oauthProvider > databaseStore > dataSource > properties.oracle

Data source properties for Oracle JDBC driver.

NameTypeDefaultDescription
driverType
  • oci
  • thin
thinJDBC driver property: driverType.
oci
oci
thin
thin
databaseNamestringJDBC driver property: databaseName.
serverNamestringlocalhostServer where the database is running.
portNumberint1521Port on which to obtain database connections.
URLstringURL for connecting to the database. Examples: jdbc:oracle:thin:@//localhost:1521/sample or jdbc:oracle:oci:@//localhost:1521/sample.
connectionPropertiesstringJDBC driver property: connectionProperties.
loginTimeoutA period of time with second precisionJDBC driver property: loginTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
networkProtocolstringJDBC driver property: networkProtocol.
ONSConfigurationstringJDBC driver property: ONSConfiguration.
passwordReversably encoded password (string)It is recommended to use a container managed authentication alias instead of configuring this property.
roleNamestringJDBC driver property: roleName.
serviceNamestringJDBC driver property: serviceName.
TNSEntryNamestringJDBC driver property: TNSEntryName.
userstringIt is recommended to use a container managed authentication alias instead of configuring this property.

oauthProvider > databaseStore > dataSource > properties.derby.client

Data source properties for Derby Network Client JDBC driver.

NameTypeDefaultDescription
createDatabase
  • false
  • create
JDBC driver property: createDatabase.
false
Do not automatically create the database.
create
When the first connection is established, automatically create the database if it doesn't exist.
databaseNamestringJDBC driver property: databaseName.
serverNamestringlocalhostServer where the database is running.
portNumberint1527Port on which to obtain database connections.
connectionAttributesstringJDBC driver property: connectionAttributes.
loginTimeoutA period of time with second precisionJDBC driver property: loginTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
passwordReversably encoded password (string)It is recommended to use a container managed authentication alias instead of configuring this property.
retrieveMessageTextbooleantrueJDBC driver property: retrieveMessageText.
securityMechanism
  • 3
  • 4
  • 7
  • 8
  • 9
3JDBC driver property: securityMechanism. Values are: 3 (CLEAR_TEXT_PASSWORD_SECURITY), 4 (USER_ONLY_SECURITY), 7 (ENCRYPTED_PASSWORD_SECURITY), 8 (STRONG_PASSWORD_SUBSTITUTE_SECURITY), 9 (ENCRYPTED_USER_AND_PASSWORD_SECURITY).
3
CLEAR_TEXT_PASSWORD_SECURITY
4
USER_ONLY_SECURITY
7
ENCRYPTED_PASSWORD_SECURITY
8
STRONG_PASSWORD_SUBSTITUTE_SECURITY
9
ENCRYPTED_USER_AND_PASSWORD_SECURITY
shutdownDatabase
  • false
  • shutdown
JDBC driver property: shutdownDatabase.
false
Do not shut down the database.
shutdown
Shut down the database when a connection is attempted.
ssl
  • peerAuthentication
  • basic
  • off
JDBC driver property: ssl.
peerAuthentication
peerAuthentication
basic
basic
off
off
traceDirectorystringJDBC driver property: traceDirectory.
traceFilestringJDBC driver property: traceFile.
traceFileAppendbooleanJDBC driver property: traceFileAppend.
traceLevelintBitwise combination of the following constant values: TRACE_NONE=0, TRACE_CONNECTION_CALLS=1, TRACE_STATEMENT_CALLS=2, TRACE_RESULT_SET_CALLS=4, TRACE_DRIVER_CONFIGURATION=16, TRACE_CONNECTS=32, TRACE_DRDA_FLOWS=64, TRACE_RESULT_SET_META_DATA=128, TRACE_PARAMETER_META_DATA=256, TRACE_DIAGNOSTICS=512, TRACE_XA_CALLS=2048, TRACE_ALL=-1.
userstringIt is recommended to use a container managed authentication alias instead of configuring this property.

oauthProvider > databaseStore > dataSource > properties.datadirect.sqlserver

Data source properties for the DataDirect Connect for JDBC driver for Microsoft SQL Server.

NameTypeDefaultDescription
databaseNamestringJDBC driver property: databaseName.
serverNamestringlocalhostServer where the database is running.
portNumberintPort on which to obtain database connections.
accountingInfostringJDBC driver property: accountingInfo.
alternateServersstringJDBC driver property: alternateServers.
alwaysReportTriggerResultsbooleanJDBC driver property: alwaysReportTriggerResults.
applicationNamestringJDBC driver property: applicationName.
authenticationMethod
  • auto
  • ntlm
  • userIdPassword
  • kerberos
JDBC driver property: authenticationMethod.
auto
auto
ntlm
ntlm
userIdPassword
userIdPassword
kerberos
kerberos
bulkLoadBatchSizelongJDBC driver property: bulkLoadBatchSize.
bulkLoadOptionslongJDBC driver property: bulkLoadOptions.
clientHostNamestringJDBC driver property: clientHostName.
clientUserstringJDBC driver property: clientUser.
codePageOverridestringJDBC driver property: codePageOverride.
connectionRetryCountintJDBC driver property: connectionRetryCount.
connectionRetryDelayA period of time with second precisionJDBC driver property: connectionRetryDelay. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
convertNullintJDBC driver property: convertNull.
dateTimeInputParameterType
  • dateTime
  • dateTimeOffset
  • auto
JDBC driver property: dateTimeInputParameterType.
dateTime
dateTime
dateTimeOffset
dateTimeOffset
auto
auto
dateTimeOutputParameterType
  • dateTime
  • dateTimeOffset
  • auto
JDBC driver property: dateTimeOutputParameterType.
dateTime
dateTime
dateTimeOffset
dateTimeOffset
auto
auto
describeInputParameters
  • describeIfString
  • describeIfDateTime
  • noDescribe
  • describeAll
JDBC driver property: describeInputParameters.
describeIfString
describeIfString
describeIfDateTime
describeIfDateTime
noDescribe
noDescribe
describeAll
describeAll
describeOutputParameters
  • describeIfString
  • describeIfDateTime
  • noDescribe
  • describeAll
JDBC driver property: describeOutputParameters.
describeIfString
describeIfString
describeIfDateTime
describeIfDateTime
noDescribe
noDescribe
describeAll
describeAll
enableBulkLoadbooleanJDBC driver property: enableBulkLoad.
enableCancelTimeoutbooleanJDBC driver property: enableCancelTimeout.
encryptionMethod
  • noEncryption
  • loginSSL
  • requestSSL
  • SSL
JDBC driver property: encryptionMethod.
noEncryption
noEncryption
loginSSL
loginSSL
requestSSL
requestSSL
SSL
SSL
failoverGranularity
  • nonAtomic
  • disableIntegrityCheck
  • atomic
  • atomicWithRepositioning
JDBC driver property: failoverGranularity.
nonAtomic
nonAtomic
disableIntegrityCheck
disableIntegrityCheck
atomic
atomic
atomicWithRepositioning
atomicWithRepositioning
failoverMode
  • select
  • connect
  • extended
JDBC driver property: failoverMode.
select
select
connect
connect
extended
extended
failoverPreconnectbooleanJDBC driver property: failoverPreconnect.
hostNameInCertificatestringJDBC driver property: hostNameInCertificate.
initializationStringstringJDBC driver property: initializationString.
insensitiveResultSetBufferSizeintJDBC driver property: insensitiveResultSetBufferSize.
javaDoubleToStringbooleanJDBC driver property: javaDoubleToString.
JDBCBehavior
  • 0
  • 1
0JDBC driver property: JDBCBehavior. Values are: 0 (JDBC 4.0) or 1 (JDBC 3.0).
0
JDBC 4.0
1
JDBC 3.0
loadBalancingbooleanJDBC driver property: loadBalancing.
loginTimeoutA period of time with second precisionJDBC driver property: loginTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
longDataCacheSizeint
Min: -1
JDBC driver property: longDataCacheSize.
netAddressstringJDBC driver property: netAddress.
packetSizeint
Min: -1

Max: 128
JDBC driver property: packetSize.
passwordReversably encoded password (string)It is recommended to use a container managed authentication alias instead of configuring this property.
queryTimeoutA period of time with second precisionJDBC driver property: queryTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
resultsetMetaDataOptionsintJDBC driver property: resultsetMetaDataOptions.
selectMethod
  • cursor
  • direct
JDBC driver property: selectMethod.
cursor
cursor
direct
direct
snapshotSerializablebooleanJDBC driver property: snapshotSerializable.
spyAttributesstringJDBC driver property: spyAttributes.
stringInputParameterType
  • nvarchar
  • varchar
varcharJDBC driver property: stringInputParameterType.
nvarchar
nvarchar
varchar
varchar
stringOutputParameterType
  • nvarchar
  • varchar
varcharJDBC driver property: stringOutputParameterType.
nvarchar
nvarchar
varchar
varchar
suppressConnectionWarningsbooleanJDBC driver property: suppressConnectionWarnings.
transactionMode
  • explicit
  • implicit
JDBC driver property: transactionMode.
explicit
explicit
implicit
implicit
truncateFractionalSecondsbooleanJDBC driver property: truncateFractionalSeconds.
trustStorestringJDBC driver property: trustStore.
trustStorePasswordReversably encoded password (string)JDBC driver property: trustStorePassword.
userstringIt is recommended to use a container managed authentication alias instead of configuring this property.
useServerSideUpdatableCursorsbooleanJDBC driver property: useServerSideUpdatableCursors.
validateServerCertificatebooleanJDBC driver property: validateServerCertificate.
XATransactionGroupstringJDBC driver property: XATransactionGroup.
XMLDescribeType
  • longvarbinary
  • longvarchar
JDBC driver property: XMLDescribeType.
longvarbinary
longvarbinary
longvarchar
longvarchar

oauthProvider > databaseStore > dataSource > properties.informix.jcc

Data source properties for the IBM Data Server Driver for JDBC and SQLJ for Informix.

NameTypeDefaultDescription
databaseNamestringJDBC driver property: databaseName.
serverNamestringlocalhostServer where the database is running.
portNumberint1526Port on which to obtain database connections.
currentLockTimeoutA period of time with second precision2sJDBC driver property: currentLockTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
DBANSIWARNbooleanJDBC driver property: DBANSIWARN.
DBDATEstringJDBC driver property: DBDATE.
DBPATHstringJDBC driver property: DBPATH.
DBSPACETEMPstringJDBC driver property: DBSPACETEMP.
DBTEMPstringJDBC driver property: DBTEMP.
DBUPSPACEstringJDBC driver property: DBUPSPACE.
DELIMIDENTbooleanJDBC driver property: DELIMIDENT.
deferPreparesbooleanJDBC driver property: deferPrepares.
driverTypeint4JDBC driver property: driverType.
enableNamedParameterMarkersintJDBC driver property: enableNamedParameterMarkers. Values are: 1 (YES) or 2 (NO).
enableSeamlessFailoverintJDBC driver property: enableSeamlessFailover. Values are: 1 (YES) or 2 (NO).
enableSysplexWLBbooleanJDBC driver property: enableSysplexWLB.
fetchSizeintJDBC driver property: fetchSize.
fullyMaterializeLobDatabooleanJDBC driver property: fullyMaterializeLobData.
IFX_DIRECTIVES
  • OFF
  • ON
JDBC driver property: IFX_DIRECTIVES.
OFF
OFF
ON
ON
IFX_EXTDIRECTIVES
  • OFF
  • ON
JDBC driver property: IFX_EXTDIRECTIVES.
OFF
OFF
ON
ON
IFX_UPDDESCstringJDBC driver property: IFX_UPDDESC.
IFX_XASTDCOMPLIANCE_XAEND
  • 0
  • 1
JDBC driver property: IFX_XASTDCOMPLIANCE_XAEND.
0
0
1
1
INFORMIXOPCACHEstringJDBC driver property: INFORMIXOPCACHE.
INFORMIXSTACKSIZEstringJDBC driver property: INFORMIXSTACKSIZE.
keepDynamicintJDBC driver property: keepDynamic.
loginTimeoutA period of time with second precisionJDBC driver property: loginTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
NODEFDAC
  • no
  • yes
JDBC driver property: NODEFDAC.
no
no
yes
yes
OPTCOMPIND
  • 0
  • 1
  • 2
JDBC driver property: OPTCOMPIND.
0
0
1
1
2
2
OPTOFC
  • 0
  • 1
JDBC driver property: OPTOFC.
0
0
1
1
passwordReversably encoded password (string)It is recommended to use a container managed authentication alias instead of configuring this property.
PDQPRIORITY
  • HIGH
  • LOW
  • OFF
JDBC driver property: PDQPRIORITY.
HIGH
HIGH
LOW
LOW
OFF
OFF
progressiveStreaming
  • 1
  • 2
JDBC driver property: progressiveStreaming. Values are: 1 (YES) or 2 (NO).
1
YES
2
NO
PSORT_DBTEMPstringJDBC driver property: PSORT_DBTEMP.
PSORT_NPROCSstring
Max: 10
JDBC driver property: PSORT_NPROCS.
queryDataSizeint
Min: 4096

Max: 10485760
JDBC driver property: queryDataSize.
resultSetHoldability
  • 1
  • 2
JDBC driver property: resultSetHoldability. Values are: 1 (HOLD_CURSORS_OVER_COMMIT) or 2 (CLOSE_CURSORS_AT_COMMIT).
1
HOLD_CURSORS_OVER_COMMIT
2
CLOSE_CURSORS_AT_COMMIT
resultSetHoldabilityForCatalogQueries
  • 1
  • 2
JDBC driver property: resultSetHoldabilityForCatalogQueries. Values are: 1 (HOLD_CURSORS_OVER_COMMIT) or 2 (CLOSE_CURSORS_AT_COMMIT).
1
HOLD_CURSORS_OVER_COMMIT
2
CLOSE_CURSORS_AT_COMMIT
retrieveMessagesFromServerOnGetMessagebooleantrueJDBC driver property: retrieveMessagesFromServerOnGetMessage.
securityMechanism
  • 3
  • 4
  • 7
  • 9
JDBC driver property: securityMechanism. Values are: 3 (CLEAR_TEXT_PASSWORD_SECURITY), 4 (USER_ONLY_SECURITY), 7 (ENCRYPTED_PASSWORD_SECURITY), 9 (ENCRYPTED_USER_AND_PASSWORD_SECURITY).
3
CLEAR_TEXT_PASSWORD_SECURITY
4
USER_ONLY_SECURITY
7
ENCRYPTED_PASSWORD_SECURITY
9
ENCRYPTED_USER_AND_PASSWORD_SECURITY
STMT_CACHE
  • 0
  • 1
JDBC driver property: STMT_CACHE.
0
0
1
1
traceDirectorystringJDBC driver property: traceDirectory.
traceFilestringJDBC driver property: traceFile.
traceFileAppendbooleanJDBC driver property: traceFileAppend.
traceLevelintBitwise combination of the following constant values: TRACE_NONE=0, TRACE_CONNECTION_CALLS=1, TRACE_STATEMENT_CALLS=2, TRACE_RESULT_SET_CALLS=4, TRACE_DRIVER_CONFIGURATION=16, TRACE_CONNECTS=32, TRACE_DRDA_FLOWS=64, TRACE_RESULT_SET_META_DATA=128, TRACE_PARAMETER_META_DATA=256, TRACE_DIAGNOSTICS=512, TRACE_SQLJ=1024, TRACE_META_CALLS=8192, TRACE_DATASOURCE_CALLS=16384, TRACE_LARGE_OBJECT_CALLS=32768, TRACE_SYSTEM_MONITOR=131072, TRACE_TRACEPOINTS=262144, TRACE_ALL=-1.
useJDBC4ColumnNameAndLabelSemanticsintJDBC driver property: useJDBC4ColumnNameAndLabelSemantics. Values are: 1 (YES) or 2 (NO).
userstringIt is recommended to use a container managed authentication alias instead of configuring this property.

oauthProvider > databaseStore > dataSource > properties.db2.jcc

Data source properties for the IBM Data Server Driver for JDBC and SQLJ for DB2.

NameTypeDefaultDescription
driverType
  • 2
  • 4
4JDBC driver property: driverType.
2
Type 2 JDBC driver.
4
Type 4 JDBC driver.
databaseNamestringJDBC driver property: databaseName.
serverNamestringlocalhostServer where the database is running.
portNumberint50000Port on which to obtain database connections.
accountingIntervalstringJDBC driver property: accountingInterval.
activateDatabaseintJDBC driver property: activateDatabase.
affinityFailbackIntervalA period of time with second precisionJDBC driver property: affinityFailbackInterval. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
allowNextOnExhaustedResultSet
  • 1
  • 2
JDBC driver property: allowNextOnExhaustedResultSet.
1
YES
2
NO
allowNullResultSetForExecuteQuery
  • 1
  • 2
JDBC driver property: allowNullResultSetForExecuteQuery.
1
YES
2
NO
alternateGroupDatabaseNamestringJDBC driver property: alternateGroupDatabaseName.
alternateGroupPortNumberstringJDBC driver property: alternateGroupPortNumber.
alternateGroupServerNamestringJDBC driver property: alternateGroupServerName.
atomicMultiRowInsert
  • 1
  • 2
JDBC driver property: atomicMultiRowInsert.
1
YES
2
NO
blockingReadConnectionTimeoutA period of time with second precisionJDBC driver property: blockingReadConnectionTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
charOutputSizeshortJDBC driver property: charOutputSize.
clientApplcompatstringJDBC driver property: clientApplcompat.
clientAccountingInformationstringJDBC driver property: clientAccountingInformation.
clientApplicationInformationstringJDBC driver property: clientApplicationInformation.
clientBidiStringType
  • 11
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
JDBC driver property: clientBidiStringType.
11
BIDI_ST11
4
BIDI_ST4
5
BIDI_ST5
6
BIDI_ST6
7
BIDI_ST7
8
BIDI_ST8
9
BIDI_ST9
10
BIDI_ST10
clientDebugInfostring
Max: 254
JDBC driver property: clientDebugInfo.
clientProgramIdstring
Max: 80
JDBC driver property: clientProgramId.
clientProgramNamestring
Max: 12
JDBC driver property: clientProgramName.
clientRerouteAlternatePortNumberstringJDBC driver property: clientRerouteAlternatePortNumber.
clientRerouteAlternateServerNamestringJDBC driver property: clientRerouteAlternateServerName.
clientUserstringJDBC driver property: clientUser.
clientWorkstationstringJDBC driver property: clientWorkstation.
commandTimeoutA period of time with second precisionJDBC driver property: commandTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
concurrentAccessResolution
  • 1
  • 2
JDBC driver property: concurrentAccessResolution.
1
CONCURRENTACCESS_USE_CURRENTLY_COMMITTED
2
CONCURRENTACCESS_WAIT_FOR_OUTCOME
connectionCloseWithInFlightTransaction
  • 1
  • 2
JDBC driver property: connectionCloseWithInFlightTransaction.
1
CONNECTION_CLOSE_WITH_EXCEPTION
2
CONNECTION_CLOSE_WITH_ROLLBACK
connectionTimeoutA period of time with second precisionJDBC driver property: connectionTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
connectNodeint
Min: 0

Max: 999
JDBC driver property: connectNode.
currentAlternateGroupEntryintJDBC driver property: currentAlternateGroupEntry.
currentDegreestringJDBC driver property: currentDegree.
currentExplainModestring
Max: 254
JDBC driver property: currentExplainMode.
currentExplainSnapshotint
Max: 8
JDBC driver property: currentExplainSnapshot.
currentFunctionPathstringJDBC driver property: currentFunctionPath.
currentLocaleLcCtypestringJDBC driver property: currentLocaleLcCtype.
currentLockTimeoutA period of time with second precisionJDBC driver property: currentLockTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
currentMaintainedTableTypesForOptimization
  • SYSTEM
  • ALL
  • NONE
  • USER
JDBC driver property: currentMaintainedTableTypesForOptimization.
SYSTEM
SYSTEM
ALL
ALL
NONE
NONE
USER
USER
currentPackagePathstringJDBC driver property: currentPackagePath.
currentPackageSetstringJDBC driver property: currentPackageSet.
currentQueryOptimization
  • 0
  • 1
  • 2
  • 3
  • 5
  • 7
  • 9
JDBC driver property: currentQueryOptimization.
0
0
1
1
2
2
3
3
5
5
7
7
9
9
currentSQLIDstringJDBC driver property: currentSQLID.
currentSchemastringJDBC driver property: currentSchema.
cursorSensitivity
  • 0
  • 1
  • 2
JDBC driver property: cursorSensitivity. Values are: 0 (TYPE_SCROLL_SENSITIVE_STATIC), 1 (TYPE_SCROLL_SENSITIVE_DYNAMIC), 2 (TYPE_SCROLL_ASENSITIVE).
0
TYPE_SCROLL_SENSITIVE_STATIC
1
TYPE_SCROLL_SENSITIVE_DYNAMIC
2
TYPE_SCROLL_ASENSITIVE
dateFormat
  • 1
  • 2
  • 3
  • 4
JDBC driver property: dateFormat.
1
ISO
2
USA
3
EUR
4
JIS
decimalRoundingMode
  • 1
  • 2
  • 3
  • 4
  • 6
JDBC driver property: decimalRoundingMode.
1
ROUND_DOWN
2
ROUND_CEILING
3
ROUND_HALF_EVEN
4
ROUND_HALF_UP
6
ROUND_FLOOR
decimalSeparator
  • 1
  • 2
JDBC driver property: decimalSeparator.
1
DECIMAL_SEPARATOR_PERIOD
2
DECIMAL_SEPARATOR_COMMA
decimalStringFormat
  • 1
  • 2
JDBC driver property: decimalStringFormat.
1
DECIMAL_STRING_FORMAT_TO_STRING
2
DECIMAL_STRING_FORMAT_TO_PLAIN_STRING
deferPreparesbooleantrueJDBC driver property: deferPrepares.
downgradeHoldCursorsUnderXabooleanJDBC driver property: downgradeHoldCursorsUnderXa.
enableAlternateGroupSeamlessACRbooleanJDBC driver property: enableAlternateGroupSeamlessACR.
enableBidiLayoutTransformationbooleanJDBC driver property: enableBidiLayoutTransformation.
enableClientAffinitiesList
  • 1
  • 2
JDBC driver property: enableClientAffinitiesList. Values are: 1 (YES) or 2 (NO).
1
YES
2
NO
enableConnectionConcentratorbooleanJDBC driver property: enableConnectionConcentrator.
enableExtendedDescribe
  • 1
  • 2
JDBC driver property: enableExtendedDescribe.
1
YES
2
NO
enableExtendedIndicators
  • 1
  • 2
JDBC driver property: enableExtendedIndicators.
1
YES
2
NO
enableMultiRowInsertSupportbooleanJDBC driver property: enableMultiRowInsertSupport.
enableNamedParameterMarkers
  • 1
  • 2
JDBC driver property: enableNamedParameterMarkers. Values are: 1 (YES) or 2 (NO).
1
YES
2
NO
enableRowsetSupport
  • 1
  • 2
JDBC driver property: enableRowsetSupport.
1
YES
2
NO
enableSeamlessFailover
  • 1
  • 2
JDBC driver property: enableSeamlessFailover. Values are: 1 (YES) or 2 (NO).
1
YES
2
NO
enableSysplexWLBbooleanJDBC driver property: enableSysplexWLB.
enableT2zosLBF
  • 1
  • 2
JDBC driver property: enableT2zosLBF.
1
YES
2
NO
enableT2zosLBFSPResultSets
  • 1
  • 2
JDBC driver property: enableT2zosLBFSPResultSets.
1
YES
2
NO
enableXACleanTransactionbooleanJDBC driver property: enableXACleanTransaction.
encryptionAlgorithm
  • 1
  • 2
JDBC driver property: encryptionAlgorithm.
1
1
2
2
extendedTableInfo
  • 1
  • 2
JDBC driver property: extendedTableInfo.
1
YES
2
NO
fetchSizeintJDBC driver property: fetchSize.
fullyMaterializeInputStreamsbooleanJDBC driver property: fullyMaterializeInputStreams.
fullyMaterializeInputStreamsOnBatchExecution
  • 1
  • 2
JDBC driver property: fullyMaterializeInputStreamsOnBatchExecution.
1
YES
2
NO
fullyMaterializeLobDatabooleanJDBC driver property: fullyMaterializeLobData.
implicitRollbackOption
  • 0
  • 1
  • 2
JDBC driver property: implicitRollbackOption.
0
IMPLICIT_ROLLBACK_OPTION_NOT_SET
1
IMPLICIT_ROLLBACK_OPTION_NOT_CLOSE_CONNECTION
2
IMPLICIT_ROLLBACK_OPTION_CLOSE_CONNECTION
interruptProcessingMode
  • 0
  • 1
  • 2
JDBC driver property: interruptProcessingMode.
0
INTERRUPT_PROCESSING_MODE_DISABLED
1
INTERRUPT_PROCESSING_MODE_STATEMENT_CANCEL
2
INTERRUPT_PROCESSING_MODE_CLOSE_SOCKET
jdbcCollectionstringJDBC driver property: jdbcCollection.
keepAliveTimeOutA period of time with second precisionJDBC driver property: keepAliveTimeOut. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
keepDynamicintJDBC driver property: keepDynamic.
kerberosServerPrincipalstringJDBC driver property: kerberosServerPrincipal.
loginTimeoutA period of time with second precisionJDBC driver property: loginTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
maxConnCachedParamBufferSizeintJDBC driver property: maxConnCachedParamBufferSize.
maxRetriesForClientRerouteintJDBC driver property: maxRetriesForClientReroute.
maxRowsetSizeintJDBC driver property: maxRowsetSize.
maxTransportObjectsintJDBC driver property: maxTransportObjects.
memberConnectTimeoutA period of time with second precisionJDBC driver property: memberConnectTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
optimizationProfilestringJDBC driver property: optimizationProfile.
optimizationProfileToFlushstringJDBC driver property: optimizationProfileToFlush.
passwordReversably encoded password (string)It is recommended to use a container managed authentication alias instead of configuring this property.
pkListstringJDBC driver property: pkList.
profileNamestringJDBC driver property: profileName.
progressiveStreaming
  • 1
  • 2
JDBC driver property: progressiveStreaming. Values are: 1 (YES) or 2 (NO).
1
YES
2
NO
queryCloseImplicit
  • 1
  • 2
JDBC driver property: queryCloseImplicit. Values are: 1 (QUERY_CLOSE_IMPLICIT_YES) or 2 (QUERY_CLOSE_IMPLICIT_NO).
1
QUERY_CLOSE_IMPLICIT_YES
2
QUERY_CLOSE_IMPLICIT_NO
queryDataSizeint
Min: 4096

Max: 65535
JDBC driver property: queryDataSize.
queryTimeoutInterruptProcessingMode
  • 1
  • 2
JDBC driver property: queryTimeoutInterruptProcessingMode.
1
INTERRUPT_PROCESSING_MODE_STATEMENT_CANCEL
2
INTERRUPT_PROCESSING_MODE_CLOSE_SOCKET
readOnlybooleanJDBC driver property: readOnly.
recordTemporalHistory
  • 1
  • 2
JDBC driver property: recordTemporalHistory.
1
YES
2
NO
reportLongTypes
  • 1
  • 2
JDBC driver property: reportLongTypes.
1
YES
2
NO
resultSetHoldability
  • 1
  • 2
JDBC driver property: resultSetHoldability. Values are: 1 (HOLD_CURSORS_OVER_COMMIT) or 2 (CLOSE_CURSORS_AT_COMMIT).
1
HOLD_CURSORS_OVER_COMMIT
2
CLOSE_CURSORS_AT_COMMIT
resultSetHoldabilityForCatalogQueries
  • 1
  • 2
JDBC driver property: resultSetHoldabilityForCatalogQueries. Values are: 1 (HOLD_CURSORS_OVER_COMMIT) or 2 (CLOSE_CURSORS_AT_COMMIT).
1
HOLD_CURSORS_OVER_COMMIT
2
CLOSE_CURSORS_AT_COMMIT
retrieveMessagesFromServerOnGetMessagebooleantrueJDBC driver property: retrieveMessagesFromServerOnGetMessage.
retryIntervalForClientRerouteA period of time with second precisionJDBC driver property: retryIntervalForClientReroute. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
retryWithAlternativeSecurityMechanism
  • 1
  • 2
JDBC driver property: retryWithAlternativeSecurityMechanism.
1
YES
2
NO
returnAlias
  • 1
  • 2
JDBC driver property: returnAlias.
1
1
2
2
securityMechanism
  • 11
  • 12
  • 13
  • 3
  • 4
  • 15
  • 16
  • 7
  • 18
  • 9
JDBC driver property: securityMechanism. Values are: 3 (CLEAR_TEXT_PASSWORD_SECURITY), 4 (USER_ONLY_SECURITY), 7 (ENCRYPTED_PASSWORD_SECURITY), 9 (ENCRYPTED_USER_AND_PASSWORD_SECURITY), 11 (KERBEROS_SECURITY), 12 (ENCRYPTED_USER_AND_DATA_SECURITY), 13 (ENCRYPTED_USER_PASSWORD_AND_DATA_SECURITY), 15 (PLUGIN_SECURITY), 16 (ENCRYPTED_USER_ONLY_SECURITY), 18 (TLS_CLIENT_CERTIFICATE_SECURITY).
11
KERBEROS_SECURITY
12
ENCRYPTED_USER_AND_DATA_SECURITY
13
ENCRYPTED_USER_PASSWORD_AND_DATA_SECURITY
3
CLEAR_TEXT_PASSWORD_SECURITY
4
USER_ONLY_SECURITY
15
PLUGIN_SECURITY
16
ENCRYPTED_USER_ONLY_SECURITY
7
ENCRYPTED_PASSWORD_SECURITY
18
TLS_CLIENT_CERTIFICATE_SECURITY
9
ENCRYPTED_USER_AND_PASSWORD_SECURITY
sendCharInputsUTF8
  • 1
  • 2
JDBC driver property: sendCharInputsUTF8.
1
YES
2
NO
sendDataAsIsbooleanJDBC driver property: sendDataAsIs.
serverBidiStringType
  • 11
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
JDBC driver property: serverBidiStringType.
11
BIDI_ST11
4
BIDI_ST4
5
BIDI_ST5
6
BIDI_ST6
7
BIDI_ST7
8
BIDI_ST8
9
BIDI_ST9
10
BIDI_ST10
sessionTimeZonestringJDBC driver property: sessionTimeZone.
sqljCloseStmtsWithOpenResultSetbooleanJDBC driver property: sqljCloseStmtsWithOpenResultSet.
sqljEnableClassLoaderSpecificProfilesbooleanJDBC driver property: sqljEnableClassLoaderSpecificProfiles.
ssidstringJDBC driver property: ssid.
sslCertLocationstringJDBC driver property: sslCertLocation.
SSLCipherSuitesstringJDBC driver property: SSLCipherSuites.
sslConnectionbooleanJDBC driver property: sslConnection.
sslTrustStoreLocationstringJDBC driver property: sslTrustStoreLocation.
sslTrustStorePasswordReversably encoded password (string)JDBC driver property: sslTrustStorePassword.
sslTrustStoreTypestringJDBC driver property: sslTrustStoreType.
statementConcentrator
  • 1
  • 2
JDBC driver property: statementConcentrator.
1
STATEMENT_CONCENTRATOR_OFF
2
STATEMENT_CONCENTRATOR_WITH_LITERALS
streamBufferSizeintJDBC driver property: streamBufferSize.
stripTrailingZerosForDecimalNumbers
  • 1
  • 2
JDBC driver property: stripTrailingZerosForDecimalNumbers.
1
YES
2
NO
sysSchemastringJDBC driver property: sysSchema.
timeFormat
  • 1
  • 2
  • 3
  • 4
JDBC driver property: timeFormat.
1
ISO
2
USA
3
EUR
4
JIS
timerLevelForQueryTimeOut
  • 1
  • 2
  • -1
JDBC driver property: timerLevelForQueryTimeOut.
1
QUERYTIMEOUT_STATEMENT_LEVEL
2
QUERYTIMEOUT_CONNECTION_LEVEL
-1
QUERYTIMEOUT_DISABLED
timestampFormat
  • 1
  • 5
JDBC driver property: timestampFormat.
1
ISO
5
JDBC
timestampOutputType
  • 1
  • 2
JDBC driver property: timestampOutputType.
1
JDBC_TIMESTAMP
2
JCC_DBTIMESTAMP
timestampPrecisionReporting
  • 1
  • 2
JDBC driver property: timestampPrecisionReporting.
1
TIMESTAMP_JDBC_STANDARD
2
TIMESTAMP_ZERO_PADDING
traceDirectorystringJDBC driver property: traceDirectory.
traceFilestringJDBC driver property: traceFile.
traceFileAppendbooleanJDBC driver property: traceFileAppend.
traceFileCountintJDBC driver property: traceFileCount.
traceFileSizeintJDBC driver property: traceFileSize.
traceLevelint0Bitwise combination of the following constant values: TRACE_NONE=0, TRACE_CONNECTION_CALLS=1, TRACE_STATEMENT_CALLS=2, TRACE_RESULT_SET_CALLS=4, TRACE_DRIVER_CONFIGURATION=16, TRACE_CONNECTS=32, TRACE_DRDA_FLOWS=64, TRACE_RESULT_SET_META_DATA=128, TRACE_PARAMETER_META_DATA=256, TRACE_DIAGNOSTICS=512, TRACE_SQLJ=1024, TRACE_META_CALLS=8192, TRACE_DATASOURCE_CALLS=16384, TRACE_LARGE_OBJECT_CALLS=32768, TRACE_SYSTEM_MONITOR=131072, TRACE_TRACEPOINTS=262144, TRACE_ALL=-1.
traceOption
  • 0
  • 1
JDBC driver property: traceOption
0
0
1
1
translateForBitData
  • 1
  • 2
JDBC driver property: translateForBitData.
1
HEX_REPRESENTATION
2
SERVER_ENCODING_REPRESENTATION
updateCountForBatch
  • 1
  • 2
JDBC driver property: updateCountForBatch.
1
NO_UPDATE_COUNT
2
TOTAL_UPDATE_COUNT
useCachedCursorbooleanJDBC driver property: useCachedCursor.
useIdentityValLocalForAutoGeneratedKeysbooleanJDBC driver property: useIdentityValLocalForAutoGeneratedKeys.
useJDBC4ColumnNameAndLabelSemantics
  • 1
  • 2
JDBC driver property: useJDBC4ColumnNameAndLabelSemantics. Values are: 1 (YES) or 2 (NO).
1
YES
2
NO
useJDBC41DefinitionForGetColumns
  • 1
  • 2
JDBC driver property: useJDBC41DefinitionForGetColumns.
1
YES
2
NO
userstringIt is recommended to use a container managed authentication alias instead of configuring this property.
useRowsetCursorbooleanJDBC driver property: useRowsetCursor.
useTransactionRedirectbooleanJDBC driver property: useTransactionRedirect.
xaNetworkOptimizationbooleanJDBC driver property: xaNetworkOptimization.
xmlFormat
  • 0
  • 1
JDBC driver property: xmlFormat.
0
XML_FORMAT_TEXTUAL
1
XML_FORMAT_BINARY

oauthProvider > databaseStore > dataSource > properties.db2.i.toolbox

Data source properties for the IBM DB2 for i Toolbox JDBC driver.

NameTypeDefaultDescription
serverNamestringServer where the database is running.
databaseNamestringJDBC driver property: databaseName.
access
  • all
  • read call
  • read only
allJDBC driver property: access.
all
all
read call
read call
read only
read only
behaviorOverrideintJDBC driver property: behaviorOverride.
bidiImplicitReorderingbooleantrueJDBC driver property: bidiImplicitReordering.
bidiNumericOrderingbooleanfalseJDBC driver property: bidiNumericOrdering.
bidiStringTypeintJDBC driver property: bidiStringType.
bigDecimalbooleantrueJDBC driver property: bigDecimal.
blockCriteria
  • 0
  • 1
  • 2
2JDBC driver property: blockCriteria. Values are: 0 (no record blocking), 1 (block if FOR FETCH ONLY is specified), 2 (block if FOR UPDATE is specified).
0
0
1
1
2
2
blockSize
  • 0
  • 256
  • 16
  • 512
  • 128
  • 8
  • 64
  • 32
32JDBC driver property: blockSize.
0
0
256
256
16
16
512
512
128
128
8
8
64
64
32
32
characterTruncation
  • default
  • warning
  • none
JDBC driver property: CharacterTruncation.
default
default
warning
warning
none
none
concurrentAccessResolutionint
Min: 0

Max: 3
JDBC driver property: concurrentAccessResolution.
cursorHoldbooleanfalseJDBC driver property: cursorHold.
cursorSensitivity
  • asensitive
  • insensitive
  • sensitive
asensitiveJDBC driver property: cursorSensitivity. Values are: 0 (TYPE_SCROLL_SENSITIVE_STATIC), 1 (TYPE_SCROLL_SENSITIVE_DYNAMIC), 2 (TYPE_SCROLL_ASENSITIVE).
asensitive
asensitive
insensitive
insensitive
sensitive
sensitive
dataCompressionbooleantrueJDBC driver property: dataCompression.
dataTruncationbooleantrueJDBC driver property: dataTruncation.
dateFormat
  • julian
  • dmy
  • ymd
  • usa
  • eur
  • mdy
  • iso
  • jis
JDBC driver property: dateFormat.
julian
julian
dmy
dmy
ymd
ymd
usa
usa
eur
eur
mdy
mdy
iso
iso
jis
jis
dateSeparator
  • \,
  • -
  • .
  • /
JDBC driver property: dateSeparator.
\,
The comma character (,).
**
The space character ( ).
-
The dash character (-).
.
The period character (.).
/**
The forward slash character (/).
decfloatRoundingMode
  • ceiling
  • half even
  • half up
  • up
  • floor
  • down
  • half down
JDBC driver property: decfloatRoundingMode.
ceiling
ceiling
half even
half even
half up
half up
up
up
floor
floor
down
down
half down
half down
decimalDataErrorsstringJDBC driver property: decimalDataErrors.
decimalSeparator
  • \,
  • .
JDBC driver property: decimalSeparator.
\,
The comma character (,).
.
The period character (.).
describeOptionstringJDBC driver property: describeOption.
driver
  • native
  • toolbox
toolboxJDBC driver property: driver.
native
native
toolbox
toolbox
errors
  • basic
  • full
basicJDBC driver property: errors.
basic
basic
full
full
extendedDynamicbooleanfalseJDBC driver property: extendedDynamic.
extendedMetaDatabooleanfalseJDBC driver property: extendedMetaData.
fullOpenbooleanfalseJDBC driver property: fullOpen.
holdInputLocatorsbooleantrueJDBC driver property: holdInputLocators.
holdStatementsbooleanfalseJDBC driver property: holdStatements.
ignoreWarningsstringJDBC driver property: ignoreWarnings.
isolationLevelSwitchingSupportbooleanfalseJDBC driver property: isolationLevelSwitchingSupport.
keepAlivebooleanJDBC driver property: keepAlive.
lazyClosebooleanfalseJDBC driver property: lazyClose.
librariesstringJDBC driver property: libraries.
lobThresholdint
Min: 0

Max: 16777216
0JDBC driver property: lobThreshold.
loginTimeoutA period of time with second precisionJDBC driver property: loginTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
maximumPrecision
  • 63
  • 31
31JDBC driver property: maximumPrecision.
63
64
31
31
maximumBlockedInputRowsint
Min: 1

Max: 32000
JDBC driver property: maximumBlockedInputRows.
maximumScaleint
Min: 0

Max: 63
31JDBC driver property: maximumScale.
metaDataSourceint
Min: 0

Max: 1
1JDBC driver property: metaDataSource.
minimumDivideScaleint
Min: 0

Max: 9
0JDBC driver property: minimumDivideScale.
naming
  • system
  • sql
sqlJDBC driver property: naming.
system
system
sql
sql
numericRangeError
  • default
  • warning
  • none
JDBC driver property: numericRangeError.
default
default
warning
warning
none
none
packagestringJDBC driver property: package.
packageAddbooleantrueJDBC driver property: packageAdd.
packageCCSID
  • 1200
  • 13488
13488JDBC driver property: packageCCSID. Values are: 1200 (UCS-2) or 13488 (UTF-16).
1200
1200 (UCS-2)
13488
13488 (UTF-16)
packageCachebooleanfalseJDBC driver property: packageCache.
packageCriteria
  • default
  • select
defaultJDBC driver property: packageCriteria.
default
default
select
select
packageError
  • exception
  • warning
  • none
warningJDBC driver property: packageError.
exception
exception
warning
warning
none
none
packageLibrarystringQGPLJDBC driver property: packageLibrary.
passwordReversably encoded password (string)It is recommended to use a container managed authentication alias instead of configuring this property.
prefetchbooleantrueJDBC driver property: prefetch.
promptbooleanfalseJDBC driver property: prompt.
proxyServerstringJDBC driver property: proxyServer.
qaqqiniLibrarystringJDBC driver property: qaqqiniLibrary.
queryOptimizeGoalint
Min: 0

Max: 2
0JDBC driver property: queryOptimizeGoal. Values are: 1 (*FIRSTIO) or 2 (*ALLIO).
queryReplaceTruncatedParameterstringJDBC driver property: queryReplaceTruncatedParameter.
queryTimeoutMechanism
  • cancel
  • qqrytimlmt
JDBC driver property: queryTimeoutMechanism.
cancel
cancel
qqrytimlmt
qqrytimlmt
queryStorageLimitint
Min: -1
Query storage limit
receiveBufferSizeint
Min: 1
JDBC driver property: receiveBufferSize.
remarks
  • system
  • sql
systemJDBC driver property: remarks.
system
system
sql
sql
rollbackCursorHoldbooleanfalseJDBC driver property: rollbackCursorHold.
savePasswordWhenSerializedbooleanfalseJDBC driver property: savePasswordWhenSerialized.
secondaryUrlstringJDBC driver property: secondaryUrl.
securebooleanfalseJDBC driver property: secure.
secureCurrentUserbooleanJDBC driver property: secureCurrentUser.
sendBufferSizeint
Min: 1
JDBC driver property: sendBufferSize.
serverTraceCategoriesint0JDBC driver property: serverTraceCategories.
serverTraceintJDBC driver property: serverTrace.
soLingerA period of time with second precisionJDBC driver property: soLinger. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
soTimeoutA period of time with millisecond precisionJDBC driver property: soTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
sort
  • hex
  • language
  • table
hexJDBC driver property: sort.
hex
hex
language
language
table
table
sortLanguagestringJDBC driver property: sortLanguage.
sortTablestringJDBC driver property: sortTable.
sortWeight
  • shared
  • unqiue
JDBC driver property: sortWeight.
shared
shared
unqiue
unique
tcpNoDelaybooleanJDBC driver property: tcpNoDelay.
threadUsedbooleantrueJDBC driver property: threadUsed.
timeFormat
  • usa
  • eur
  • iso
  • jis
  • hms
JDBC driver property: timeFormat.
usa
usa
eur
eur
iso
iso
jis
jis
hms
hms
timeSeparator
  • \,
  • :
  • .
JDBC driver property: timeSeparator.
\,
The comma character (,).
**
The space character ( ).
:
The colon character (:).
.**
The period character (.).
timestampFormat
  • iso
  • ibmsql
JDBC driver property: timestampFormat.
iso
iso
ibmsql
ibmsql
toolboxTrace
  • all
  • proxy
  • datastream
  • pcml
  • warning
  • information
  • jdbc
  • none
  • diagnostic
  • thread
  • error
  • conversion
JDBC driver property: toolboxTrace.
all
all
proxy
proxy
datastream
datastream
pcml
pcml
warning
warning
information
information
jdbc
jdbc
none
none
diagnostic
diagnostic
thread
thread
error
error
conversion
conversion
tracebooleanJDBC driver property: trace.
translateBinarybooleanfalseJDBC driver property: translateBinary.
translateBooleanbooleantrueJDBC driver property: translateBoolean.
translateHex
  • character
  • binary
characterJDBC driver property: translateHex.
character
character
binary
binary
trueAutoCommitbooleanfalseJDBC driver property: trueAutoCommit.
useBlockUpdatebooleanJDBC driver property: useBlockUpdate.
useDrdaMetadataVersionbooleanJDBC driver property: useDrdaMetadataVersion.
userstringIt is recommended to use a container managed authentication alias instead of configuring this property.
variableFieldCompression
  • all
  • true
  • false
  • insert
JDBC driver property: variableFieldCompression.
all
all
true
true
false
false
insert
insert
xaLooselyCoupledSupportint
Min: 0

Max: 1
0JDBC driver property: xaLooselyCoupledSupport.

oauthProvider > databaseStore > dataSource > properties.sybase

Data source properties for Sybase JDBC driver.

NameTypeDefaultDescription
databaseNamestringJDBC driver property: databaseName.
serverNamestringlocalhostServer where the database is running.
portNumberint5000Port on which to obtain database connections.
connectionPropertiesstringSELECT_OPENS_CURSOR=trueJDBC driver property: connectionProperties.
loginTimeoutA period of time with second precisionJDBC driver property: loginTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
networkProtocol
  • socket
  • SSL
JDBC driver property: networkProtocol.
socket
socket
SSL
SSL
passwordReversably encoded password (string)It is recommended to use a container managed authentication alias instead of configuring this property.
resourceManagerNamestringJDBC driver property: resourceManagerName.
SERVER_INITIATED_TRANSACTIONS
  • true
  • false
falseJDBC driver property: SERVER_INITIATED_TRANSACTIONS.
true
true
false
false
userstringIt is recommended to use a container managed authentication alias instead of configuring this property.
versionintJDBC driver property: version.

oauthProvider > databaseStore > dataSource > containerAuthData

Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER. If updated while the server is running, the change is applied with new connection requests; in-use connections are not impacted.

NameTypeDefaultDescription
userstringName of the user to use when connecting to the EIS.
passwordReversably encoded password (string)Password of the user to use when connecting to the EIS. The value can be stored in clear text or encoded form. It is recommended that you encode the password. To do so, use the securityUtility tool with the encode option.

oauthProvider > databaseStore > dataSource > jaasLoginContextEntry

JAAS login context entry for authentication. If updated while the server is running, the update is applied with new connection requests; in-use connections are not impacted.

NameTypeDefaultDescription
namestringName of a JAAS configuration entry.
loginModuleRefList of references to top level jaasLoginModule elements (comma-separated string).hashtable,userNameAndPassword,certificate,tokenA reference to the ID of a JAAS login module.

oauthProvider > databaseStore > dataSource > onConnect

SQL command to execute once on each new connection that is established to the database. The SQL statement applies only to newly created connections, not to existing connections that are reused from the connection pool. If updated while the server is running, existing connections are destroyed.

oauthProvider > databaseStore > dataSource > recoveryAuthData

Authentication data for transaction recovery.

NameTypeDefaultDescription
userstringName of the user to use when connecting to the EIS.
passwordReversably encoded password (string)Password of the user to use when connecting to the EIS. The value can be stored in clear text or encoded form. It is recommended that you encode the password. To do so, use the securityUtility tool with the encode option.

oauthProvider > library

Reference to shared library containing the mediator plugin class.

NameTypeDefaultDescription
namestringName of shared library for administrators
descriptionstringDescription of shared library for administrators
filesetRefList of references to top level fileset elements (comma-separated string).Id of referenced Fileset
apiTypeVisibilitystringspec,ibm-api,api,stableThe types of API packages that this class loader supports. This value is a comma-separated list of any combination of the following API packages: spec, ibm-api, api, stable, third-party.

oauthProvider > library > fileset

Id of referenced Fileset

NameTypeDefaultDescription
idstringA unique configuration ID.
dirPath to a directory${server.config.dir}The base directory to search for files.
caseSensitivebooleantrueBoolean to indicate whether or not the search should be case sensitive (default: true).
includesstring*The comma or space separated list of file name patterns to include in the search results (default: *).
excludesstringThe comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded.
scanIntervalA period of time with millisecond precision0Scanning interval to check the fileset for changes as a long with a time unit suffix h-hour, m-minute, s-second, ms-millisecond (e.g. 2ms or 5s). Disabled (scanInterval=0) by default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

oauthProvider > library > folder

Id of referenced folder

NameTypeDefaultDescription
idstringA unique configuration ID.
dirPath to a directoryDirectory or folder to be included in the library classpath for locating resource files

oauthProvider > library > file

Id of referenced File

NameTypeDefaultDescription
idstringA unique configuration ID.
namePath to a fileFully qualified filename

oauthProvider > mediatorClassname

Mediator plugin class name. The equivalent provider parameter in the full application server profile is oauth20.mediator.classnames.

oauthProvider > grantType

An access token grant type (as detailed in the OAuth specification) that is allowed for the provider. The equivalent provider parameter in the full application server profile is oauth20.grant.types.allowed.

oauthProvider > autoAuthorizeClient

Name of a client that is allowed to use auto authorization. The equivalent provider parameter in the full application server profile is oauth20.autoauthorize.clients.

oauthProvider > tokenFormat

The type of token to be produced. One of opaque, jwt, or mpjwt. Mpjwt is microprofile standardized format. The default is opaque.

oauthProvider > jwtGrantType

The grant_type for JWT Token handler

NameTypeDefaultDescription
maxJtiCacheSizelong
Min: 1
10000The maximum size of cache, which keeps jti data of jwt token, to prevent the jti from being reused.
clockSkewA period of time with second precision300sThe time difference allowed between OpenID Connect Client and OpenID Connect Provider systems when they are not synchronized. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
tokenMaxLifetimeA period of time with second precision7200sThe time indicates the maximum lifetime of an alive jwt token since its issued-at-time. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
iatRequiredbooleanfalseThe iat claim in a jwt token is required.

customClaims

The extra claims to be put in the payloads of the ID Token, in addition to the default realmName, uniqueSecurityName and groupIds claims.

scopeToClaimMap

Specify the claims for the scope.

NameTypeDefaultDescription
profilestringname, family_name, given_name, middle_name, nickname, preferred_username, profile, picture, website, gender, birthdate, zoneinfo, locale, updated_atSpecify a comma-separated list of claims associated with the profile scope.
emailstringemail, email_verifiedSpecify a comma-separated list of claims associated with the email scope.
addressstringaddressSpecify a comma-separated list of claims associated with the address scope.
phonestringphone_number, phone_number_verifiedSpecify a comma-separated list of claims associated with the phone scope.

scopeToClaimMap > property

A unique configuration ID.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringSpecify the name of the property
valuestringSpecify the value of the property

claimToUserRegistryMap

Specify the user registry key for the claim.

NameTypeDefaultDescription
namestringdisplayNameSpecify the user registry key that will be retrieved for the name claim.
given_namestringgivenNameSpecify the user registry key that will be retrieved for the given_name claim.
picturestringphotoURLSpecify the user registry key that will be retrieved for the picture claim.
emailstringmailSpecify the user registry key that will be retrieved for the email claim.
addressstringpostalAddressSpecify the user registry key that will be retrieved for the address claim.
phone_numberstringtelephoneNumberSpecify the user registry key that will be retrieved for the phone_number claim.

claimToUserRegistryMap > property

A unique configuration ID.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringSpecify the name of the property
valuestringSpecify the value of the property

discovery

Discovery is based on OpenID Connect and Jazz Authorization Server Profile.

NameTypeDefaultDescription
claimsParameterSupportedbooleanfalseIndicate by true or false whether claims parameter is supported.
requestParameterSupportedbooleanfalseIndicate by true or false whether request parameter is supported.
requestUriParameterSupportedbooleanfalseIndicate by true or false whether request URI parameter is supported.
requireRequestUriRegistrationbooleanfalseIndicate by true or false whether require request URI registration is supported.

discovery > responseTypesSupported

Specify by comma the list of the response types that will be supported by the OP.

discovery > idTokenSigningAlgValuesSupported

Specify the signature algorithm that will be used to sign the ID token.

discovery > scopesSupported

Specify by comma the list of scopes that will be supported.

discovery > claimsSupported

Specify by comma the list of claims that will be supported.

discovery > responseModesSupported

Specify by comma the list of the response modes that will be used.

discovery > grantTypesSupported

Specify by comma the list of the grant types that will be used.

discovery > tokenEndpointAuthMethodsSupported

Specify by comma the list of the token endpoint authentication methods that will be used.