Class CloudFoundryOptions

Namespace

Steeltoe.Security.Authentication.CloudFoundry.Wcf

Assembly

Steeltoe.Security.Authentication.CloudFoundryWcf.dll

public class CloudFoundryOptions : AuthServerOptions

Inheritance

object

AuthServerOptions

CloudFoundryOptions

Inherited Members

AuthServerOptions.AuthorizationUrl

AuthServerOptions.CallbackUrl

AuthServerOptions.ClientId

AuthServerOptions.ClientSecret

AuthServerOptions.SignInAsAuthenticationType

AuthServerOptions.ClientTimeout

AuthServerOptions.AdditionalTokenScopes

AuthServerOptions.RequiredScopes

AuthServerOptions.AdditionalAudiences

AuthServerOptions.ValidateCertificates

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

CloudFoundryOptions(IConfiguration)

[Obsolete("This constructor is expected to be removed in a future release. Please reach out if this constructor is important to you!")]
public CloudFoundryOptions(IConfiguration config)

Parameters

config IConfiguration

CloudFoundryOptions(LoggerFactory)

Initializes a new instance of the CloudFoundryOptions class.

public CloudFoundryOptions(LoggerFactory loggerFactory = null)

Parameters

loggerFactory LoggerFactory

For logging within the library

CloudFoundryOptions(string, LoggerFactory)

[Obsolete("This constructor is expected to be removed in a future release. Please reach out if this constructor is important to you!")]
public CloudFoundryOptions(string authUrl, LoggerFactory loggerFactory = null)

Parameters

authUrl string

loggerFactory LoggerFactory

CloudFoundryOptions(string, string, string, LoggerFactory)

[Obsolete("This constructor is expected to be removed in a future release. Please reach out if this constructor is important to you!")]
public CloudFoundryOptions(string authDomain, string clientId, string clientSecret, LoggerFactory loggerFactory = null)

Parameters

authDomain string

clientId string

clientSecret string

loggerFactory LoggerFactory

Fields

AUTHENTICATION_SCHEME

public const string AUTHENTICATION_SCHEME = "CloudFoundry"

Field Value

string

OAUTH_AUTHENTICATION_SCHEME

public const string OAUTH_AUTHENTICATION_SCHEME = "CloudFoundry.OAuth"

Field Value

string

Properties

AccessTokenEndpoint

Gets or sets the Access Token URI. Default value is /oauth/token

public string AccessTokenEndpoint { get; set; }

Property Value

string

AuthorizationEndpoint

Gets or sets the authorization endpoint. Default value is /oauth/authorize

public string AuthorizationEndpoint { get; set; }

Property Value

string

ForwardUserCredentials

Gets or sets a value indicating whether to use app credentials or forward users's credentials

public bool ForwardUserCredentials { get; set; }

Property Value

bool

Remarks

Setting to true results in passing the user's JWT to downstream services

JwtKeyEndpoint

[Obsolete("This property will be removed in a future release. Use CloudFoundryDefaults.JwtTokenKey instead")]
public string JwtKeyEndpoint { get; set; }

Property Value

string

OAuthServiceUrl

[Obsolete("This property will be removed in a future release. Use AuthorizationUrl instead")]
public string OAuthServiceUrl { get; set; }

Property Value

string

TokenInfoEndpoint

[Obsolete("This property will be removed in a future release. Use CloudFoundryDefaults.CheckTokenUri instead")]
public string TokenInfoEndpoint { get; set; }

Property Value

string

TokenInfoUrl

public string TokenInfoUrl { get; }

Property Value

string

TokenValidationParameters

public TokenValidationParameters TokenValidationParameters { get; set; }

Property Value

TokenValidationParameters

UserInformationEndpoint

Gets or sets the User Information Endpoint. Default value is /userinfo

public string UserInformationEndpoint { get; set; }

Property Value

string

ValidateAudience

Gets or sets a value indicating whether the token's audience should be validated

public bool ValidateAudience { get; set; }

Property Value

bool

ValidateIssuer

Gets or sets a value indicating whether the token's issuer should be validated

public bool ValidateIssuer { get; set; }

Property Value

bool

ValidateLifetime

Gets or sets a value indicating whether the token's lifetime should be validated

public bool ValidateLifetime { get; set; }

Property Value

bool