Configuration options

Table 1. Optional configuration options
key type default value description

fingerprint

string

 

The OCI authentication fingerprint.

This configuration property must be provided in order to set the API signing key’s fingerprint. See com.oracle.bmc.auth.SimpleAuthenticationDetailsProvider.getFingerprint() for more details.

initial-refresh-delay

Duration

 

Delay of the first refresh. Defaults to 0, to refresh immediately (implemented in the authentication details provider).

See com.oracle.bmc.auth.SessionTokenAuthenticationDetailsProvider.SessionTokenAuthenticationDetailsProviderBuilder.initialRefreshDelay(long)

passphrase

char[]

 

The OCI authentication passphrase.

This property must be provided in order to set the com.oracle.bmc.auth.SimpleAuthenticationDetailsProvider.getPassphraseCharacters().

private-key-path

Path

 

The OCI authentication private key resource. A resource can be defined as a resource on classpath, file on the file system, base64 encoded text value in config, or plain-text value in config.

If not defined, we will use ".oci/sessions/DEFAULT/oci_api_key.pem file in user home directory.

refresh-period

Duration

 

Refresh period, i.e. how often refresh occurs. Defaults to 55 minutes (implemented in the authentication details provider).

See com.oracle.bmc.auth.SessionTokenAuthenticationDetailsProvider.SessionTokenAuthenticationDetailsProviderBuilder.refreshPeriod(long)

region

string

 

The OCI region.

session-lifetime-hours

long

 

Maximal lifetime of a session. Defaults to (and maximum is) 24 hours. Can only be set to a lower value.

session-token

string

 

Session token value. If both this value, and sessionTokenPath() is defined, this value is used.

session-token-path

Path

 

Session token path. If both this value, and sessionToken() is defined, the value of sessionToken() is used.

tenant-id

string

 

The OCI tenant id.

This property must be provided in order to set the com.oracle.bmc.auth.SimpleAuthenticationDetailsProvider.getTenantId().

user-id

string

 

The OCI user id.

This property must be provided in order to set the com.oracle.bmc.auth.SimpleAuthenticationDetailsProvider.getUserId().