1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ApiGateway
  5. getDeployment
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

oci.ApiGateway.getDeployment

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

This data source provides details about a specific Deployment resource in Oracle Cloud Infrastructure API Gateway service.

Gets a deployment by identifier.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDeployment = oci.ApiGateway.getDeployment({
    deploymentId: testDeploymentOciApigatewayDeployment.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_deployment = oci.ApiGateway.get_deployment(deployment_id=test_deployment_oci_apigateway_deployment["id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/apigateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigateway.GetDeployment(ctx, &apigateway.GetDeploymentArgs{
			DeploymentId: testDeploymentOciApigatewayDeployment.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testDeployment = Oci.ApiGateway.GetDeployment.Invoke(new()
    {
        DeploymentId = testDeploymentOciApigatewayDeployment.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ApiGateway.ApiGatewayFunctions;
import com.pulumi.oci.ApiGateway.inputs.GetDeploymentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testDeployment = ApiGatewayFunctions.getDeployment(GetDeploymentArgs.builder()
            .deploymentId(testDeploymentOciApigatewayDeployment.id())
            .build());

    }
}
Copy
variables:
  testDeployment:
    fn::invoke:
      function: oci:ApiGateway:getDeployment
      arguments:
        deploymentId: ${testDeploymentOciApigatewayDeployment.id}
Copy

Using getDeployment

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDeployment(args: GetDeploymentArgs, opts?: InvokeOptions): Promise<GetDeploymentResult>
function getDeploymentOutput(args: GetDeploymentOutputArgs, opts?: InvokeOptions): Output<GetDeploymentResult>
Copy
def get_deployment(deployment_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDeploymentResult
def get_deployment_output(deployment_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDeploymentResult]
Copy
func GetDeployment(ctx *Context, args *GetDeploymentArgs, opts ...InvokeOption) (*GetDeploymentResult, error)
func GetDeploymentOutput(ctx *Context, args *GetDeploymentOutputArgs, opts ...InvokeOption) GetDeploymentResultOutput
Copy

> Note: This function is named GetDeployment in the Go SDK.

public static class GetDeployment 
{
    public static Task<GetDeploymentResult> InvokeAsync(GetDeploymentArgs args, InvokeOptions? opts = null)
    public static Output<GetDeploymentResult> Invoke(GetDeploymentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)
public static Output<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:ApiGateway/getDeployment:getDeployment
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DeploymentId This property is required. string
The ocid of the deployment.
DeploymentId This property is required. string
The ocid of the deployment.
deploymentId This property is required. String
The ocid of the deployment.
deploymentId This property is required. string
The ocid of the deployment.
deployment_id This property is required. str
The ocid of the deployment.
deploymentId This property is required. String
The ocid of the deployment.

getDeployment Result

The following output properties are available:

CompartmentId string
The OCID of the compartment in which the resource is created.
DefinedTags Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DeploymentId string
DisplayName string
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
Endpoint string
The endpoint to access this deployment on the gateway.
FreeformTags Dictionary<string, string>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
GatewayId string
The OCID of the resource.
Id string
The OCID of the resource.
LifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
PathPrefix string
A path on which to deploy all routes contained in the API deployment specification. For more information, see Deploying an API on an API Gateway by Creating an API Deployment.
Specifications List<GetDeploymentSpecification>
The logical configuration of the API exposed by a deployment.
State string
The current state of the deployment.
TimeCreated string
The time this resource was created. An RFC3339 formatted datetime string.
TimeUpdated string
The time this resource was last updated. An RFC3339 formatted datetime string.
CompartmentId string
The OCID of the compartment in which the resource is created.
DefinedTags map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DeploymentId string
DisplayName string
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
Endpoint string
The endpoint to access this deployment on the gateway.
FreeformTags map[string]string
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
GatewayId string
The OCID of the resource.
Id string
The OCID of the resource.
LifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
PathPrefix string
A path on which to deploy all routes contained in the API deployment specification. For more information, see Deploying an API on an API Gateway by Creating an API Deployment.
Specifications []GetDeploymentSpecification
The logical configuration of the API exposed by a deployment.
State string
The current state of the deployment.
TimeCreated string
The time this resource was created. An RFC3339 formatted datetime string.
TimeUpdated string
The time this resource was last updated. An RFC3339 formatted datetime string.
compartmentId String
The OCID of the compartment in which the resource is created.
definedTags Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
deploymentId String
displayName String
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
endpoint String
The endpoint to access this deployment on the gateway.
freeformTags Map<String,String>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
gatewayId String
The OCID of the resource.
id String
The OCID of the resource.
lifecycleDetails String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
pathPrefix String
A path on which to deploy all routes contained in the API deployment specification. For more information, see Deploying an API on an API Gateway by Creating an API Deployment.
specifications List<GetDeploymentSpecification>
The logical configuration of the API exposed by a deployment.
state String
The current state of the deployment.
timeCreated String
The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated String
The time this resource was last updated. An RFC3339 formatted datetime string.
compartmentId string
The OCID of the compartment in which the resource is created.
definedTags {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
deploymentId string
displayName string
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
endpoint string
The endpoint to access this deployment on the gateway.
freeformTags {[key: string]: string}
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
gatewayId string
The OCID of the resource.
id string
The OCID of the resource.
lifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
pathPrefix string
A path on which to deploy all routes contained in the API deployment specification. For more information, see Deploying an API on an API Gateway by Creating an API Deployment.
specifications GetDeploymentSpecification[]
The logical configuration of the API exposed by a deployment.
state string
The current state of the deployment.
timeCreated string
The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated string
The time this resource was last updated. An RFC3339 formatted datetime string.
compartment_id str
The OCID of the compartment in which the resource is created.
defined_tags Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
deployment_id str
display_name str
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
endpoint str
The endpoint to access this deployment on the gateway.
freeform_tags Mapping[str, str]
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
gateway_id str
The OCID of the resource.
id str
The OCID of the resource.
lifecycle_details str
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
path_prefix str
A path on which to deploy all routes contained in the API deployment specification. For more information, see Deploying an API on an API Gateway by Creating an API Deployment.
specifications Sequence[apigateway.GetDeploymentSpecification]
The logical configuration of the API exposed by a deployment.
state str
The current state of the deployment.
time_created str
The time this resource was created. An RFC3339 formatted datetime string.
time_updated str
The time this resource was last updated. An RFC3339 formatted datetime string.
compartmentId String
The OCID of the compartment in which the resource is created.
definedTags Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
deploymentId String
displayName String
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
endpoint String
The endpoint to access this deployment on the gateway.
freeformTags Map<String>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
gatewayId String
The OCID of the resource.
id String
The OCID of the resource.
lifecycleDetails String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
pathPrefix String
A path on which to deploy all routes contained in the API deployment specification. For more information, see Deploying an API on an API Gateway by Creating an API Deployment.
specifications List<Property Map>
The logical configuration of the API exposed by a deployment.
state String
The current state of the deployment.
timeCreated String
The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated String
The time this resource was last updated. An RFC3339 formatted datetime string.

Supporting Types

GetDeploymentSpecification

LoggingPolicies This property is required. List<GetDeploymentSpecificationLoggingPolicy>
Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
RequestPolicies This property is required. List<GetDeploymentSpecificationRequestPolicy>
Behavior applied to any requests received by the API on this route.
Routes This property is required. List<GetDeploymentSpecificationRoute>
A list of routes that this API exposes.
LoggingPolicies This property is required. []GetDeploymentSpecificationLoggingPolicy
Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
RequestPolicies This property is required. []GetDeploymentSpecificationRequestPolicy
Behavior applied to any requests received by the API on this route.
Routes This property is required. []GetDeploymentSpecificationRoute
A list of routes that this API exposes.
loggingPolicies This property is required. List<GetDeploymentSpecificationLoggingPolicy>
Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
requestPolicies This property is required. List<GetDeploymentSpecificationRequestPolicy>
Behavior applied to any requests received by the API on this route.
routes This property is required. List<GetDeploymentSpecificationRoute>
A list of routes that this API exposes.
loggingPolicies This property is required. GetDeploymentSpecificationLoggingPolicy[]
Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
requestPolicies This property is required. GetDeploymentSpecificationRequestPolicy[]
Behavior applied to any requests received by the API on this route.
routes This property is required. GetDeploymentSpecificationRoute[]
A list of routes that this API exposes.
logging_policies This property is required. Sequence[apigateway.GetDeploymentSpecificationLoggingPolicy]
Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
request_policies This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicy]
Behavior applied to any requests received by the API on this route.
routes This property is required. Sequence[apigateway.GetDeploymentSpecificationRoute]
A list of routes that this API exposes.
loggingPolicies This property is required. List<Property Map>
Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
requestPolicies This property is required. List<Property Map>
Behavior applied to any requests received by the API on this route.
routes This property is required. List<Property Map>
A list of routes that this API exposes.

GetDeploymentSpecificationLoggingPolicy

AccessLogs This property is required. List<GetDeploymentSpecificationLoggingPolicyAccessLog>
Configures the logging policies for the access logs of an API Deployment.
ExecutionLogs This property is required. List<GetDeploymentSpecificationLoggingPolicyExecutionLog>
Configures the logging policies for the execution logs of an API Deployment.
AccessLogs This property is required. []GetDeploymentSpecificationLoggingPolicyAccessLog
Configures the logging policies for the access logs of an API Deployment.
ExecutionLogs This property is required. []GetDeploymentSpecificationLoggingPolicyExecutionLog
Configures the logging policies for the execution logs of an API Deployment.
accessLogs This property is required. List<GetDeploymentSpecificationLoggingPolicyAccessLog>
Configures the logging policies for the access logs of an API Deployment.
executionLogs This property is required. List<GetDeploymentSpecificationLoggingPolicyExecutionLog>
Configures the logging policies for the execution logs of an API Deployment.
accessLogs This property is required. GetDeploymentSpecificationLoggingPolicyAccessLog[]
Configures the logging policies for the access logs of an API Deployment.
executionLogs This property is required. GetDeploymentSpecificationLoggingPolicyExecutionLog[]
Configures the logging policies for the execution logs of an API Deployment.
access_logs This property is required. Sequence[apigateway.GetDeploymentSpecificationLoggingPolicyAccessLog]
Configures the logging policies for the access logs of an API Deployment.
execution_logs This property is required. Sequence[apigateway.GetDeploymentSpecificationLoggingPolicyExecutionLog]
Configures the logging policies for the execution logs of an API Deployment.
accessLogs This property is required. List<Property Map>
Configures the logging policies for the access logs of an API Deployment.
executionLogs This property is required. List<Property Map>
Configures the logging policies for the execution logs of an API Deployment.

GetDeploymentSpecificationLoggingPolicyAccessLog

IsEnabled This property is required. bool
Whether this policy is currently enabled.
IsEnabled This property is required. bool
Whether this policy is currently enabled.
isEnabled This property is required. Boolean
Whether this policy is currently enabled.
isEnabled This property is required. boolean
Whether this policy is currently enabled.
is_enabled This property is required. bool
Whether this policy is currently enabled.
isEnabled This property is required. Boolean
Whether this policy is currently enabled.

GetDeploymentSpecificationLoggingPolicyExecutionLog

IsEnabled This property is required. bool
Whether this policy is currently enabled.
LogLevel This property is required. string
Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.
IsEnabled This property is required. bool
Whether this policy is currently enabled.
LogLevel This property is required. string
Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.
isEnabled This property is required. Boolean
Whether this policy is currently enabled.
logLevel This property is required. String
Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.
isEnabled This property is required. boolean
Whether this policy is currently enabled.
logLevel This property is required. string
Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.
is_enabled This property is required. bool
Whether this policy is currently enabled.
log_level This property is required. str
Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.
isEnabled This property is required. Boolean
Whether this policy is currently enabled.
logLevel This property is required. String
Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.

GetDeploymentSpecificationRequestPolicy

Authentications This property is required. List<GetDeploymentSpecificationRequestPolicyAuthentication>
Information on how to authenticate incoming requests.
Cors This property is required. List<GetDeploymentSpecificationRequestPolicyCor>
Enable CORS (Cross-Origin-Resource-Sharing) request handling.
DynamicAuthentications This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthentication>
Policy on how to authenticate requests when multiple authentication options are configured for a deployment. For an incoming request, the value of selector specified under selectionSource will be matched against the keys specified for each authentication server. The authentication server whose key matches the value of selector will be used for authentication.
MutualTls This property is required. List<GetDeploymentSpecificationRequestPolicyMutualTl>
Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
RateLimitings This property is required. List<GetDeploymentSpecificationRequestPolicyRateLimiting>
Limit the number of requests that should be handled for the specified window using a specfic key.
UsagePlans This property is required. List<GetDeploymentSpecificationRequestPolicyUsagePlan>
Usage plan policies for this deployment
Authentications This property is required. []GetDeploymentSpecificationRequestPolicyAuthentication
Information on how to authenticate incoming requests.
Cors This property is required. []GetDeploymentSpecificationRequestPolicyCor
Enable CORS (Cross-Origin-Resource-Sharing) request handling.
DynamicAuthentications This property is required. []GetDeploymentSpecificationRequestPolicyDynamicAuthentication
Policy on how to authenticate requests when multiple authentication options are configured for a deployment. For an incoming request, the value of selector specified under selectionSource will be matched against the keys specified for each authentication server. The authentication server whose key matches the value of selector will be used for authentication.
MutualTls This property is required. []GetDeploymentSpecificationRequestPolicyMutualTl
Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
RateLimitings This property is required. []GetDeploymentSpecificationRequestPolicyRateLimiting
Limit the number of requests that should be handled for the specified window using a specfic key.
UsagePlans This property is required. []GetDeploymentSpecificationRequestPolicyUsagePlan
Usage plan policies for this deployment
authentications This property is required. List<GetDeploymentSpecificationRequestPolicyAuthentication>
Information on how to authenticate incoming requests.
cors This property is required. List<GetDeploymentSpecificationRequestPolicyCor>
Enable CORS (Cross-Origin-Resource-Sharing) request handling.
dynamicAuthentications This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthentication>
Policy on how to authenticate requests when multiple authentication options are configured for a deployment. For an incoming request, the value of selector specified under selectionSource will be matched against the keys specified for each authentication server. The authentication server whose key matches the value of selector will be used for authentication.
mutualTls This property is required. List<GetDeploymentSpecificationRequestPolicyMutualTl>
Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
rateLimitings This property is required. List<GetDeploymentSpecificationRequestPolicyRateLimiting>
Limit the number of requests that should be handled for the specified window using a specfic key.
usagePlans This property is required. List<GetDeploymentSpecificationRequestPolicyUsagePlan>
Usage plan policies for this deployment
authentications This property is required. GetDeploymentSpecificationRequestPolicyAuthentication[]
Information on how to authenticate incoming requests.
cors This property is required. GetDeploymentSpecificationRequestPolicyCor[]
Enable CORS (Cross-Origin-Resource-Sharing) request handling.
dynamicAuthentications This property is required. GetDeploymentSpecificationRequestPolicyDynamicAuthentication[]
Policy on how to authenticate requests when multiple authentication options are configured for a deployment. For an incoming request, the value of selector specified under selectionSource will be matched against the keys specified for each authentication server. The authentication server whose key matches the value of selector will be used for authentication.
mutualTls This property is required. GetDeploymentSpecificationRequestPolicyMutualTl[]
Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
rateLimitings This property is required. GetDeploymentSpecificationRequestPolicyRateLimiting[]
Limit the number of requests that should be handled for the specified window using a specfic key.
usagePlans This property is required. GetDeploymentSpecificationRequestPolicyUsagePlan[]
Usage plan policies for this deployment
authentications This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyAuthentication]
Information on how to authenticate incoming requests.
cors This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyCor]
Enable CORS (Cross-Origin-Resource-Sharing) request handling.
dynamic_authentications This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyDynamicAuthentication]
Policy on how to authenticate requests when multiple authentication options are configured for a deployment. For an incoming request, the value of selector specified under selectionSource will be matched against the keys specified for each authentication server. The authentication server whose key matches the value of selector will be used for authentication.
mutual_tls This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyMutualTl]
Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
rate_limitings This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyRateLimiting]
Limit the number of requests that should be handled for the specified window using a specfic key.
usage_plans This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyUsagePlan]
Usage plan policies for this deployment
authentications This property is required. List<Property Map>
Information on how to authenticate incoming requests.
cors This property is required. List<Property Map>
Enable CORS (Cross-Origin-Resource-Sharing) request handling.
dynamicAuthentications This property is required. List<Property Map>
Policy on how to authenticate requests when multiple authentication options are configured for a deployment. For an incoming request, the value of selector specified under selectionSource will be matched against the keys specified for each authentication server. The authentication server whose key matches the value of selector will be used for authentication.
mutualTls This property is required. List<Property Map>
Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
rateLimitings This property is required. List<Property Map>
Limit the number of requests that should be handled for the specified window using a specfic key.
usagePlans This property is required. List<Property Map>
Usage plan policies for this deployment

GetDeploymentSpecificationRequestPolicyAuthentication

