Class JwtAuthenticationPolicy
Validate a JWT 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 JwtAuthenticationPolicy : AuthenticationPolicy
Properties
Audiences
Declaration
[Required(ErrorMessage = "Audiences is required.")]
[JsonProperty(PropertyName = "audiences")]
public List<string> Audiences { get; set; }
Property Value
Type | Description |
---|---|
List<string> | The list of intended recipients for the token. |
Remarks
Required
Issuers
Declaration
[Required(ErrorMessage = "Issuers is required.")]
[JsonProperty(PropertyName = "issuers")]
public List<string> Issuers { get; set; }
Property Value
Type | Description |
---|---|
List<string> | A list of parties that could have issued the token. |
Remarks
Required
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. |
PublicKeys
Declaration
[Required(ErrorMessage = "PublicKeys is required.")]
[JsonProperty(PropertyName = "publicKeys")]
public PublicKeySet PublicKeys { get; set; }
Property Value
Type | Description |
---|---|
PublicKeySet |
Remarks
Required
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. |
VerifyClaims
Declaration
[JsonProperty(PropertyName = "verifyClaims")]
public List<JsonWebTokenClaim> VerifyClaims { get; set; }
Property Value
Type | Description |
---|---|
List<JsonWebTokenClaim> | A list of claims which should be validated to consider the token valid. |