Class WebOAuthSecurityClientElement
Represents a configuration element containing information about how client application is calling OAuth/OpendID Connect server in order to retrieve an access token.
Inherited Members
Namespace: Nevatech.Vsb.Repository.Security.OAuth
Assembly: Nevatech.Vsb.Repository.dll
Syntax
public sealed class WebOAuthSecurityClientElement : ConfigurationElementConstructors
WebOAuthSecurityClientElement()
Declaration
public WebOAuthSecurityClientElement()Properties
AdditionalParameters
Gets or sets the Url-encoded, ampersand-separated list of additional query parameters to be submitted with the request for an access token.
Declaration
[ConfigurationProperty("parameters")]
public string AdditionalParameters { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Audience
Gets or sets the audience (resource identifier) for which access token is requested.
Declaration
[ConfigurationProperty("audience")]
public string Audience { get; set; }Property Value
| Type | Description |
|---|---|
| string |
AuthenticationFlow
Gets or sets the value specifying what credentials are going to be used to request access token from OAuth service. Default is Resource Owner credentials flow.
Declaration
[ConfigurationProperty("authenticationFlow")]
public ClientAuthenticationFlow AuthenticationFlow { get; set; }Property Value
| Type | Description |
|---|---|
| ClientAuthenticationFlow |
AuthenticationType
Gets or sets the value specifying how client credentials are going to be passed to OAuth service. Default is Form Post.
Declaration
[ConfigurationProperty("authenticationType")]
public ClientAuthenticationType AuthenticationType { get; set; }Property Value
| Type | Description |
|---|---|
| ClientAuthenticationType |
ClientAssertionLifetime
Gets or sets the time of validity for the self-issued client assertion JWT token. Default is 15 minutes.
Declaration
[ConfigurationProperty("clientAssertionLifetime", DefaultValue = "00:15:00")]
public TimeSpan ClientAssertionLifetime { get; set; }Property Value
| Type | Description |
|---|---|
| TimeSpan |
ClientId
Gets or set the client application identifier to be used to authenticate with OAuth service.
Declaration
[ConfigurationProperty("clientId")]
public string ClientId { get; set; }Property Value
| Type | Description |
|---|---|
| string |
ClientSecret
Gets or set the client application secret (password) to be used to authenticate with OAuth service.
Declaration
[ConfigurationProperty("clientSecret")]
public string ClientSecret { get; set; }Property Value
| Type | Description |
|---|---|
| string |
MaximumCacheLifetime
Gets or sets the maximum caching time of a valid access token. Default is one hour.
Declaration
[ConfigurationProperty("maximumCacheLifetime", DefaultValue = "01:00:00")]
public TimeSpan MaximumCacheLifetime { get; set; }Property Value
| Type | Description |
|---|---|
| TimeSpan |
MinimumCacheLifetime
Gets or sets the minimum caching time of a valid OR invalid access token. Default is zero.
Declaration
[ConfigurationProperty("minimumCacheLifetime", DefaultValue = "00:00:00")]
public TimeSpan MinimumCacheLifetime { get; set; }Property Value
| Type | Description |
|---|---|
| TimeSpan |
Properties
Gets collection of configuration element properties.
Declaration
protected override ConfigurationPropertyCollection Properties { get; }Property Value
| Type | Description |
|---|---|
| ConfigurationPropertyCollection |
Overrides
Scopes
Gets or sets the space-separated list of scopes to be requested from OAuth service.
Declaration
[ConfigurationProperty("scopes")]
public string Scopes { get; set; }Property Value
| Type | Description |
|---|---|
| string |
TokenEndpoint
Gets or sets the URI to OAuth token retrieval endpoint. This endpoint is used to request access tokens by the client.
Declaration
[ConfigurationProperty("tokenEndpoint")]
public Uri TokenEndpoint { get; set; }Property Value
| Type | Description |
|---|---|
| Uri |
TokenRequestTimeout
Gets or sets the access token request timeout. Default is one minute.
Declaration
[ConfigurationProperty("requestTimeout", DefaultValue = "00:01:00")]
public TimeSpan TokenRequestTimeout { get; set; }Property Value
| Type | Description |
|---|---|
| TimeSpan |
Methods
Copy(WebOAuthSecurityClientElement)
Copies the content of the specified configuration element to this configuration element.
Declaration
public void Copy(WebOAuthSecurityClientElement from)Parameters
| Type | Name | Description |
|---|---|---|
| WebOAuthSecurityClientElement | from | The configuration element to be copied. |