Audiences This property is required. List<string>
The list of intended recipients for the token.
CacheKeys This property is required. List<string>
A list of keys from "parameters" attribute value whose values will be added to the cache key.
FunctionId This property is required. string
The OCID of the Oracle Functions function resource.
IsAnonymousAccessAllowed This property is required. bool
Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
Issuers This property is required. List<string>
A list of parties that could have issued the token.
MaxClockSkewInSeconds This property is required. double
The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
Parameters This property is required. Dictionary<string, string>
PublicKeys This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationPublicKey>
A set of Public Keys that will be used to verify the JWT signature.
TokenAuthScheme This property is required. string
The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
TokenHeader This property is required. string
The name of the header containing the authentication token.
TokenQueryParam This property is required. string
The name of the query parameter containing the authentication token.
Type This property is required. string
Type of the Response Cache Store Policy.
ValidationFailurePolicies This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicy>
Policy for defining behaviour on validation failure.
ValidationPolicies This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicy>
Authentication Policies for the Token Authentication types.
VerifyClaims This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim>
A list of claims which should be validated to consider the token valid.
Audiences This property is required. []string
The list of intended recipients for the token.
CacheKeys This property is required. []string
A list of keys from "parameters" attribute value whose values will be added to the cache key.
FunctionId This property is required. string
The OCID of the Oracle Functions function resource.
IsAnonymousAccessAllowed This property is required. bool
Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
Issuers This property is required. []string
A list of parties that could have issued the token.
MaxClockSkewInSeconds This property is required. float64
The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
Parameters This property is required. map[string]string
PublicKeys This property is required. []GetDeploymentSpecificationRequestPolicyAuthenticationPublicKey
A set of Public Keys that will be used to verify the JWT signature.
TokenAuthScheme This property is required. string
The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
TokenHeader This property is required. string
The name of the header containing the authentication token.
TokenQueryParam This property is required. string
The name of the query parameter containing the authentication token.
Type This property is required. string
Type of the Response Cache Store Policy.
ValidationFailurePolicies This property is required. []GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicy
Policy for defining behaviour on validation failure.
ValidationPolicies This property is required. []GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicy
Authentication Policies for the Token Authentication types.
VerifyClaims This property is required. []GetDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim
A list of claims which should be validated to consider the token valid.
audiences This property is required. List<String>
The list of intended recipients for the token.
cacheKeys This property is required. List<String>
A list of keys from "parameters" attribute value whose values will be added to the cache key.
functionId This property is required. String
The OCID of the Oracle Functions function resource.
isAnonymousAccessAllowed This property is required. Boolean
Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
issuers This property is required. List<String>
A list of parties that could have issued the token.
maxClockSkewInSeconds This property is required. Double
The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
parameters This property is required. Map<String,String>
publicKeys This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationPublicKey>
A set of Public Keys that will be used to verify the JWT signature.
tokenAuthScheme This property is required. String
The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
tokenHeader This property is required. String
The name of the header containing the authentication token.
tokenQueryParam This property is required. String
The name of the query parameter containing the authentication token.
type This property is required. String
Type of the Response Cache Store Policy.
validationFailurePolicies This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicy>
Policy for defining behaviour on validation failure.
validationPolicies This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicy>
Authentication Policies for the Token Authentication types.
verifyClaims This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim>
A list of claims which should be validated to consider the token valid.
audiences This property is required. string[]
The list of intended recipients for the token.
cacheKeys This property is required. string[]
A list of keys from "parameters" attribute value whose values will be added to the cache key.
functionId This property is required. string
The OCID of the Oracle Functions function resource.
isAnonymousAccessAllowed This property is required. boolean
Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
issuers This property is required. string[]
A list of parties that could have issued the token.
maxClockSkewInSeconds This property is required. number
The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
parameters This property is required. {[key: string]: string}
publicKeys This property is required. GetDeploymentSpecificationRequestPolicyAuthenticationPublicKey[]
A set of Public Keys that will be used to verify the JWT signature.
tokenAuthScheme This property is required. string
The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
tokenHeader This property is required. string
The name of the header containing the authentication token.
tokenQueryParam This property is required. string
The name of the query parameter containing the authentication token.
type This property is required. string
Type of the Response Cache Store Policy.
validationFailurePolicies This property is required. GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicy[]
Policy for defining behaviour on validation failure.
validationPolicies This property is required. GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicy[]
Authentication Policies for the Token Authentication types.
verifyClaims This property is required. GetDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim[]
A list of claims which should be validated to consider the token valid.
audiences This property is required. Sequence[str]
The list of intended recipients for the token.
cache_keys This property is required. Sequence[str]
A list of keys from "parameters" attribute value whose values will be added to the cache key.
function_id This property is required. str
The OCID of the Oracle Functions function resource.
is_anonymous_access_allowed This property is required. bool
Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
issuers This property is required. Sequence[str]
A list of parties that could have issued the token.
max_clock_skew_in_seconds This property is required. float
The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
parameters This property is required. Mapping[str, str]
public_keys This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyAuthenticationPublicKey]
A set of Public Keys that will be used to verify the JWT signature.
token_auth_scheme This property is required. str
The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
token_header This property is required. str
The name of the header containing the authentication token.
token_query_param This property is required. str
The name of the query parameter containing the authentication token.
type This property is required. str
Type of the Response Cache Store Policy.
validation_failure_policies This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicy]
Policy for defining behaviour on validation failure.
validation_policies This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicy]
Authentication Policies for the Token Authentication types.
verify_claims This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim]
A list of claims which should be validated to consider the token valid.
audiences This property is required. List<String>
The list of intended recipients for the token.
cacheKeys This property is required. List<String>
A list of keys from "parameters" attribute value whose values will be added to the cache key.
functionId This property is required. String
The OCID of the Oracle Functions function resource.
isAnonymousAccessAllowed This property is required. Boolean
Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
issuers This property is required. List<String>
A list of parties that could have issued the token.
maxClockSkewInSeconds This property is required. Number
The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
parameters This property is required. Map<String>
publicKeys This property is required. List<Property Map>
A set of Public Keys that will be used to verify the JWT signature.
tokenAuthScheme This property is required. String
The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
tokenHeader This property is required. String
The name of the header containing the authentication token.
tokenQueryParam This property is required. String
The name of the query parameter containing the authentication token.
type This property is required. String
Type of the Response Cache Store Policy.
validationFailurePolicies This property is required. List<Property Map>
Policy for defining behaviour on validation failure.
validationPolicies This property is required. List<Property Map>
Authentication Policies for the Token Authentication types.
verifyClaims This property is required. List<Property Map>
A list of claims which should be validated to consider the token valid.

GetDeploymentSpecificationRequestPolicyAuthenticationPublicKey

IsSslVerifyDisabled This property is required. bool
Defines whether or not to uphold SSL verification.
Keys This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey>
The set of static public keys.
MaxCacheDurationInHours This property is required. int
The duration for which the introspect URL response should be cached before it is fetched again.
Type This property is required. string
Type of the Response Cache Store Policy.
Uri This property is required. string
The uri from which to retrieve the key. It must be accessible without authentication.
IsSslVerifyDisabled This property is required. bool
Defines whether or not to uphold SSL verification.
Keys This property is required. []GetDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey
The set of static public keys.
MaxCacheDurationInHours This property is required. int
The duration for which the introspect URL response should be cached before it is fetched again.
Type This property is required. string
Type of the Response Cache Store Policy.
Uri This property is required. string
The uri from which to retrieve the key. It must be accessible without authentication.
isSslVerifyDisabled This property is required. Boolean
Defines whether or not to uphold SSL verification.
keys This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey>
The set of static public keys.
maxCacheDurationInHours This property is required. Integer
The duration for which the introspect URL response should be cached before it is fetched again.
type This property is required. String
Type of the Response Cache Store Policy.
uri This property is required. String
The uri from which to retrieve the key. It must be accessible without authentication.
isSslVerifyDisabled This property is required. boolean
Defines whether or not to uphold SSL verification.
keys This property is required. GetDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey[]
The set of static public keys.
maxCacheDurationInHours This property is required. number
The duration for which the introspect URL response should be cached before it is fetched again.
type This property is required. string
Type of the Response Cache Store Policy.
uri This property is required. string
The uri from which to retrieve the key. It must be accessible without authentication.
is_ssl_verify_disabled This property is required. bool
Defines whether or not to uphold SSL verification.
keys This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey]
The set of static public keys.
max_cache_duration_in_hours This property is required. int
The duration for which the introspect URL response should be cached before it is fetched again.
type This property is required. str
Type of the Response Cache Store Policy.
uri This property is required. str
The uri from which to retrieve the key. It must be accessible without authentication.
isSslVerifyDisabled This property is required. Boolean
Defines whether or not to uphold SSL verification.
keys This property is required. List<Property Map>
The set of static public keys.
maxCacheDurationInHours This property is required. Number
The duration for which the introspect URL response should be cached before it is fetched again.
type This property is required. String
Type of the Response Cache Store Policy.
uri This property is required. String
The uri from which to retrieve the key. It must be accessible without authentication.

GetDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey

Alg This property is required. string
The algorithm intended for use with this key.
E This property is required. string
The base64 url encoded exponent of the RSA public key represented by this key.
Format This property is required. string
The format of the public key.
Key This property is required. string
Information around the values for selector of an authentication/ routing branch.
KeyOps This property is required. List<string>
The operations for which this key is to be used.
Kid This property is required. string
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
Kty This property is required. string
The key type.
N This property is required. string
The base64 url encoded modulus of the RSA public key represented by this key.
Use This property is required. string
The intended use of the public key.
Alg This property is required. string
The algorithm intended for use with this key.
E This property is required. string
The base64 url encoded exponent of the RSA public key represented by this key.
Format This property is required. string
The format of the public key.
Key This property is required. string
Information around the values for selector of an authentication/ routing branch.
KeyOps This property is required. []string
The operations for which this key is to be used.
Kid This property is required. string
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
Kty This property is required. string
The key type.
N This property is required. string
The base64 url encoded modulus of the RSA public key represented by this key.
Use This property is required. string
The intended use of the public key.
alg This property is required. String
The algorithm intended for use with this key.
e This property is required. String
The base64 url encoded exponent of the RSA public key represented by this key.
format This property is required. String
The format of the public key.
key This property is required. String
Information around the values for selector of an authentication/ routing branch.
keyOps This property is required. List<String>
The operations for which this key is to be used.
kid This property is required. String
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
kty This property is required. String
The key type.
n This property is required. String
The base64 url encoded modulus of the RSA public key represented by this key.
use This property is required. String
The intended use of the public key.
alg This property is required. string
The algorithm intended for use with this key.
e This property is required. string
The base64 url encoded exponent of the RSA public key represented by this key.
format This property is required. string
The format of the public key.
key This property is required. string
Information around the values for selector of an authentication/ routing branch.
keyOps This property is required. string[]
The operations for which this key is to be used.
kid This property is required. string
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
kty This property is required. string
The key type.
n This property is required. string
The base64 url encoded modulus of the RSA public key represented by this key.
use This property is required. string
The intended use of the public key.
alg This property is required. str
The algorithm intended for use with this key.
e This property is required. str
The base64 url encoded exponent of the RSA public key represented by this key.
format This property is required. str
The format of the public key.
key This property is required. str
Information around the values for selector of an authentication/ routing branch.
key_ops This property is required. Sequence[str]
The operations for which this key is to be used.
kid This property is required. str
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
kty This property is required. str
The key type.
n This property is required. str
The base64 url encoded modulus of the RSA public key represented by this key.
use This property is required. str
The intended use of the public key.
alg This property is required. String
The algorithm intended for use with this key.
e This property is required. String
The base64 url encoded exponent of the RSA public key represented by this key.
format This property is required. String
The format of the public key.
key This property is required. String
Information around the values for selector of an authentication/ routing branch.
keyOps This property is required. List<String>
The operations for which this key is to be used.
kid This property is required. String
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
kty This property is required. String
The key type.
n This property is required. String
The base64 url encoded modulus of the RSA public key represented by this key.
use This property is required. String
The intended use of the public key.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicy

ClientDetails This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail>
Client App Credential details.
FallbackRedirectPath This property is required. string
The path to be used as fallback after OAuth2.
LogoutPath This property is required. string
The path to be used as logout.
MaxExpiryDurationInHours This property is required. int
The duration for which the OAuth2 success token should be cached before it is fetched again.
ResponseCode This property is required. string
HTTP response code, can include context variables.
ResponseHeaderTransformations This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation>
A set of transformations to apply to HTTP headers that pass through the gateway.
ResponseMessage This property is required. string
HTTP response message.
ResponseType This property is required. string
Response Type.
Scopes This property is required. List<string>
List of scopes.
SourceUriDetails This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail>
Auth endpoint details.
Type This property is required. string
Type of the Response Cache Store Policy.
UseCookiesForIntermediateSteps This property is required. bool
Defines whether or not to use cookies for OAuth2 intermediate steps.
UseCookiesForSession This property is required. bool
Defines whether or not to use cookies for session maintenance.
UsePkce This property is required. bool
Defines whether or not to support PKCE.
ClientDetails This property is required. []GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail
Client App Credential details.
FallbackRedirectPath This property is required. string
The path to be used as fallback after OAuth2.
LogoutPath This property is required. string
The path to be used as logout.
MaxExpiryDurationInHours This property is required. int
The duration for which the OAuth2 success token should be cached before it is fetched again.
ResponseCode This property is required. string
HTTP response code, can include context variables.
ResponseHeaderTransformations This property is required. []GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation
A set of transformations to apply to HTTP headers that pass through the gateway.
ResponseMessage This property is required. string
HTTP response message.
ResponseType This property is required. string
Response Type.
Scopes This property is required. []string
List of scopes.
SourceUriDetails This property is required. []GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail
Auth endpoint details.
Type This property is required. string
Type of the Response Cache Store Policy.
UseCookiesForIntermediateSteps This property is required. bool
Defines whether or not to use cookies for OAuth2 intermediate steps.
UseCookiesForSession This property is required. bool
Defines whether or not to use cookies for session maintenance.
UsePkce This property is required. bool
Defines whether or not to support PKCE.
clientDetails This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail>
Client App Credential details.
fallbackRedirectPath This property is required. String
The path to be used as fallback after OAuth2.
logoutPath This property is required. String
The path to be used as logout.
maxExpiryDurationInHours This property is required. Integer
The duration for which the OAuth2 success token should be cached before it is fetched again.
responseCode This property is required. String
HTTP response code, can include context variables.
responseHeaderTransformations This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation>
A set of transformations to apply to HTTP headers that pass through the gateway.
responseMessage This property is required. String
HTTP response message.
responseType This property is required. String
Response Type.
scopes This property is required. List<String>
List of scopes.
sourceUriDetails This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail>
Auth endpoint details.
type This property is required. String
Type of the Response Cache Store Policy.
useCookiesForIntermediateSteps This property is required. Boolean
Defines whether or not to use cookies for OAuth2 intermediate steps.
useCookiesForSession This property is required. Boolean
Defines whether or not to use cookies for session maintenance.
usePkce This property is required. Boolean
Defines whether or not to support PKCE.
clientDetails This property is required. GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail[]
Client App Credential details.
fallbackRedirectPath This property is required. string
The path to be used as fallback after OAuth2.
logoutPath This property is required. string
The path to be used as logout.
maxExpiryDurationInHours This property is required. number
The duration for which the OAuth2 success token should be cached before it is fetched again.
responseCode This property is required. string
HTTP response code, can include context variables.
responseHeaderTransformations This property is required. GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation[]
A set of transformations to apply to HTTP headers that pass through the gateway.
responseMessage This property is required. string
HTTP response message.
responseType This property is required. string
Response Type.
scopes This property is required. string[]
List of scopes.
sourceUriDetails This property is required. GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail[]
Auth endpoint details.
type This property is required. string
Type of the Response Cache Store Policy.
useCookiesForIntermediateSteps This property is required. boolean
Defines whether or not to use cookies for OAuth2 intermediate steps.
useCookiesForSession This property is required. boolean
Defines whether or not to use cookies for session maintenance.
usePkce This property is required. boolean
Defines whether or not to support PKCE.
client_details This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail]
Client App Credential details.
fallback_redirect_path This property is required. str
The path to be used as fallback after OAuth2.
logout_path This property is required. str
The path to be used as logout.
max_expiry_duration_in_hours This property is required. int
The duration for which the OAuth2 success token should be cached before it is fetched again.
response_code This property is required. str
HTTP response code, can include context variables.
response_header_transformations This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation]
A set of transformations to apply to HTTP headers that pass through the gateway.
response_message This property is required. str
HTTP response message.
response_type This property is required. str
Response Type.
scopes This property is required. Sequence[str]
List of scopes.
source_uri_details This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail]
Auth endpoint details.
type This property is required. str
Type of the Response Cache Store Policy.
use_cookies_for_intermediate_steps This property is required. bool
Defines whether or not to use cookies for OAuth2 intermediate steps.
use_cookies_for_session This property is required. bool
Defines whether or not to use cookies for session maintenance.
use_pkce This property is required. bool
Defines whether or not to support PKCE.
clientDetails This property is required. List<Property Map>
Client App Credential details.
fallbackRedirectPath This property is required. String
The path to be used as fallback after OAuth2.
logoutPath This property is required. String
The path to be used as logout.
maxExpiryDurationInHours This property is required. Number
The duration for which the OAuth2 success token should be cached before it is fetched again.
responseCode This property is required. String
HTTP response code, can include context variables.
responseHeaderTransformations This property is required. List<Property Map>
A set of transformations to apply to HTTP headers that pass through the gateway.
responseMessage This property is required. String
HTTP response message.
responseType This property is required. String
Response Type.
scopes This property is required. List<String>
List of scopes.
sourceUriDetails This property is required. List<Property Map>
Auth endpoint details.
type This property is required. String
Type of the Response Cache Store Policy.
useCookiesForIntermediateSteps This property is required. Boolean
Defines whether or not to use cookies for OAuth2 intermediate steps.
useCookiesForSession This property is required. Boolean
Defines whether or not to use cookies for session maintenance.
usePkce This property is required. Boolean
Defines whether or not to support PKCE.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail

ClientId This property is required. string
Client ID for the OAuth2/OIDC app.
ClientSecretId This property is required. string
The OCID of the Oracle Vault Service secret resource.
ClientSecretVersionNumber This property is required. string
The version number of the client secret to use.
Type This property is required. string
Type of the Response Cache Store Policy.
ClientId This property is required. string
Client ID for the OAuth2/OIDC app.
ClientSecretId This property is required. string
The OCID of the Oracle Vault Service secret resource.
ClientSecretVersionNumber This property is required. string
The version number of the client secret to use.
Type This property is required. string
Type of the Response Cache Store Policy.
clientId This property is required. String
Client ID for the OAuth2/OIDC app.
clientSecretId This property is required. String
The OCID of the Oracle Vault Service secret resource.
clientSecretVersionNumber This property is required. String
The version number of the client secret to use.
type This property is required. String
Type of the Response Cache Store Policy.
clientId This property is required. string
Client ID for the OAuth2/OIDC app.
clientSecretId This property is required. string
The OCID of the Oracle Vault Service secret resource.
clientSecretVersionNumber This property is required. string
The version number of the client secret to use.
type This property is required. string
Type of the Response Cache Store Policy.
client_id This property is required. str
Client ID for the OAuth2/OIDC app.
client_secret_id This property is required. str
The OCID of the Oracle Vault Service secret resource.
client_secret_version_number This property is required. str
The version number of the client secret to use.
type This property is required. str
Type of the Response Cache Store Policy.
clientId This property is required. String
Client ID for the OAuth2/OIDC app.
clientSecretId This property is required. String
The OCID of the Oracle Vault Service secret resource.
clientSecretVersionNumber This property is required. String
The version number of the client secret to use.
type This property is required. String
Type of the Response Cache Store Policy.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation

FilterHeaders This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader>
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
RenameHeaders This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader>
Rename HTTP headers as they pass through the gateway.
SetHeaders This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader>
Set HTTP headers as they pass through the gateway.
FilterHeaders This property is required. []GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
RenameHeaders This property is required. []GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader
Rename HTTP headers as they pass through the gateway.
SetHeaders This property is required. []GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader
Set HTTP headers as they pass through the gateway.
filterHeaders This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader>
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
renameHeaders This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader>
Rename HTTP headers as they pass through the gateway.
setHeaders This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader>
Set HTTP headers as they pass through the gateway.
filterHeaders This property is required. GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader[]
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
renameHeaders This property is required. GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader[]
Rename HTTP headers as they pass through the gateway.
setHeaders This property is required. GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader[]
Set HTTP headers as they pass through the gateway.
filter_headers This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader]
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
rename_headers This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader]
Rename HTTP headers as they pass through the gateway.
set_headers This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader]
Set HTTP headers as they pass through the gateway.
filterHeaders This property is required. List<Property Map>
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
renameHeaders This property is required. List<Property Map>
Rename HTTP headers as they pass through the gateway.
setHeaders This property is required. List<Property Map>
Set HTTP headers as they pass through the gateway.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader

