This type encapsulates credentials required for generating OCI request signature. It is used as a return type for loadCredentials in IAMCredentialsProvider. The properties of this type are the same as in IAMConfig when credentials are provided directly. See IAMConfig for more information.

When returning this object, you have choices to return privateKey or privateKeyFile and to return Buffer or string for fields indicated as such.

See

Hierarchy

  • IAMCredentials

Properties

fingerprint: string

Public key fingerprint.

passphrase?: string | Buffer

Passphrase for the private key if it is encrypted. If specified as Buffer, you may clear the buffer contents after NoSQLClient instance is created for added security.

privateKey?: string | Buffer

PEM-encoded private key data. If specified as Buffer, you may clear the buffer contents afer NoSQLClient instance is created for added security. Note that only one of privateKey or privateKeyFile properties may be specified.

privateKeyFile?: string | Buffer

Path to PEM private key file. Path may be absolute or relative to current directory. May be string or UTF-8 encoded Buffer. Note that only one of privateKey or privateKeyFile properties may be specified.

tenantId: string

Tenancy OCID.

userId: string

User OCID.

Generated using TypeDoc