Class TokenAuthenticationPolicy
Validate a token present in the header or query parameter. A valid policy must specify either tokenHeader or tokenQueryParam.
Inherited Members
Namespace: Oci.ApigatewayService.Models
Assembly: OCI.DotNetSDK.Apigateway.dll
Syntax
public class TokenAuthenticationPolicy : AuthenticationPolicy
Properties
MaxClockSkewInSeconds
Declaration
[JsonProperty(PropertyName = "maxClockSkewInSeconds")]
public float? MaxClockSkewInSeconds { get; set; }
Property Value
Type | Description |
---|---|
float? | The maximum expected time difference between the system clocks of the token issuer and the API Gateway. |
TokenAuthScheme
Declaration
[JsonProperty(PropertyName = "tokenAuthScheme")]
public string TokenAuthScheme { get; set; }
Property Value
Type | Description |
---|---|
string | The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified. |
TokenHeader
Declaration
[JsonProperty(PropertyName = "tokenHeader")]
public string TokenHeader { get; set; }
Property Value
Type | Description |
---|---|
string | The name of the header containing the authentication token. |
TokenQueryParam
Declaration
[JsonProperty(PropertyName = "tokenQueryParam")]
public string TokenQueryParam { get; set; }
Property Value
Type | Description |
---|---|
string | The name of the query parameter containing the authentication token. |
ValidationFailurePolicy
Declaration
[JsonProperty(PropertyName = "validationFailurePolicy")]
public ValidationFailurePolicy ValidationFailurePolicy { get; set; }
Property Value
Type | Description |
---|---|
ValidationFailurePolicy |
ValidationPolicy
Declaration
[Required(ErrorMessage = "ValidationPolicy is required.")]
[JsonProperty(PropertyName = "validationPolicy")]
public TokenAuthenticationValidationPolicy ValidationPolicy { get; set; }
Property Value
Type | Description |
---|---|
TokenAuthenticationValidationPolicy |
Remarks
Required