Items This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem>
The list of headers.
Type This property is required. string
Type of the Response Cache Store Policy.
Items This property is required. []GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem
The list of headers.
Type This property is required. string
Type of the Response Cache Store Policy.
items This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem>
The list of headers.
type This property is required. String
Type of the Response Cache Store Policy.
items This property is required. GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem[]
The list of headers.
type This property is required. string
Type of the Response Cache Store Policy.
items This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem]
The list of headers.
type This property is required. str
Type of the Response Cache Store Policy.
items This property is required. List<Property Map>
The list of headers.
type This property is required. String
Type of the Response Cache Store Policy.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem

Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
name This property is required. str
The case-insensitive name of the header. This name must be unique across transformation policies.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader

items This property is required. List<Property Map>
The list of headers.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem

From This property is required. string
The original case-insensitive name of the header. This name must be unique across transformation policies.
To This property is required. string
The new name of the header. This name must be unique across transformation policies.
From This property is required. string
The original case-insensitive name of the header. This name must be unique across transformation policies.
To This property is required. string
The new name of the header. This name must be unique across transformation policies.
from This property is required. String
The original case-insensitive name of the header. This name must be unique across transformation policies.
to This property is required. String
The new name of the header. This name must be unique across transformation policies.
from This property is required. string
The original case-insensitive name of the header. This name must be unique across transformation policies.
to This property is required. string
The new name of the header. This name must be unique across transformation policies.
from_ This property is required. str
The original case-insensitive name of the header. This name must be unique across transformation policies.
to This property is required. str
The new name of the header. This name must be unique across transformation policies.
from This property is required. String
The original case-insensitive name of the header. This name must be unique across transformation policies.
to This property is required. String
The new name of the header. This name must be unique across transformation policies.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader

items This property is required. List<Property Map>
The list of headers.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeaderItem

IfExists This property is required. string
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Values This property is required. List<string>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
IfExists This property is required. string
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Values This property is required. []string
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
ifExists This property is required. String
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
values This property is required. List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
ifExists This property is required. string
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
values This property is required. string[]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
if_exists This property is required. str
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
name This property is required. str
The case-insensitive name of the header. This name must be unique across transformation policies.
values This property is required. Sequence[str]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
ifExists This property is required. String
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
values This property is required. List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail

Type This property is required. string
Type of the Response Cache Store Policy.
Uri This property is required. string
The uri from which to retrieve the key. It must be accessible without authentication.
Type This property is required. string
Type of the Response Cache Store Policy.
Uri This property is required. string
The uri from which to retrieve the key. It must be accessible without authentication.
type This property is required. String
Type of the Response Cache Store Policy.
uri This property is required. String
The uri from which to retrieve the key. It must be accessible without authentication.
type This property is required. string
Type of the Response Cache Store Policy.
uri This property is required. string
The uri from which to retrieve the key. It must be accessible without authentication.
type This property is required. str
Type of the Response Cache Store Policy.
uri This property is required. str
The uri from which to retrieve the key. It must be accessible without authentication.
type This property is required. String
Type of the Response Cache Store Policy.
uri This property is required. String
The uri from which to retrieve the key. It must be accessible without authentication.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicy

AdditionalValidationPolicies This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy>
Additional JWT validation checks.
ClientDetails This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail>
Client App Credential details.
IsSslVerifyDisabled This property is required. bool
Defines whether or not to uphold SSL verification.
Keys This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyKey>
The set of static public keys.
MaxCacheDurationInHours This property is required. int
The duration for which the introspect URL response should be cached before it is fetched again.
SourceUriDetails This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail>
Auth endpoint details.
Type This property is required. string
Type of the Response Cache Store Policy.
Uri This property is required. string
The uri from which to retrieve the key. It must be accessible without authentication.
AdditionalValidationPolicies This property is required. []GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy
Additional JWT validation checks.
ClientDetails This property is required. []GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail
Client App Credential details.
IsSslVerifyDisabled This property is required. bool
Defines whether or not to uphold SSL verification.
Keys This property is required. []GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyKey
The set of static public keys.
MaxCacheDurationInHours This property is required. int
The duration for which the introspect URL response should be cached before it is fetched again.
SourceUriDetails This property is required. []GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail
Auth endpoint details.
Type This property is required. string
Type of the Response Cache Store Policy.
Uri This property is required. string
The uri from which to retrieve the key. It must be accessible without authentication.
additionalValidationPolicies This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy>
Additional JWT validation checks.
clientDetails This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail>
Client App Credential details.
isSslVerifyDisabled This property is required. Boolean
Defines whether or not to uphold SSL verification.
keys This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyKey>
The set of static public keys.
maxCacheDurationInHours This property is required. Integer
The duration for which the introspect URL response should be cached before it is fetched again.
sourceUriDetails This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail>
Auth endpoint details.
type This property is required. String
Type of the Response Cache Store Policy.
uri This property is required. String
The uri from which to retrieve the key. It must be accessible without authentication.
additionalValidationPolicies This property is required. GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy[]
Additional JWT validation checks.
clientDetails This property is required. GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail[]
Client App Credential details.
isSslVerifyDisabled This property is required. boolean
Defines whether or not to uphold SSL verification.
keys This property is required. GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyKey[]
The set of static public keys.
maxCacheDurationInHours This property is required. number
The duration for which the introspect URL response should be cached before it is fetched again.
sourceUriDetails This property is required. GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail[]
Auth endpoint details.
type This property is required. string
Type of the Response Cache Store Policy.
uri This property is required. string
The uri from which to retrieve the key. It must be accessible without authentication.
additional_validation_policies This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy]
Additional JWT validation checks.
client_details This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail]
Client App Credential details.
is_ssl_verify_disabled This property is required. bool
Defines whether or not to uphold SSL verification.
keys This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyKey]
The set of static public keys.
max_cache_duration_in_hours This property is required. int
The duration for which the introspect URL response should be cached before it is fetched again.
source_uri_details This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail]
Auth endpoint details.
type This property is required. str
Type of the Response Cache Store Policy.
uri This property is required. str
The uri from which to retrieve the key. It must be accessible without authentication.
additionalValidationPolicies This property is required. List<Property Map>
Additional JWT validation checks.
clientDetails This property is required. List<Property Map>
Client App Credential details.
isSslVerifyDisabled This property is required. Boolean
Defines whether or not to uphold SSL verification.
keys This property is required. List<Property Map>
The set of static public keys.
maxCacheDurationInHours This property is required. Number
The duration for which the introspect URL response should be cached before it is fetched again.
sourceUriDetails This property is required. List<Property Map>
Auth endpoint details.
type This property is required. String
Type of the Response Cache Store Policy.
uri This property is required. String
The uri from which to retrieve the key. It must be accessible without authentication.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy

Audiences This property is required. List<string>
The list of intended recipients for the token.
Issuers This property is required. List<string>
A list of parties that could have issued the token.
VerifyClaims This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim>
A list of claims which should be validated to consider the token valid.
Audiences This property is required. []string
The list of intended recipients for the token.
Issuers This property is required. []string
A list of parties that could have issued the token.
VerifyClaims This property is required. []GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim
A list of claims which should be validated to consider the token valid.
audiences This property is required. List<String>
The list of intended recipients for the token.
issuers This property is required. List<String>
A list of parties that could have issued the token.
verifyClaims This property is required. List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim>
A list of claims which should be validated to consider the token valid.
audiences This property is required. string[]
The list of intended recipients for the token.
issuers This property is required. string[]
A list of parties that could have issued the token.
verifyClaims This property is required. GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim[]
A list of claims which should be validated to consider the token valid.
audiences This property is required. Sequence[str]
The list of intended recipients for the token.
issuers This property is required. Sequence[str]
A list of parties that could have issued the token.
verify_claims This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim]
A list of claims which should be validated to consider the token valid.
audiences This property is required. List<String>
The list of intended recipients for the token.
issuers This property is required. List<String>
A list of parties that could have issued the token.
verifyClaims This property is required. List<Property Map>
A list of claims which should be validated to consider the token valid.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim

IsRequired This property is required. bool
Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
Key This property is required. string
Information around the values for selector of an authentication/ routing branch.
Values This property is required. List<string>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
IsRequired This property is required. bool
Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
Key This property is required. string
Information around the values for selector of an authentication/ routing branch.
Values This property is required. []string
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
isRequired This property is required. Boolean
Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
key This property is required. String
Information around the values for selector of an authentication/ routing branch.
values This property is required. List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
isRequired This property is required. boolean
Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
key This property is required. string
Information around the values for selector of an authentication/ routing branch.
values This property is required. string[]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
is_required This property is required. bool
Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
key This property is required. str
Information around the values for selector of an authentication/ routing branch.
values This property is required. Sequence[str]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
isRequired This property is required. Boolean
Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
key This property is required. String
Information around the values for selector of an authentication/ routing branch.
values This property is required. List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail

ClientId This property is required. string
Client ID for the OAuth2/OIDC app.
ClientSecretId This property is required. string
The OCID of the Oracle Vault Service secret resource.
ClientSecretVersionNumber This property is required. string
The version number of the client secret to use.
Type This property is required. string
Type of the Response Cache Store Policy.
ClientId This property is required. string
Client ID for the OAuth2/OIDC app.
ClientSecretId This property is required. string
The OCID of the Oracle Vault Service secret resource.
ClientSecretVersionNumber This property is required. string
The version number of the client secret to use.
Type This property is required. string
Type of the Response Cache Store Policy.
clientId This property is required. String
Client ID for the OAuth2/OIDC app.
clientSecretId This property is required. String
The OCID of the Oracle Vault Service secret resource.
clientSecretVersionNumber This property is required. String
The version number of the client secret to use.
type This property is required. String
Type of the Response Cache Store Policy.
clientId This property is required. string
Client ID for the OAuth2/OIDC app.
clientSecretId This property is required. string
The OCID of the Oracle Vault Service secret resource.
clientSecretVersionNumber This property is required. string
The version number of the client secret to use.
type This property is required. string
Type of the Response Cache Store Policy.
client_id This property is required. str
Client ID for the OAuth2/OIDC app.
client_secret_id This property is required. str
The OCID of the Oracle Vault Service secret resource.
client_secret_version_number This property is required. str
The version number of the client secret to use.
type This property is required. str
Type of the Response Cache Store Policy.
clientId This property is required. String
Client ID for the OAuth2/OIDC app.
clientSecretId This property is required. String
The OCID of the Oracle Vault Service secret resource.
clientSecretVersionNumber This property is required. String
The version number of the client secret to use.
type This property is required. String
Type of the Response Cache Store Policy.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyKey

Alg This property is required. string
The algorithm intended for use with this key.
E This property is required. string
The base64 url encoded exponent of the RSA public key represented by this key.
Format This property is required. string
The format of the public key.
Key This property is required. string
Information around the values for selector of an authentication/ routing branch.
KeyOps This property is required. List<string>
The operations for which this key is to be used.
Kid This property is required. string
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
Kty This property is required. string
The key type.
N This property is required. string
The base64 url encoded modulus of the RSA public key represented by this key.
Use This property is required. string
The intended use of the public key.
Alg This property is required. string
The algorithm intended for use with this key.
E This property is required. string
The base64 url encoded exponent of the RSA public key represented by this key.
Format This property is required. string
The format of the public key.
Key This property is required. string
Information around the values for selector of an authentication/ routing branch.
KeyOps This property is required. []string
The operations for which this key is to be used.
Kid This property is required. string
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
Kty This property is required. string
The key type.
N This property is required. string
The base64 url encoded modulus of the RSA public key represented by this key.
Use This property is required. string
The intended use of the public key.
alg This property is required. String
The algorithm intended for use with this key.
e This property is required. String
The base64 url encoded exponent of the RSA public key represented by this key.
format This property is required. String
The format of the public key.
key This property is required. String
Information around the values for selector of an authentication/ routing branch.
keyOps This property is required. List<String>
The operations for which this key is to be used.
kid This property is required. String
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
kty This property is required. String
The key type.
n This property is required. String
The base64 url encoded modulus of the RSA public key represented by this key.
use This property is required. String
The intended use of the public key.
alg This property is required. string
The algorithm intended for use with this key.
e This property is required. string
The base64 url encoded exponent of the RSA public key represented by this key.
format This property is required. string
The format of the public key.
key This property is required. string
Information around the values for selector of an authentication/ routing branch.
keyOps This property is required. string[]
The operations for which this key is to be used.
kid This property is required. string
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
kty This property is required. string
The key type.
n This property is required. string
The base64 url encoded modulus of the RSA public key represented by this key.
use This property is required. string
The intended use of the public key.
alg This property is required. str
The algorithm intended for use with this key.
e This property is required. str
The base64 url encoded exponent of the RSA public key represented by this key.
format This property is required. str
The format of the public key.
key This property is required. str
Information around the values for selector of an authentication/ routing branch.
key_ops This property is required. Sequence[str]
The operations for which this key is to be used.
kid This property is required. str
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
kty This property is required. str
The key type.
n This property is required. str
The base64 url encoded modulus of the RSA public key represented by this key.
use This property is required. str
The intended use of the public key.
alg This property is required. String
The algorithm intended for use with this key.
e This property is required. String
The base64 url encoded exponent of the RSA public key represented by this key.
format This property is required. String
The format of the public key.
key This property is required. String
Information around the values for selector of an authentication/ routing branch.
keyOps This property is required. List<String>
The operations for which this key is to be used.
kid This property is required. String
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
kty This property is required. String
The key type.
n This property is required. String
The base64 url encoded modulus of the RSA public key represented by this key.
use This property is required. String
The intended use of the public key.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail

Type This property is required. string
Type of the Response Cache Store Policy.
Uri This property is required. string
The uri from which to retrieve the key. It must be accessible without authentication.
Type This property is required. string
Type of the Response Cache Store Policy.
Uri This property is required. string
The uri from which to retrieve the key. It must be accessible without authentication.
type This property is required. String
Type of the Response Cache Store Policy.
uri This property is required. String
The uri from which to retrieve the key. It must be accessible without authentication.
type This property is required. string
Type of the Response Cache Store Policy.
uri This property is required. string
The uri from which to retrieve the key. It must be accessible without authentication.
type This property is required. str
Type of the Response Cache Store Policy.
uri This property is required. str
The uri from which to retrieve the key. It must be accessible without authentication.
type This property is required. String
Type of the Response Cache Store Policy.
uri This property is required. String
The uri from which to retrieve the key. It must be accessible without authentication.

GetDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim

IsRequired This property is required. bool
Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
Key This property is required. string
Information around the values for selector of an authentication/ routing branch.
Values This property is required. List<string>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
IsRequired This property is required. bool
Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
Key This property is required. string
Information around the values for selector of an authentication/ routing branch.
Values This property is required. []string
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
isRequired This property is required. Boolean
Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
key This property is required. String
Information around the values for selector of an authentication/ routing branch.
values This property is required. List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
isRequired This property is required. boolean
Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
key This property is required. string
Information around the values for selector of an authentication/ routing branch.
values This property is required. string[]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
is_required This property is required. bool
Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
key This property is required. str
Information around the values for selector of an authentication/ routing branch.
values This property is required. Sequence[str]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
isRequired This property is required. Boolean
Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
key This property is required. String
Information around the values for selector of an authentication/ routing branch.
values This property is required. List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

GetDeploymentSpecificationRequestPolicyCor

AllowedHeaders This property is required. List<string>
The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
AllowedMethods This property is required. List<string>
The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
AllowedOrigins This property is required. List<string>
The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
ExposedHeaders This property is required. List<string>
The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
IsAllowCredentialsEnabled This property is required. bool
Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
MaxAgeInSeconds This property is required. int
The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
AllowedHeaders This property is required. []string
The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
AllowedMethods This property is required. []string
The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
AllowedOrigins This property is required. []string
The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
ExposedHeaders This property is required. []string
The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
IsAllowCredentialsEnabled This property is required. bool
Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
MaxAgeInSeconds This property is required. int
The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
allowedHeaders This property is required. List<String>
The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
allowedMethods This property is required. List<String>
The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
allowedOrigins This property is required. List<String>
The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
exposedHeaders This property is required. List<String>
The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
isAllowCredentialsEnabled This property is required. Boolean
Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
maxAgeInSeconds This property is required. Integer
The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
allowedHeaders This property is required. string[]
The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
allowedMethods This property is required. string[]
The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
allowedOrigins This property is required. string[]
The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
exposedHeaders This property is required. string[]
The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
isAllowCredentialsEnabled This property is required. boolean
Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
maxAgeInSeconds This property is required. number
The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
allowed_headers This property is required. Sequence[str]
The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
allowed_methods This property is required. Sequence[str]
The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
allowed_origins This property is required. Sequence[str]
The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
exposed_headers This property is required. Sequence[str]
The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
is_allow_credentials_enabled This property is required. bool
Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
max_age_in_seconds This property is required. int
The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
allowedHeaders This property is required. List<String>
The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
allowedMethods This property is required. List<String>
The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
allowedOrigins This property is required. List<String>
The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
exposedHeaders This property is required. List<String>
The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
isAllowCredentialsEnabled This property is required. Boolean
Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
maxAgeInSeconds This property is required. Number
The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.

GetDeploymentSpecificationRequestPolicyDynamicAuthentication

AuthenticationServers This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer>
List of authentication servers to choose from during dynamic authentication.
SelectionSources This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationSelectionSource>
Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.
AuthenticationServers This property is required. []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer
List of authentication servers to choose from during dynamic authentication.
SelectionSources This property is required. []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationSelectionSource
Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.
authenticationServers This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer>
List of authentication servers to choose from during dynamic authentication.
selectionSources This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationSelectionSource>
Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.
authenticationServers This property is required. GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer[]
List of authentication servers to choose from during dynamic authentication.
selectionSources This property is required. GetDeploymentSpecificationRequestPolicyDynamicAuthenticationSelectionSource[]
Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.
authentication_servers This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer]
List of authentication servers to choose from during dynamic authentication.
selection_sources This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationSelectionSource]
Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.
authenticationServers This property is required. List<Property Map>
List of authentication servers to choose from during dynamic authentication.
selectionSources This property is required. List<Property Map>
Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer

