Class OktaClientConfiguration

Configuration for an IOktaClient.

Inheritance

System.Object

OktaClientConfiguration

Implements

IDeepCloneable<OktaClientConfiguration>

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Okta.Sdk.Configuration

Assembly: Okta.Sdk.dll

Syntax

public sealed class OktaClientConfiguration : IDeepCloneable<OktaClientConfiguration>

Fields

DefaultConnectionTimeout

The default HTTP connection timeout in seconds.

Declaration

public const int DefaultConnectionTimeout = 30

Field Value

Type	Description
System.Int32

DefaultMaxRetries

The default number of times to retry

Declaration

public const int DefaultMaxRetries = 2

Field Value

Type	Description
System.Int32

DefaultRequestTimeout

The default request timeout in seconds

Declaration

public const int DefaultRequestTimeout = 0

Field Value

Type	Description
System.Int32

Properties

AuthorizationMode

Gets or sets the authorization mode.

Declaration

public AuthorizationMode AuthorizationMode { get; set; }

Property Value

Type	Description
AuthorizationMode

ClientId

Gets or sets the client id. Required when AuthorizationMode is equal to PrivateKey.

Declaration

public string ClientId { get; set; }

Property Value

Type	Description
System.String

ConnectionTimeout

Gets or sets the HTTP connection timeout in seconds. If null, the default timeout is used.

Declaration

public int? ConnectionTimeout { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	The HTTP connection timeout in seconds.

DisableHttpsCheck

Gets or sets the flag to disable https check. This allows for insecure configurations and is NOT recommended for production use.

Declaration

public bool DisableHttpsCheck { get; set; }

Property Value

Type	Description
System.Boolean

MaxRetries

Gets or sets the number of times to retry

Declaration

public int? MaxRetries { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	The number of times to retry

OktaDomain

Gets or sets the Okta Organization URL to use.

Declaration

public string OktaDomain { get; set; }

Property Value

Type	Description
System.String	The Okta Organization URL to use.

Remarks

This URL is typically in the form https://dev-12345.oktapreview.com. If your Okta domain includes -admin, remove it.

PrivateKey

Gets or sets the private key. Required when AuthorizationMode is equal to PrivateKey.

Declaration

public JsonWebKeyConfiguration PrivateKey { get; set; }

Property Value

Type	Description
JsonWebKeyConfiguration

Proxy

Gets or sets the optional proxy to use for HTTP connections. If null, the default system proxy is used, if any.

Declaration

public ProxyConfiguration Proxy { get; set; }

Property Value

Type	Description
ProxyConfiguration	The proxy to use for HTTP connections.

RequestTimeout

Gets or sets the time to waiting time for the client to resolve the request (includes retries). Less than or equal to 0 means "no timeout".

Declaration

public int? RequestTimeout { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	The request timeout in seconds.

Scopes

Gets or sets the Okta scopes

Declaration

public List<string> Scopes { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>

Token

Gets or sets the Okta API token.

Declaration

public string Token { get; set; }

Property Value

Type	Description
System.String	The Okta API token.

Remarks

An API token can be generated from the Okta developer dashboard.

Methods

DeepClone()

Returns a deep clone (copy) of this object.

Declaration

public OktaClientConfiguration DeepClone()

Returns

Type	Description
OktaClientConfiguration	A deep clone (copy) of this object.

Implements

IDeepCloneable<T>