Class CustomAuthenticationPolicy
Use a function to validate a custom header or query parameter sent with the request authentication. A valid policy must specify either tokenHeader or tokenQueryParam.
Inherited Members
Namespace: Oci.ApigatewayService.Models
Assembly: OCI.DotNetSDK.Apigateway.dll
Syntax
public class CustomAuthenticationPolicy : AuthenticationPolicy
Properties
CacheKey
Declaration
[JsonProperty(PropertyName = "cacheKey")]
public List<string> CacheKey { get; set; }
Property Value
Type | Description |
---|---|
List<string> | A list of keys from "parameters" attribute value whose values will be added to the cache key. |
FunctionId
Declaration
[Required(ErrorMessage = "FunctionId is required.")]
[JsonProperty(PropertyName = "functionId")]
public string FunctionId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the Oracle Functions function resource. |
Remarks
Required
Parameters
Declaration
[JsonProperty(PropertyName = "parameters")]
public Dictionary<string, string> Parameters { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, string> | A map where key is a user defined string and value is a context expressions whose values will be sent to the custom auth function. Values should contain an expression. Example: {"foo": "request.header[abc]"} |
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 |