AuthenticationServerDetails This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail>
Information on how to authenticate incoming requests.
Keys This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerKey>
Information around the values for selector of an authentication/ routing branch.
AuthenticationServerDetails This property is required. []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail
Information on how to authenticate incoming requests.
Keys This property is required. []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerKey
Information around the values for selector of an authentication/ routing branch.
authenticationServerDetails This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail>
Information on how to authenticate incoming requests.
keys This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerKey>
Information around the values for selector of an authentication/ routing branch.
authenticationServerDetails This property is required. GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail[]
Information on how to authenticate incoming requests.
keys This property is required. GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerKey[]
Information around the values for selector of an authentication/ routing branch.
authentication_server_details This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail]
Information on how to authenticate incoming requests.
keys This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerKey]
Information around the values for selector of an authentication/ routing branch.
authenticationServerDetails This property is required. List<Property Map>
Information on how to authenticate incoming requests.
keys This property is required. List<Property Map>
Information around the values for selector of an authentication/ routing branch.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail

Audiences This property is required. List<string>
The list of intended recipients for the token.
CacheKeys This property is required. List<string>
A list of keys from "parameters" attribute value whose values will be added to the cache key.
FunctionId This property is required. string
The OCID of the Oracle Functions function resource.
IsAnonymousAccessAllowed This property is required. bool
Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
Issuers This property is required. List<string>
A list of parties that could have issued the token.
MaxClockSkewInSeconds This property is required. double
The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
Parameters This property is required. Dictionary<string, string>
PublicKeys This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey>
A set of Public Keys that will be used to verify the JWT signature.
TokenAuthScheme This property is required. string
The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
TokenHeader This property is required. string
The name of the header containing the authentication token.
TokenQueryParam This property is required. string
The name of the query parameter containing the authentication token.
Type This property is required. string
Type of the Response Cache Store Policy.
ValidationFailurePolicies This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy>
Policy for defining behaviour on validation failure.
ValidationPolicies This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy>
Authentication Policies for the Token Authentication types.
VerifyClaims This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim>
A list of claims which should be validated to consider the token valid.
Audiences This property is required. []string
The list of intended recipients for the token.
CacheKeys This property is required. []string
A list of keys from "parameters" attribute value whose values will be added to the cache key.
FunctionId This property is required. string
The OCID of the Oracle Functions function resource.
IsAnonymousAccessAllowed This property is required. bool
Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
Issuers This property is required. []string
A list of parties that could have issued the token.
MaxClockSkewInSeconds This property is required. float64
The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
Parameters This property is required. map[string]string
PublicKeys This property is required. []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey
A set of Public Keys that will be used to verify the JWT signature.
TokenAuthScheme This property is required. string
The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
TokenHeader This property is required. string
The name of the header containing the authentication token.
TokenQueryParam This property is required. string
The name of the query parameter containing the authentication token.
Type This property is required. string
Type of the Response Cache Store Policy.
ValidationFailurePolicies This property is required. []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy
Policy for defining behaviour on validation failure.
ValidationPolicies This property is required. []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy
Authentication Policies for the Token Authentication types.
VerifyClaims This property is required. []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim
A list of claims which should be validated to consider the token valid.
audiences This property is required. List<String>
The list of intended recipients for the token.
cacheKeys This property is required. List<String>
A list of keys from "parameters" attribute value whose values will be added to the cache key.
functionId This property is required. String
The OCID of the Oracle Functions function resource.
isAnonymousAccessAllowed This property is required. Boolean
Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
issuers This property is required. List<String>
A list of parties that could have issued the token.
maxClockSkewInSeconds This property is required. Double
The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
parameters This property is required. Map<String,String>
publicKeys This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey>
A set of Public Keys that will be used to verify the JWT signature.
tokenAuthScheme This property is required. String
The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
tokenHeader This property is required. String
The name of the header containing the authentication token.
tokenQueryParam This property is required. String
The name of the query parameter containing the authentication token.
type This property is required. String
Type of the Response Cache Store Policy.
validationFailurePolicies This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy>
Policy for defining behaviour on validation failure.
validationPolicies This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy>
Authentication Policies for the Token Authentication types.
verifyClaims This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim>
A list of claims which should be validated to consider the token valid.
audiences This property is required. string[]
The list of intended recipients for the token.
cacheKeys This property is required. string[]
A list of keys from "parameters" attribute value whose values will be added to the cache key.
functionId This property is required. string
The OCID of the Oracle Functions function resource.
isAnonymousAccessAllowed This property is required. boolean
Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
issuers This property is required. string[]
A list of parties that could have issued the token.
maxClockSkewInSeconds This property is required. number
The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
parameters This property is required. {[key: string]: string}
publicKeys This property is required. GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey[]
A set of Public Keys that will be used to verify the JWT signature.
tokenAuthScheme This property is required. string
The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
tokenHeader This property is required. string
The name of the header containing the authentication token.
tokenQueryParam This property is required. string
The name of the query parameter containing the authentication token.
type This property is required. string
Type of the Response Cache Store Policy.
validationFailurePolicies This property is required. GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy[]
Policy for defining behaviour on validation failure.
validationPolicies This property is required. GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy[]
Authentication Policies for the Token Authentication types.
verifyClaims This property is required. GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim[]
A list of claims which should be validated to consider the token valid.
audiences This property is required. Sequence[str]
The list of intended recipients for the token.
cache_keys This property is required. Sequence[str]
A list of keys from "parameters" attribute value whose values will be added to the cache key.
function_id This property is required. str
The OCID of the Oracle Functions function resource.
is_anonymous_access_allowed This property is required. bool
Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
issuers This property is required. Sequence[str]
A list of parties that could have issued the token.
max_clock_skew_in_seconds This property is required. float
The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
parameters This property is required. Mapping[str, str]
public_keys This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey]
A set of Public Keys that will be used to verify the JWT signature.
token_auth_scheme This property is required. str
The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
token_header This property is required. str
The name of the header containing the authentication token.
token_query_param This property is required. str
The name of the query parameter containing the authentication token.
type This property is required. str
Type of the Response Cache Store Policy.
validation_failure_policies This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy]
Policy for defining behaviour on validation failure.
validation_policies This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy]
Authentication Policies for the Token Authentication types.
verify_claims This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim]
A list of claims which should be validated to consider the token valid.
audiences This property is required. List<String>
The list of intended recipients for the token.
cacheKeys This property is required. List<String>
A list of keys from "parameters" attribute value whose values will be added to the cache key.
functionId This property is required. String
The OCID of the Oracle Functions function resource.
isAnonymousAccessAllowed This property is required. Boolean
Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
issuers This property is required. List<String>
A list of parties that could have issued the token.
maxClockSkewInSeconds This property is required. Number
The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
parameters This property is required. Map<String>
publicKeys This property is required. List<Property Map>
A set of Public Keys that will be used to verify the JWT signature.
tokenAuthScheme This property is required. String
The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
tokenHeader This property is required. String
The name of the header containing the authentication token.
tokenQueryParam This property is required. String
The name of the query parameter containing the authentication token.
type This property is required. String
Type of the Response Cache Store Policy.
validationFailurePolicies This property is required. List<Property Map>
Policy for defining behaviour on validation failure.
validationPolicies This property is required. List<Property Map>
Authentication Policies for the Token Authentication types.
verifyClaims This property is required. List<Property Map>
A list of claims which should be validated to consider the token valid.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey

IsSslVerifyDisabled This property is required. bool
Defines whether or not to uphold SSL verification.
Keys This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey>
The set of static public keys.
MaxCacheDurationInHours This property is required. int
The duration for which the introspect URL response should be cached before it is fetched again.
Type This property is required. string
Type of the Response Cache Store Policy.
Uri This property is required. string
The uri from which to retrieve the key. It must be accessible without authentication.
IsSslVerifyDisabled This property is required. bool
Defines whether or not to uphold SSL verification.
Keys This property is required. []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey
The set of static public keys.
MaxCacheDurationInHours This property is required. int
The duration for which the introspect URL response should be cached before it is fetched again.
Type This property is required. string
Type of the Response Cache Store Policy.
Uri This property is required. string
The uri from which to retrieve the key. It must be accessible without authentication.
isSslVerifyDisabled This property is required. Boolean
Defines whether or not to uphold SSL verification.
keys This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey>
The set of static public keys.
maxCacheDurationInHours This property is required. Integer
The duration for which the introspect URL response should be cached before it is fetched again.
type This property is required. String
Type of the Response Cache Store Policy.
uri This property is required. String
The uri from which to retrieve the key. It must be accessible without authentication.
isSslVerifyDisabled This property is required. boolean
Defines whether or not to uphold SSL verification.
keys This property is required. GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey[]
The set of static public keys.
maxCacheDurationInHours This property is required. number
The duration for which the introspect URL response should be cached before it is fetched again.
type This property is required. string
Type of the Response Cache Store Policy.
uri This property is required. string
The uri from which to retrieve the key. It must be accessible without authentication.
is_ssl_verify_disabled This property is required. bool
Defines whether or not to uphold SSL verification.
keys This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey]
The set of static public keys.
max_cache_duration_in_hours This property is required. int
The duration for which the introspect URL response should be cached before it is fetched again.
type This property is required. str
Type of the Response Cache Store Policy.
uri This property is required. str
The uri from which to retrieve the key. It must be accessible without authentication.
isSslVerifyDisabled This property is required. Boolean
Defines whether or not to uphold SSL verification.
keys This property is required. List<Property Map>
The set of static public keys.
maxCacheDurationInHours This property is required. Number
The duration for which the introspect URL response should be cached before it is fetched again.
type This property is required. String
Type of the Response Cache Store Policy.
uri This property is required. String
The uri from which to retrieve the key. It must be accessible without authentication.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey

Alg This property is required. string
The algorithm intended for use with this key.
E This property is required. string
The base64 url encoded exponent of the RSA public key represented by this key.
Format This property is required. string
The format of the public key.
Key This property is required. string
Information around the values for selector of an authentication/ routing branch.
KeyOps This property is required. List<string>
The operations for which this key is to be used.
Kid This property is required. string
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
Kty This property is required. string
The key type.
N This property is required. string
The base64 url encoded modulus of the RSA public key represented by this key.
Use This property is required. string
The intended use of the public key.
Alg This property is required. string
The algorithm intended for use with this key.
E This property is required. string
The base64 url encoded exponent of the RSA public key represented by this key.
Format This property is required. string
The format of the public key.
Key This property is required. string
Information around the values for selector of an authentication/ routing branch.
KeyOps This property is required. []string
The operations for which this key is to be used.
Kid This property is required. string
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
Kty This property is required. string
The key type.
N This property is required. string
The base64 url encoded modulus of the RSA public key represented by this key.
Use This property is required. string
The intended use of the public key.
alg This property is required. String
The algorithm intended for use with this key.
e This property is required. String
The base64 url encoded exponent of the RSA public key represented by this key.
format This property is required. String
The format of the public key.
key This property is required. String
Information around the values for selector of an authentication/ routing branch.
keyOps This property is required. List<String>
The operations for which this key is to be used.
kid This property is required. String
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
kty This property is required. String
The key type.
n This property is required. String
The base64 url encoded modulus of the RSA public key represented by this key.
use This property is required. String
The intended use of the public key.
alg This property is required. string
The algorithm intended for use with this key.
e This property is required. string
The base64 url encoded exponent of the RSA public key represented by this key.
format This property is required. string
The format of the public key.
key This property is required. string
Information around the values for selector of an authentication/ routing branch.
keyOps This property is required. string[]
The operations for which this key is to be used.
kid This property is required. string
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
kty This property is required. string
The key type.
n This property is required. string
The base64 url encoded modulus of the RSA public key represented by this key.
use This property is required. string
The intended use of the public key.
alg This property is required. str
The algorithm intended for use with this key.
e This property is required. str
The base64 url encoded exponent of the RSA public key represented by this key.
format This property is required. str
The format of the public key.
key This property is required. str
Information around the values for selector of an authentication/ routing branch.
key_ops This property is required. Sequence[str]
The operations for which this key is to be used.
kid This property is required. str
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
kty This property is required. str
The key type.
n This property is required. str
The base64 url encoded modulus of the RSA public key represented by this key.
use This property is required. str
The intended use of the public key.
alg This property is required. String
The algorithm intended for use with this key.
e This property is required. String
The base64 url encoded exponent of the RSA public key represented by this key.
format This property is required. String
The format of the public key.
key This property is required. String
Information around the values for selector of an authentication/ routing branch.
keyOps This property is required. List<String>
The operations for which this key is to be used.
kid This property is required. String
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
kty This property is required. String
The key type.
n This property is required. String
The base64 url encoded modulus of the RSA public key represented by this key.
use This property is required. String
The intended use of the public key.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy

ClientDetails This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail>
Client App Credential details.
FallbackRedirectPath This property is required. string
The path to be used as fallback after OAuth2.
LogoutPath This property is required. string
The path to be used as logout.
MaxExpiryDurationInHours This property is required. int
The duration for which the OAuth2 success token should be cached before it is fetched again.
ResponseCode This property is required. string
HTTP response code, can include context variables.
ResponseHeaderTransformations This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation>
A set of transformations to apply to HTTP headers that pass through the gateway.
ResponseMessage This property is required. string
HTTP response message.
ResponseType This property is required. string
Response Type.
Scopes This property is required. List<string>
List of scopes.
SourceUriDetails This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail>
Auth endpoint details.
Type This property is required. string
Type of the Response Cache Store Policy.
UseCookiesForIntermediateSteps This property is required. bool
Defines whether or not to use cookies for OAuth2 intermediate steps.
UseCookiesForSession This property is required. bool
Defines whether or not to use cookies for session maintenance.
UsePkce This property is required. bool
Defines whether or not to support PKCE.
ClientDetails This property is required. []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail
Client App Credential details.
FallbackRedirectPath This property is required. string
The path to be used as fallback after OAuth2.
LogoutPath This property is required. string
The path to be used as logout.
MaxExpiryDurationInHours This property is required. int
The duration for which the OAuth2 success token should be cached before it is fetched again.
ResponseCode This property is required. string
HTTP response code, can include context variables.
ResponseHeaderTransformations This property is required. []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation
A set of transformations to apply to HTTP headers that pass through the gateway.
ResponseMessage This property is required. string
HTTP response message.
ResponseType This property is required. string
Response Type.
Scopes This property is required. []string
List of scopes.
SourceUriDetails This property is required. []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail
Auth endpoint details.
Type This property is required. string
Type of the Response Cache Store Policy.
UseCookiesForIntermediateSteps This property is required. bool
Defines whether or not to use cookies for OAuth2 intermediate steps.
UseCookiesForSession This property is required. bool
Defines whether or not to use cookies for session maintenance.
UsePkce This property is required. bool
Defines whether or not to support PKCE.
clientDetails This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail>
Client App Credential details.
fallbackRedirectPath This property is required. String
The path to be used as fallback after OAuth2.
logoutPath This property is required. String
The path to be used as logout.
maxExpiryDurationInHours This property is required. Integer
The duration for which the OAuth2 success token should be cached before it is fetched again.
responseCode This property is required. String
HTTP response code, can include context variables.
responseHeaderTransformations This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation>
A set of transformations to apply to HTTP headers that pass through the gateway.
responseMessage This property is required. String
HTTP response message.
responseType This property is required. String
Response Type.
scopes This property is required. List<String>
List of scopes.
sourceUriDetails This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail>
Auth endpoint details.
type This property is required. String
Type of the Response Cache Store Policy.
useCookiesForIntermediateSteps This property is required. Boolean
Defines whether or not to use cookies for OAuth2 intermediate steps.
useCookiesForSession This property is required. Boolean
Defines whether or not to use cookies for session maintenance.
usePkce This property is required. Boolean
Defines whether or not to support PKCE.
clientDetails This property is required. GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail[]
Client App Credential details.
fallbackRedirectPath This property is required. string
The path to be used as fallback after OAuth2.
logoutPath This property is required. string
The path to be used as logout.
maxExpiryDurationInHours This property is required. number
The duration for which the OAuth2 success token should be cached before it is fetched again.
responseCode This property is required. string
HTTP response code, can include context variables.
responseHeaderTransformations This property is required. GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation[]
A set of transformations to apply to HTTP headers that pass through the gateway.
responseMessage This property is required. string
HTTP response message.
responseType This property is required. string
Response Type.
scopes This property is required. string[]
List of scopes.
sourceUriDetails This property is required. GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail[]
Auth endpoint details.
type This property is required. string
Type of the Response Cache Store Policy.
useCookiesForIntermediateSteps This property is required. boolean
Defines whether or not to use cookies for OAuth2 intermediate steps.
useCookiesForSession This property is required. boolean
Defines whether or not to use cookies for session maintenance.
usePkce This property is required. boolean
Defines whether or not to support PKCE.
client_details This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail]
Client App Credential details.
fallback_redirect_path This property is required. str
The path to be used as fallback after OAuth2.
logout_path This property is required. str
The path to be used as logout.
max_expiry_duration_in_hours This property is required. int
The duration for which the OAuth2 success token should be cached before it is fetched again.
response_code This property is required. str
HTTP response code, can include context variables.
response_header_transformations This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation]
A set of transformations to apply to HTTP headers that pass through the gateway.
response_message This property is required. str
HTTP response message.
response_type This property is required. str
Response Type.
scopes This property is required. Sequence[str]
List of scopes.
source_uri_details This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail]
Auth endpoint details.
type This property is required. str
Type of the Response Cache Store Policy.
use_cookies_for_intermediate_steps This property is required. bool
Defines whether or not to use cookies for OAuth2 intermediate steps.
use_cookies_for_session This property is required. bool
Defines whether or not to use cookies for session maintenance.
use_pkce This property is required. bool
Defines whether or not to support PKCE.
clientDetails This property is required. List<Property Map>
Client App Credential details.
fallbackRedirectPath This property is required. String
The path to be used as fallback after OAuth2.
logoutPath This property is required. String
The path to be used as logout.
maxExpiryDurationInHours This property is required. Number
The duration for which the OAuth2 success token should be cached before it is fetched again.
responseCode This property is required. String
HTTP response code, can include context variables.
responseHeaderTransformations This property is required. List<Property Map>
A set of transformations to apply to HTTP headers that pass through the gateway.
responseMessage This property is required. String
HTTP response message.
responseType This property is required. String
Response Type.
scopes This property is required. List<String>
List of scopes.
sourceUriDetails This property is required. List<Property Map>
Auth endpoint details.
type This property is required. String
Type of the Response Cache Store Policy.
useCookiesForIntermediateSteps This property is required. Boolean
Defines whether or not to use cookies for OAuth2 intermediate steps.
useCookiesForSession This property is required. Boolean
Defines whether or not to use cookies for session maintenance.
usePkce This property is required. Boolean
Defines whether or not to support PKCE.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail

