Class SessionTokenAuthenticationDetailsProvider

Inheritance
object
SessionTokenAuthenticationDetailsProvider
Implements
Inherited Members
Namespace: Oci.Common.Auth
Assembly: OCI.DotNetSDK.Common.dll
Syntax
public class SessionTokenAuthenticationDetailsProvider : IAuthenticationDetailsProvider, IBasicAuthenticationDetailsProvider, IAbstractAuthenticationDetailsProvider, IRegionProvider, IRefreshableOnNotAuthenticatedProvider<string>

Constructors

SessionTokenAuthenticationDetailsProvider(SimpleAuthenticationDetailsProvider, string)

Declaration
public SessionTokenAuthenticationDetailsProvider(SimpleAuthenticationDetailsProvider provider, string sessionToken)
Parameters
Type Name Description
SimpleAuthenticationDetailsProvider provider
string sessionToken

SessionTokenAuthenticationDetailsProvider(ConfigFile, FilePrivateKeySupplier)

Constructor. Reads from a ConfigFile object. 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 SessionTokenAuthenticationDetailsProvider(ConfigFile configFile, FilePrivateKeySupplier keySupplier = null)
Parameters
Type Name Description
ConfigFile configFile
FilePrivateKeySupplier keySupplier

SessionTokenAuthenticationDetailsProvider(string, FilePrivateKeySupplier)

Constructor. Reads from the config file at default location.

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

SessionTokenAuthenticationDetailsProvider(string, string, FilePrivateKeySupplier)

Constructor. Reads from the config file at given location.

Declaration
public SessionTokenAuthenticationDetailsProvider(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

GetPrivateKey()

Declaration
public RsaKeyParameters GetPrivateKey()
Returns
Type Description
RsaKeyParameters

GetSessionTokenExpiryDate()

Declaration
public DateTime GetSessionTokenExpiryDate()
Returns
Type Description
DateTime

IsSessionTokenValid()

Declaration
public bool IsSessionTokenValid()
Returns
Type Description
bool

Refresh()

Refreshes the authentication data used by the provider.

Declaration
public string Refresh()
Returns
Type Description
string

The refreshed authentication data.

Implements