Class ConfigFileAuthenticationDetailsProvider

An authentication details provider implementation that reads all authentication information from config file.

Inheritance
object
ConfigFileAuthenticationDetailsProvider
Implements
Inherited Members
Namespace: Oci.Common.Auth
Assembly: OCI.DotNetSDK.Common.dll
Syntax
public class ConfigFileAuthenticationDetailsProvider : IAuthenticationDetailsProvider, IRegionProvider, IUserDelegationDetailsProvider, IBasicAuthenticationDetailsProvider, IAbstractAuthenticationDetailsProvider

Constructors

ConfigFileAuthenticationDetailsProvider(ConfigFile, FilePrivateKeySupplier)

Constructor. Reads from a ConfigFile object. If ConfigFile specifies an instance principal authentication, auth provider will use instance principals with delegation token. Otherwise, If a FilePrivateKeySupplier is provided, it will be used to obtain private key. Otherwise, a FilePrivateKeySupplier object will be created based on information from configFile. If additional security checks on the private key file are needed, provide a FileSecurePrivateKeySupplier object.

Declaration
public ConfigFileAuthenticationDetailsProvider(ConfigFile configFile, FilePrivateKeySupplier keySupplier = null)
Parameters
Type Name Description
ConfigFile configFile
FilePrivateKeySupplier keySupplier

ConfigFileAuthenticationDetailsProvider(string, FilePrivateKeySupplier)

Constructor. Reads from the config file at default location.

Declaration
public ConfigFileAuthenticationDetailsProvider(string profile, FilePrivateKeySupplier keySupplier = null)
Parameters
Type Name Description
string profile
FilePrivateKeySupplier keySupplier

ConfigFileAuthenticationDetailsProvider(string, string, FilePrivateKeySupplier)

Constructor. Reads from the config file at given location.

Declaration
public ConfigFileAuthenticationDetailsProvider(string configurationFilePath, string profile, FilePrivateKeySupplier keySupplier = null)
Parameters
Type Name Description
string configurationFilePath
string profile
FilePrivateKeySupplier keySupplier

Fields

logger

Declaration
protected static Logger logger
Field Value
Type Description
Logger

Properties

Fingerprint

Declaration
public string Fingerprint { get; }
Property Value
Type Description
string

KeyId

Declaration
public string KeyId { get; }
Property Value
Type Description
string

PassPhraseCharacters

Declaration
public char[] PassPhraseCharacters { get; }
Property Value
Type Description
char[]

Region

Declaration
public Region Region { get; }
Property Value
Type Description
Region

TenantId

Declaration
public string TenantId { get; }
Property Value
Type Description
string

UserId

Declaration
public string UserId { get; }
Property Value
Type Description
string

Methods

GetDelegationToken()

Declaration
public string GetDelegationToken()
Returns
Type Description
string

GetPrivateKey()

Declaration
public RsaKeyParameters GetPrivateKey()
Returns
Type Description
RsaKeyParameters

Implements