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.
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
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
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
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
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
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
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
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
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
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 |
Scopes
Gets or sets the space-separated list of scopes to be requested from OAuth service.
Declaration
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
public Uri TokenEndpoint { get; set; }Property Value
| Type | Description |
|---|---|
| Uri |
TokenRequestTimeout
Gets or sets the access token request timeout. Default is one minute.
Declaration
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. |