ClientId This property is required. string
Client ID for the OAuth2/OIDC app.
ClientSecretId This property is required. string
The OCID of the Oracle Vault Service secret resource.
ClientSecretVersionNumber This property is required. string
The version number of the client secret to use.
Type This property is required. string
Type of the Response Cache Store Policy.
ClientId This property is required. string
Client ID for the OAuth2/OIDC app.
ClientSecretId This property is required. string
The OCID of the Oracle Vault Service secret resource.
ClientSecretVersionNumber This property is required. string
The version number of the client secret to use.
Type This property is required. string
Type of the Response Cache Store Policy.
clientId This property is required. String
Client ID for the OAuth2/OIDC app.
clientSecretId This property is required. String
The OCID of the Oracle Vault Service secret resource.
clientSecretVersionNumber This property is required. String
The version number of the client secret to use.
type This property is required. String
Type of the Response Cache Store Policy.
clientId This property is required. string
Client ID for the OAuth2/OIDC app.
clientSecretId This property is required. string
The OCID of the Oracle Vault Service secret resource.
clientSecretVersionNumber This property is required. string
The version number of the client secret to use.
type This property is required. string
Type of the Response Cache Store Policy.
client_id This property is required. str
Client ID for the OAuth2/OIDC app.
client_secret_id This property is required. str
The OCID of the Oracle Vault Service secret resource.
client_secret_version_number This property is required. str
The version number of the client secret to use.
type This property is required. str
Type of the Response Cache Store Policy.
clientId This property is required. String
Client ID for the OAuth2/OIDC app.
clientSecretId This property is required. String
The OCID of the Oracle Vault Service secret resource.
clientSecretVersionNumber This property is required. String
The version number of the client secret to use.
type This property is required. String
Type of the Response Cache Store Policy.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation

FilterHeaders This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader>
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
RenameHeaders This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader>
Rename HTTP headers as they pass through the gateway.
SetHeaders This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader>
Set HTTP headers as they pass through the gateway.
FilterHeaders This property is required. []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
RenameHeaders This property is required. []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader
Rename HTTP headers as they pass through the gateway.
SetHeaders This property is required. []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader
Set HTTP headers as they pass through the gateway.
filterHeaders This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader>
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
renameHeaders This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader>
Rename HTTP headers as they pass through the gateway.
setHeaders This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader>
Set HTTP headers as they pass through the gateway.
filterHeaders This property is required. GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader[]
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
renameHeaders This property is required. GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader[]
Rename HTTP headers as they pass through the gateway.
setHeaders This property is required. GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader[]
Set HTTP headers as they pass through the gateway.
filter_headers This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader]
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
rename_headers This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader]
Rename HTTP headers as they pass through the gateway.
set_headers This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader]
Set HTTP headers as they pass through the gateway.
filterHeaders This property is required. List<Property Map>
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
renameHeaders This property is required. List<Property Map>
Rename HTTP headers as they pass through the gateway.
setHeaders This property is required. List<Property Map>
Set HTTP headers as they pass through the gateway.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader

items This property is required. List<Property Map>
The list of headers.
type This property is required. String
Type of the Response Cache Store Policy.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem

Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
name This property is required. str
The case-insensitive name of the header. This name must be unique across transformation policies.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader

items This property is required. List<Property Map>
The list of headers.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem

From This property is required. string
The original case-insensitive name of the header. This name must be unique across transformation policies.
To This property is required. string
The new name of the header. This name must be unique across transformation policies.
From This property is required. string
The original case-insensitive name of the header. This name must be unique across transformation policies.
To This property is required. string
The new name of the header. This name must be unique across transformation policies.
from This property is required. String
The original case-insensitive name of the header. This name must be unique across transformation policies.
to This property is required. String
The new name of the header. This name must be unique across transformation policies.
from This property is required. string
The original case-insensitive name of the header. This name must be unique across transformation policies.
to This property is required. string
The new name of the header. This name must be unique across transformation policies.
from_ This property is required. str
The original case-insensitive name of the header. This name must be unique across transformation policies.
to This property is required. str
The new name of the header. This name must be unique across transformation policies.
from This property is required. String
The original case-insensitive name of the header. This name must be unique across transformation policies.
to This property is required. String
The new name of the header. This name must be unique across transformation policies.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader

items This property is required. List<Property Map>
The list of headers.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeaderItem

IfExists This property is required. string
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Values This property is required. List<string>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
IfExists This property is required. string
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Values This property is required. []string
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
ifExists This property is required. String
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
values This property is required. List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
ifExists This property is required. string
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
values This property is required. string[]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
if_exists This property is required. str
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
name This property is required. str
The case-insensitive name of the header. This name must be unique across transformation policies.
values This property is required. Sequence[str]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
ifExists This property is required. String
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
values This property is required. List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail

Type This property is required. string
Type of the Response Cache Store Policy.
Uri This property is required. string
The uri from which to retrieve the key. It must be accessible without authentication.
Type This property is required. string
Type of the Response Cache Store Policy.
Uri This property is required. string
The uri from which to retrieve the key. It must be accessible without authentication.
type This property is required. String
Type of the Response Cache Store Policy.
uri This property is required. String
The uri from which to retrieve the key. It must be accessible without authentication.
type This property is required. string
Type of the Response Cache Store Policy.
uri This property is required. string
The uri from which to retrieve the key. It must be accessible without authentication.
type This property is required. str
Type of the Response Cache Store Policy.
uri This property is required. str
The uri from which to retrieve the key. It must be accessible without authentication.
type This property is required. String
Type of the Response Cache Store Policy.
uri This property is required. String
The uri from which to retrieve the key. It must be accessible without authentication.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy

AdditionalValidationPolicies This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy>
Additional JWT validation checks.
ClientDetails This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail>
Client App Credential details.
IsSslVerifyDisabled This property is required. bool
Defines whether or not to uphold SSL verification.
Keys This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey>
The set of static public keys.
MaxCacheDurationInHours This property is required. int
The duration for which the introspect URL response should be cached before it is fetched again.
SourceUriDetails This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail>
Auth endpoint details.
Type This property is required. string
Type of the Response Cache Store Policy.
Uri This property is required. string
The uri from which to retrieve the key. It must be accessible without authentication.
AdditionalValidationPolicies This property is required. []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy
Additional JWT validation checks.
ClientDetails This property is required. []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail
Client App Credential details.
IsSslVerifyDisabled This property is required. bool
Defines whether or not to uphold SSL verification.
Keys This property is required. []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey
The set of static public keys.
MaxCacheDurationInHours This property is required. int
The duration for which the introspect URL response should be cached before it is fetched again.
SourceUriDetails This property is required. []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail
Auth endpoint details.
Type This property is required. string
Type of the Response Cache Store Policy.
Uri This property is required. string
The uri from which to retrieve the key. It must be accessible without authentication.
additionalValidationPolicies This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy>
Additional JWT validation checks.
clientDetails This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail>
Client App Credential details.
isSslVerifyDisabled This property is required. Boolean
Defines whether or not to uphold SSL verification.
keys This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey>
The set of static public keys.
maxCacheDurationInHours This property is required. Integer
The duration for which the introspect URL response should be cached before it is fetched again.
sourceUriDetails This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail>
Auth endpoint details.
type This property is required. String
Type of the Response Cache Store Policy.
uri This property is required. String
The uri from which to retrieve the key. It must be accessible without authentication.
additionalValidationPolicies This property is required. GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy[]
Additional JWT validation checks.
clientDetails This property is required. GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail[]
Client App Credential details.
isSslVerifyDisabled This property is required. boolean
Defines whether or not to uphold SSL verification.
keys This property is required. GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey[]
The set of static public keys.
maxCacheDurationInHours This property is required. number
The duration for which the introspect URL response should be cached before it is fetched again.
sourceUriDetails This property is required. GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail[]
Auth endpoint details.
type This property is required. string
Type of the Response Cache Store Policy.
uri This property is required. string
The uri from which to retrieve the key. It must be accessible without authentication.
additional_validation_policies This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy]
Additional JWT validation checks.
client_details This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail]
Client App Credential details.
is_ssl_verify_disabled This property is required. bool
Defines whether or not to uphold SSL verification.
keys This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey]
The set of static public keys.
max_cache_duration_in_hours This property is required. int
The duration for which the introspect URL response should be cached before it is fetched again.
source_uri_details This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail]
Auth endpoint details.
type This property is required. str
Type of the Response Cache Store Policy.
uri This property is required. str
The uri from which to retrieve the key. It must be accessible without authentication.
additionalValidationPolicies This property is required. List<Property Map>
Additional JWT validation checks.
clientDetails This property is required. List<Property Map>
Client App Credential details.
isSslVerifyDisabled This property is required. Boolean
Defines whether or not to uphold SSL verification.
keys This property is required. List<Property Map>
The set of static public keys.
maxCacheDurationInHours This property is required. Number
The duration for which the introspect URL response should be cached before it is fetched again.
sourceUriDetails This property is required. List<Property Map>
Auth endpoint details.
type This property is required. String
Type of the Response Cache Store Policy.
uri This property is required. String
The uri from which to retrieve the key. It must be accessible without authentication.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy

Audiences This property is required. List<string>
The list of intended recipients for the token.
Issuers This property is required. List<string>
A list of parties that could have issued the token.
VerifyClaims This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim>
A list of claims which should be validated to consider the token valid.
Audiences This property is required. []string
The list of intended recipients for the token.
Issuers This property is required. []string
A list of parties that could have issued the token.
VerifyClaims This property is required. []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim
A list of claims which should be validated to consider the token valid.
audiences This property is required. List<String>
The list of intended recipients for the token.
issuers This property is required. List<String>
A list of parties that could have issued the token.
verifyClaims This property is required. List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim>
A list of claims which should be validated to consider the token valid.
audiences This property is required. string[]
The list of intended recipients for the token.
issuers This property is required. string[]
A list of parties that could have issued the token.
verifyClaims This property is required. GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim[]
A list of claims which should be validated to consider the token valid.
audiences This property is required. Sequence[str]
The list of intended recipients for the token.
issuers This property is required. Sequence[str]
A list of parties that could have issued the token.
verify_claims This property is required. Sequence[apigateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim]
A list of claims which should be validated to consider the token valid.
audiences This property is required. List<String>
The list of intended recipients for the token.
issuers This property is required. List<String>
A list of parties that could have issued the token.
verifyClaims This property is required. List<Property Map>
A list of claims which should be validated to consider the token valid.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim

IsRequired This property is required. bool
Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
Key This property is required. string
Information around the values for selector of an authentication/ routing branch.
Values This property is required. List<string>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
IsRequired This property is required. bool
Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
Key This property is required. string
Information around the values for selector of an authentication/ routing branch.
Values This property is required. []string
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
isRequired This property is required. Boolean
Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
key This property is required. String
Information around the values for selector of an authentication/ routing branch.
values This property is required. List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
isRequired This property is required. boolean
Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
key This property is required. string
Information around the values for selector of an authentication/ routing branch.
values This property is required. string[]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
is_required This property is required. bool
Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
key This property is required. str
Information around the values for selector of an authentication/ routing branch.
values This property is required. Sequence[str]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
isRequired This property is required. Boolean
Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
key This property is required. String
Information around the values for selector of an authentication/ routing branch.
values This property is required. List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail

ClientId This property is required. string
Client ID for the OAuth2/OIDC app.
ClientSecretId This property is required. string
The OCID of the Oracle Vault Service secret resource.
ClientSecretVersionNumber This property is required. string
The version number of the client secret to use.
Type This property is required. string
Type of the Response Cache Store Policy.
ClientId This property is required. string
Client ID for the OAuth2/OIDC app.
ClientSecretId This property is required. string
The OCID of the Oracle Vault Service secret resource.
ClientSecretVersionNumber This property is required. string
The version number of the client secret to use.
Type This property is required. string
Type of the Response Cache Store Policy.
clientId This property is required. String
Client ID for the OAuth2/OIDC app.
clientSecretId This property is required. String
The OCID of the Oracle Vault Service secret resource.
clientSecretVersionNumber This property is required. String
The version number of the client secret to use.
type This property is required. String
Type of the Response Cache Store Policy.
clientId This property is required. string
Client ID for the OAuth2/OIDC app.
clientSecretId This property is required. string
The OCID of the Oracle Vault Service secret resource.
clientSecretVersionNumber This property is required. string
The version number of the client secret to use.
type This property is required. string
Type of the Response Cache Store Policy.
client_id This property is required. str
Client ID for the OAuth2/OIDC app.
client_secret_id This property is required. str
The OCID of the Oracle Vault Service secret resource.
client_secret_version_number This property is required. str
The version number of the client secret to use.
type This property is required. str
Type of the Response Cache Store Policy.
clientId This property is required. String
Client ID for the OAuth2/OIDC app.
clientSecretId This property is required. String
The OCID of the Oracle Vault Service secret resource.
clientSecretVersionNumber This property is required. String
The version number of the client secret to use.
type This property is required. String
Type of the Response Cache Store Policy.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey

Alg This property is required. string
The algorithm intended for use with this key.
E This property is required. string
The base64 url encoded exponent of the RSA public key represented by this key.
Format This property is required. string
The format of the public key.
Key This property is required. string
Information around the values for selector of an authentication/ routing branch.
KeyOps This property is required. List<string>
The operations for which this key is to be used.
Kid This property is required. string
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
Kty This property is required. string
The key type.
N This property is required. string
The base64 url encoded modulus of the RSA public key represented by this key.
Use This property is required. string
The intended use of the public key.
Alg This property is required. string
The algorithm intended for use with this key.
E This property is required. string
The base64 url encoded exponent of the RSA public key represented by this key.
Format This property is required. string
The format of the public key.
Key This property is required. string
Information around the values for selector of an authentication/ routing branch.
KeyOps This property is required. []string
The operations for which this key is to be used.
Kid This property is required. string
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
Kty This property is required. string
The key type.
N This property is required. string
The base64 url encoded modulus of the RSA public key represented by this key.
Use This property is required. string
The intended use of the public key.
alg This property is required. String
The algorithm intended for use with this key.
e This property is required. String
The base64 url encoded exponent of the RSA public key represented by this key.
format This property is required. String
The format of the public key.
key This property is required. String
Information around the values for selector of an authentication/ routing branch.
keyOps This property is required. List<String>
The operations for which this key is to be used.
kid This property is required. String
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
kty This property is required. String
The key type.
n This property is required. String
The base64 url encoded modulus of the RSA public key represented by this key.
use This property is required. String
The intended use of the public key.
alg This property is required. string
The algorithm intended for use with this key.
e This property is required. string
The base64 url encoded exponent of the RSA public key represented by this key.
format This property is required. string
The format of the public key.
key This property is required. string
Information around the values for selector of an authentication/ routing branch.
keyOps This property is required. string[]
The operations for which this key is to be used.
kid This property is required. string
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
kty This property is required. string
The key type.
n This property is required. string
The base64 url encoded modulus of the RSA public key represented by this key.
use This property is required. string
The intended use of the public key.
alg This property is required. str
The algorithm intended for use with this key.
e This property is required. str
The base64 url encoded exponent of the RSA public key represented by this key.
format This property is required. str
The format of the public key.
key This property is required. str
Information around the values for selector of an authentication/ routing branch.
key_ops This property is required. Sequence[str]
The operations for which this key is to be used.
kid This property is required. str
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
kty This property is required. str
The key type.
n This property is required. str
The base64 url encoded modulus of the RSA public key represented by this key.
use This property is required. str
The intended use of the public key.
alg This property is required. String
The algorithm intended for use with this key.
e This property is required. String
The base64 url encoded exponent of the RSA public key represented by this key.
format This property is required. String
The format of the public key.
key This property is required. String
Information around the values for selector of an authentication/ routing branch.
keyOps This property is required. List<String>
The operations for which this key is to be used.
kid This property is required. String
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
kty This property is required. String
The key type.
n This property is required. String
The base64 url encoded modulus of the RSA public key represented by this key.
use This property is required. String
The intended use of the public key.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail

Type This property is required. string
Type of the Response Cache Store Policy.
Uri This property is required. string
The uri from which to retrieve the key. It must be accessible without authentication.
Type This property is required. string
Type of the Response Cache Store Policy.
Uri This property is required. string
The uri from which to retrieve the key. It must be accessible without authentication.
type This property is required. String
Type of the Response Cache Store Policy.
uri This property is required. String
The uri from which to retrieve the key. It must be accessible without authentication.
type This property is required. string
Type of the Response Cache Store Policy.
uri This property is required. string
The uri from which to retrieve the key. It must be accessible without authentication.
type This property is required. str
Type of the Response Cache Store Policy.
uri This property is required. str
The uri from which to retrieve the key. It must be accessible without authentication.
type This property is required. String
Type of the Response Cache Store Policy.
uri This property is required. String
The uri from which to retrieve the key. It must be accessible without authentication.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim

IsRequired This property is required. bool
Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
Key This property is required. string
Information around the values for selector of an authentication/ routing branch.
Values This property is required. List<string>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
IsRequired This property is required. bool
Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
Key This property is required. string
Information around the values for selector of an authentication/ routing branch.
Values This property is required. []string
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
isRequired This property is required. Boolean
Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
key This property is required. String
Information around the values for selector of an authentication/ routing branch.
values This property is required. List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
isRequired This property is required. boolean
Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
key This property is required. string
Information around the values for selector of an authentication/ routing branch.
values This property is required. string[]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
is_required This property is required. bool
Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
key This property is required. str
Information around the values for selector of an authentication/ routing branch.
values This property is required. Sequence[str]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
isRequired This property is required. Boolean
Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
key This property is required. String
Information around the values for selector of an authentication/ routing branch.
values This property is required. List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerKey

Expression This property is required. string
String describing the expression with wildcards.
IsDefault This property is required. bool
Information regarding whether this is the default branch.
Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Type This property is required. string
Type of the Response Cache Store Policy.
Values This property is required. List<string>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
Expression This property is required. string
String describing the expression with wildcards.
IsDefault This property is required. bool
Information regarding whether this is the default branch.
Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Type This property is required. string
Type of the Response Cache Store Policy.
Values This property is required. []string
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
expression This property is required. String
String describing the expression with wildcards.
isDefault This property is required. Boolean
Information regarding whether this is the default branch.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
type This property is required. String
Type of the Response Cache Store Policy.
values This property is required. List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
expression This property is required. string
String describing the expression with wildcards.
isDefault This property is required. boolean
Information regarding whether this is the default branch.
name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
type This property is required. string
Type of the Response Cache Store Policy.
values This property is required. string[]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
expression This property is required. str
String describing the expression with wildcards.
is_default This property is required. bool
Information regarding whether this is the default branch.
name This property is required. str
The case-insensitive name of the header. This name must be unique across transformation policies.
type This property is required. str
Type of the Response Cache Store Policy.
values This property is required. Sequence[str]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
expression This property is required. String
String describing the expression with wildcards.
isDefault This property is required. Boolean
Information regarding whether this is the default branch.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
type This property is required. String
Type of the Response Cache Store Policy.
values This property is required. List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationSelectionSource

