Authorization configuration for the driver provided as auth when NoSQLClient instance is created.

Every request to the server made by NoSQLClient methods requires authorization information. The way authorization information is obtained depends on the ServiceType used (set as serviceType):

  • For CLOUD, authorization information is obtained using Oracle Cloud Infrastructure Identity and Access Management (IAM). To enable authorization, you must set iam property to IAM configuration object in the form of IAMConfig. Alternatively, you may set provider property to an instance of IAMAuthorizationProvider. The only exception to this is if using default default OCI configuration file and default profile name, in which case you need not specify auth property (see IAMConfig and ServiceType).
  • For CLOUDSIM, authorization is not required and you do not need to specify auth property.
  • For KVSTORE, if using secure store, you need to set kvstore property to specify the store authentication information such as user name and password in the form of KVStoreAuthConfig. Alternatively, you may set provider property to an instance of KVStoreAuthorizationProvider.

    If using non-secure store, authorization is not required and you do not need to specify auth property.

  • You may also choose to implement your own authorization provider to obtain authorization information for each request. In this case, set provider property to this provider's instance. If the provider is set, ServiceType can be undefined, although it may also be possible to have custom provider for existing service types.

Note that you must specify only one of iam, kvstore or provider properties.

Hierarchy

  • AuthConfig

Properties

Properties

iam?: IAMConfig

IAM configuration, see IAMConfig. Must be set to use Oracle NoSQL Cloud service.

See

IAMConfig

Configuration to authenticate with secure On-Premise NoSQL database. Must be set to connect to secure store.

See

KVStoreAuthConfig

Custom authorization provider.

See

AuthorizationProvider

Generated using TypeDoc