OpenID Connect Server Provider (openidConnectProvider)
OpenID Connect server provider
Name | Type | Default | Description |
---|---|---|---|
allowDefaultSsoCookieName | boolean | false | When 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. |
customClaims | string | The extra claims to be put in the payloads of the ID token, in addition to the default realmName, uniqueSecurityName, and groupIds claims. | |
id | string | A unique configuration ID. | |
idTokenCacheEnabled | boolean | true | Enable caching to save ID tokens in the database and in-memory cache. |
idTokenLifetime | A period of time with second precision | 2h | Time 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. |
issuerIdentifier | string | Specify an issuer identifier for the issuer of the response. | |
jwkEnabled | boolean | false | When JWK is enabled, the OpenID Connect provider dynamically generates key pairs for signing JWT tokens that it creates. To validate the signature, the client can retrieve the key from the JWK endpoint, which has the format https://<host_name>:<port_number>/oidc/endpoint/<provider_id>/jwk. When this attribute is false, the provider will use the key that is specified by the keyAliasName attribute to sign the JWT. The provider will still make that key available as a JWK from the JWK endpoint if this attribute is false. |
jwkRotationTime | A period of time with minute precision | 720m | Amount 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 |
| 2048 | Size measured in bits of the signing key. |
keyAliasName | string | Key alias name to locate the private key for signing with an asymmetric algorithm. | |
keyStoreRef | A reference to top level keyStore element (string). | opKeyStore | A keystore containing the private key necessary for signing with an asymmetric algorithm. |
oauthProviderRef | A reference to top level oauthProvider element (string). | A reference to the ID of an OAuth provider. | |
sessionManaged | boolean | false | Indicate by true or false whether session management is supported. Default is false. |
signatureAlgorithm |
| HS256 | Specify the signature algorithm that will be used to sign the ID token. |
trustStoreRef | A reference to top level keyStore element (string). | A keystore containing the public key necessary for verifying a signature of the JWT token. |
claimToUserRegistryMap
Specify the user registry key for the claim.
Name | Type | Default | Description |
---|---|---|---|
address | string | postalAddress | Specify the user registry key that will be retrieved for the address claim. |
string | Specify the user registry key that will be retrieved for the email claim. | ||
given_name | string | givenName | Specify the user registry key that will be retrieved for the given_name claim. |
name | string | displayName | Specify the user registry key that will be retrieved for the name claim. |
phone_number | string | telephoneNumber | Specify the user registry key that will be retrieved for the phone_number claim. |
picture | string | photoURL | Specify the user registry key that will be retrieved for the picture claim. |
claimToUserRegistryMap > property
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
name | string | Specify the name of the property | |
value | string | Specify the value of the property |
discovery
Discovery is based on OpenID Connect and Jazz Authorization Server Profile.
Name | Type | Default | Description |
---|---|---|---|
claimsParameterSupported | boolean | false | Indicate by true or false whether claims parameter is supported. |
claimsSupported | string | sub | Specify by comma the list of claims that will be supported. |
grantTypesSupported |
| authorization_code | Specify by comma the list of the grant types that will be used. |
idTokenSigningAlgValuesSupported |
| HS256 | Specify the signature algorithm that will be used to sign the ID token. |
requestParameterSupported | boolean | false | Indicate by true or false whether request parameter is supported. |
requestUriParameterSupported | boolean | false | Indicate by true or false whether request URI parameter is supported. |
requireRequestUriRegistration | boolean | false | Indicate by true or false whether require request URI registration is supported. |
responseModesSupported |
| query | Specify by comma the list of the response modes that will be used. |
responseTypesSupported |
| code | Specify by comma the list of the response types that will be supported by the OP. |
scopesSupported | string | openid | Specify by comma the list of scopes that will be supported. |
tokenEndpointAuthMethodsSupported |
| client_secret_post | Specify by comma the list of the token endpoint authentication methods that will be used. |
oauthProvider
A reference to the ID of an OAuth provider.
Name | Type | Default | Description |
---|---|---|---|
accessTokenCacheEnabled | boolean | true | Enable caching to save access tokens in the database and in-memory cache. |
accessTokenEncoding |
| plain | The encoding type for the stored access token. The default is set to plain, for compatibility with earlier versions. PBKDF2WithHmacSHA512 is recommended. |
accessTokenLength | long | 40 | Length of the generated OAuth access token. |
accessTokenLifetime | A period of time with second precision | 7200 | Time that access 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. |
allowCertAuthentication | boolean | true | Allow the authentication of a client certificate if a client certificate is included in the https request. This attribute allows client certificates to be used for authentication even if the certAuthentication attribute is set to false. |
allowPublicClients | boolean | false | A value of false disables the access of public clients as detailed in the OAuth specification. |
allowSpnegoAuthentication | boolean | false | Allow the authentication of an SPNEGO token in the https request. |
appPasswordLifetime | A period of time with second precision | 90d | Specifies the lifetime of application passwords that are generated by this OAuth provider. 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. |
appTokenLifetime | A period of time with second precision | 90d | Specifies the lifetime of application tokens that are generated by this OAuth provider. 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. |
appTokenOrPasswordLimit | long | 100 | Token limit for each user and client combination. |
authorizationCodeLength | long | 30 | Length of the generated authorization code. |
authorizationCodeLifetime | A period of time with second precision | 60 | Authorization 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. |
authorizationErrorTemplate | string | URL of a custom authorization error page template. | |
authorizationFormTemplate | string | template.html | URL of a custom authorization page template. |
authorizationGrantLifetime | A period of time with second precision | 604800 | 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. |
autoAuthorize | boolean | false | To use auto authorization, append the autoAuthorize parameter to requests with a value of true. |
autoAuthorizeClient | string | Name of a client that is allowed to use auto authorization. | |
autoAuthorizeParam | string | autoauthz | To use auto authorization, append the autoAuthorize parameter to requests with a value of true. |
certAuthentication | boolean | false | Enable the authentication of client certificate in the https request. |
characterEncoding | string | Set request character encoding to this value. | |
clientSecretEncoding |
| xor | The encoding type for the stored client secret. The default is set to XOR, for compatibility with earlier versions. PBKDF2WithHmacSHA512 is recommended. |
clientTokenCacheSize | long | Maximum number of entries in the client token cache. | |
clientURISubstitutions | string | Optional value to replace client URI strings for dynamic host names. | |
consentCacheEntryLifetime | A period of time with second precision | 1800 | Time 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. |
consentCacheSize | long | 1000 | Maximum number of entries allowed in the consent cache. |
coverageMapSessionMaxAge | A period of time with second precision | 600 | The 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. |
customLoginURL | string | login.jsp | URL of a custom login page. |
filter | string | URI filter selects requests to be authorized by this provider. | |
grantType | string | authorization_code | An OAuth 2.0 grant type, as detailed in the OAuth 2.0 specification, that is allowed for the provider. By default, all grant types are allowed. The supported values are authorization_code, client_credentials, refresh_token, password, implicit and urn:ietf:params:oauth:grant-type:jwt-bearer. |
httpsRequired | boolean | true | SSL communication between the OAuth client and provider is required. |
includeTokenInSubject | boolean | true | If the value is true, add the com.ibm.wsspi.security.oauth20.token.WSOAuth20Token as a private credential. |
internalClientId | string | The ID of an existing client that will be used to generate tokens for PersonalTokenManagement and UsersTokenManagement UI pages. | |
internalClientSecret | Reversably encoded password (string) | The secret of an existing client that will be used to generate tokens for PersonalTokenManagement and UsersTokenManagement UI pages. | |
issueRefreshToken | boolean | true | A value of false disables generation and the use of refresh tokens. |
jwtAccessToken | boolean | false | Generate the Json Web Token, serialize it as a string and put in the place of the access token. |
libraryRef | A reference to top level library element (string). | Reference to shared library containing the mediator plugin class. | |
logoutRedirectURL | string | Optional 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. | |
mediatorClassname | string | Mediator plugin class name. | |
oauthOnly | boolean | true | If 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. |
passwordGrantRequiresAppPassword | boolean | false | When set to true, OAuth authorization flows that use the resource owner password credentials grant type must use an application password instead of the password configured for a user in the user registry. When this attribute is enabled, OAuth clients must obtain an application password from this OAuth provider to use the password grant type. |
refreshTokenLength | long | 50 | Length of generated refresh token. |
refreshedAccessTokenLimit | long | 100 | Maximum number of access tokens that can be created by using refresh tokens for a single OAuth client and user combination. |
revokeAccessTokensWithRefreshTokens | boolean | true | A value of false disables revocation of associated access tokens when a refresh token is revoked. The default value is true. |
ropcPreferUserPrincipalName | boolean | false | If the user principal name differs from the username that is supplied in the ROPC (Resource Owner Password Credentials) request, then the username is set to the user principal name for all tokens that are created by the ROPC grant type. The default is false. If both ropcPreferUserSecurityName and ropcPreferUserPrincipalName are set to true, then ropcPreferUserPrincipalName takes precedence. |
ropcPreferUserSecurityName | boolean | false | If the user security name differs from the username that is supplied in the ROPC (Resource Owner Password Credentials) request, then the username is set to the user security name for all tokens that are created by the ROPC grant type. The default is false. If both ropcPreferUserSecurityName and ropcPreferUserPrincipalName are set to true, then ropcPreferUserPrincipalName takes precedence. |
skipResourceOwnerValidation | boolean | false | If the value is true, skip validation of resource owner. |
tokenFormat |
| The type of token to be produced. One of opaque, jwt, or mpjwt. Mpjwt is microprofile standardized format. The default is opaque. | |
trackOAuthClients | boolean | false | Track all OAuth clients that interact with this OAuth provider. |
userClientTokenLimit | long | Token limit for each user and client combination. |
oauthProvider > customStore
Clients are defined, and tokens and consents are cached in a custom OAuthStore implementation.
Name | Type | Default | Description |
---|---|---|---|
cleanupExpiredInterval | A period of time with second precision | 3600 | The interval to use for cleaning up expired tokens and consents from the custom OAuthStore implementation. The valid range is 0 to Integer.MAX_VALUE in seconds. A value of 0 indicates that no cleanup is performed. 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. |
storeId | string | Specifies the OAuthStore ID to use for a custom store. The value must match the value of the oauth.store.id property that is specified for the OAuthStore implementation. |
oauthProvider > databaseStore
Clients are defined and tokens are cached in the database.
Name | Type | Default | Description |
---|---|---|---|
cleanupExpiredTokenInterval | A period of time with second precision | 3600 | The interval to use for cleaning up expired tokens from the database store. The valid range is 0 to Integer.MAX_VALUE in seconds. A value of 0 indicates that no cleanup is performed. 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. |
dataSourceRef | A reference to top level dataSource element (string). | Reference to the data source for the store. | |
password | Reversably encoded password (string) | Password used to access the database. | |
schema | string | OAuthDBSchema | Schema |
user | string | User |
oauthProvider > databaseStore > dataSource
Reference to the data source for the store.
Name | Type | Default | Description |
---|---|---|---|
connectionManagerRef | A reference to top level connectionManager element (string). | Connection manager for a data source. If updated while the server is running, existing connections are destroyed. | |
connectionSharing |
| MatchOriginalRequest | Specifies how connections are matched for sharing. |
containerAuthDataRef | A 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. | |
isolationLevel |
| 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. | |
jaasLoginContextEntryRef | A 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. | |
jdbcDriverRef | A reference to top level jdbcDriver element (string). | JDBC driver for a data source. If updated while the server is running, existing connections are destroyed. | |
jndiName | string | JNDI name for a data source. If updated while the server is running, existing connections are destroyed. | |
statementCacheSize | int | 10 | Maximum number of cached statements per connection. If updated while the server is running, the statement cache is resized upon next use. To set this option, complete the following prerequisites: Review either the application code or an SQL trace that you gather from the database or database driver for all unique prepared statements. Ensure that the cache size is larger than the number of statements. |
transactional | boolean | true | Enable participation in transactions that are managed by the application server. If updated while the server is running, existing connections are destroyed. |
type |
| Type of data source. If updated while the server is running, existing connections are destroyed. | |
Advanced Properties | |||
beginTranForResultSetScrollingAPIs | boolean | true | Attempt transaction enlistment when result set scrolling interfaces are used. |
beginTranForVendorAPIs | boolean | true | Attempt transaction enlistment when vendor interfaces are used. |
commitOrRollbackOnCleanup |
| 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. | |
enableConnectionCasting | boolean | false | Indicates 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. |
onConnect | string | 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. | |
queryTimeout | A period of time with second precision | Default 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. | |
recoveryAuthDataRef | A reference to top level authData element (string). | Authentication data for transaction recovery. | |
supplementalJDBCTrace | boolean | Supplements 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. | |
syncQueryTimeoutWithTransactionTimeout | boolean | false | Use the time remaining (if any) in a JTA transaction as the default query timeout for SQL statements. |
validationTimeout | A period of time with second precision | 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. The full amount of the validation timeout applies to each connection that is validated, which is done via the Connection.isValid(timeout) JDBC API operation. 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 > connectionManager
Connection manager for a data source. If updated while the server is running, existing connections are destroyed.
Name | Type | Default | Description |
---|---|---|---|
agedTimeout | A period of time with second precision | -1 | Amount 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. |
connectionTimeout | A period of time with second precision | 30s | Amount of time after which a connection request times out. A value of -1 disables this timeout, meaning infinite wait. A value of 0 is immediate, meaning no 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. |
maxIdleTime | A period of time with second precision | 30m | Amount 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. |
maxPoolSize | int | 50 | Maximum number of physical connections for a pool. A value of 0 means unlimited. The optimal setting depends on the application characteristics. For an application in which every thread obtains a connection to the database, you might start with a 1:1 mapping to the `coreThreads` attribute. |
minPoolSize | int | Minimum number of physical connections to maintain in the pool. The pool is not pre-populated. Aged timeout can override the minimum. | |
purgePolicy |
| EntirePool | Specifies which connections to destroy when a stale connection is detected in a pool. |
reapTime | A period of time with second precision | 3m | Amount 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. |
Advanced Properties | |||
autoCloseConnections | boolean | true | Attempts to clean up after applications that leave connections open after the end of a servlet request, enterprise bean instance, managed executor task, contextual task, or managed completion stage. When an unsharable connection is obtained within one of these application artifacts and remains open when it ends, the container attempts to close the connection handle. The container may also close sharable connections that do not support DissociatableManagedConnection. Applications should always follow the programming model defined by the specification and close connections at the appropriate times rather than relying on the container, even when this option is enabled. |
enableContainerAuthForDirectLookups | boolean | false | If set to true, connections use container authentication. If set to false, connections use application authentication. |
enableSharingForDirectLookups | boolean | true | If set to true, connections are shared. If set to false, connections are unshared. |
maxConnectionsPerThread | int | Limits the number of open connections on each thread. | |
numConnectionsPerThreadLocal | int | Caches the specified number of connections for each thread. This setting can provide a performance improvement on large multi-core (8+) machines by reserving the specified number of database connections for each thread. For best performance, if you have n applications threads, set the maximum pool connections to at least n times the value of the numConnectionsPerThreadLocal attribute. Use the same credentials for all connection requests. For example, if you use 20 application threads, set the maximum pool connections to 20 or more. If you set the value of numConnectionPerThreadLocal attribute as 2 and you have 20 application threads, set the maximum pool connection to 40 or more. If setting numConnectionsPerThreadLocal does not improve performance due to application connection usage patterns that do not benefit from using numConnectionsPerThreadLocal, remove the attribute from configuration or set the value to 0. |
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.
Name | Type | Default | Description |
---|---|---|---|
krb5Principal | string | The name of the Kerberos principal name or Kerberos service name to be used. | |
krb5TicketCache | Path to a file | The file location where Kerberos credentials for the Kerberos principal name or service name will be stored. Also known as the Kerberos credential cache (ccache) | |
password | Reversably 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. | |
user | string | Name of the user to use when connecting to the EIS. |
oauthProvider > databaseStore > dataSource > identifyException
Identify a specific SQL error code or SQL state on a SQLException. This enables the server to take appropriate action based on the error condition. For example, closing a stale connection instead of returning it to the connection pool.
Name | Type | Default | Description |
---|---|---|---|
as | string | Identifies the error condition that the SQL error code or SQL state represents. Allowed values are: None, StaleConnection, StaleStatement, Unsupported. None removes the identification of the exception. StaleConnection causes connections to be evicted from the connection pool per the purge policy. StaleStatement causes statements to be evicted from the statement cache. Unsupported indicates an operation that is not supported by the JDBC driver. | |
errorCode | int | An error code specific to the backend database. Normally, this is the actual error code that is returned by the underlying database. | |
id | string | A unique configuration ID. | |
sqlState | string | A string that follows either the XOPEN SQL state conventions or the SQL:2003 conventions. |
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.
Name | Type | Default | Description |
---|---|---|---|
loginModuleRef | List of references to top level jaasLoginModule elements (comma-separated string). | hashtable,userNameAndPassword,certificate,token | A reference to the ID of a JAAS login module. |
name | string | Name of a JAAS configuration entry. |
oauthProvider > databaseStore > dataSource > jdbcDriver
JDBC driver for a data source. If updated while the server is running, existing connections are destroyed.
Name | Type | Default | Description |
---|---|---|---|
libraryRef | A reference to top level library element (string). | Identifies JDBC driver JARs and native files. | |
Advanced Properties | |||
javax.sql.ConnectionPoolDataSource | string | JDBC driver implementation of javax.sql.ConnectionPoolDataSource. | |
javax.sql.DataSource | string | JDBC driver implementation of javax.sql.DataSource. | |
javax.sql.XADataSource | string | JDBC driver implementation of javax.sql.XADataSource. |
oauthProvider > databaseStore > dataSource > jdbcDriver > library
Identifies JDBC driver JARs and native files.
Name | Type | Default | Description |
---|---|---|---|
apiTypeVisibility | string | spec,ibm-api,api,stable | The 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. |
description | string | Description of shared library for administrators | |
filesetRef | List of references to top level fileset elements (comma-separated string). | Id of referenced Fileset | |
name | string | Name of shared library for administrators |
oauthProvider > databaseStore > dataSource > jdbcDriver > library > file
Id of referenced File
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
name | Path to a file | Fully qualified filename |
oauthProvider > databaseStore > dataSource > jdbcDriver > library > fileset
Id of referenced Fileset
Name | Type | Default | Description |
---|---|---|---|
caseSensitive | boolean | true | Boolean to indicate whether or not the search should be case sensitive (default: true). |
dir | Path to a directory | ${server.config.dir} | The base directory to search for files. |
excludes | string | The comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded. | |
id | string | A unique configuration ID. | |
includes | string | * | The comma or space separated list of file name patterns to include in the search results (default: *). |
scanInterval | A period of time with millisecond precision | 0 | The scanning interval to determine whether files are added or removed from the fileset. The individual files are not scanned. The suffix for the interval of time is h-hour, m-minute, s-second, and ms-millisecond, for example, 2ms or 5s. The scanning interval is disabled by default and is disabled manually by setting the scan interval, scanInterval, to 0. 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
Name | Type | Default | Description |
---|---|---|---|
dir | Path to a directory | Directory or folder to be included in the library classpath for locating resource files | |
id | string | A unique configuration ID. |
oauthProvider > databaseStore > dataSource > properties
List of JDBC vendor properties for the data source. For example, databaseName="dbname" serverName="localhost" portNumber="50000". Use this generic properties list when no vendor-specific properties list type is available for your JDBC driver. Do not specify multiple properties elements under a data source. Instead, place all property name-value pairs on a single properties or properties.{JDBC_VENDOR_TYPE} element.
Name | Type | Default | Description |
---|---|---|---|
URL | string | URL for connecting to the database. | |
databaseName | string | JDBC driver property: databaseName. | |
password | Reversably encoded password (string) | It is recommended to use a container managed authentication alias instead of configuring this property. | |
portNumber | int | Port on which to obtain database connections. | |
serverName | string | Server where the database is running. | |
user | string | It 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.
Name | Type | Default | Description |
---|---|---|---|
databaseName | string | JDBC driver property: databaseName. | |
portNumber | int | Port on which to obtain database connections. | |
serverName | string | localhost | Server where the database is running. |
Advanced Properties | |||
JDBCBehavior |
| 0 | JDBC driver property: JDBCBehavior. Values are: 0 (JDBC 4.0) or 1 (JDBC 3.0). |
XATransactionGroup | string | JDBC driver property: XATransactionGroup. | |
XMLDescribeType |
| JDBC driver property: XMLDescribeType. | |
accountingInfo | string | JDBC driver property: accountingInfo. | |
alwaysReportTriggerResults | boolean | JDBC driver property: alwaysReportTriggerResults. | |
applicationName | string | JDBC driver property: applicationName. | |
authenticationMethod |
| JDBC driver property: authenticationMethod. | |
bulkLoadBatchSize | long | JDBC driver property: bulkLoadBatchSize. | |
bulkLoadOptions | long | JDBC driver property: bulkLoadOptions. | |
clientHostName | string | JDBC driver property: clientHostName. | |
clientUser | string | JDBC driver property: clientUser. | |
codePageOverride | string | JDBC driver property: codePageOverride. | |
convertNull | int | JDBC driver property: convertNull. | |
dateTimeInputParameterType |
| JDBC driver property: dateTimeInputParameterType. | |
dateTimeOutputParameterType |
| JDBC driver property: dateTimeOutputParameterType. | |
describeInputParameters |
| JDBC driver property: describeInputParameters. | |
describeOutputParameters |
| JDBC driver property: describeOutputParameters. | |
enableBulkLoad | boolean | JDBC driver property: enableBulkLoad. | |
enableCancelTimeout | boolean | JDBC driver property: enableCancelTimeout. | |
encryptionMethod |
| JDBC driver property: encryptionMethod. | |
hostNameInCertificate | string | JDBC driver property: hostNameInCertificate. | |
initializationString | string | JDBC driver property: initializationString. | |
insensitiveResultSetBufferSize | int | JDBC driver property: insensitiveResultSetBufferSize. | |
javaDoubleToString | boolean | JDBC driver property: javaDoubleToString. | |
loginTimeout | A period of time with second precision | JDBC 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. | |
longDataCacheSize | int | JDBC driver property: longDataCacheSize. | |
netAddress | string | JDBC driver property: netAddress. | |
packetSize | int | JDBC driver property: packetSize. | |
password | Reversably encoded password (string) | It is recommended to use a container managed authentication alias instead of configuring this property. | |
queryTimeout | A period of time with second precision | JDBC 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. | |
resultsetMetaDataOptions | int | JDBC driver property: resultsetMetaDataOptions. | |
selectMethod |
| JDBC driver property: selectMethod. | |
snapshotSerializable | boolean | JDBC driver property: snapshotSerializable. | |
spyAttributes | string | JDBC driver property: spyAttributes. | |
stringInputParameterType |
| varchar | JDBC driver property: stringInputParameterType. |
stringOutputParameterType |
| varchar | JDBC driver property: stringOutputParameterType. |
suppressConnectionWarnings | boolean | JDBC driver property: suppressConnectionWarnings. | |
transactionMode |
| JDBC driver property: transactionMode. | |
truncateFractionalSeconds | boolean | JDBC driver property: truncateFractionalSeconds. | |
trustStore | string | JDBC driver property: trustStore. | |
trustStorePassword | Reversably encoded password (string) | JDBC driver property: trustStorePassword. | |
useServerSideUpdatableCursors | boolean | JDBC driver property: useServerSideUpdatableCursors. | |
user | string | It is recommended to use a container managed authentication alias instead of configuring this property. | |
validateServerCertificate | boolean | JDBC driver property: validateServerCertificate. | |
Failover Properties | |||
alternateServers | string | JDBC driver property: alternateServers. | |
connectionRetryCount | int | JDBC driver property: connectionRetryCount. | |
connectionRetryDelay | A period of time with second precision | JDBC 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. | |
failoverGranularity |
| JDBC driver property: failoverGranularity. | |
failoverMode |
| JDBC driver property: failoverMode. | |
failoverPreconnect | boolean | JDBC driver property: failoverPreconnect. | |
loadBalancing | boolean | JDBC driver property: loadBalancing. |
oauthProvider > databaseStore > dataSource > properties.db2.i.native
Data source properties for the IBM DB2 for i Native JDBC driver.
Name | Type | Default | Description |
---|---|---|---|
databaseName | string | *LOCAL | JDBC driver property: databaseName. |
Advanced Properties | |||
access |
| all | JDBC driver property: access. |
autoCommit | boolean | true | JDBC driver property: autoCommit. |
batchStyle |
| 2.0 | JDBC driver property: batchStyle. |
behaviorOverride | int | JDBC driver property: behaviorOverride. | |
blockSize |
| 32 | JDBC driver property: blockSize. |
cursorHold | boolean | false | JDBC driver property: cursorHold. |
cursorSensitivity |
| asensitive | JDBC driver property: cursorSensitivity. Values are: 0 (TYPE_SCROLL_SENSITIVE_STATIC), 1 (TYPE_SCROLL_SENSITIVE_DYNAMIC), 2 (TYPE_SCROLL_ASENSITIVE). |
dataTruncation | string | true | JDBC driver property: dataTruncation. |
dateFormat |
| JDBC driver property: dateFormat. | |
dateSeparator |
| JDBC driver property: dateSeparator. | |
decimalSeparator |
| JDBC driver property: decimalSeparator. | |
directMap | boolean | true | JDBC driver property: directMap. |
doEscapeProcessing | boolean | true | JDBC driver property: doEscapeProcessing. |
fullErrors | boolean | JDBC driver property: fullErrors. | |
libraries | string | JDBC driver property: libraries. | |
lobThreshold | int | 0 | JDBC driver property: lobThreshold. |
lockTimeout | A period of time with second precision | 0 | JDBC 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. |
loginTimeout | A period of time with second precision | JDBC 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 |
| 31 | JDBC driver property: maximumPrecision. |
maximumScale | int | 31 | JDBC driver property: maximumScale. |
minimumDivideScale | int | 0 | JDBC driver property: minimumDivideScale. |
networkProtocol | int | JDBC driver property: networkProtocol. | |
password | Reversably encoded password (string) | It is recommended to use a container managed authentication alias instead of configuring this property. | |
portNumber | int | Port on which to obtain database connections. | |
prefetch | boolean | true | JDBC driver property: prefetch. |
queryOptimizeGoal |
| 2 | JDBC driver property: queryOptimizeGoal. Values are: 1 (*FIRSTIO) or 2 (*ALLIO). |
reuseObjects | boolean | true | JDBC driver property: reuseObjects. |
serverName | string | Server where the database is running. | |
serverTraceCategories | int | 0 | JDBC driver property: serverTraceCategories. |
systemNaming | boolean | false | JDBC driver property: systemNaming. |
timeFormat |
| JDBC driver property: timeFormat. | |
timeSeparator |
| JDBC driver property: timeSeparator. | |
trace | boolean | JDBC driver property: trace. | |
transactionTimeout | A period of time with second precision | 0 | JDBC 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. |
translateBinary | boolean | false | JDBC driver property: translateBinary. |
translateHex |
| character | JDBC driver property: translateHex. |
useBlockInsert | boolean | false | JDBC driver property: useBlockInsert. |
user | string | It is recommended to use a container managed authentication alias instead of configuring this property. |
oauthProvider > databaseStore > dataSource > properties.db2.i.toolbox
Data source properties for the IBM DB2 for i Toolbox JDBC driver.
Name | Type | Default | Description |
---|---|---|---|
databaseName | string | JDBC driver property: databaseName. | |
serverName | string | Server where the database is running. | |
Advanced Properties | |||
access |
| all | JDBC driver property: access. |
behaviorOverride | int | JDBC driver property: behaviorOverride. | |
bidiImplicitReordering | boolean | true | JDBC driver property: bidiImplicitReordering. |
bidiNumericOrdering | boolean | false | JDBC driver property: bidiNumericOrdering. |
bidiStringType | int | JDBC driver property: bidiStringType. | |
bigDecimal | boolean | true | JDBC driver property: bigDecimal. |
blockCriteria |
| 2 | JDBC driver property: blockCriteria. Values are: 0 (no record blocking), 1 (block if FOR FETCH ONLY is specified), 2 (block if FOR UPDATE is specified). |
blockSize |
| 32 | JDBC driver property: blockSize. |
characterTruncation |
| JDBC driver property: CharacterTruncation. | |
concurrentAccessResolution | int | JDBC driver property: concurrentAccessResolution. | |
cursorHold | boolean | false | JDBC driver property: cursorHold. |
cursorSensitivity |
| asensitive | JDBC driver property: cursorSensitivity. Values are: 0 (TYPE_SCROLL_SENSITIVE_STATIC), 1 (TYPE_SCROLL_SENSITIVE_DYNAMIC), 2 (TYPE_SCROLL_ASENSITIVE). |
dataCompression | boolean | true | JDBC driver property: dataCompression. |
dataTruncation | boolean | true | JDBC driver property: dataTruncation. |
dateFormat |
| JDBC driver property: dateFormat. | |
dateSeparator | * * - * . * / * \, | JDBC driver property: dateSeparator. | |
decfloatRoundingMode |
| JDBC driver property: decfloatRoundingMode. | |
decimalDataErrors | string | JDBC driver property: decimalDataErrors. | |
decimalSeparator |
| JDBC driver property: decimalSeparator. | |
describeOption | string | JDBC driver property: describeOption. | |
driver |
| toolbox | JDBC driver property: driver. |
errors |
| basic | JDBC driver property: errors. |
extendedDynamic | boolean | false | JDBC driver property: extendedDynamic. |
extendedMetaData | boolean | false | JDBC driver property: extendedMetaData. |
fullOpen | boolean | false | JDBC driver property: fullOpen. |
holdInputLocators | boolean | true | JDBC driver property: holdInputLocators. |
holdStatements | boolean | false | JDBC driver property: holdStatements. |
ignoreWarnings | string | JDBC driver property: ignoreWarnings. | |
isolationLevelSwitchingSupport | boolean | false | JDBC driver property: isolationLevelSwitchingSupport. |
keepAlive | boolean | JDBC driver property: keepAlive. | |
lazyClose | boolean | false | JDBC driver property: lazyClose. |
libraries | string | JDBC driver property: libraries. | |
lobThreshold | int | 0 | JDBC driver property: lobThreshold. |
loginTimeout | A period of time with second precision | JDBC 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. | |
maximumBlockedInputRows | int | JDBC driver property: maximumBlockedInputRows. | |
maximumPrecision |
| 31 | JDBC driver property: maximumPrecision. |
maximumScale | int | 31 | JDBC driver property: maximumScale. |
metaDataSource | int | 1 | JDBC driver property: metaDataSource. |
minimumDivideScale | int | 0 | JDBC driver property: minimumDivideScale. |
naming |
| sql | JDBC driver property: naming. |
numericRangeError |
| JDBC driver property: numericRangeError. | |
package | string | JDBC driver property: package. | |
packageAdd | boolean | true | JDBC driver property: packageAdd. |
packageCCSID |
| 13488 | JDBC driver property: packageCCSID. Values are: 1200 (UCS-2) or 13488 (UTF-16). |
packageCache | boolean | false | JDBC driver property: packageCache. |
packageCriteria |
| default | JDBC driver property: packageCriteria. |
packageError |
| warning | JDBC driver property: packageError. |
packageLibrary | string | QGPL | JDBC driver property: packageLibrary. |
password | Reversably encoded password (string) | It is recommended to use a container managed authentication alias instead of configuring this property. | |
prefetch | boolean | true | JDBC driver property: prefetch. |
prompt | boolean | false | JDBC driver property: prompt. |
proxyServer | string | JDBC driver property: proxyServer. | |
qaqqiniLibrary | string | JDBC driver property: qaqqiniLibrary. | |
queryOptimizeGoal | int | 0 | JDBC driver property: queryOptimizeGoal. Values are: 1 (*FIRSTIO) or 2 (*ALLIO). |
queryReplaceTruncatedParameter | string | JDBC driver property: queryReplaceTruncatedParameter. | |
queryStorageLimit | int | Query storage limit | |
queryTimeoutMechanism |
| JDBC driver property: queryTimeoutMechanism. | |
receiveBufferSize | int | JDBC driver property: receiveBufferSize. | |
remarks |
| system | JDBC driver property: remarks. |
rollbackCursorHold | boolean | false | JDBC driver property: rollbackCursorHold. |
savePasswordWhenSerialized | boolean | false | JDBC driver property: savePasswordWhenSerialized. |
secondaryUrl | string | JDBC driver property: secondaryUrl. | |
secure | boolean | false | JDBC driver property: secure. |
secureCurrentUser | boolean | JDBC driver property: secureCurrentUser. | |
sendBufferSize | int | JDBC driver property: sendBufferSize. | |
serverTrace | int | JDBC driver property: serverTrace. | |
serverTraceCategories | int | 0 | JDBC driver property: serverTraceCategories. |
soLinger | A period of time with second precision | JDBC 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. | |
soTimeout | A period of time with millisecond precision | JDBC 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 | JDBC driver property: sort. |
sortLanguage | string | JDBC driver property: sortLanguage. | |
sortTable | string | JDBC driver property: sortTable. | |
sortWeight |
| JDBC driver property: sortWeight. | |
tcpNoDelay | boolean | JDBC driver property: tcpNoDelay. | |
threadUsed | boolean | true | JDBC driver property: threadUsed. |
timeFormat |
| JDBC driver property: timeFormat. | |
timeSeparator | * * . * : * \, | JDBC driver property: timeSeparator. | |
timestampFormat |
| JDBC driver property: timestampFormat. | |
toolboxTrace |
| JDBC driver property: toolboxTrace. | |
trace | boolean | JDBC driver property: trace. | |
translateBinary | boolean | false | JDBC driver property: translateBinary. |
translateBoolean | boolean | true | JDBC driver property: translateBoolean. |
translateHex |
| character | JDBC driver property: translateHex. |
trueAutoCommit | boolean | false | JDBC driver property: trueAutoCommit. |
useBlockUpdate | boolean | JDBC driver property: useBlockUpdate. | |
useDrdaMetadataVersion | boolean | JDBC driver property: useDrdaMetadataVersion. | |
user | string | It is recommended to use a container managed authentication alias instead of configuring this property. | |
variableFieldCompression |
| JDBC driver property: variableFieldCompression. | |
xaLooselyCoupledSupport | int | 0 | JDBC driver property: xaLooselyCoupledSupport. |
oauthProvider > databaseStore > dataSource > properties.db2.jcc
Data source properties for the IBM Data Server Driver for JDBC and SQLJ for DB2.
Name | Type | Default | Description |
---|---|---|---|
databaseName | string | JDBC driver property: databaseName. | |
driverType |
| 4 | JDBC driver property: driverType. |
portNumber | int | 50000 | Port on which to obtain database connections. |
serverName | string | localhost | Server where the database is running. |
Advanced Properties | |||
SSLCipherSuites | string | JDBC driver property: SSLCipherSuites. | |
accessToken | Reversably encoded password (string) | JDBC driver property: accessToken. | |
accountingInterval | string | JDBC driver property: accountingInterval. | |
activateDatabase | int | JDBC driver property: activateDatabase. | |
allowNextOnExhaustedResultSet |
| JDBC driver property: allowNextOnExhaustedResultSet. | |
allowNullResultSetForExecuteQuery |
| JDBC driver property: allowNullResultSetForExecuteQuery. | |
alternateGroupDatabaseName | string | JDBC driver property: alternateGroupDatabaseName. | |
alternateGroupPortNumber | string | JDBC driver property: alternateGroupPortNumber. | |
alternateGroupServerName | string | JDBC driver property: alternateGroupServerName. | |
apiKey | Reversably encoded password (string) | JDBC driver property: apiKey. | |
atomicMultiRowInsert |
| JDBC driver property: atomicMultiRowInsert. | |
blockingReadConnectionTimeout | A period of time with second precision | JDBC 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. | |
charOutputSize | short | JDBC driver property: charOutputSize. | |
clientAccountingInformation | string | JDBC driver property: clientAccountingInformation. | |
clientApplcompat | string | JDBC driver property: clientApplcompat. | |
clientApplicationInformation | string | JDBC driver property: clientApplicationInformation. | |
clientBidiStringType |
| JDBC driver property: clientBidiStringType. | |
clientDebugInfo | string | JDBC driver property: clientDebugInfo. | |
clientProgramId | string | JDBC driver property: clientProgramId. | |
clientProgramName | string | JDBC driver property: clientProgramName. | |
clientUser | string | JDBC driver property: clientUser. | |
clientWorkstation | string | JDBC driver property: clientWorkstation. | |
commandTimeout | A period of time with second precision | JDBC 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 |
| JDBC driver property: concurrentAccessResolution. | |
connectNode | int | JDBC driver property: connectNode. | |
connectionCloseWithInFlightTransaction |
| JDBC driver property: connectionCloseWithInFlightTransaction. | |
connectionTimeout | A period of time with second precision | JDBC 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. | |
currentAlternateGroupEntry | int | JDBC driver property: currentAlternateGroupEntry. | |
currentDegree | string | JDBC driver property: currentDegree. | |
currentExplainMode | string | JDBC driver property: currentExplainMode. | |
currentExplainSnapshot | int | JDBC driver property: currentExplainSnapshot. | |
currentFunctionPath | string | JDBC driver property: currentFunctionPath. | |
currentLocaleLcCtype | string | JDBC driver property: currentLocaleLcCtype. | |
currentLockTimeout | A period of time with second precision | JDBC 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 |
| JDBC driver property: currentMaintainedTableTypesForOptimization. | |
currentPackagePath | string | JDBC driver property: currentPackagePath. | |
currentPackageSet | string | JDBC driver property: currentPackageSet. | |
currentQueryOptimization |
| JDBC driver property: currentQueryOptimization. | |
currentSQLID | string | JDBC driver property: currentSQLID. | |
currentSchema | string | JDBC driver property: currentSchema. | |
cursorSensitivity |
| JDBC driver property: cursorSensitivity. Values are: 0 (TYPE_SCROLL_SENSITIVE_STATIC), 1 (TYPE_SCROLL_SENSITIVE_DYNAMIC), 2 (TYPE_SCROLL_ASENSITIVE). | |
dateFormat |
| JDBC driver property: dateFormat. | |
decimalRoundingMode |
| JDBC driver property: decimalRoundingMode. | |
decimalSeparator |
| JDBC driver property: decimalSeparator. | |
decimalStringFormat |
| JDBC driver property: decimalStringFormat. | |
deferPrepares | boolean | true | JDBC driver property: deferPrepares. |
downgradeHoldCursorsUnderXa | boolean | JDBC driver property: downgradeHoldCursorsUnderXa. | |
enableAlternateGroupSeamlessACR | boolean | JDBC driver property: enableAlternateGroupSeamlessACR. | |
enableBidiLayoutTransformation | boolean | JDBC driver property: enableBidiLayoutTransformation. | |
enableClientAffinitiesList |
| JDBC driver property: enableClientAffinitiesList. Values are: 1 (YES) or 2 (NO). | |
enableConnectionConcentrator | boolean | JDBC driver property: enableConnectionConcentrator. | |
enableExtendedDescribe |
| JDBC driver property: enableExtendedDescribe. | |
enableExtendedIndicators |
| JDBC driver property: enableExtendedIndicators. | |
enableMultiRowInsertSupport | boolean | JDBC driver property: enableMultiRowInsertSupport. | |
enableNamedParameterMarkers |
| JDBC driver property: enableNamedParameterMarkers. Values are: 1 (YES) or 2 (NO). | |
enableRowsetSupport |
| JDBC driver property: enableRowsetSupport. | |
enableSeamlessFailover |
| JDBC driver property: enableSeamlessFailover. Values are: 1 (YES) or 2 (NO). | |
enableSysplexWLB | boolean | JDBC driver property: enableSysplexWLB. | |
enableT2zosLBF |
| JDBC driver property: enableT2zosLBF. | |
enableT2zosLBFSPResultSets |
| JDBC driver property: enableT2zosLBFSPResultSets. | |
enableXACleanTransaction | boolean | JDBC driver property: enableXACleanTransaction. | |
encryptionAlgorithm |
| JDBC driver property: encryptionAlgorithm. | |
extendedTableInfo |
| JDBC driver property: extendedTableInfo. | |
fetchSize | int | JDBC driver property: fetchSize. | |
fullyMaterializeInputStreams | boolean | JDBC driver property: fullyMaterializeInputStreams. | |
fullyMaterializeInputStreamsOnBatchExecution |
| JDBC driver property: fullyMaterializeInputStreamsOnBatchExecution. | |
fullyMaterializeLobData | boolean | JDBC driver property: fullyMaterializeLobData. | |
implicitRollbackOption |
| JDBC driver property: implicitRollbackOption. | |
interruptProcessingMode |
| JDBC driver property: interruptProcessingMode. | |
jdbcCollection | string | JDBC driver property: jdbcCollection. | |
keepAliveTimeOut | A period of time with second precision | JDBC 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. | |
keepDynamic | int | JDBC driver property: keepDynamic. | |
kerberosServerPrincipal | string | JDBC driver property: kerberosServerPrincipal. | |
loginTimeout | A period of time with second precision | JDBC 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. | |
maxConnCachedParamBufferSize | int | JDBC driver property: maxConnCachedParamBufferSize. | |
maxRowsetSize | int | JDBC driver property: maxRowsetSize. | |
maxTransportObjects | int | JDBC driver property: maxTransportObjects. | |
optimizationProfile | string | JDBC driver property: optimizationProfile. | |
optimizationProfileToFlush | string | JDBC driver property: optimizationProfileToFlush. | |
password | Reversably encoded password (string) | It is recommended to use a container managed authentication alias instead of configuring this property. | |
pkList | string | JDBC driver property: pkList. | |
profileName | string | JDBC driver property: profileName. | |
progressiveStreaming |
| JDBC driver property: progressiveStreaming. Values are: 1 (YES) or 2 (NO). | |
queryCloseImplicit |
| JDBC driver property: queryCloseImplicit. Values are: 1 (QUERY_CLOSE_IMPLICIT_YES) or 2 (QUERY_CLOSE_IMPLICIT_NO). | |
queryDataSize | int | JDBC driver property: queryDataSize. | |
queryTimeoutInterruptProcessingMode |
| JDBC driver property: queryTimeoutInterruptProcessingMode. | |
readOnly | boolean | JDBC driver property: readOnly. | |
recordTemporalHistory |
| JDBC driver property: recordTemporalHistory. | |
reportLongTypes |
| JDBC driver property: reportLongTypes. | |
resultSetHoldability |
| JDBC driver property: resultSetHoldability. Values are: 1 (HOLD_CURSORS_OVER_COMMIT) or 2 (CLOSE_CURSORS_AT_COMMIT). | |
resultSetHoldabilityForCatalogQueries |
| JDBC driver property: resultSetHoldabilityForCatalogQueries. Values are: 1 (HOLD_CURSORS_OVER_COMMIT) or 2 (CLOSE_CURSORS_AT_COMMIT). | |
retrieveMessagesFromServerOnGetMessage | boolean | true | JDBC driver property: retrieveMessagesFromServerOnGetMessage. |
retryWithAlternativeSecurityMechanism |
| JDBC driver property: retryWithAlternativeSecurityMechanism. | |
returnAlias |
| JDBC driver property: returnAlias. | |
securityMechanism |
| 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). | |
sendCharInputsUTF8 |
| JDBC driver property: sendCharInputsUTF8. | |
sendDataAsIs | boolean | JDBC driver property: sendDataAsIs. | |
serverBidiStringType |
| JDBC driver property: serverBidiStringType. | |
sessionTimeZone | string | JDBC driver property: sessionTimeZone. | |
sqljCloseStmtsWithOpenResultSet | boolean | JDBC driver property: sqljCloseStmtsWithOpenResultSet. | |
sqljEnableClassLoaderSpecificProfiles | boolean | JDBC driver property: sqljEnableClassLoaderSpecificProfiles. | |
ssid | string | JDBC driver property: ssid. | |
sslCertLocation | string | JDBC driver property: sslCertLocation. | |
sslConnection | boolean | JDBC driver property: sslConnection. | |
sslKeyStoreLocation | string | JDBC driver property: sslKeyStoreLocation. | |
sslKeyStorePassword | Reversably encoded password (string) | JDBC driver property: sslKeyStorePassword. | |
sslKeyStoreType | string | JDBC driver property: sslKeyStoreType. | |
sslTrustStoreLocation | string | JDBC driver property: sslTrustStoreLocation. | |
sslTrustStorePassword | Reversably encoded password (string) | JDBC driver property: sslTrustStorePassword. | |
sslTrustStoreType | string | JDBC driver property: sslTrustStoreType. | |
statementConcentrator |
| JDBC driver property: statementConcentrator. | |
streamBufferSize | int | JDBC driver property: streamBufferSize. | |
stripTrailingZerosForDecimalNumbers |
| JDBC driver property: stripTrailingZerosForDecimalNumbers. | |
sysSchema | string | JDBC driver property: sysSchema. | |
timeFormat |
| JDBC driver property: timeFormat. | |
timerLevelForQueryTimeOut |
| JDBC driver property: timerLevelForQueryTimeOut. | |
timestampFormat |
| JDBC driver property: timestampFormat. | |
timestampOutputType |
| JDBC driver property: timestampOutputType. | |
timestampPrecisionReporting |
| JDBC driver property: timestampPrecisionReporting. | |
traceDirectory | string | JDBC driver property: traceDirectory. | |
traceFile | string | JDBC driver property: traceFile. | |
traceFileAppend | boolean | JDBC driver property: traceFileAppend. | |
traceFileCount | int | JDBC driver property: traceFileCount. | |
traceFileSize | int | JDBC driver property: traceFileSize. | |
traceLevel | int | 0 | Bitwise 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 |
| JDBC driver property: traceOption | |
translateForBitData |
| JDBC driver property: translateForBitData. | |
updateCountForBatch |
| JDBC driver property: updateCountForBatch. | |
useCachedCursor | boolean | JDBC driver property: useCachedCursor. | |
useIdentityValLocalForAutoGeneratedKeys | boolean | JDBC driver property: useIdentityValLocalForAutoGeneratedKeys. | |
useJDBC41DefinitionForGetColumns |
| JDBC driver property: useJDBC41DefinitionForGetColumns. | |
useJDBC4ColumnNameAndLabelSemantics |
| JDBC driver property: useJDBC4ColumnNameAndLabelSemantics. Values are: 1 (YES) or 2 (NO). | |
useRowsetCursor | boolean | JDBC driver property: useRowsetCursor. | |
useTransactionRedirect | boolean | JDBC driver property: useTransactionRedirect. | |
user | string | It is recommended to use a container managed authentication alias instead of configuring this property. | |
xaNetworkOptimization | boolean | JDBC driver property: xaNetworkOptimization. | |
xmlFormat |
| JDBC driver property: xmlFormat. | |
Automatic Client Reroute Properties | |||
affinityFailbackInterval | A period of time with second precision | JDBC 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. | |
clientRerouteAlternatePortNumber | string | JDBC driver property: clientRerouteAlternatePortNumber. | |
clientRerouteAlternateServerName | string | JDBC driver property: clientRerouteAlternateServerName. | |
maxRetriesForClientReroute | int | JDBC driver property: maxRetriesForClientReroute. | |
memberConnectTimeout | A period of time with second precision | JDBC 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. | |
retryIntervalForClientReroute | A period of time with second precision | JDBC 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. |
oauthProvider > databaseStore > dataSource > properties.derby.client
Data source properties for Derby Network Client JDBC driver.
Name | Type | Default | Description |
---|---|---|---|
createDatabase |
| JDBC driver property: createDatabase. | |
databaseName | string | JDBC driver property: databaseName. | |
portNumber | int | 1527 | Port on which to obtain database connections. |
serverName | string | localhost | Server where the database is running. |
Advanced Properties | |||
connectionAttributes | string | JDBC driver property: connectionAttributes. | |
loginTimeout | A period of time with second precision | JDBC 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. | |
password | Reversably encoded password (string) | It is recommended to use a container managed authentication alias instead of configuring this property. | |
retrieveMessageText | boolean | true | JDBC driver property: retrieveMessageText. |
securityMechanism |
| 3 | JDBC 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). |
shutdownDatabase |
| JDBC driver property: shutdownDatabase. | |
ssl |
| JDBC driver property: ssl. | |
traceDirectory | string | JDBC driver property: traceDirectory. | |
traceFile | string | JDBC driver property: traceFile. | |
traceFileAppend | boolean | JDBC driver property: traceFileAppend. | |
traceLevel | int | Bitwise 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. | |
user | string | It 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.
Name | Type | Default | Description |
---|---|---|---|
createDatabase |
| JDBC driver property: createDatabase. | |
databaseName | string | JDBC driver property: databaseName. | |
Advanced Properties | |||
connectionAttributes | string | JDBC driver property: connectionAttributes. | |
loginTimeout | A period of time with second precision | JDBC 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. | |
password | Reversably encoded password (string) | It is recommended to use a container managed authentication alias instead of configuring this property. | |
shutdownDatabase |
| JDBC driver property: shutdownDatabase. | |
user | string | It is recommended to use a container managed authentication alias instead of configuring this property. |
oauthProvider > databaseStore > dataSource > properties.informix
Data source properties for the Informix JDBC driver.
Name | Type | Default | Description |
---|---|---|---|
databaseName | string | JDBC driver property: databaseName. | |
ifxIFXHOST | string | localhost | JDBC driver property: ifxIFXHOST. |
portNumber | int | 1526 | Port on which to obtain database connections. |
serverName | string | Server where the database is running. | |
Advanced Properties | |||
ifxCLIENT_LOCALE | string | JDBC driver property: ifxCLIENT_LOCALE. | |
ifxDBANSIWARN | boolean | JDBC driver property: ifxDBANSIWARN. | |
ifxDBCENTURY | string | JDBC driver property: ifxDBCENTURY. | |
ifxDBDATE | string | JDBC driver property: ifxDBDATE. | |
ifxDBSPACETEMP | string | JDBC driver property: ifxDBSPACETEMP. | |
ifxDBTEMP | string | JDBC driver property: ifxDBTEMP. | |
ifxDBTIME | string | JDBC driver property: ifxDBTIME. | |
ifxDBUPSPACE | string | JDBC driver property: ifxDBUPSPACE. | |
ifxDB_LOCALE | string | JDBC driver property: ifxDB_LOCALE. | |
ifxDELIMIDENT | boolean | JDBC driver property: ifxDELIMIDENT. | |
ifxENABLE_TYPE_CACHE | boolean | JDBC driver property: ifxENABLE_TYPE_CACHE. | |
ifxFET_BUF_SIZE | int | JDBC driver property: ifxFET_BUF_SIZE. | |
ifxGL_DATE | string | JDBC driver property: ifxGL_DATE. | |
ifxGL_DATETIME | string | JDBC driver property: ifxGL_DATETIME. | |
ifxIFX_AUTOFREE | boolean | JDBC driver property: ifxIFX_AUTOFREE. | |
ifxIFX_DIRECTIVES | string | JDBC driver property: ifxIFX_DIRECTIVES. | |
ifxIFX_LOCK_MODE_WAIT | A period of time with second precision | 2s | JDBC 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_TIMEOUT | A period of time with millisecond precision | JDBC 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_USEPUT | boolean | JDBC driver property: ifxIFX_USEPUT. | |
ifxIFX_USE_STRENC | boolean | JDBC driver property: ifxIFX_USE_STRENC. | |
ifxIFX_XASPEC | string | y | JDBC driver property: ifxIFX_XASPEC. |
ifxINFORMIXCONRETRY | int | JDBC driver property: ifxINFORMIXCONRETRY. | |
ifxINFORMIXCONTIME | A period of time with second precision | JDBC 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. | |
ifxINFORMIXOPCACHE | string | JDBC driver property: ifxINFORMIXOPCACHE. | |
ifxINFORMIXSTACKSIZE | int | JDBC driver property: ifxINFORMIXSTACKSIZE. | |
ifxJDBCTEMP | string | JDBC driver property: ifxJDBCTEMP. | |
ifxLDAP_IFXBASE | string | JDBC driver property: ifxLDAP_IFXBASE. | |
ifxLDAP_PASSWD | string | JDBC driver property: ifxLDAP_PASSWD. | |
ifxLDAP_URL | string | JDBC driver property: ifxLDAP_URL. | |
ifxLDAP_USER | string | JDBC driver property: ifxLDAP_USER. | |
ifxLOBCACHE | int | JDBC driver property: ifxLOBCACHE. | |
ifxNEWCODESET | string | JDBC driver property: ifxNEWCODESET. | |
ifxNEWLOCALE | string | JDBC driver property: ifxNEWLOCALE. | |
ifxNODEFDAC | string | JDBC driver property: ifxNODEFDAC. | |
ifxOPTCOMPIND | string | JDBC driver property: ifxOPTCOMPIND. | |
ifxOPTOFC | string | JDBC driver property: ifxOPTOFC. | |
ifxOPT_GOAL | string | JDBC driver property: ifxOPT_GOAL. | |
ifxPATH | string | JDBC driver property: ifxPATH. | |
ifxPDQPRIORITY | string | JDBC driver property: ifxPDQPRIORITY. | |
ifxPLCONFIG | string | JDBC driver property: ifxPLCONFIG. | |
ifxPLOAD_LO_PATH | string | JDBC driver property: ifxPLOAD_LO_PATH. | |
ifxPROTOCOLTRACE | int | JDBC driver property: ifxPROTOCOLTRACE. | |
ifxPROTOCOLTRACEFILE | string | JDBC driver property: ifxPROTOCOLTRACEFILE. | |
ifxPROXY | string | JDBC driver property: ifxPROXY. | |
ifxPSORT_DBTEMP | string | JDBC driver property: ifxPSORT_DBTEMP. | |
ifxPSORT_NPROCS | boolean | JDBC driver property: ifxPSORT_NPROCS. | |
ifxSECURITY | string | JDBC driver property: ifxSECURITY. | |
ifxSQLH_FILE | string | JDBC driver property: ifxSQLH_FILE. | |
ifxSQLH_LOC | string | JDBC driver property: ifxSQLH_LOC. | |
ifxSQLH_TYPE | string | JDBC driver property: ifxSQLH_TYPE. | |
ifxSSLCONNECTION | string | JDBC driver property: ifxSSLCONNECTION. | |
ifxSTMT_CACHE | string | JDBC driver property: ifxSTMT_CACHE. | |
ifxTRACE | int | JDBC driver property: ifxTRACE. | |
ifxTRACEFILE | string | JDBC driver property: ifxTRACEFILE. | |
ifxTRUSTED_CONTEXT | string | JDBC driver property: ifxTRUSTED_CONTEXT. | |
ifxUSEV5SERVER | boolean | JDBC driver property: ifxUSEV5SERVER. | |
ifxUSE_DTENV | boolean | JDBC driver property: ifxUSE_DTENV. | |
loginTimeout | A period of time with second precision | JDBC 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. | |
password | Reversably encoded password (string) | It is recommended to use a container managed authentication alias instead of configuring this property. | |
roleName | string | JDBC driver property: roleName. | |
user | string | It is recommended to use a container managed authentication alias instead of configuring this property. | |
Informix Connection Pool Properties | |||
ifxCPMAgeLimit | A period of time with second precision | JDBC 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. | |
ifxCPMInitPoolSize | int | JDBC driver property: ifxCPMInitPoolSize. | |
ifxCPMMaxConnections | int | JDBC driver property: ifxCPMMaxConnections. | |
ifxCPMMaxPoolSize | int | JDBC driver property: ifxCPMMaxPoolSize. | |
ifxCPMMinAgeLimit | A period of time with second precision | JDBC 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. | |
ifxCPMMinPoolSize | int | JDBC driver property: ifxCPMMinPoolSize. | |
ifxCPMServiceInterval | A period of time with millisecond precision | JDBC 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. |
oauthProvider > databaseStore > dataSource > properties.informix.jcc
Data source properties for the IBM Data Server Driver for JDBC and SQLJ for Informix.
Name | Type | Default | Description |
---|---|---|---|
databaseName | string | JDBC driver property: databaseName. | |
portNumber | int | 1526 | Port on which to obtain database connections. |
serverName | string | localhost | Server where the database is running. |
Advanced Properties | |||
DBANSIWARN | boolean | JDBC driver property: DBANSIWARN. | |
DBDATE | string | JDBC driver property: DBDATE. | |
DBPATH | string | JDBC driver property: DBPATH. | |
DBSPACETEMP | string | JDBC driver property: DBSPACETEMP. | |
DBTEMP | string | JDBC driver property: DBTEMP. | |
DBUPSPACE | string | JDBC driver property: DBUPSPACE. | |
DELIMIDENT | boolean | JDBC driver property: DELIMIDENT. | |
IFX_DIRECTIVES |
| JDBC driver property: IFX_DIRECTIVES. | |
IFX_EXTDIRECTIVES |
| JDBC driver property: IFX_EXTDIRECTIVES. | |
IFX_UPDDESC | string | JDBC driver property: IFX_UPDDESC. | |
IFX_XASTDCOMPLIANCE_XAEND |
| JDBC driver property: IFX_XASTDCOMPLIANCE_XAEND. | |
INFORMIXOPCACHE | string | JDBC driver property: INFORMIXOPCACHE. | |
INFORMIXSTACKSIZE | string | JDBC driver property: INFORMIXSTACKSIZE. | |
NODEFDAC |
| JDBC driver property: NODEFDAC. | |
OPTCOMPIND |
| JDBC driver property: OPTCOMPIND. | |
OPTOFC |
| JDBC driver property: OPTOFC. | |
PDQPRIORITY |
| JDBC driver property: PDQPRIORITY. | |
PSORT_DBTEMP | string | JDBC driver property: PSORT_DBTEMP. | |
PSORT_NPROCS | string | JDBC driver property: PSORT_NPROCS. | |
STMT_CACHE |
| JDBC driver property: STMT_CACHE. | |
currentLockTimeout | A period of time with second precision | 2s | JDBC 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. |
deferPrepares | boolean | JDBC driver property: deferPrepares. | |
driverType | int | 4 | JDBC driver property: driverType. |
enableNamedParameterMarkers | int | JDBC driver property: enableNamedParameterMarkers. Values are: 1 (YES) or 2 (NO). | |
enableSeamlessFailover | int | JDBC driver property: enableSeamlessFailover. Values are: 1 (YES) or 2 (NO). | |
enableSysplexWLB | boolean | JDBC driver property: enableSysplexWLB. | |
fetchSize | int | JDBC driver property: fetchSize. | |
fullyMaterializeLobData | boolean | JDBC driver property: fullyMaterializeLobData. | |
keepDynamic | int | JDBC driver property: keepDynamic. | |
loginTimeout | A period of time with second precision | JDBC 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. | |
password | Reversably encoded password (string) | It is recommended to use a container managed authentication alias instead of configuring this property. | |
progressiveStreaming |
| JDBC driver property: progressiveStreaming. Values are: 1 (YES) or 2 (NO). | |
queryDataSize | int | JDBC driver property: queryDataSize. | |
resultSetHoldability |
| JDBC driver property: resultSetHoldability. Values are: 1 (HOLD_CURSORS_OVER_COMMIT) or 2 (CLOSE_CURSORS_AT_COMMIT). | |
resultSetHoldabilityForCatalogQueries |
| JDBC driver property: resultSetHoldabilityForCatalogQueries. Values are: 1 (HOLD_CURSORS_OVER_COMMIT) or 2 (CLOSE_CURSORS_AT_COMMIT). | |
retrieveMessagesFromServerOnGetMessage | boolean | true | JDBC driver property: retrieveMessagesFromServerOnGetMessage. |
securityMechanism |
| 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). | |
traceDirectory | string | JDBC driver property: traceDirectory. | |
traceFile | string | JDBC driver property: traceFile. | |
traceFileAppend | boolean | JDBC driver property: traceFileAppend. | |
traceLevel | int | Bitwise 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. | |
useJDBC4ColumnNameAndLabelSemantics | int | JDBC driver property: useJDBC4ColumnNameAndLabelSemantics. Values are: 1 (YES) or 2 (NO). | |
user | 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.
Name | Type | Default | Description |
---|---|---|---|
databaseName | string | JDBC driver property: databaseName. | |
instanceName | string | JDBC driver property: instanceName. | |
portNumber | int | Port on which to obtain database connections. | |
serverName | string | localhost | Server where the database is running. |
Advanced Properties | |||
URL | string | URL for connecting to the database. Example: jdbc:sqlserver://localhost:1433;databaseName=myDB. | |
accessToken | Reversably encoded password (string) | JDBC driver property: accessToken. | |
applicationIntent |
| JDBC driver property: applicationIntent. | |
applicationName | string | JDBC driver property: applicationName. | |
authentication |
| JDBC driver property: authentication. | |
authenticationScheme |
| JDBC driver property: authenticationScheme. | |
columnEncryptionSetting |
| JDBC driver property: columnEncryptionSetting. | |
encrypt | boolean | JDBC driver property: encrypt. | |
failoverPartner | string | JDBC driver property: failoverPartner. | |
hostNameInCertificate | string | JDBC driver property: hostNameInCertificate. | |
integratedSecurity | boolean | JDBC driver property: integratedSecurity. | |
keyStoreAuthentication |
| JDBC driver property: keyStoreAuthentication. | |
keyStoreLocation | Path to a file | JDBC driver property: keyStoreLocation. | |
keyStoreSecret | Reversably encoded password (string) | JDBC driver property: keyStoreSecret. | |
lastUpdateCount | boolean | JDBC driver property: lastUpdateCount. | |
lockTimeout | A period of time with millisecond precision | JDBC 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. | |
loginTimeout | A period of time with second precision | JDBC 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. | |
multiSubnetFailover | boolean | JDBC driver property: multiSubnetFailover. | |
packetSize | int | JDBC driver property: packetSize. | |
password | Reversably encoded password (string) | It is recommended to use a container managed authentication alias instead of configuring this property. | |
responseBuffering |
| JDBC driver property: responseBuffering. | |
selectMethod |
| JDBC driver property: selectMethod. | |
sendStringParametersAsUnicode | boolean | false | JDBC driver property: sendStringParametersAsUnicode. |
sendTimeAsDatetime | boolean | JDBC driver property: sendTimeAsDatetime. | |
serverNameAsACE | boolean | JDBC driver property: serverNameAsACE. | |
serverSpn | string | JDBC driver property: serverSpn. | |
transparentNetworkIPResolution | boolean | JDBC driver property: transparentNetworkIPResolution. | |
trustServerCertificate | boolean | JDBC driver property: trustServerCertificate. | |
trustStore | string | JDBC driver property: trustStore. | |
trustStorePassword | Reversably encoded password (string) | JDBC driver property: trustStorePassword. | |
user | string | It is recommended to use a container managed authentication alias instead of configuring this property. | |
workstationID | string | JDBC driver property: workstationID. | |
xopenStates | boolean | JDBC driver property: xopenStates. |
oauthProvider > databaseStore > dataSource > properties.oracle
Data source properties for Oracle JDBC driver.
Name | Type | Default | Description |
---|---|---|---|
URL | string | JDBC driver property: URL. URL for connecting to the database. If a URL is configured, the Oracle JDBC driver ignores individual connection properties such as serverName and driverType. Oracle JDBC driver updates might impact this behavior. Examples: jdbc:oracle:thin:@//localhost:1521/sample or jdbc:oracle:oci:@//localhost:1521/sample. | |
databaseName | string | JDBC driver property: databaseName. | |
driverType |
| thin | JDBC driver property: driverType. |
portNumber | int | 1521 | Port on which to obtain database connections. |
serverName | string | localhost | Server where the database is running. |
Advanced Properties | |||
ONSConfiguration | string | JDBC driver property: ONSConfiguration. | |
TNSEntryName | string | JDBC driver property: TNSEntryName. | |
connectionProperties | string | JDBC driver property: connectionProperties. Encrypted values can be configured for the javax.net.ssl.keyStorePassword and javax.net.ssl.trustStorePassword SSL properties by using the same process that is used for other data source passwords. | |
loginTimeout | A period of time with second precision | JDBC 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 | string | JDBC driver property: networkProtocol. | |
password | Reversably encoded password (string) | It is recommended to use a container managed authentication alias instead of configuring this property. | |
roleName | string | JDBC driver property: roleName. | |
serviceName | string | JDBC driver property: serviceName. | |
user | string | It is recommended to use a container managed authentication alias instead of configuring this property. |
oauthProvider > databaseStore > dataSource > properties.oracle.ucp
Data source properties for Oracle Universal Connection Pooling.
Name | Type | Default | Description |
---|---|---|---|
URL | string | JDBC driver property: URL. URL for connecting to the database. If a URL is configured, the Oracle JDBC driver ignores individual connection properties such as serverName and driverType. Oracle JDBC driver updates might impact this behavior. Examples: jdbc:oracle:thin:@//localhost:1521/sample or jdbc:oracle:oci:@//localhost:1521/sample. | |
connectionFactoryClassName |
| JDBC driver property: connectionFactoryClassName. | |
connectionPoolName | string | JDBC driver property: connectionPoolName. | |
databaseName | string | JDBC driver property: databaseName. | |
portNumber | int | 1521 | Port on which to obtain database connections. |
serverName | string | localhost | Server where the database is running. |
Advanced Properties | |||
ONSConfiguration | string | JDBC driver property: ONSConfiguration. | |
SQLForValidateConnection | string | JDBC driver property: SQLForValidateConnection. | |
abandonedConnectionTimeout | A period of time with second precision | JDBC driver property: abandonedConnectionTimeout. 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. | |
connectionFactoryProperties | string | JDBC driver property: connectionFactoryProperties. | |
connectionHarvestMaxCount | int | JDBC driver property: connectionHarvestMaxCount. | |
connectionHarvestTriggerCount | int | JDBC driver property: connectionHarvestTriggerCount. | |
connectionProperties | string | JDBC driver property: connectionProperties. Encrypted values can be configured for the javax.net.ssl.keyStorePassword and javax.net.ssl.trustStorePassword SSL properties by using the same process that is used for other data source passwords. | |
connectionWaitTimeout | A period of time with second precision | JDBC driver property: connectionWaitTimeout. 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. | |
fastConnectionFailoverEnabled | boolean | JDBC driver property: fastConnectionFailoverEnabled. | |
initialPoolSize | int | JDBC driver property: initialPoolSize. | |
loginTimeout | A period of time with second precision | JDBC 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. | |
maxConnectionReuseCount | int | JDBC driver property: maxConnectionReuseCount. | |
maxConnectionReuseTime | A period of time with second precision | JDBC driver property: maxConnectionReuseTime. 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. | |
maxConnectionsPerShard | int | JDBC driver property: maxConnectionsPerShard. | |
maxIdleTime | A period of time with second precision | JDBC driver property: maxIdleTime. 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. | |
maxPoolSize | int | JDBC driver property: maxPoolSize. | |
maxStatements | int | JDBC driver property: maxStatements. | |
minPoolSize | int | JDBC driver property: minPoolSize. | |
networkProtocol | string | JDBC driver property: networkProtocol. | |
password | Reversably encoded password (string) | It is recommended to use a container managed authentication alias instead of configuring this property. | |
roleName | string | JDBC driver property: roleName. | |
secondsToTrustIdleConnection | A period of time with second precision | JDBC driver property: secondsToTrustIdleConnection. 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. | |
timeToLiveConnectionTimeout | A period of time with second precision | JDBC driver property: timeToLiveConnectionTimeout. 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. | |
timeoutCheckInterval | A period of time with second precision | JDBC driver property: timeoutCheckInterval. 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. | |
user | string | It is recommended to use a container managed authentication alias instead of configuring this property. | |
validateConnectionOnBorrow | boolean | JDBC driver property: validateConnectionOnBorrow. |
oauthProvider > databaseStore > dataSource > properties.postgresql
Data source properties for PostgreSQL JDBC driver.
Name | Type | Default | Description |
---|---|---|---|
databaseName | string | JDBC driver property: databaseName. | |
portNumber | int | Port on which to obtain database connections. | |
serverName | string | Server where the database is running. | |
Advanced Properties | |||
URL | string | URL for connecting to the database. | |
applicationName | string | JDBC driver property: applicationName. | |
cancelSignalTimeout | A period of time with second precision | JDBC driver property: cancelSignalTimeout. 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. | |
connectTimeout | A period of time with second precision | JDBC driver property: connectTimeout. 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. | |
currentSchema | string | JDBC driver property: currentSchema. | |
defaultRowFetchSize | int | JDBC driver property: defaultRowFetchSize. | |
loginTimeout | A period of time with second precision | JDBC 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. | |
password | Reversably encoded password (string) | It is recommended to use a container managed authentication alias instead of configuring this property. | |
preparedStatementCacheQueries | int | 0 | JDBC driver property: preparedStatementCacheQueries. |
readOnly | boolean | JDBC driver property: readOnly. | |
socketTimeout | A period of time with second precision | JDBC driver property: socketTimeout. 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. | |
ssl | boolean | JDBC driver property: ssl. | |
sslCert | A file, directory or url. | JDBC driver property: sslCert. | |
sslKey | A file, directory or url. | JDBC driver property: sslKey. | |
sslMode |
| JDBC driver property: sslMode. | |
sslPassword | Reversably encoded password (string) | JDBC driver property: sslPassword. | |
sslRootCert | A file, directory or url. | JDBC driver property: sslRootCert. | |
sslfactory | string | JDBC driver property: sslfactory. | |
targetServerType | string | JDBC driver property: targetServerType. | |
tcpKeepAlive | boolean | JDBC driver property: tcpKeepAlive. | |
user | string | It is recommended to use a container managed authentication alias instead of configuring this property. |
oauthProvider > databaseStore > dataSource > properties.sybase
Data source properties for Sybase JDBC driver.
Name | Type | Default | Description |
---|---|---|---|
databaseName | string | JDBC driver property: databaseName. | |
portNumber | int | 5000 | Port on which to obtain database connections. |
serverName | string | localhost | Server where the database is running. |
Advanced Properties | |||
SERVER_INITIATED_TRANSACTIONS |
| false | JDBC driver property: SERVER_INITIATED_TRANSACTIONS. |
connectionProperties | string | SELECT_OPENS_CURSOR=true | JDBC driver property: connectionProperties. Encrypted values can be configured for the javax.net.ssl.keyStorePassword and javax.net.ssl.trustStorePassword SSL properties by using the same process that is used for other data source passwords. |
loginTimeout | A period of time with second precision | JDBC 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 |
| JDBC driver property: networkProtocol. | |
password | Reversably encoded password (string) | It is recommended to use a container managed authentication alias instead of configuring this property. | |
resourceManagerName | string | JDBC driver property: resourceManagerName. | |
user | string | It is recommended to use a container managed authentication alias instead of configuring this property. | |
version | int | JDBC driver property: version. |
oauthProvider > databaseStore > dataSource > recoveryAuthData
Authentication data for transaction recovery.
Name | Type | Default | Description |
---|---|---|---|
krb5Principal | string | The name of the Kerberos principal name or Kerberos service name to be used. | |
krb5TicketCache | Path to a file | The file location where Kerberos credentials for the Kerberos principal name or service name will be stored. Also known as the Kerberos credential cache (ccache) | |
password | Reversably 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. | |
user | string | Name of the user to use when connecting to the EIS. |
oauthProvider > jwtGrantType
The grant_type for JWT Token handler
Name | Type | Default | Description |
---|---|---|---|
clockSkew | A period of time with second precision | 300s | The 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. |
iatRequired | boolean | false | The iat claim in a jwt token is required. |
maxJtiCacheSize | long | 10000 | The maximum size of cache, which keeps jti data of jwt token, to prevent the jti from being reused. |
tokenMaxLifetime | A period of time with second precision | 7200s | The 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. |
oauthProvider > library
Reference to shared library containing the mediator plugin class.
Name | Type | Default | Description |
---|---|---|---|
apiTypeVisibility | string | spec,ibm-api,api,stable | The 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. |
description | string | Description of shared library for administrators | |
filesetRef | List of references to top level fileset elements (comma-separated string). | Id of referenced Fileset | |
name | string | Name of shared library for administrators |
oauthProvider > library > file
Id of referenced File
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
name | Path to a file | Fully qualified filename |
oauthProvider > library > fileset
Id of referenced Fileset
Name | Type | Default | Description |
---|---|---|---|
caseSensitive | boolean | true | Boolean to indicate whether or not the search should be case sensitive (default: true). |
dir | Path to a directory | ${server.config.dir} | The base directory to search for files. |
excludes | string | The comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded. | |
id | string | A unique configuration ID. | |
includes | string | * | The comma or space separated list of file name patterns to include in the search results (default: *). |
scanInterval | A period of time with millisecond precision | 0 | The scanning interval to determine whether files are added or removed from the fileset. The individual files are not scanned. The suffix for the interval of time is h-hour, m-minute, s-second, and ms-millisecond, for example, 2ms or 5s. The scanning interval is disabled by default and is disabled manually by setting the scan interval, scanInterval, to 0. 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
Name | Type | Default | Description |
---|---|---|---|
dir | Path to a directory | Directory or folder to be included in the library classpath for locating resource files | |
id | string | A unique configuration ID. |
oauthProvider > localStore
Clients are defined in server.xml and tokens are cached in the server.
Name | Type | Default | Description |
---|---|---|---|
tokenStoreSize | long | 2000 | Token store size |
oauthProvider > localStore > client
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
allowRegexpRedirects | boolean | false | Allow redirect URLs to contain regular expressions. The default is false. |
appPasswordAllowed | boolean | false | When set to true, the OAuth client is allowed to request application passwords. |
appTokenAllowed | boolean | false | When set to true, the OAuth client is allowed to request application tokens. |
applicationType |
| web | The type of application best describing the client. |
displayname | string | Display name of the client. | |
enabled | boolean | true | Client is enabled if true, disabled if false. |
functionalUserGroupIds | string | 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. | |
functionalUserId | string | A 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. | |
grantTypes |
| authorization_code | Grant types the client may use. |
id | string | A unique configuration ID. | |
introspectTokens | boolean | false | Boolean value specifying whether the client is allowed to access the introspection endpoint to introspect tokens issued by the authorization server. |
name | string | Name of the client (sometimes referred to as the Id). | |
postLogoutRedirectUris | string | 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. | |
preAuthorizedScope | string | Space 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. | |
proofKeyForCodeExchange | boolean | false | Proof key for code exchange support for OAuth clients. |
publicClient | boolean | false | Specify whether OAuth client is public. |
redirect | string | 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. Each URI must be an absolute URI as defined by RFC 3986. | |
resourceIds | string | The resource identifiers which are the audiences of the Json Web Token. | |
responseTypes |
| code | Response types the client may use. |
scope | string | Specify by spaces the list of scopes of the client. | |
secret | Reversably encoded password (string) | Secret key of the client. | |
sessionManaged | boolean | false | Boolean indicating whether the client participates in OpenID session management. |
subjectType |
| Subject type requested for response to this client. | |
tokenEndpointAuthMethod |
| client_secret_basic | The requested authentication method for the token endpoint of the client. |
trustedUriPrefixes | string | URIs for use by the coverage map. |
scopeToClaimMap
Specify the claims for the scope.
Name | Type | Default | Description |
---|---|---|---|
address | string | address | Specify a comma-separated list of claims associated with the address scope. |
string | email, email_verified | Specify a comma-separated list of claims associated with the email scope. | |
phone | string | phone_number, phone_number_verified | Specify a comma-separated list of claims associated with the phone scope. |
profile | string | name, family_name, given_name, middle_name, nickname, preferred_username, profile, picture, website, gender, birthdate, zoneinfo, locale, updated_at | Specify a comma-separated list of claims associated with the profile scope. |
scopeToClaimMap > property
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
name | string | Specify the name of the property | |
value | string | Specify the value of the property |