Selector This property is required. string
String describing the context variable used as selector.
Type This property is required. string
Type of the Response Cache Store Policy.
Selector This property is required. string
String describing the context variable used as selector.
Type This property is required. string
Type of the Response Cache Store Policy.
selector This property is required. String
String describing the context variable used as selector.
type This property is required. String
Type of the Response Cache Store Policy.
selector This property is required. string
String describing the context variable used as selector.
type This property is required. string
Type of the Response Cache Store Policy.
selector This property is required. str
String describing the context variable used as selector.
type This property is required. str
Type of the Response Cache Store Policy.
selector This property is required. String
String describing the context variable used as selector.
type This property is required. String
Type of the Response Cache Store Policy.

GetDeploymentSpecificationRequestPolicyMutualTl

AllowedSans This property is required. List<string>
Allowed list of CN or SAN which will be used for verification of certificate.
IsVerifiedCertificateRequired This property is required. bool
Determines whether to enable client verification when API Consumer makes connection to the gateway.
AllowedSans This property is required. []string
Allowed list of CN or SAN which will be used for verification of certificate.
IsVerifiedCertificateRequired This property is required. bool
Determines whether to enable client verification when API Consumer makes connection to the gateway.
allowedSans This property is required. List<String>
Allowed list of CN or SAN which will be used for verification of certificate.
isVerifiedCertificateRequired This property is required. Boolean
Determines whether to enable client verification when API Consumer makes connection to the gateway.
allowedSans This property is required. string[]
Allowed list of CN or SAN which will be used for verification of certificate.
isVerifiedCertificateRequired This property is required. boolean
Determines whether to enable client verification when API Consumer makes connection to the gateway.
allowed_sans This property is required. Sequence[str]
Allowed list of CN or SAN which will be used for verification of certificate.
is_verified_certificate_required This property is required. bool
Determines whether to enable client verification when API Consumer makes connection to the gateway.
allowedSans This property is required. List<String>
Allowed list of CN or SAN which will be used for verification of certificate.
isVerifiedCertificateRequired This property is required. Boolean
Determines whether to enable client verification when API Consumer makes connection to the gateway.

GetDeploymentSpecificationRequestPolicyRateLimiting

RateInRequestsPerSecond This property is required. int
The maximum number of requests per second to allow.
RateKey This property is required. string
The key used to group requests together.
RateInRequestsPerSecond This property is required. int
The maximum number of requests per second to allow.
RateKey This property is required. string
The key used to group requests together.
rateInRequestsPerSecond This property is required. Integer
The maximum number of requests per second to allow.
rateKey This property is required. String
The key used to group requests together.
rateInRequestsPerSecond This property is required. number
The maximum number of requests per second to allow.
rateKey This property is required. string
The key used to group requests together.
rate_in_requests_per_second This property is required. int
The maximum number of requests per second to allow.
rate_key This property is required. str
The key used to group requests together.
rateInRequestsPerSecond This property is required. Number
The maximum number of requests per second to allow.
rateKey This property is required. String
The key used to group requests together.

GetDeploymentSpecificationRequestPolicyUsagePlan

TokenLocations This property is required. List<string>
A list of context variables specifying where API tokens may be located in a request. Example locations:

  • "request.headers[token]"
  • "request.query[token]"
  • "request.auth[Token]"
  • "request.path[TOKEN]"
TokenLocations This property is required. []string
A list of context variables specifying where API tokens may be located in a request. Example locations:

  • "request.headers[token]"
  • "request.query[token]"
  • "request.auth[Token]"
  • "request.path[TOKEN]"
tokenLocations This property is required. List<String>
A list of context variables specifying where API tokens may be located in a request. Example locations:

  • "request.headers[token]"
  • "request.query[token]"
  • "request.auth[Token]"
  • "request.path[TOKEN]"
tokenLocations This property is required. string[]
A list of context variables specifying where API tokens may be located in a request. Example locations:

  • "request.headers[token]"
  • "request.query[token]"
  • "request.auth[Token]"
  • "request.path[TOKEN]"
token_locations This property is required. Sequence[str]
A list of context variables specifying where API tokens may be located in a request. Example locations:

  • "request.headers[token]"
  • "request.query[token]"
  • "request.auth[Token]"
  • "request.path[TOKEN]"
tokenLocations This property is required. List<String>
A list of context variables specifying where API tokens may be located in a request. Example locations:

  • "request.headers[token]"
  • "request.query[token]"
  • "request.auth[Token]"
  • "request.path[TOKEN]"

GetDeploymentSpecificationRoute

Backends This property is required. List<GetDeploymentSpecificationRouteBackend>
The backend to forward requests to.
LoggingPolicies This property is required. List<GetDeploymentSpecificationRouteLoggingPolicy>
Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
Methods This property is required. List<string>
A list of allowed methods on this route.
Path This property is required. string
A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers to allow wildcard and parameterized matching.
RequestPolicies This property is required. List<GetDeploymentSpecificationRouteRequestPolicy>
Behavior applied to any requests received by the API on this route.
ResponsePolicies This property is required. List<GetDeploymentSpecificationRouteResponsePolicy>
Behavior applied to any responses sent by the API for requests on this route.
Backends This property is required. []GetDeploymentSpecificationRouteBackend
The backend to forward requests to.
LoggingPolicies This property is required. []GetDeploymentSpecificationRouteLoggingPolicy
Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
Methods This property is required. []string
A list of allowed methods on this route.
Path This property is required. string
A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers to allow wildcard and parameterized matching.
RequestPolicies This property is required. []GetDeploymentSpecificationRouteRequestPolicy
Behavior applied to any requests received by the API on this route.
ResponsePolicies This property is required. []GetDeploymentSpecificationRouteResponsePolicy
Behavior applied to any responses sent by the API for requests on this route.
backends This property is required. List<GetDeploymentSpecificationRouteBackend>
The backend to forward requests to.
loggingPolicies This property is required. List<GetDeploymentSpecificationRouteLoggingPolicy>
Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
methods This property is required. List<String>
A list of allowed methods on this route.
path This property is required. String
A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers to allow wildcard and parameterized matching.
requestPolicies This property is required. List<GetDeploymentSpecificationRouteRequestPolicy>
Behavior applied to any requests received by the API on this route.
responsePolicies This property is required. List<GetDeploymentSpecificationRouteResponsePolicy>
Behavior applied to any responses sent by the API for requests on this route.
backends This property is required. GetDeploymentSpecificationRouteBackend[]
The backend to forward requests to.
loggingPolicies This property is required. GetDeploymentSpecificationRouteLoggingPolicy[]
Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
methods This property is required. string[]
A list of allowed methods on this route.
path This property is required. string
A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers to allow wildcard and parameterized matching.
requestPolicies This property is required. GetDeploymentSpecificationRouteRequestPolicy[]
Behavior applied to any requests received by the API on this route.
responsePolicies This property is required. GetDeploymentSpecificationRouteResponsePolicy[]
Behavior applied to any responses sent by the API for requests on this route.
backends This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteBackend]
The backend to forward requests to.
logging_policies This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteLoggingPolicy]
Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
methods This property is required. Sequence[str]
A list of allowed methods on this route.
path This property is required. str
A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers to allow wildcard and parameterized matching.
request_policies This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteRequestPolicy]
Behavior applied to any requests received by the API on this route.
response_policies This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteResponsePolicy]
Behavior applied to any responses sent by the API for requests on this route.
backends This property is required. List<Property Map>
The backend to forward requests to.
loggingPolicies This property is required. List<Property Map>
Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
methods This property is required. List<String>
A list of allowed methods on this route.
path This property is required. String
A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers to allow wildcard and parameterized matching.
requestPolicies This property is required. List<Property Map>
Behavior applied to any requests received by the API on this route.
responsePolicies This property is required. List<Property Map>
Behavior applied to any responses sent by the API for requests on this route.

GetDeploymentSpecificationRouteBackend

AllowedPostLogoutUris This property is required. List<string>
Body This property is required. string
The body of the stock response from the mock backend.
ConnectTimeoutInSeconds This property is required. double
Defines a timeout for establishing a connection with a proxied server.
FunctionId This property is required. string
The OCID of the Oracle Functions function resource.
Headers This property is required. List<GetDeploymentSpecificationRouteBackendHeader>
IsSslVerifyDisabled This property is required. bool
Defines whether or not to uphold SSL verification.
PostLogoutState This property is required. string
Defines a state that should be shared on redirecting to postLogout URL.
ReadTimeoutInSeconds This property is required. double
Defines a timeout for reading a response from the proxied server.
RoutingBackends This property is required. List<GetDeploymentSpecificationRouteBackendRoutingBackend>
List of backends to chose from for Dynamic Routing.
SelectionSources This property is required. List<GetDeploymentSpecificationRouteBackendSelectionSource>
Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.
SendTimeoutInSeconds This property is required. double
Defines a timeout for transmitting a request to the proxied server.
Status This property is required. int
The status code of the stock response from the mock backend.
Type This property is required. string
Type of the Response Cache Store Policy.
Url This property is required. string
AllowedPostLogoutUris This property is required. []string
Body This property is required. string
The body of the stock response from the mock backend.
ConnectTimeoutInSeconds This property is required. float64
Defines a timeout for establishing a connection with a proxied server.
FunctionId This property is required. string
The OCID of the Oracle Functions function resource.
Headers This property is required. []GetDeploymentSpecificationRouteBackendHeader
IsSslVerifyDisabled This property is required. bool
Defines whether or not to uphold SSL verification.
PostLogoutState This property is required. string
Defines a state that should be shared on redirecting to postLogout URL.
ReadTimeoutInSeconds This property is required. float64
Defines a timeout for reading a response from the proxied server.
RoutingBackends This property is required. []GetDeploymentSpecificationRouteBackendRoutingBackend
List of backends to chose from for Dynamic Routing.
SelectionSources This property is required. []GetDeploymentSpecificationRouteBackendSelectionSource
Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.
SendTimeoutInSeconds This property is required. float64
Defines a timeout for transmitting a request to the proxied server.
Status This property is required. int
The status code of the stock response from the mock backend.
Type This property is required. string
Type of the Response Cache Store Policy.
Url This property is required. string
allowedPostLogoutUris This property is required. List<String>
body This property is required. String
The body of the stock response from the mock backend.
connectTimeoutInSeconds This property is required. Double
Defines a timeout for establishing a connection with a proxied server.
functionId This property is required. String
The OCID of the Oracle Functions function resource.
headers This property is required. List<GetDeploymentSpecificationRouteBackendHeader>
isSslVerifyDisabled This property is required. Boolean
Defines whether or not to uphold SSL verification.
postLogoutState This property is required. String
Defines a state that should be shared on redirecting to postLogout URL.
readTimeoutInSeconds This property is required. Double
Defines a timeout for reading a response from the proxied server.
routingBackends This property is required. List<GetDeploymentSpecificationRouteBackendRoutingBackend>
List of backends to chose from for Dynamic Routing.
selectionSources This property is required. List<GetDeploymentSpecificationRouteBackendSelectionSource>
Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.
sendTimeoutInSeconds This property is required. Double
Defines a timeout for transmitting a request to the proxied server.
status This property is required. Integer
The status code of the stock response from the mock backend.
type This property is required. String
Type of the Response Cache Store Policy.
url This property is required. String
allowedPostLogoutUris This property is required. string[]
body This property is required. string
The body of the stock response from the mock backend.
connectTimeoutInSeconds This property is required. number
Defines a timeout for establishing a connection with a proxied server.
functionId This property is required. string
The OCID of the Oracle Functions function resource.
headers This property is required. GetDeploymentSpecificationRouteBackendHeader[]
isSslVerifyDisabled This property is required. boolean
Defines whether or not to uphold SSL verification.
postLogoutState This property is required. string
Defines a state that should be shared on redirecting to postLogout URL.
readTimeoutInSeconds This property is required. number
Defines a timeout for reading a response from the proxied server.
routingBackends This property is required. GetDeploymentSpecificationRouteBackendRoutingBackend[]
List of backends to chose from for Dynamic Routing.
selectionSources This property is required. GetDeploymentSpecificationRouteBackendSelectionSource[]
Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.
sendTimeoutInSeconds This property is required. number
Defines a timeout for transmitting a request to the proxied server.
status This property is required. number
The status code of the stock response from the mock backend.
type This property is required. string
Type of the Response Cache Store Policy.
url This property is required. string
allowed_post_logout_uris This property is required. Sequence[str]
body This property is required. str
The body of the stock response from the mock backend.
connect_timeout_in_seconds This property is required. float
Defines a timeout for establishing a connection with a proxied server.
function_id This property is required. str
The OCID of the Oracle Functions function resource.
headers This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteBackendHeader]
is_ssl_verify_disabled This property is required. bool
Defines whether or not to uphold SSL verification.
post_logout_state This property is required. str
Defines a state that should be shared on redirecting to postLogout URL.
read_timeout_in_seconds This property is required. float
Defines a timeout for reading a response from the proxied server.
routing_backends This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteBackendRoutingBackend]
List of backends to chose from for Dynamic Routing.
selection_sources This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteBackendSelectionSource]
Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.
send_timeout_in_seconds This property is required. float
Defines a timeout for transmitting a request to the proxied server.
status This property is required. int
The status code of the stock response from the mock backend.
type This property is required. str
Type of the Response Cache Store Policy.
url This property is required. str
allowedPostLogoutUris This property is required. List<String>
body This property is required. String
The body of the stock response from the mock backend.
connectTimeoutInSeconds This property is required. Number
Defines a timeout for establishing a connection with a proxied server.
functionId This property is required. String
The OCID of the Oracle Functions function resource.
headers This property is required. List<Property Map>
isSslVerifyDisabled This property is required. Boolean
Defines whether or not to uphold SSL verification.
postLogoutState This property is required. String
Defines a state that should be shared on redirecting to postLogout URL.
readTimeoutInSeconds This property is required. Number
Defines a timeout for reading a response from the proxied server.
routingBackends This property is required. List<Property Map>
List of backends to chose from for Dynamic Routing.
selectionSources This property is required. List<Property Map>
Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.
sendTimeoutInSeconds This property is required. Number
Defines a timeout for transmitting a request to the proxied server.
status This property is required. Number
The status code of the stock response from the mock backend.
type This property is required. String
Type of the Response Cache Store Policy.
url This property is required. String

GetDeploymentSpecificationRouteBackendHeader

Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Value This property is required. string
Value of the header.
Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Value This property is required. string
Value of the header.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
value This property is required. String
Value of the header.
name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
value This property is required. string
Value of the header.
name This property is required. str
The case-insensitive name of the header. This name must be unique across transformation policies.
value This property is required. str
Value of the header.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
value This property is required. String
Value of the header.

GetDeploymentSpecificationRouteBackendRoutingBackend

Backends This property is required. List<GetDeploymentSpecificationRouteBackendRoutingBackendBackend>
The backend to forward requests to.
Keys This property is required. List<GetDeploymentSpecificationRouteBackendRoutingBackendKey>
Information around the values for selector of an authentication/ routing branch.
Backends This property is required. []GetDeploymentSpecificationRouteBackendRoutingBackendBackend
The backend to forward requests to.
Keys This property is required. []GetDeploymentSpecificationRouteBackendRoutingBackendKey
Information around the values for selector of an authentication/ routing branch.
backends This property is required. List<GetDeploymentSpecificationRouteBackendRoutingBackendBackend>
The backend to forward requests to.
keys This property is required. List<GetDeploymentSpecificationRouteBackendRoutingBackendKey>
Information around the values for selector of an authentication/ routing branch.
backends This property is required. GetDeploymentSpecificationRouteBackendRoutingBackendBackend[]
The backend to forward requests to.
keys This property is required. GetDeploymentSpecificationRouteBackendRoutingBackendKey[]
Information around the values for selector of an authentication/ routing branch.
backends This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteBackendRoutingBackendBackend]
The backend to forward requests to.
keys This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteBackendRoutingBackendKey]
Information around the values for selector of an authentication/ routing branch.
backends This property is required. List<Property Map>
The backend to forward requests to.
keys This property is required. List<Property Map>
Information around the values for selector of an authentication/ routing branch.

GetDeploymentSpecificationRouteBackendRoutingBackendBackend

Body This property is required. string
The body of the stock response from the mock backend.
ConnectTimeoutInSeconds This property is required. double
Defines a timeout for establishing a connection with a proxied server.
FunctionId This property is required. string
The OCID of the Oracle Functions function resource.
Headers This property is required. List<GetDeploymentSpecificationRouteBackendRoutingBackendBackendHeader>
IsSslVerifyDisabled This property is required. bool
Defines whether or not to uphold SSL verification.
ReadTimeoutInSeconds This property is required. double
Defines a timeout for reading a response from the proxied server.
SendTimeoutInSeconds This property is required. double
Defines a timeout for transmitting a request to the proxied server.
Status This property is required. int
The status code of the stock response from the mock backend.
Type This property is required. string
Type of the Response Cache Store Policy.
Url This property is required. string
Body This property is required. string
The body of the stock response from the mock backend.
ConnectTimeoutInSeconds This property is required. float64
Defines a timeout for establishing a connection with a proxied server.
FunctionId This property is required. string
The OCID of the Oracle Functions function resource.
Headers This property is required. []GetDeploymentSpecificationRouteBackendRoutingBackendBackendHeader
IsSslVerifyDisabled This property is required. bool
Defines whether or not to uphold SSL verification.
ReadTimeoutInSeconds This property is required. float64
Defines a timeout for reading a response from the proxied server.
SendTimeoutInSeconds This property is required. float64
Defines a timeout for transmitting a request to the proxied server.
Status This property is required. int
The status code of the stock response from the mock backend.
Type This property is required. string
Type of the Response Cache Store Policy.
Url This property is required. string
body This property is required. String
The body of the stock response from the mock backend.
connectTimeoutInSeconds This property is required. Double
Defines a timeout for establishing a connection with a proxied server.
functionId This property is required. String
The OCID of the Oracle Functions function resource.
headers This property is required. List<GetDeploymentSpecificationRouteBackendRoutingBackendBackendHeader>
isSslVerifyDisabled This property is required. Boolean
Defines whether or not to uphold SSL verification.
readTimeoutInSeconds This property is required. Double
Defines a timeout for reading a response from the proxied server.
sendTimeoutInSeconds This property is required. Double
Defines a timeout for transmitting a request to the proxied server.
status This property is required. Integer
The status code of the stock response from the mock backend.
type This property is required. String
Type of the Response Cache Store Policy.
url This property is required. String
body This property is required. string
The body of the stock response from the mock backend.
connectTimeoutInSeconds This property is required. number
Defines a timeout for establishing a connection with a proxied server.
functionId This property is required. string
The OCID of the Oracle Functions function resource.
headers This property is required. GetDeploymentSpecificationRouteBackendRoutingBackendBackendHeader[]
isSslVerifyDisabled This property is required. boolean
Defines whether or not to uphold SSL verification.
readTimeoutInSeconds This property is required. number
Defines a timeout for reading a response from the proxied server.
sendTimeoutInSeconds This property is required. number
Defines a timeout for transmitting a request to the proxied server.
status This property is required. number
The status code of the stock response from the mock backend.
type This property is required. string
Type of the Response Cache Store Policy.
url This property is required. string
body This property is required. str
The body of the stock response from the mock backend.
connect_timeout_in_seconds This property is required. float
Defines a timeout for establishing a connection with a proxied server.
function_id This property is required. str
The OCID of the Oracle Functions function resource.
headers This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteBackendRoutingBackendBackendHeader]
is_ssl_verify_disabled This property is required. bool
Defines whether or not to uphold SSL verification.
read_timeout_in_seconds This property is required. float
Defines a timeout for reading a response from the proxied server.
send_timeout_in_seconds This property is required. float
Defines a timeout for transmitting a request to the proxied server.
status This property is required. int
The status code of the stock response from the mock backend.
type This property is required. str
Type of the Response Cache Store Policy.
url This property is required. str
body This property is required. String
The body of the stock response from the mock backend.
connectTimeoutInSeconds This property is required. Number
Defines a timeout for establishing a connection with a proxied server.
functionId This property is required. String
The OCID of the Oracle Functions function resource.
headers This property is required. List<Property Map>
isSslVerifyDisabled This property is required. Boolean
Defines whether or not to uphold SSL verification.
readTimeoutInSeconds This property is required. Number
Defines a timeout for reading a response from the proxied server.
sendTimeoutInSeconds This property is required. Number
Defines a timeout for transmitting a request to the proxied server.
status This property is required. Number
The status code of the stock response from the mock backend.
type This property is required. String
Type of the Response Cache Store Policy.
url This property is required. String

GetDeploymentSpecificationRouteBackendRoutingBackendBackendHeader

Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Value This property is required. string
Value of the header.
Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Value This property is required. string
Value of the header.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
value This property is required. String
Value of the header.
name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
value This property is required. string
Value of the header.
name This property is required. str
The case-insensitive name of the header. This name must be unique across transformation policies.
value This property is required. str
Value of the header.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
value This property is required. String
Value of the header.

GetDeploymentSpecificationRouteBackendRoutingBackendKey

Expression This property is required. string
String describing the expression with wildcards.
IsDefault This property is required. bool
Information regarding whether this is the default branch.
Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Type This property is required. string
Type of the Response Cache Store Policy.
Values This property is required. List<string>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
Expression This property is required. string
String describing the expression with wildcards.
IsDefault This property is required. bool
Information regarding whether this is the default branch.
Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Type This property is required. string
Type of the Response Cache Store Policy.
Values This property is required. []string
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
expression This property is required. String
String describing the expression with wildcards.
isDefault This property is required. Boolean
Information regarding whether this is the default branch.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
type This property is required. String
Type of the Response Cache Store Policy.
values This property is required. List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
expression This property is required. string
String describing the expression with wildcards.
isDefault This property is required. boolean
Information regarding whether this is the default branch.
name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
type This property is required. string
Type of the Response Cache Store Policy.
values This property is required. string[]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
expression This property is required. str
String describing the expression with wildcards.
is_default This property is required. bool
Information regarding whether this is the default branch.
name This property is required. str
The case-insensitive name of the header. This name must be unique across transformation policies.
type This property is required. str
Type of the Response Cache Store Policy.
values This property is required. Sequence[str]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
expression This property is required. String
String describing the expression with wildcards.
isDefault This property is required. Boolean
Information regarding whether this is the default branch.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
type This property is required. String
Type of the Response Cache Store Policy.
values This property is required. List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

GetDeploymentSpecificationRouteBackendSelectionSource

Selector This property is required. string
String describing the context variable used as selector.
Type This property is required. string
Type of the Response Cache Store Policy.
Selector This property is required. string
String describing the context variable used as selector.
Type This property is required. string
Type of the Response Cache Store Policy.
selector This property is required. String
String describing the context variable used as selector.
type This property is required. String
Type of the Response Cache Store Policy.
selector This property is required. string
String describing the context variable used as selector.
type This property is required. string
Type of the Response Cache Store Policy.
selector This property is required. str
String describing the context variable used as selector.
type This property is required. str
Type of the Response Cache Store Policy.
selector This property is required. String
String describing the context variable used as selector.
type This property is required. String
Type of the Response Cache Store Policy.

GetDeploymentSpecificationRouteLoggingPolicy

AccessLogs This property is required. List<GetDeploymentSpecificationRouteLoggingPolicyAccessLog>
Configures the logging policies for the access logs of an API Deployment.
ExecutionLogs This property is required. List<GetDeploymentSpecificationRouteLoggingPolicyExecutionLog>
Configures the logging policies for the execution logs of an API Deployment.
AccessLogs This property is required. []GetDeploymentSpecificationRouteLoggingPolicyAccessLog
Configures the logging policies for the access logs of an API Deployment.
ExecutionLogs This property is required. []GetDeploymentSpecificationRouteLoggingPolicyExecutionLog
Configures the logging policies for the execution logs of an API Deployment.
accessLogs This property is required. List<GetDeploymentSpecificationRouteLoggingPolicyAccessLog>
Configures the logging policies for the access logs of an API Deployment.
executionLogs This property is required. List<GetDeploymentSpecificationRouteLoggingPolicyExecutionLog>
Configures the logging policies for the execution logs of an API Deployment.
accessLogs This property is required. GetDeploymentSpecificationRouteLoggingPolicyAccessLog[]
Configures the logging policies for the access logs of an API Deployment.
executionLogs This property is required. GetDeploymentSpecificationRouteLoggingPolicyExecutionLog[]
Configures the logging policies for the execution logs of an API Deployment.
access_logs This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteLoggingPolicyAccessLog]
Configures the logging policies for the access logs of an API Deployment.
execution_logs This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteLoggingPolicyExecutionLog]
Configures the logging policies for the execution logs of an API Deployment.
accessLogs This property is required. List<Property Map>
Configures the logging policies for the access logs of an API Deployment.
executionLogs This property is required. List<Property Map>
Configures the logging policies for the execution logs of an API Deployment.

GetDeploymentSpecificationRouteLoggingPolicyAccessLog

IsEnabled This property is required. bool
Whether this policy is currently enabled.
IsEnabled This property is required. bool
Whether this policy is currently enabled.
isEnabled This property is required. Boolean
Whether this policy is currently enabled.
isEnabled This property is required. boolean
Whether this policy is currently enabled.
is_enabled This property is required. bool
Whether this policy is currently enabled.
isEnabled This property is required. Boolean
Whether this policy is currently enabled.

GetDeploymentSpecificationRouteLoggingPolicyExecutionLog

IsEnabled This property is required. bool
Whether this policy is currently enabled.
LogLevel This property is required. string
Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.
IsEnabled This property is required. bool
Whether this policy is currently enabled.
LogLevel This property is required. string
Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.
isEnabled This property is required. Boolean
Whether this policy is currently enabled.
logLevel This property is required. String
Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.
isEnabled This property is required. boolean
Whether this policy is currently enabled.
logLevel This property is required. string
Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.
is_enabled This property is required. bool
Whether this policy is currently enabled.
log_level This property is required. str
Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.
isEnabled This property is required. Boolean
Whether this policy is currently enabled.
logLevel This property is required. String
Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.

GetDeploymentSpecificationRouteRequestPolicy

Authorizations This property is required. List<GetDeploymentSpecificationRouteRequestPolicyAuthorization>
If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.
BodyValidations This property is required. List<GetDeploymentSpecificationRouteRequestPolicyBodyValidation>
Validate the payload body of the incoming API requests on a specific route.
Cors This property is required. List<GetDeploymentSpecificationRouteRequestPolicyCor>
Enable CORS (Cross-Origin-Resource-Sharing) request handling.
HeaderTransformations This property is required. List<GetDeploymentSpecificationRouteRequestPolicyHeaderTransformation>
A set of transformations to apply to HTTP headers that pass through the gateway.
HeaderValidations This property is required. List<GetDeploymentSpecificationRouteRequestPolicyHeaderValidation>
Validate the HTTP headers on the incoming API requests on a specific route.
QueryParameterTransformations This property is required. List<GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation>
A set of transformations to apply to query parameters that pass through the gateway.
QueryParameterValidations This property is required. List<GetDeploymentSpecificationRouteRequestPolicyQueryParameterValidation>
Validate the URL query parameters on the incoming API requests on a specific route.
ResponseCacheLookups This property is required. List<GetDeploymentSpecificationRouteRequestPolicyResponseCacheLookup>
Base policy for Response Cache lookup.
Authorizations This property is required. []GetDeploymentSpecificationRouteRequestPolicyAuthorization
If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.
BodyValidations This property is required. []GetDeploymentSpecificationRouteRequestPolicyBodyValidation
Validate the payload body of the incoming API requests on a specific route.
Cors This property is required. []GetDeploymentSpecificationRouteRequestPolicyCor
Enable CORS (Cross-Origin-Resource-Sharing) request handling.
HeaderTransformations This property is required. []GetDeploymentSpecificationRouteRequestPolicyHeaderTransformation
A set of transformations to apply to HTTP headers that pass through the gateway.
HeaderValidations This property is required. []GetDeploymentSpecificationRouteRequestPolicyHeaderValidation
Validate the HTTP headers on the incoming API requests on a specific route.
QueryParameterTransformations This property is required. []GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation
A set of transformations to apply to query parameters that pass through the gateway.
QueryParameterValidations This property is required. []GetDeploymentSpecificationRouteRequestPolicyQueryParameterValidation
Validate the URL query parameters on the incoming API requests on a specific route.
ResponseCacheLookups This property is required. []GetDeploymentSpecificationRouteRequestPolicyResponseCacheLookup
Base policy for Response Cache lookup.
authorizations This property is required. List<GetDeploymentSpecificationRouteRequestPolicyAuthorization>
If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.
bodyValidations This property is required. List<GetDeploymentSpecificationRouteRequestPolicyBodyValidation>
Validate the payload body of the incoming API requests on a specific route.
cors This property is required. List<GetDeploymentSpecificationRouteRequestPolicyCor>
Enable CORS (Cross-Origin-Resource-Sharing) request handling.
headerTransformations This property is required. List<GetDeploymentSpecificationRouteRequestPolicyHeaderTransformation>
A set of transformations to apply to HTTP headers that pass through the gateway.
headerValidations This property is required. List<GetDeploymentSpecificationRouteRequestPolicyHeaderValidation>
Validate the HTTP headers on the incoming API requests on a specific route.
queryParameterTransformations This property is required. List<GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation>
A set of transformations to apply to query parameters that pass through the gateway.
queryParameterValidations This property is required. List<GetDeploymentSpecificationRouteRequestPolicyQueryParameterValidation>
Validate the URL query parameters on the incoming API requests on a specific route.
responseCacheLookups This property is required. List<GetDeploymentSpecificationRouteRequestPolicyResponseCacheLookup>
Base policy for Response Cache lookup.
authorizations This property is required. GetDeploymentSpecificationRouteRequestPolicyAuthorization[]
If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.
bodyValidations This property is required. GetDeploymentSpecificationRouteRequestPolicyBodyValidation[]
Validate the payload body of the incoming API requests on a specific route.
cors This property is required. GetDeploymentSpecificationRouteRequestPolicyCor[]
Enable CORS (Cross-Origin-Resource-Sharing) request handling.
headerTransformations This property is required. GetDeploymentSpecificationRouteRequestPolicyHeaderTransformation[]
A set of transformations to apply to HTTP headers that pass through the gateway.
headerValidations This property is required. GetDeploymentSpecificationRouteRequestPolicyHeaderValidation[]
Validate the HTTP headers on the incoming API requests on a specific route.
queryParameterTransformations This property is required. GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation[]
A set of transformations to apply to query parameters that pass through the gateway.
queryParameterValidations This property is required. GetDeploymentSpecificationRouteRequestPolicyQueryParameterValidation[]
Validate the URL query parameters on the incoming API requests on a specific route.
responseCacheLookups This property is required. GetDeploymentSpecificationRouteRequestPolicyResponseCacheLookup[]
Base policy for Response Cache lookup.
authorizations This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteRequestPolicyAuthorization]
If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.
body_validations This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteRequestPolicyBodyValidation]
Validate the payload body of the incoming API requests on a specific route.
cors This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteRequestPolicyCor]
Enable CORS (Cross-Origin-Resource-Sharing) request handling.
header_transformations This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteRequestPolicyHeaderTransformation]
A set of transformations to apply to HTTP headers that pass through the gateway.
header_validations This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteRequestPolicyHeaderValidation]
Validate the HTTP headers on the incoming API requests on a specific route.
query_parameter_transformations This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation]
A set of transformations to apply to query parameters that pass through the gateway.
query_parameter_validations This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteRequestPolicyQueryParameterValidation]
Validate the URL query parameters on the incoming API requests on a specific route.
response_cache_lookups This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteRequestPolicyResponseCacheLookup]
Base policy for Response Cache lookup.
authorizations This property is required. List<Property Map>
If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.
bodyValidations This property is required. List<Property Map>
Validate the payload body of the incoming API requests on a specific route.
cors This property is required. List<Property Map>
Enable CORS (Cross-Origin-Resource-Sharing) request handling.
headerTransformations This property is required. List<Property Map>
A set of transformations to apply to HTTP headers that pass through the gateway.
headerValidations This property is required. List<Property Map>
Validate the HTTP headers on the incoming API requests on a specific route.
queryParameterTransformations This property is required. List<Property Map>
A set of transformations to apply to query parameters that pass through the gateway.
queryParameterValidations This property is required. List<Property Map>
Validate the URL query parameters on the incoming API requests on a specific route.
responseCacheLookups This property is required. List<Property Map>
Base policy for Response Cache lookup.

GetDeploymentSpecificationRouteRequestPolicyAuthorization

AllowedScopes This property is required. List<string>
A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.
Type This property is required. string
Type of the Response Cache Store Policy.
AllowedScopes This property is required. []string
A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.
Type This property is required. string
Type of the Response Cache Store Policy.
allowedScopes This property is required. List<String>
A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.
type This property is required. String
Type of the Response Cache Store Policy.
allowedScopes This property is required. string[]
A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.
type This property is required. string
Type of the Response Cache Store Policy.
allowed_scopes This property is required. Sequence[str]
A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.
type This property is required. str
Type of the Response Cache Store Policy.
allowedScopes This property is required. List<String>
A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.
type This property is required. String
Type of the Response Cache Store Policy.

GetDeploymentSpecificationRouteRequestPolicyBodyValidation

Contents This property is required. List<GetDeploymentSpecificationRouteRequestPolicyBodyValidationContent>
The content of the request body.
Required This property is required. bool
Determines if the parameter is required in the request.
ValidationMode This property is required. string
Validation behavior mode.
Contents This property is required. []GetDeploymentSpecificationRouteRequestPolicyBodyValidationContent
The content of the request body.
Required This property is required. bool
Determines if the parameter is required in the request.
ValidationMode This property is required. string
Validation behavior mode.
contents This property is required. List<GetDeploymentSpecificationRouteRequestPolicyBodyValidationContent>
The content of the request body.
required This property is required. Boolean
Determines if the parameter is required in the request.
validationMode This property is required. String
Validation behavior mode.
contents This property is required. GetDeploymentSpecificationRouteRequestPolicyBodyValidationContent[]
The content of the request body.
required This property is required. boolean
Determines if the parameter is required in the request.
validationMode This property is required. string
Validation behavior mode.
contents This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteRequestPolicyBodyValidationContent]
The content of the request body.
required This property is required. bool
Determines if the parameter is required in the request.
validation_mode This property is required. str
Validation behavior mode.
contents This property is required. List<Property Map>
The content of the request body.
required This property is required. Boolean
Determines if the parameter is required in the request.
validationMode This property is required. String
Validation behavior mode.

GetDeploymentSpecificationRouteRequestPolicyBodyValidationContent

MediaType This property is required. string
The media type is a media type range subset restricted to the following schema
ValidationType This property is required. string
Validation type defines the content validation method.
MediaType This property is required. string
The media type is a media type range subset restricted to the following schema
ValidationType This property is required. string
Validation type defines the content validation method.
mediaType This property is required. String
The media type is a media type range subset restricted to the following schema
validationType This property is required. String
Validation type defines the content validation method.
mediaType This property is required. string
The media type is a media type range subset restricted to the following schema
validationType This property is required. string
Validation type defines the content validation method.
media_type This property is required. str
The media type is a media type range subset restricted to the following schema
validation_type This property is required. str
Validation type defines the content validation method.
mediaType This property is required. String
The media type is a media type range subset restricted to the following schema
validationType This property is required. String
Validation type defines the content validation method.

GetDeploymentSpecificationRouteRequestPolicyCor

AllowedHeaders This property is required. List<string>
The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
AllowedMethods This property is required. List<string>
The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
AllowedOrigins This property is required. List<string>
The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
ExposedHeaders This property is required. List<string>
The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
IsAllowCredentialsEnabled This property is required. bool
Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
MaxAgeInSeconds This property is required. int
The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
AllowedHeaders This property is required. []string
The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
AllowedMethods This property is required. []string
The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
AllowedOrigins This property is required. []string
The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
ExposedHeaders This property is required. []string
The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
IsAllowCredentialsEnabled This property is required. bool
Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
MaxAgeInSeconds This property is required. int
The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
allowedHeaders This property is required. List<String>
The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
allowedMethods This property is required. List<String>
The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
allowedOrigins This property is required. List<String>
The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
exposedHeaders This property is required. List<String>
The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
isAllowCredentialsEnabled This property is required. Boolean
Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
maxAgeInSeconds This property is required. Integer
The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
allowedHeaders This property is required. string[]
The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
allowedMethods This property is required. string[]
The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
allowedOrigins This property is required. string[]
The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
exposedHeaders This property is required. string[]
The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
isAllowCredentialsEnabled This property is required. boolean
Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
maxAgeInSeconds This property is required. number
The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
allowed_headers This property is required. Sequence[str]
The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
allowed_methods This property is required. Sequence[str]
The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
allowed_origins This property is required. Sequence[str]
The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
exposed_headers This property is required. Sequence[str]
The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
is_allow_credentials_enabled This property is required. bool
Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
max_age_in_seconds This property is required. int
The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
allowedHeaders This property is required. List<String>
The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
allowedMethods This property is required. List<String>
The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
allowedOrigins This property is required. List<String>
The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
exposedHeaders This property is required. List<String>
The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
isAllowCredentialsEnabled This property is required. Boolean
Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
maxAgeInSeconds This property is required. Number
The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.

GetDeploymentSpecificationRouteRequestPolicyHeaderTransformation

FilterHeaders This property is required. List<GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader>
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
RenameHeaders This property is required. List<GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader>
Rename HTTP headers as they pass through the gateway.
SetHeaders This property is required. List<GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader>
Set HTTP headers as they pass through the gateway.
FilterHeaders This property is required. []GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
RenameHeaders This property is required. []GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader
Rename HTTP headers as they pass through the gateway.
SetHeaders This property is required. []GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader
Set HTTP headers as they pass through the gateway.
filterHeaders This property is required. List<GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader>
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
renameHeaders This property is required. List<GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader>
Rename HTTP headers as they pass through the gateway.
setHeaders This property is required. List<GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader>
Set HTTP headers as they pass through the gateway.
filterHeaders This property is required. GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader[]
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
renameHeaders This property is required. GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader[]
Rename HTTP headers as they pass through the gateway.
setHeaders This property is required. GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader[]
Set HTTP headers as they pass through the gateway.
filter_headers This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader]
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
rename_headers This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader]
Rename HTTP headers as they pass through the gateway.
set_headers This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader]
Set HTTP headers as they pass through the gateway.
filterHeaders This property is required. List<Property Map>
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
renameHeaders This property is required. List<Property Map>
Rename HTTP headers as they pass through the gateway.
setHeaders This property is required. List<Property Map>
Set HTTP headers as they pass through the gateway.

GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader

Items This property is required. List<GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem>
The list of headers.
Type This property is required. string
Type of the Response Cache Store Policy.
Items This property is required. []GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem
The list of headers.
Type This property is required. string
Type of the Response Cache Store Policy.
items This property is required. List<GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem>
The list of headers.
type This property is required. String
Type of the Response Cache Store Policy.
items This property is required. GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem[]
The list of headers.
type This property is required. string
Type of the Response Cache Store Policy.
items This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem]
The list of headers.
type This property is required. str
Type of the Response Cache Store Policy.
items This property is required. List<Property Map>
The list of headers.
type This property is required. String
Type of the Response Cache Store Policy.

GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem

Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
name This property is required. str
The case-insensitive name of the header. This name must be unique across transformation policies.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.

GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader

items This property is required. List<Property Map>
The list of headers.

GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeaderItem

From This property is required. string
The original case-insensitive name of the header. This name must be unique across transformation policies.
To This property is required. string
The new name of the header. This name must be unique across transformation policies.
From This property is required. string
The original case-insensitive name of the header. This name must be unique across transformation policies.
To This property is required. string
The new name of the header. This name must be unique across transformation policies.
from This property is required. String
The original case-insensitive name of the header. This name must be unique across transformation policies.
to This property is required. String
The new name of the header. This name must be unique across transformation policies.
from This property is required. string
The original case-insensitive name of the header. This name must be unique across transformation policies.
to This property is required. string
The new name of the header. This name must be unique across transformation policies.
from_ This property is required. str
The original case-insensitive name of the header. This name must be unique across transformation policies.
to This property is required. str
The new name of the header. This name must be unique across transformation policies.
from This property is required. String
The original case-insensitive name of the header. This name must be unique across transformation policies.
to This property is required. String
The new name of the header. This name must be unique across transformation policies.

GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader

items This property is required. List<Property Map>
The list of headers.

GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeaderItem

IfExists This property is required. string
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Values This property is required. List<string>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
IfExists This property is required. string
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Values This property is required. []string
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
ifExists This property is required. String
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
values This property is required. List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
ifExists This property is required. string
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
values This property is required. string[]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
if_exists This property is required. str
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
name This property is required. str
The case-insensitive name of the header. This name must be unique across transformation policies.
values This property is required. Sequence[str]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
ifExists This property is required. String
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
values This property is required. List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

GetDeploymentSpecificationRouteRequestPolicyHeaderValidation

Headers This property is required. List<GetDeploymentSpecificationRouteRequestPolicyHeaderValidationHeader>
ValidationMode This property is required. string
Validation behavior mode.
Headers This property is required. []GetDeploymentSpecificationRouteRequestPolicyHeaderValidationHeader
ValidationMode This property is required. string
Validation behavior mode.
headers This property is required. List<GetDeploymentSpecificationRouteRequestPolicyHeaderValidationHeader>
validationMode This property is required. String
Validation behavior mode.
headers This property is required. GetDeploymentSpecificationRouteRequestPolicyHeaderValidationHeader[]
validationMode This property is required. string
Validation behavior mode.
headers This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteRequestPolicyHeaderValidationHeader]
validation_mode This property is required. str
Validation behavior mode.
headers This property is required. List<Property Map>
validationMode This property is required. String
Validation behavior mode.

GetDeploymentSpecificationRouteRequestPolicyHeaderValidationHeader

Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Required This property is required. bool
Determines if the parameter is required in the request.
Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Required This property is required. bool
Determines if the parameter is required in the request.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
required This property is required. Boolean
Determines if the parameter is required in the request.
name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
required This property is required. boolean
Determines if the parameter is required in the request.
name This property is required. str
The case-insensitive name of the header. This name must be unique across transformation policies.
required This property is required. bool
Determines if the parameter is required in the request.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
required This property is required. Boolean
Determines if the parameter is required in the request.

GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation

FilterQueryParameters This property is required. List<GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter>
Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.
RenameQueryParameters This property is required. List<GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter>
Rename parameters on the query string as they pass through the gateway.
SetQueryParameters This property is required. List<GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter>
Set parameters on the query string as they pass through the gateway.
FilterQueryParameters This property is required. []GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter
Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.
RenameQueryParameters This property is required. []GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter
Rename parameters on the query string as they pass through the gateway.
SetQueryParameters This property is required. []GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter
Set parameters on the query string as they pass through the gateway.
filterQueryParameters This property is required. List<GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter>
Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.
renameQueryParameters This property is required. List<GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter>
Rename parameters on the query string as they pass through the gateway.
setQueryParameters This property is required. List<GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter>
Set parameters on the query string as they pass through the gateway.
filterQueryParameters This property is required. GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter[]
Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.
renameQueryParameters This property is required. GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter[]
Rename parameters on the query string as they pass through the gateway.
setQueryParameters This property is required. GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter[]
Set parameters on the query string as they pass through the gateway.
filter_query_parameters This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter]
Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.
rename_query_parameters This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter]
Rename parameters on the query string as they pass through the gateway.
set_query_parameters This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter]
Set parameters on the query string as they pass through the gateway.
filterQueryParameters This property is required. List<Property Map>
Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.
renameQueryParameters This property is required. List<Property Map>
Rename parameters on the query string as they pass through the gateway.
setQueryParameters This property is required. List<Property Map>
Set parameters on the query string as they pass through the gateway.

GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter

Items This property is required. List<GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem>
The list of headers.
Type This property is required. string
Type of the Response Cache Store Policy.
Items This property is required. []GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem
The list of headers.
Type This property is required. string
Type of the Response Cache Store Policy.
items This property is required. List<GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem>
The list of headers.
type This property is required. String
Type of the Response Cache Store Policy.
items This property is required. GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem[]
The list of headers.
type This property is required. string
Type of the Response Cache Store Policy.
items This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem]
The list of headers.
type This property is required. str
Type of the Response Cache Store Policy.
items This property is required. List<Property Map>
The list of headers.
type This property is required. String
Type of the Response Cache Store Policy.

GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem

Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
name This property is required. str
The case-insensitive name of the header. This name must be unique across transformation policies.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.

GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter

items This property is required. List<Property Map>
The list of headers.

GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameterItem

From This property is required. string
The original case-insensitive name of the header. This name must be unique across transformation policies.
To This property is required. string
The new name of the header. This name must be unique across transformation policies.
From This property is required. string
The original case-insensitive name of the header. This name must be unique across transformation policies.
To This property is required. string
The new name of the header. This name must be unique across transformation policies.
from This property is required. String
The original case-insensitive name of the header. This name must be unique across transformation policies.
to This property is required. String
The new name of the header. This name must be unique across transformation policies.
from This property is required. string
The original case-insensitive name of the header. This name must be unique across transformation policies.
to This property is required. string
The new name of the header. This name must be unique across transformation policies.
from_ This property is required. str
The original case-insensitive name of the header. This name must be unique across transformation policies.
to This property is required. str
The new name of the header. This name must be unique across transformation policies.
from This property is required. String
The original case-insensitive name of the header. This name must be unique across transformation policies.
to This property is required. String
The new name of the header. This name must be unique across transformation policies.

GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter

items This property is required. List<Property Map>
The list of headers.

GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameterItem

IfExists This property is required. string
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Values This property is required. List<string>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
IfExists This property is required. string
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Values This property is required. []string
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
ifExists This property is required. String
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
values This property is required. List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
ifExists This property is required. string
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
values This property is required. string[]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
if_exists This property is required. str
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
name This property is required. str
The case-insensitive name of the header. This name must be unique across transformation policies.
values This property is required. Sequence[str]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
ifExists This property is required. String
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
values This property is required. List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

GetDeploymentSpecificationRouteRequestPolicyQueryParameterValidation

Parameters This property is required. List<GetDeploymentSpecificationRouteRequestPolicyQueryParameterValidationParameter>
ValidationMode This property is required. string
Validation behavior mode.
Parameters This property is required. []GetDeploymentSpecificationRouteRequestPolicyQueryParameterValidationParameter
ValidationMode This property is required. string
Validation behavior mode.
parameters This property is required. List<GetDeploymentSpecificationRouteRequestPolicyQueryParameterValidationParameter>
validationMode This property is required. String
Validation behavior mode.
parameters This property is required. GetDeploymentSpecificationRouteRequestPolicyQueryParameterValidationParameter[]
validationMode This property is required. string
Validation behavior mode.
parameters This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteRequestPolicyQueryParameterValidationParameter]
validation_mode This property is required. str
Validation behavior mode.
parameters This property is required. List<Property Map>
validationMode This property is required. String
Validation behavior mode.

GetDeploymentSpecificationRouteRequestPolicyQueryParameterValidationParameter

Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Required This property is required. bool
Determines if the parameter is required in the request.
Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Required This property is required. bool
Determines if the parameter is required in the request.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
required This property is required. Boolean
Determines if the parameter is required in the request.
name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
required This property is required. boolean
Determines if the parameter is required in the request.
name This property is required. str
The case-insensitive name of the header. This name must be unique across transformation policies.
required This property is required. bool
Determines if the parameter is required in the request.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
required This property is required. Boolean
Determines if the parameter is required in the request.

GetDeploymentSpecificationRouteRequestPolicyResponseCacheLookup

CacheKeyAdditions This property is required. List<string>
A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.
IsEnabled This property is required. bool
Whether this policy is currently enabled.
IsPrivateCachingEnabled This property is required. bool
Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require.
Type This property is required. string
Type of the Response Cache Store Policy.
CacheKeyAdditions This property is required. []string
A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.
IsEnabled This property is required. bool
Whether this policy is currently enabled.
IsPrivateCachingEnabled This property is required. bool
Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require.
Type This property is required. string
Type of the Response Cache Store Policy.
cacheKeyAdditions This property is required. List<String>
A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.
isEnabled This property is required. Boolean
Whether this policy is currently enabled.
isPrivateCachingEnabled This property is required. Boolean
Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require.
type This property is required. String
Type of the Response Cache Store Policy.
cacheKeyAdditions This property is required. string[]
A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.
isEnabled This property is required. boolean
Whether this policy is currently enabled.
isPrivateCachingEnabled This property is required. boolean
Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require.
type This property is required. string
Type of the Response Cache Store Policy.
cache_key_additions This property is required. Sequence[str]
A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.
is_enabled This property is required. bool
Whether this policy is currently enabled.
is_private_caching_enabled This property is required. bool
Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require.
type This property is required. str
Type of the Response Cache Store Policy.
cacheKeyAdditions This property is required. List<String>
A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.
isEnabled This property is required. Boolean
Whether this policy is currently enabled.
isPrivateCachingEnabled This property is required. Boolean
Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require.
type This property is required. String
Type of the Response Cache Store Policy.

GetDeploymentSpecificationRouteResponsePolicy

HeaderTransformations This property is required. List<GetDeploymentSpecificationRouteResponsePolicyHeaderTransformation>
A set of transformations to apply to HTTP headers that pass through the gateway.
ResponseCacheStores This property is required. List<GetDeploymentSpecificationRouteResponsePolicyResponseCacheStore>
Base policy for how a response from a backend is cached in the Response Cache.
HeaderTransformations This property is required. []GetDeploymentSpecificationRouteResponsePolicyHeaderTransformation
A set of transformations to apply to HTTP headers that pass through the gateway.
ResponseCacheStores This property is required. []GetDeploymentSpecificationRouteResponsePolicyResponseCacheStore
Base policy for how a response from a backend is cached in the Response Cache.
headerTransformations This property is required. List<GetDeploymentSpecificationRouteResponsePolicyHeaderTransformation>
A set of transformations to apply to HTTP headers that pass through the gateway.
responseCacheStores This property is required. List<GetDeploymentSpecificationRouteResponsePolicyResponseCacheStore>
Base policy for how a response from a backend is cached in the Response Cache.
headerTransformations This property is required. GetDeploymentSpecificationRouteResponsePolicyHeaderTransformation[]
A set of transformations to apply to HTTP headers that pass through the gateway.
responseCacheStores This property is required. GetDeploymentSpecificationRouteResponsePolicyResponseCacheStore[]
Base policy for how a response from a backend is cached in the Response Cache.
header_transformations This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteResponsePolicyHeaderTransformation]
A set of transformations to apply to HTTP headers that pass through the gateway.
response_cache_stores This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteResponsePolicyResponseCacheStore]
Base policy for how a response from a backend is cached in the Response Cache.
headerTransformations This property is required. List<Property Map>
A set of transformations to apply to HTTP headers that pass through the gateway.
responseCacheStores This property is required. List<Property Map>
Base policy for how a response from a backend is cached in the Response Cache.

GetDeploymentSpecificationRouteResponsePolicyHeaderTransformation

FilterHeaders This property is required. List<GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader>
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
RenameHeaders This property is required. List<GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader>
Rename HTTP headers as they pass through the gateway.
SetHeaders This property is required. List<GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader>
Set HTTP headers as they pass through the gateway.
FilterHeaders This property is required. []GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
RenameHeaders This property is required. []GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader
Rename HTTP headers as they pass through the gateway.
SetHeaders This property is required. []GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader
Set HTTP headers as they pass through the gateway.
filterHeaders This property is required. List<GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader>
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
renameHeaders This property is required. List<GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader>
Rename HTTP headers as they pass through the gateway.
setHeaders This property is required. List<GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader>
Set HTTP headers as they pass through the gateway.
filterHeaders This property is required. GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader[]
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
renameHeaders This property is required. GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader[]
Rename HTTP headers as they pass through the gateway.
setHeaders This property is required. GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader[]
Set HTTP headers as they pass through the gateway.
filter_headers This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader]
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
rename_headers This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader]
Rename HTTP headers as they pass through the gateway.
set_headers This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader]
Set HTTP headers as they pass through the gateway.
filterHeaders This property is required. List<Property Map>
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
renameHeaders This property is required. List<Property Map>
Rename HTTP headers as they pass through the gateway.
setHeaders This property is required. List<Property Map>
Set HTTP headers as they pass through the gateway.

GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader

Items This property is required. List<GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem>
The list of headers.
Type This property is required. string
Type of the Response Cache Store Policy.
Items This property is required. []GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem
The list of headers.
Type This property is required. string
Type of the Response Cache Store Policy.
items This property is required. List<GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem>
The list of headers.
type This property is required. String
Type of the Response Cache Store Policy.
items This property is required. GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem[]
The list of headers.
type This property is required. string
Type of the Response Cache Store Policy.
items This property is required. Sequence[apigateway.GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem]
The list of headers.
type This property is required. str
Type of the Response Cache Store Policy.
items This property is required. List<Property Map>
The list of headers.
type This property is required. String
Type of the Response Cache Store Policy.

GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem

Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
name This property is required. str
The case-insensitive name of the header. This name must be unique across transformation policies.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.

GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader

items This property is required. List<Property Map>
The list of headers.

GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeaderItem

From This property is required. string
The original case-insensitive name of the header. This name must be unique across transformation policies.
To This property is required. string
The new name of the header. This name must be unique across transformation policies.
From This property is required. string
The original case-insensitive name of the header. This name must be unique across transformation policies.
To This property is required. string
The new name of the header. This name must be unique across transformation policies.
from This property is required. String
The original case-insensitive name of the header. This name must be unique across transformation policies.
to This property is required. String
The new name of the header. This name must be unique across transformation policies.
from This property is required. string
The original case-insensitive name of the header. This name must be unique across transformation policies.
to This property is required. string
The new name of the header. This name must be unique across transformation policies.
from_ This property is required. str
The original case-insensitive name of the header. This name must be unique across transformation policies.
to This property is required. str
The new name of the header. This name must be unique across transformation policies.
from This property is required. String
The original case-insensitive name of the header. This name must be unique across transformation policies.
to This property is required. String
The new name of the header. This name must be unique across transformation policies.

GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader

items This property is required. List<Property Map>
The list of headers.

GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeaderItem

IfExists This property is required. string
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Values This property is required. List<string>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
IfExists This property is required. string
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
Name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
Values This property is required. []string
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
ifExists This property is required. String
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
values This property is required. List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
ifExists This property is required. string
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
name This property is required. string
The case-insensitive name of the header. This name must be unique across transformation policies.
values This property is required. string[]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
if_exists This property is required. str
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
name This property is required. str
The case-insensitive name of the header. This name must be unique across transformation policies.
values This property is required. Sequence[str]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
ifExists This property is required. String
If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
name This property is required. String
The case-insensitive name of the header. This name must be unique across transformation policies.
values This property is required. List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

GetDeploymentSpecificationRouteResponsePolicyResponseCacheStore

TimeToLiveInSeconds This property is required. int
Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.
Type This property is required. string
Type of the Response Cache Store Policy.
TimeToLiveInSeconds This property is required. int
Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.
Type This property is required. string
Type of the Response Cache Store Policy.
timeToLiveInSeconds This property is required. Integer
Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.
type This property is required. String
Type of the Response Cache Store Policy.
timeToLiveInSeconds This property is required. number
Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.
type This property is required. string
Type of the Response Cache Store Policy.
time_to_live_in_seconds This property is required. int
Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.
type This property is required. str
Type of the Response Cache Store Policy.
timeToLiveInSeconds This property is required. Number
Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.
type This property is required. String
Type of the Response Cache Store Policy.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi