oci logo
Oracle Cloud Infrastructure v0.19.0, May 26 23

oci.ApiGateway.getDeployment

Explore with Pulumi AI

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

Gets a deployment by identifier.

Example Usage

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 = oci_apigateway_deployment.Test_deployment.Id,
    });

});
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/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: oci_apigateway_deployment.Test_deployment.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
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(oci_apigateway_deployment.test_deployment().id())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_deployment = oci.ApiGateway.get_deployment(deployment_id=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDeployment = oci.ApiGateway.getDeployment({
    deploymentId: oci_apigateway_deployment.test_deployment.id,
});
variables:
  testDeployment:
    fn::invoke:
      Function: oci:ApiGateway:getDeployment
      Arguments:
        deploymentId: ${oci_apigateway_deployment.test_deployment.id}

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>
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]
func GetDeployment(ctx *Context, args *GetDeploymentArgs, opts ...InvokeOption) (*GetDeploymentResult, error)
func GetDeploymentOutput(ctx *Context, args *GetDeploymentOutputArgs, opts ...InvokeOption) GetDeploymentResultOutput

> 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)
}
public static CompletableFuture<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: oci:ApiGateway/getDeployment:getDeployment
  arguments:
    # arguments dictionary

The following arguments are supported:

DeploymentId string

The ocid of the deployment.

DeploymentId string

The ocid of the deployment.

deploymentId String

The ocid of the deployment.

deploymentId string

The ocid of the deployment.

deployment_id str

The ocid of the deployment.

deploymentId 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, object>

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, object>

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]interface{}

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]interface{}

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,Object>

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,Object>

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]: any}

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]: any}

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, Any]

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, Any]

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 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<Any>

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<Any>

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 List<GetDeploymentSpecificationLoggingPolicy>

Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.

RequestPolicies List<GetDeploymentSpecificationRequestPolicy>

Behavior applied to any requests received by the API on this route.

Routes List<GetDeploymentSpecificationRoute>

A list of routes that this API exposes.

LoggingPolicies []GetDeploymentSpecificationLoggingPolicy

Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.

RequestPolicies []GetDeploymentSpecificationRequestPolicy

Behavior applied to any requests received by the API on this route.

Routes []GetDeploymentSpecificationRoute

A list of routes that this API exposes.

loggingPolicies List<GetDeploymentSpecificationLoggingPolicy>

Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.

requestPolicies List<GetDeploymentSpecificationRequestPolicy>

Behavior applied to any requests received by the API on this route.

routes List<GetDeploymentSpecificationRoute>

A list of routes that this API exposes.

loggingPolicies GetDeploymentSpecificationLoggingPolicy[]

Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.

requestPolicies GetDeploymentSpecificationRequestPolicy[]

Behavior applied to any requests received by the API on this route.

routes GetDeploymentSpecificationRoute[]

A list of routes that this API exposes.

logging_policies GetDeploymentSpecificationLoggingPolicy]

Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.

request_policies GetDeploymentSpecificationRequestPolicy]

Behavior applied to any requests received by the API on this route.

routes GetDeploymentSpecificationRoute]

A list of routes that this API exposes.

loggingPolicies List<Property Map>

Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.

requestPolicies List<Property Map>

Behavior applied to any requests received by the API on this route.

routes List<Property Map>

A list of routes that this API exposes.

GetDeploymentSpecificationLoggingPolicy

AccessLogs List<GetDeploymentSpecificationLoggingPolicyAccessLog>

Configures the logging policies for the access logs of an API Deployment.

ExecutionLogs List<GetDeploymentSpecificationLoggingPolicyExecutionLog>

Configures the logging policies for the execution logs of an API Deployment.

AccessLogs []GetDeploymentSpecificationLoggingPolicyAccessLog

Configures the logging policies for the access logs of an API Deployment.

ExecutionLogs []GetDeploymentSpecificationLoggingPolicyExecutionLog

Configures the logging policies for the execution logs of an API Deployment.

accessLogs List<GetDeploymentSpecificationLoggingPolicyAccessLog>

Configures the logging policies for the access logs of an API Deployment.

executionLogs List<GetDeploymentSpecificationLoggingPolicyExecutionLog>

Configures the logging policies for the execution logs of an API Deployment.

accessLogs GetDeploymentSpecificationLoggingPolicyAccessLog[]

Configures the logging policies for the access logs of an API Deployment.

executionLogs GetDeploymentSpecificationLoggingPolicyExecutionLog[]

Configures the logging policies for the execution logs of an API Deployment.

access_logs GetDeploymentSpecificationLoggingPolicyAccessLog]

Configures the logging policies for the access logs of an API Deployment.

execution_logs GetDeploymentSpecificationLoggingPolicyExecutionLog]

Configures the logging policies for the execution logs of an API Deployment.

accessLogs List<Property Map>

Configures the logging policies for the access logs of an API Deployment.

executionLogs List<Property Map>

Configures the logging policies for the execution logs of an API Deployment.

GetDeploymentSpecificationLoggingPolicyAccessLog

IsEnabled bool

Whether this policy is currently enabled.

IsEnabled bool

Whether this policy is currently enabled.

isEnabled Boolean

Whether this policy is currently enabled.

isEnabled boolean

Whether this policy is currently enabled.

is_enabled bool

Whether this policy is currently enabled.

isEnabled Boolean

Whether this policy is currently enabled.

GetDeploymentSpecificationLoggingPolicyExecutionLog

IsEnabled bool

Whether this policy is currently enabled.

LogLevel 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 bool

Whether this policy is currently enabled.

LogLevel 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 Boolean

Whether this policy is currently enabled.

logLevel 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 boolean

Whether this policy is currently enabled.

logLevel 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 bool

Whether this policy is currently enabled.

log_level 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 Boolean

Whether this policy is currently enabled.

logLevel 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 List<GetDeploymentSpecificationRequestPolicyAuthentication>

Information on how to authenticate incoming requests.

Cors List<GetDeploymentSpecificationRequestPolicyCor>

Enable CORS (Cross-Origin-Resource-Sharing) request handling.

DynamicAuthentications 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 List<GetDeploymentSpecificationRequestPolicyMutualTl>

Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.

RateLimitings List<GetDeploymentSpecificationRequestPolicyRateLimiting>

Limit the number of requests that should be handled for the specified window using a specfic key.

UsagePlans List<GetDeploymentSpecificationRequestPolicyUsagePlan>

Usage plan policies for this deployment

Authentications []GetDeploymentSpecificationRequestPolicyAuthentication

Information on how to authenticate incoming requests.

Cors []GetDeploymentSpecificationRequestPolicyCor

Enable CORS (Cross-Origin-Resource-Sharing) request handling.

DynamicAuthentications []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 []GetDeploymentSpecificationRequestPolicyMutualTl

Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.

RateLimitings []GetDeploymentSpecificationRequestPolicyRateLimiting

Limit the number of requests that should be handled for the specified window using a specfic key.

UsagePlans []GetDeploymentSpecificationRequestPolicyUsagePlan

Usage plan policies for this deployment

authentications List<GetDeploymentSpecificationRequestPolicyAuthentication>

Information on how to authenticate incoming requests.

cors List<GetDeploymentSpecificationRequestPolicyCor>

Enable CORS (Cross-Origin-Resource-Sharing) request handling.

dynamicAuthentications 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 List<GetDeploymentSpecificationRequestPolicyMutualTl>

Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.

rateLimitings List<GetDeploymentSpecificationRequestPolicyRateLimiting>

Limit the number of requests that should be handled for the specified window using a specfic key.

usagePlans List<GetDeploymentSpecificationRequestPolicyUsagePlan>

Usage plan policies for this deployment

authentications GetDeploymentSpecificationRequestPolicyAuthentication[]

Information on how to authenticate incoming requests.

cors GetDeploymentSpecificationRequestPolicyCor[]

Enable CORS (Cross-Origin-Resource-Sharing) request handling.

dynamicAuthentications 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 GetDeploymentSpecificationRequestPolicyMutualTl[]

Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.

rateLimitings GetDeploymentSpecificationRequestPolicyRateLimiting[]

Limit the number of requests that should be handled for the specified window using a specfic key.

usagePlans GetDeploymentSpecificationRequestPolicyUsagePlan[]

Usage plan policies for this deployment

authentications GetDeploymentSpecificationRequestPolicyAuthentication]

Information on how to authenticate incoming requests.

cors GetDeploymentSpecificationRequestPolicyCor]

Enable CORS (Cross-Origin-Resource-Sharing) request handling.

dynamic_authentications 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 GetDeploymentSpecificationRequestPolicyMutualTl]

Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.

rate_limitings GetDeploymentSpecificationRequestPolicyRateLimiting]

Limit the number of requests that should be handled for the specified window using a specfic key.

usage_plans GetDeploymentSpecificationRequestPolicyUsagePlan]

Usage plan policies for this deployment

authentications List<Property Map>

Information on how to authenticate incoming requests.

cors List<Property Map>

Enable CORS (Cross-Origin-Resource-Sharing) request handling.

dynamicAuthentications 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 List<Property Map>

Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.

rateLimitings List<Property Map>

Limit the number of requests that should be handled for the specified window using a specfic key.

usagePlans List<Property Map>

Usage plan policies for this deployment

GetDeploymentSpecificationRequestPolicyAuthentication

Audiences List<string>

The list of intended recipients for the token.

CacheKeys List<string>

A list of keys from "parameters" attribute value whose values will be added to the cache key.

FunctionId string

The OCID of the Oracle Functions function resource.

IsAnonymousAccessAllowed bool

Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.

Issuers List<string>

A list of parties that could have issued the token.

MaxClockSkewInSeconds double

The maximum expected time difference between the system clocks of the token issuer and the API Gateway.

Parameters Dictionary<string, object>
PublicKeys List<GetDeploymentSpecificationRequestPolicyAuthenticationPublicKey>

A set of Public Keys that will be used to verify the JWT signature.

TokenAuthScheme string

The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.

TokenHeader string

The name of the header containing the authentication token.

TokenQueryParam string

The name of the query parameter containing the authentication token.

Type string

Type of the Response Cache Store Policy.

ValidationFailurePolicies List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicy>

Policy for defining behaviour on validation failure.

ValidationPolicies List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicy>

Authentication Policies for the Token Authentication types.

VerifyClaims List<GetDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim>

A list of claims which should be validated to consider the token valid.

Audiences []string

The list of intended recipients for the token.

CacheKeys []string

A list of keys from "parameters" attribute value whose values will be added to the cache key.

FunctionId string

The OCID of the Oracle Functions function resource.

IsAnonymousAccessAllowed bool

Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.

Issuers []string

A list of parties that could have issued the token.

MaxClockSkewInSeconds float64

The maximum expected time difference between the system clocks of the token issuer and the API Gateway.

Parameters map[string]interface{}
PublicKeys []GetDeploymentSpecificationRequestPolicyAuthenticationPublicKey

A set of Public Keys that will be used to verify the JWT signature.

TokenAuthScheme string

The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.

TokenHeader string

The name of the header containing the authentication token.

TokenQueryParam string

The name of the query parameter containing the authentication token.

Type string

Type of the Response Cache Store Policy.

ValidationFailurePolicies []GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicy

Policy for defining behaviour on validation failure.

ValidationPolicies []GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicy

Authentication Policies for the Token Authentication types.

VerifyClaims []GetDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim

A list of claims which should be validated to consider the token valid.

audiences List<String>

The list of intended recipients for the token.

cacheKeys List<String>

A list of keys from "parameters" attribute value whose values will be added to the cache key.

functionId String

The OCID of the Oracle Functions function resource.

isAnonymousAccessAllowed Boolean

Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.

issuers List<String>

A list of parties that could have issued the token.

maxClockSkewInSeconds Double

The maximum expected time difference between the system clocks of the token issuer and the API Gateway.

parameters Map<String,Object>
publicKeys List<GetDeploymentSpecificationRequestPolicyAuthenticationPublicKey>

A set of Public Keys that will be used to verify the JWT signature.

tokenAuthScheme String

The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.

tokenHeader String

The name of the header containing the authentication token.

tokenQueryParam String

The name of the query parameter containing the authentication token.

type String

Type of the Response Cache Store Policy.

validationFailurePolicies List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicy>

Policy for defining behaviour on validation failure.

validationPolicies List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicy>

Authentication Policies for the Token Authentication types.

verifyClaims List<GetDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim>

A list of claims which should be validated to consider the token valid.

audiences string[]

The list of intended recipients for the token.

cacheKeys string[]

A list of keys from "parameters" attribute value whose values will be added to the cache key.

functionId string

The OCID of the Oracle Functions function resource.

isAnonymousAccessAllowed boolean

Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.

issuers string[]

A list of parties that could have issued the token.

maxClockSkewInSeconds number

The maximum expected time difference between the system clocks of the token issuer and the API Gateway.

parameters {[key: string]: any}
publicKeys GetDeploymentSpecificationRequestPolicyAuthenticationPublicKey[]

A set of Public Keys that will be used to verify the JWT signature.

tokenAuthScheme string

The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.

tokenHeader string

The name of the header containing the authentication token.

tokenQueryParam string

The name of the query parameter containing the authentication token.

type string

Type of the Response Cache Store Policy.

validationFailurePolicies GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicy[]

Policy for defining behaviour on validation failure.

validationPolicies GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicy[]

Authentication Policies for the Token Authentication types.

verifyClaims GetDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim[]

A list of claims which should be validated to consider the token valid.

audiences Sequence[str]

The list of intended recipients for the token.

cache_keys Sequence[str]

A list of keys from "parameters" attribute value whose values will be added to the cache key.

function_id str

The OCID of the Oracle Functions function resource.

is_anonymous_access_allowed bool

Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.

issuers Sequence[str]

A list of parties that could have issued the token.

max_clock_skew_in_seconds float

The maximum expected time difference between the system clocks of the token issuer and the API Gateway.

parameters Mapping[str, Any]
public_keys GetDeploymentSpecificationRequestPolicyAuthenticationPublicKey]

A set of Public Keys that will be used to verify the JWT signature.

token_auth_scheme str

The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.

token_header str

The name of the header containing the authentication token.

token_query_param str

The name of the query parameter containing the authentication token.

type str

Type of the Response Cache Store Policy.

validation_failure_policies GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicy]

Policy for defining behaviour on validation failure.

validation_policies GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicy]

Authentication Policies for the Token Authentication types.

verify_claims GetDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim]

A list of claims which should be validated to consider the token valid.

audiences List<String>

The list of intended recipients for the token.

cacheKeys List<String>

A list of keys from "parameters" attribute value whose values will be added to the cache key.

functionId String

The OCID of the Oracle Functions function resource.

isAnonymousAccessAllowed Boolean

Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.

issuers List<String>

A list of parties that could have issued the token.

maxClockSkewInSeconds Number

The maximum expected time difference between the system clocks of the token issuer and the API Gateway.

parameters Map<Any>
publicKeys List<Property Map>

A set of Public Keys that will be used to verify the JWT signature.

tokenAuthScheme String

The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.

tokenHeader String

The name of the header containing the authentication token.

tokenQueryParam String

The name of the query parameter containing the authentication token.

type String

Type of the Response Cache Store Policy.

validationFailurePolicies List<Property Map>

Policy for defining behaviour on validation failure.

validationPolicies List<Property Map>

Authentication Policies for the Token Authentication types.

verifyClaims List<Property Map>

A list of claims which should be validated to consider the token valid.

GetDeploymentSpecificationRequestPolicyAuthenticationPublicKey

IsSslVerifyDisabled bool

Defines whether or not to uphold SSL verification.

Keys List<GetDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey>

The set of static public keys.

MaxCacheDurationInHours int

The duration for which the introspect URL response should be cached before it is fetched again.

Type string

Type of the Response Cache Store Policy.

Uri string

The uri from which to retrieve the key. It must be accessible without authentication.

IsSslVerifyDisabled bool

Defines whether or not to uphold SSL verification.

Keys []GetDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey

The set of static public keys.

MaxCacheDurationInHours int

The duration for which the introspect URL response should be cached before it is fetched again.

Type string

Type of the Response Cache Store Policy.

Uri string

The uri from which to retrieve the key. It must be accessible without authentication.

isSslVerifyDisabled Boolean

Defines whether or not to uphold SSL verification.

keys List<GetDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey>

The set of static public keys.

maxCacheDurationInHours Integer

The duration for which the introspect URL response should be cached before it is fetched again.

type String

Type of the Response Cache Store Policy.

uri String

The uri from which to retrieve the key. It must be accessible without authentication.

isSslVerifyDisabled boolean

Defines whether or not to uphold SSL verification.

keys GetDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey[]

The set of static public keys.

maxCacheDurationInHours number

The duration for which the introspect URL response should be cached before it is fetched again.

type string

Type of the Response Cache Store Policy.

uri string

The uri from which to retrieve the key. It must be accessible without authentication.

is_ssl_verify_disabled bool

Defines whether or not to uphold SSL verification.

keys GetDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey]

The set of static public keys.

max_cache_duration_in_hours int

The duration for which the introspect URL response should be cached before it is fetched again.

type str

Type of the Response Cache Store Policy.

uri str

The uri from which to retrieve the key. It must be accessible without authentication.

isSslVerifyDisabled Boolean

Defines whether or not to uphold SSL verification.

keys List<Property Map>

The set of static public keys.

maxCacheDurationInHours Number

The duration for which the introspect URL response should be cached before it is fetched again.

type String

Type of the Response Cache Store Policy.

uri String

The uri from which to retrieve the key. It must be accessible without authentication.

GetDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey

Alg string

The algorithm intended for use with this key.

E string

The base64 url encoded exponent of the RSA public key represented by this key.

Format string

The format of the public key.

Key string

Information around the values for selector of an authentication/ routing branch.

KeyOps List<string>

The operations for which this key is to be used.

Kid string

A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

Kty string

The key type.

N string

The base64 url encoded modulus of the RSA public key represented by this key.

Use string

The intended use of the public key.

Alg string

The algorithm intended for use with this key.

E string

The base64 url encoded exponent of the RSA public key represented by this key.

Format string

The format of the public key.

Key string

Information around the values for selector of an authentication/ routing branch.

KeyOps []string

The operations for which this key is to be used.

Kid string

A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

Kty string

The key type.

N string

The base64 url encoded modulus of the RSA public key represented by this key.

Use string

The intended use of the public key.

alg String

The algorithm intended for use with this key.

e String

The base64 url encoded exponent of the RSA public key represented by this key.

format String

The format of the public key.

key String

Information around the values for selector of an authentication/ routing branch.

keyOps List<String>

The operations for which this key is to be used.

kid String

A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

kty String

The key type.

n String

The base64 url encoded modulus of the RSA public key represented by this key.

use String

The intended use of the public key.

alg string

The algorithm intended for use with this key.

e string

The base64 url encoded exponent of the RSA public key represented by this key.

format string

The format of the public key.

key string

Information around the values for selector of an authentication/ routing branch.

keyOps string[]

The operations for which this key is to be used.

kid string

A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

kty string

The key type.

n string

The base64 url encoded modulus of the RSA public key represented by this key.

use string

The intended use of the public key.

alg str

The algorithm intended for use with this key.

e str

The base64 url encoded exponent of the RSA public key represented by this key.

format str

The format of the public key.

key str

Information around the values for selector of an authentication/ routing branch.

key_ops Sequence[str]

The operations for which this key is to be used.

kid str

A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

kty str

The key type.

n str

The base64 url encoded modulus of the RSA public key represented by this key.

use str

The intended use of the public key.

alg String

The algorithm intended for use with this key.

e String

The base64 url encoded exponent of the RSA public key represented by this key.

format String

The format of the public key.

key String

Information around the values for selector of an authentication/ routing branch.

keyOps List<String>

The operations for which this key is to be used.

kid String

A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

kty String

The key type.

n String

The base64 url encoded modulus of the RSA public key represented by this key.

use String

The intended use of the public key.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicy

ClientDetails List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail>

Client App Credential details.

FallbackRedirectPath string

The path to be used as fallback after OAuth2.

LogoutPath string

The path to be used as logout.

MaxExpiryDurationInHours int

The duration for which the OAuth2 success token should be cached before it is fetched again.

ResponseCode string

HTTP response code, can include context variables.

ResponseHeaderTransformations List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation>

A set of transformations to apply to HTTP headers that pass through the gateway.

ResponseMessage string

HTTP response message.

ResponseType string

Response Type.

Scopes List<string>

List of scopes.

SourceUriDetails List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail>

Auth endpoint details.

Type string

Type of the Response Cache Store Policy.

UseCookiesForIntermediateSteps bool

Defines whether or not to use cookies for OAuth2 intermediate steps.

UseCookiesForSession bool

Defines whether or not to use cookies for session maintenance.

UsePkce bool

Defines whether or not to support PKCE.

ClientDetails []GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail

Client App Credential details.

FallbackRedirectPath string

The path to be used as fallback after OAuth2.

LogoutPath string

The path to be used as logout.

MaxExpiryDurationInHours int

The duration for which the OAuth2 success token should be cached before it is fetched again.

ResponseCode string

HTTP response code, can include context variables.

ResponseHeaderTransformations []GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation

A set of transformations to apply to HTTP headers that pass through the gateway.

ResponseMessage string

HTTP response message.

ResponseType string

Response Type.

Scopes []string

List of scopes.

SourceUriDetails []GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail

Auth endpoint details.

Type string

Type of the Response Cache Store Policy.

UseCookiesForIntermediateSteps bool

Defines whether or not to use cookies for OAuth2 intermediate steps.

UseCookiesForSession bool

Defines whether or not to use cookies for session maintenance.

UsePkce bool

Defines whether or not to support PKCE.

clientDetails List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail>

Client App Credential details.

fallbackRedirectPath String

The path to be used as fallback after OAuth2.

logoutPath String

The path to be used as logout.

maxExpiryDurationInHours Integer

The duration for which the OAuth2 success token should be cached before it is fetched again.

responseCode String

HTTP response code, can include context variables.

responseHeaderTransformations List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation>

A set of transformations to apply to HTTP headers that pass through the gateway.

responseMessage String

HTTP response message.

responseType String

Response Type.

scopes List<String>

List of scopes.

sourceUriDetails List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail>

Auth endpoint details.

type String

Type of the Response Cache Store Policy.

useCookiesForIntermediateSteps Boolean

Defines whether or not to use cookies for OAuth2 intermediate steps.

useCookiesForSession Boolean

Defines whether or not to use cookies for session maintenance.

usePkce Boolean

Defines whether or not to support PKCE.

clientDetails GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail[]

Client App Credential details.

fallbackRedirectPath string

The path to be used as fallback after OAuth2.

logoutPath string

The path to be used as logout.

maxExpiryDurationInHours number

The duration for which the OAuth2 success token should be cached before it is fetched again.

responseCode string

HTTP response code, can include context variables.

responseHeaderTransformations GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation[]

A set of transformations to apply to HTTP headers that pass through the gateway.

responseMessage string

HTTP response message.

responseType string

Response Type.

scopes string[]

List of scopes.

sourceUriDetails GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail[]

Auth endpoint details.

type string

Type of the Response Cache Store Policy.

useCookiesForIntermediateSteps boolean

Defines whether or not to use cookies for OAuth2 intermediate steps.

useCookiesForSession boolean

Defines whether or not to use cookies for session maintenance.

usePkce boolean

Defines whether or not to support PKCE.

client_details GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail]

Client App Credential details.

fallback_redirect_path str

The path to be used as fallback after OAuth2.

logout_path str

The path to be used as logout.

max_expiry_duration_in_hours int

The duration for which the OAuth2 success token should be cached before it is fetched again.

response_code str

HTTP response code, can include context variables.

response_header_transformations GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation]

A set of transformations to apply to HTTP headers that pass through the gateway.

response_message str

HTTP response message.

response_type str

Response Type.

scopes Sequence[str]

List of scopes.

source_uri_details GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail]

Auth endpoint details.

type str

Type of the Response Cache Store Policy.

use_cookies_for_intermediate_steps bool

Defines whether or not to use cookies for OAuth2 intermediate steps.

use_cookies_for_session bool

Defines whether or not to use cookies for session maintenance.

use_pkce bool

Defines whether or not to support PKCE.

clientDetails List<Property Map>

Client App Credential details.

fallbackRedirectPath String

The path to be used as fallback after OAuth2.

logoutPath String

The path to be used as logout.

maxExpiryDurationInHours Number

The duration for which the OAuth2 success token should be cached before it is fetched again.

responseCode String

HTTP response code, can include context variables.

responseHeaderTransformations List<Property Map>

A set of transformations to apply to HTTP headers that pass through the gateway.

responseMessage String

HTTP response message.

responseType String

Response Type.

scopes List<String>

List of scopes.

sourceUriDetails List<Property Map>

Auth endpoint details.

type String

Type of the Response Cache Store Policy.

useCookiesForIntermediateSteps Boolean

Defines whether or not to use cookies for OAuth2 intermediate steps.

useCookiesForSession Boolean

Defines whether or not to use cookies for session maintenance.

usePkce Boolean

Defines whether or not to support PKCE.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail

ClientId string

Client ID for the OAuth2/OIDC app.

ClientSecretId string

The OCID of the Oracle Vault Service secret resource.

ClientSecretVersionNumber string

The version number of the client secret to use.

Type string

Type of the Response Cache Store Policy.

ClientId string

Client ID for the OAuth2/OIDC app.

ClientSecretId string

The OCID of the Oracle Vault Service secret resource.

ClientSecretVersionNumber string

The version number of the client secret to use.

Type string

Type of the Response Cache Store Policy.

clientId String

Client ID for the OAuth2/OIDC app.

clientSecretId String

The OCID of the Oracle Vault Service secret resource.

clientSecretVersionNumber String

The version number of the client secret to use.

type String

Type of the Response Cache Store Policy.

clientId string

Client ID for the OAuth2/OIDC app.

clientSecretId string

The OCID of the Oracle Vault Service secret resource.

clientSecretVersionNumber string

The version number of the client secret to use.

type string

Type of the Response Cache Store Policy.

client_id str

Client ID for the OAuth2/OIDC app.

client_secret_id str

The OCID of the Oracle Vault Service secret resource.

client_secret_version_number str

The version number of the client secret to use.

type str

Type of the Response Cache Store Policy.

clientId String

Client ID for the OAuth2/OIDC app.

clientSecretId String

The OCID of the Oracle Vault Service secret resource.

clientSecretVersionNumber String

The version number of the client secret to use.

type String

Type of the Response Cache Store Policy.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation

FilterHeaders 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 List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader>

Rename HTTP headers as they pass through the gateway.

SetHeaders List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader>

Set HTTP headers as they pass through the gateway.

FilterHeaders []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 []GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader

Rename HTTP headers as they pass through the gateway.

SetHeaders []GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader

Set HTTP headers as they pass through the gateway.

filterHeaders 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 List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader>

Rename HTTP headers as they pass through the gateway.

setHeaders List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader>

Set HTTP headers as they pass through the gateway.

filterHeaders 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 GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader[]

Rename HTTP headers as they pass through the gateway.

setHeaders GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader[]

Set HTTP headers as they pass through the gateway.

filter_headers 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 GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader]

Rename HTTP headers as they pass through the gateway.

set_headers GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader]

Set HTTP headers as they pass through the gateway.

filterHeaders 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 List<Property Map>

Rename HTTP headers as they pass through the gateway.

setHeaders List<Property Map>

Set HTTP headers as they pass through the gateway.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader

items List<Property Map>

The list of headers.

type String

Type of the Response Cache Store Policy.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

name string

The case-insensitive name of the header. This name must be unique across transformation policies.

name str

The case-insensitive name of the header. This name must be unique across transformation policies.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader

items List<Property Map>

The list of headers.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem

From string

The original case-insensitive name of the header. This name must be unique across transformation policies.

To string

The new name of the header. This name must be unique across transformation policies.

From string

The original case-insensitive name of the header. This name must be unique across transformation policies.

To string

The new name of the header. This name must be unique across transformation policies.

from String

The original case-insensitive name of the header. This name must be unique across transformation policies.

to String

The new name of the header. This name must be unique across transformation policies.

from string

The original case-insensitive name of the header. This name must be unique across transformation policies.

to string

The new name of the header. This name must be unique across transformation policies.

from_ str

The original case-insensitive name of the header. This name must be unique across transformation policies.

to str

The new name of the header. This name must be unique across transformation policies.

from String

The original case-insensitive name of the header. This name must be unique across transformation policies.

to String

The new name of the header. This name must be unique across transformation policies.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader

items List<Property Map>

The list of headers.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeaderItem

IfExists 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 string

The case-insensitive name of the header. This name must be unique across transformation policies.

Values List<string>

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

IfExists 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 string

The case-insensitive name of the header. This name must be unique across transformation policies.

Values []string

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

ifExists 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 String

The case-insensitive name of the header. This name must be unique across transformation policies.

values List<String>

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

ifExists 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 string

The case-insensitive name of the header. This name must be unique across transformation policies.

values string[]

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

if_exists 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 str

The case-insensitive name of the header. This name must be unique across transformation policies.

values Sequence[str]

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

ifExists 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 String

The case-insensitive name of the header. This name must be unique across transformation policies.

values 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 string

Type of the Response Cache Store Policy.

Uri string

The uri from which to retrieve the key. It must be accessible without authentication.

Type string

Type of the Response Cache Store Policy.

Uri string

The uri from which to retrieve the key. It must be accessible without authentication.

type String

Type of the Response Cache Store Policy.

uri String

The uri from which to retrieve the key. It must be accessible without authentication.

type string

Type of the Response Cache Store Policy.

uri string

The uri from which to retrieve the key. It must be accessible without authentication.

type str

Type of the Response Cache Store Policy.

uri str

The uri from which to retrieve the key. It must be accessible without authentication.

type String

Type of the Response Cache Store Policy.

uri String

The uri from which to retrieve the key. It must be accessible without authentication.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicy

AdditionalValidationPolicies List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy>

Additional JWT validation checks.

ClientDetails List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail>

Client App Credential details.

IsSslVerifyDisabled bool

Defines whether or not to uphold SSL verification.

Keys List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyKey>

The set of static public keys.

MaxCacheDurationInHours int

The duration for which the introspect URL response should be cached before it is fetched again.

SourceUriDetails List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail>

Auth endpoint details.

Type string

Type of the Response Cache Store Policy.

Uri string

The uri from which to retrieve the key. It must be accessible without authentication.

AdditionalValidationPolicies []GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy

Additional JWT validation checks.

ClientDetails []GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail

Client App Credential details.

IsSslVerifyDisabled bool

Defines whether or not to uphold SSL verification.

Keys []GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyKey

The set of static public keys.

MaxCacheDurationInHours int

The duration for which the introspect URL response should be cached before it is fetched again.

SourceUriDetails []GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail

Auth endpoint details.

Type string

Type of the Response Cache Store Policy.

Uri string

The uri from which to retrieve the key. It must be accessible without authentication.

additionalValidationPolicies List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy>

Additional JWT validation checks.

clientDetails List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail>

Client App Credential details.

isSslVerifyDisabled Boolean

Defines whether or not to uphold SSL verification.

keys List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyKey>

The set of static public keys.

maxCacheDurationInHours Integer

The duration for which the introspect URL response should be cached before it is fetched again.

sourceUriDetails List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail>

Auth endpoint details.

type String

Type of the Response Cache Store Policy.

uri String

The uri from which to retrieve the key. It must be accessible without authentication.

additionalValidationPolicies GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy[]

Additional JWT validation checks.

clientDetails GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail[]

Client App Credential details.

isSslVerifyDisabled boolean

Defines whether or not to uphold SSL verification.

keys GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyKey[]

The set of static public keys.

maxCacheDurationInHours number

The duration for which the introspect URL response should be cached before it is fetched again.

sourceUriDetails GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail[]

Auth endpoint details.

type string

Type of the Response Cache Store Policy.

uri string

The uri from which to retrieve the key. It must be accessible without authentication.

additional_validation_policies GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy]

Additional JWT validation checks.

client_details GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail]

Client App Credential details.

is_ssl_verify_disabled bool

Defines whether or not to uphold SSL verification.

keys GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyKey]

The set of static public keys.

max_cache_duration_in_hours int

The duration for which the introspect URL response should be cached before it is fetched again.

source_uri_details GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail]

Auth endpoint details.

type str

Type of the Response Cache Store Policy.

uri str

The uri from which to retrieve the key. It must be accessible without authentication.

additionalValidationPolicies List<Property Map>

Additional JWT validation checks.

clientDetails List<Property Map>

Client App Credential details.

isSslVerifyDisabled Boolean

Defines whether or not to uphold SSL verification.

keys List<Property Map>

The set of static public keys.

maxCacheDurationInHours Number

The duration for which the introspect URL response should be cached before it is fetched again.

sourceUriDetails List<Property Map>

Auth endpoint details.

type String

Type of the Response Cache Store Policy.

uri String

The uri from which to retrieve the key. It must be accessible without authentication.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy

Audiences List<string>

The list of intended recipients for the token.

Issuers List<string>

A list of parties that could have issued the token.

VerifyClaims List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim>

A list of claims which should be validated to consider the token valid.

Audiences []string

The list of intended recipients for the token.

Issuers []string

A list of parties that could have issued the token.

VerifyClaims []GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim

A list of claims which should be validated to consider the token valid.

audiences List<String>

The list of intended recipients for the token.

issuers List<String>

A list of parties that could have issued the token.

verifyClaims List<GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim>

A list of claims which should be validated to consider the token valid.

audiences string[]

The list of intended recipients for the token.

issuers string[]

A list of parties that could have issued the token.

verifyClaims GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim[]

A list of claims which should be validated to consider the token valid.

audiences Sequence[str]

The list of intended recipients for the token.

issuers Sequence[str]

A list of parties that could have issued the token.

verify_claims GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim]

A list of claims which should be validated to consider the token valid.

audiences List<String>

The list of intended recipients for the token.

issuers List<String>

A list of parties that could have issued the token.

verifyClaims List<Property Map>

A list of claims which should be validated to consider the token valid.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim

IsRequired 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 string

Information around the values for selector of an authentication/ routing branch.

Values List<string>

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

IsRequired 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 string

Information around the values for selector of an authentication/ routing branch.

Values []string

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

isRequired 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 String

Information around the values for selector of an authentication/ routing branch.

values List<String>

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

isRequired 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 string

Information around the values for selector of an authentication/ routing branch.

values string[]

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

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 str

Information around the values for selector of an authentication/ routing branch.

values Sequence[str]

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

isRequired 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 String

Information around the values for selector of an authentication/ routing branch.

values 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 string

Client ID for the OAuth2/OIDC app.

ClientSecretId string

The OCID of the Oracle Vault Service secret resource.

ClientSecretVersionNumber string

The version number of the client secret to use.

Type string

Type of the Response Cache Store Policy.

ClientId string

Client ID for the OAuth2/OIDC app.

ClientSecretId string

The OCID of the Oracle Vault Service secret resource.

ClientSecretVersionNumber string

The version number of the client secret to use.

Type string

Type of the Response Cache Store Policy.

clientId String

Client ID for the OAuth2/OIDC app.

clientSecretId String

The OCID of the Oracle Vault Service secret resource.

clientSecretVersionNumber String

The version number of the client secret to use.

type String

Type of the Response Cache Store Policy.

clientId string

Client ID for the OAuth2/OIDC app.

clientSecretId string

The OCID of the Oracle Vault Service secret resource.

clientSecretVersionNumber string

The version number of the client secret to use.

type string

Type of the Response Cache Store Policy.

client_id str

Client ID for the OAuth2/OIDC app.

client_secret_id str

The OCID of the Oracle Vault Service secret resource.

client_secret_version_number str

The version number of the client secret to use.

type str

Type of the Response Cache Store Policy.

clientId String

Client ID for the OAuth2/OIDC app.

clientSecretId String

The OCID of the Oracle Vault Service secret resource.

clientSecretVersionNumber String

The version number of the client secret to use.

type String

Type of the Response Cache Store Policy.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyKey

Alg string

The algorithm intended for use with this key.

E string

The base64 url encoded exponent of the RSA public key represented by this key.

Format string

The format of the public key.

Key string

Information around the values for selector of an authentication/ routing branch.

KeyOps List<string>

The operations for which this key is to be used.

Kid string

A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

Kty string

The key type.

N string

The base64 url encoded modulus of the RSA public key represented by this key.

Use string

The intended use of the public key.

Alg string

The algorithm intended for use with this key.

E string

The base64 url encoded exponent of the RSA public key represented by this key.

Format string

The format of the public key.

Key string

Information around the values for selector of an authentication/ routing branch.

KeyOps []string

The operations for which this key is to be used.

Kid string

A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

Kty string

The key type.

N string

The base64 url encoded modulus of the RSA public key represented by this key.

Use string

The intended use of the public key.

alg String

The algorithm intended for use with this key.

e String

The base64 url encoded exponent of the RSA public key represented by this key.

format String

The format of the public key.

key String

Information around the values for selector of an authentication/ routing branch.

keyOps List<String>

The operations for which this key is to be used.

kid String

A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

kty String

The key type.

n String

The base64 url encoded modulus of the RSA public key represented by this key.

use String

The intended use of the public key.

alg string

The algorithm intended for use with this key.

e string

The base64 url encoded exponent of the RSA public key represented by this key.

format string

The format of the public key.

key string

Information around the values for selector of an authentication/ routing branch.

keyOps string[]

The operations for which this key is to be used.

kid string

A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

kty string

The key type.

n string

The base64 url encoded modulus of the RSA public key represented by this key.

use string

The intended use of the public key.

alg str

The algorithm intended for use with this key.

e str

The base64 url encoded exponent of the RSA public key represented by this key.

format str

The format of the public key.

key str

Information around the values for selector of an authentication/ routing branch.

key_ops Sequence[str]

The operations for which this key is to be used.

kid str

A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

kty str

The key type.

n str

The base64 url encoded modulus of the RSA public key represented by this key.

use str

The intended use of the public key.

alg String

The algorithm intended for use with this key.

e String

The base64 url encoded exponent of the RSA public key represented by this key.

format String

The format of the public key.

key String

Information around the values for selector of an authentication/ routing branch.

keyOps List<String>

The operations for which this key is to be used.

kid String

A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

kty String

The key type.

n String

The base64 url encoded modulus of the RSA public key represented by this key.

use String

The intended use of the public key.

GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail

Type string

Type of the Response Cache Store Policy.

Uri string

The uri from which to retrieve the key. It must be accessible without authentication.

Type string

Type of the Response Cache Store Policy.

Uri string

The uri from which to retrieve the key. It must be accessible without authentication.

type String

Type of the Response Cache Store Policy.

uri String

The uri from which to retrieve the key. It must be accessible without authentication.

type string

Type of the Response Cache Store Policy.

uri string

The uri from which to retrieve the key. It must be accessible without authentication.

type str

Type of the Response Cache Store Policy.

uri str

The uri from which to retrieve the key. It must be accessible without authentication.

type String

Type of the Response Cache Store Policy.

uri String

The uri from which to retrieve the key. It must be accessible without authentication.

GetDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim

IsRequired 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 string

Information around the values for selector of an authentication/ routing branch.

Values List<string>

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

IsRequired 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 string

Information around the values for selector of an authentication/ routing branch.

Values []string

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

isRequired 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 String

Information around the values for selector of an authentication/ routing branch.

values List<String>

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

isRequired 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 string

Information around the values for selector of an authentication/ routing branch.

values string[]

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

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 str

Information around the values for selector of an authentication/ routing branch.

values Sequence[str]

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

isRequired 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 String

Information around the values for selector of an authentication/ routing branch.

values 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 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 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 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 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 bool

Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

MaxAgeInSeconds 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 []string

The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.

AllowedMethods []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 []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 []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 bool

Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

MaxAgeInSeconds 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 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 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 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 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 Boolean

Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

maxAgeInSeconds 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 string[]

The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.

allowedMethods 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 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 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 boolean

Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

maxAgeInSeconds 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 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 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 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 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 bool

Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

max_age_in_seconds 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 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 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 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 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 Boolean

Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

maxAgeInSeconds 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 List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer>

List of authentication servers to choose from during dynamic authentication.

SelectionSources List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationSelectionSource>

Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.

AuthenticationServers []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer

List of authentication servers to choose from during dynamic authentication.

SelectionSources []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationSelectionSource

Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.

authenticationServers List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer>

List of authentication servers to choose from during dynamic authentication.

selectionSources List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationSelectionSource>

Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.

authenticationServers GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer[]

List of authentication servers to choose from during dynamic authentication.

selectionSources GetDeploymentSpecificationRequestPolicyDynamicAuthenticationSelectionSource[]

Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.

authentication_servers GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer]

List of authentication servers to choose from during dynamic authentication.

selection_sources GetDeploymentSpecificationRequestPolicyDynamicAuthenticationSelectionSource]

Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.

authenticationServers List<Property Map>

List of authentication servers to choose from during dynamic authentication.

selectionSources List<Property Map>

Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer

authenticationServerDetails List<Property Map>

Information on how to authenticate incoming requests.

keys List<Property Map>

Information around the values for selector of an authentication/ routing branch.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail

Audiences List<string>

The list of intended recipients for the token.

CacheKeys List<string>

A list of keys from "parameters" attribute value whose values will be added to the cache key.

FunctionId string

The OCID of the Oracle Functions function resource.

IsAnonymousAccessAllowed bool

Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.

Issuers List<string>

A list of parties that could have issued the token.

MaxClockSkewInSeconds double

The maximum expected time difference between the system clocks of the token issuer and the API Gateway.

Parameters Dictionary<string, object>
PublicKeys List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey>

A set of Public Keys that will be used to verify the JWT signature.

TokenAuthScheme string

The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.

TokenHeader string

The name of the header containing the authentication token.

TokenQueryParam string

The name of the query parameter containing the authentication token.

Type string

Type of the Response Cache Store Policy.

ValidationFailurePolicies List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy>

Policy for defining behaviour on validation failure.

ValidationPolicies List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy>

Authentication Policies for the Token Authentication types.

VerifyClaims List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim>

A list of claims which should be validated to consider the token valid.

Audiences []string

The list of intended recipients for the token.

CacheKeys []string

A list of keys from "parameters" attribute value whose values will be added to the cache key.

FunctionId string

The OCID of the Oracle Functions function resource.

IsAnonymousAccessAllowed bool

Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.

Issuers []string

A list of parties that could have issued the token.

MaxClockSkewInSeconds float64

The maximum expected time difference between the system clocks of the token issuer and the API Gateway.

Parameters map[string]interface{}
PublicKeys []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey

A set of Public Keys that will be used to verify the JWT signature.

TokenAuthScheme string

The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.

TokenHeader string

The name of the header containing the authentication token.

TokenQueryParam string

The name of the query parameter containing the authentication token.

Type string

Type of the Response Cache Store Policy.

ValidationFailurePolicies []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy

Policy for defining behaviour on validation failure.

ValidationPolicies []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy

Authentication Policies for the Token Authentication types.

VerifyClaims []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim

A list of claims which should be validated to consider the token valid.

audiences List<String>

The list of intended recipients for the token.

cacheKeys List<String>

A list of keys from "parameters" attribute value whose values will be added to the cache key.

functionId String

The OCID of the Oracle Functions function resource.

isAnonymousAccessAllowed Boolean

Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.

issuers List<String>

A list of parties that could have issued the token.

maxClockSkewInSeconds Double

The maximum expected time difference between the system clocks of the token issuer and the API Gateway.

parameters Map<String,Object>
publicKeys List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey>

A set of Public Keys that will be used to verify the JWT signature.

tokenAuthScheme String

The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.

tokenHeader String

The name of the header containing the authentication token.

tokenQueryParam String

The name of the query parameter containing the authentication token.

type String

Type of the Response Cache Store Policy.

validationFailurePolicies List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy>

Policy for defining behaviour on validation failure.

validationPolicies List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy>

Authentication Policies for the Token Authentication types.

verifyClaims List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim>

A list of claims which should be validated to consider the token valid.

audiences string[]

The list of intended recipients for the token.

cacheKeys string[]

A list of keys from "parameters" attribute value whose values will be added to the cache key.

functionId string

The OCID of the Oracle Functions function resource.

isAnonymousAccessAllowed boolean

Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.

issuers string[]

A list of parties that could have issued the token.

maxClockSkewInSeconds number

The maximum expected time difference between the system clocks of the token issuer and the API Gateway.

parameters {[key: string]: any}
publicKeys GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey[]

A set of Public Keys that will be used to verify the JWT signature.

tokenAuthScheme string

The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.

tokenHeader string

The name of the header containing the authentication token.

tokenQueryParam string

The name of the query parameter containing the authentication token.

type string

Type of the Response Cache Store Policy.

validationFailurePolicies GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy[]

Policy for defining behaviour on validation failure.

validationPolicies GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy[]

Authentication Policies for the Token Authentication types.

verifyClaims GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim[]

A list of claims which should be validated to consider the token valid.

audiences Sequence[str]

The list of intended recipients for the token.

cache_keys Sequence[str]

A list of keys from "parameters" attribute value whose values will be added to the cache key.

function_id str

The OCID of the Oracle Functions function resource.

is_anonymous_access_allowed bool

Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.

issuers Sequence[str]

A list of parties that could have issued the token.

max_clock_skew_in_seconds float

The maximum expected time difference between the system clocks of the token issuer and the API Gateway.

parameters Mapping[str, Any]
public_keys GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey]

A set of Public Keys that will be used to verify the JWT signature.

token_auth_scheme str

The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.

token_header str

The name of the header containing the authentication token.

token_query_param str

The name of the query parameter containing the authentication token.

type str

Type of the Response Cache Store Policy.

validation_failure_policies GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy]

Policy for defining behaviour on validation failure.

validation_policies GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy]

Authentication Policies for the Token Authentication types.

verify_claims GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim]

A list of claims which should be validated to consider the token valid.

audiences List<String>

The list of intended recipients for the token.

cacheKeys List<String>

A list of keys from "parameters" attribute value whose values will be added to the cache key.

functionId String

The OCID of the Oracle Functions function resource.

isAnonymousAccessAllowed Boolean

Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.

issuers List<String>

A list of parties that could have issued the token.

maxClockSkewInSeconds Number

The maximum expected time difference between the system clocks of the token issuer and the API Gateway.

parameters Map<Any>
publicKeys List<Property Map>

A set of Public Keys that will be used to verify the JWT signature.

tokenAuthScheme String

The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.

tokenHeader String

The name of the header containing the authentication token.

tokenQueryParam String

The name of the query parameter containing the authentication token.

type String

Type of the Response Cache Store Policy.

validationFailurePolicies List<Property Map>

Policy for defining behaviour on validation failure.

validationPolicies List<Property Map>

Authentication Policies for the Token Authentication types.

verifyClaims List<Property Map>

A list of claims which should be validated to consider the token valid.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey

IsSslVerifyDisabled bool

Defines whether or not to uphold SSL verification.

Keys List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey>

The set of static public keys.

MaxCacheDurationInHours int

The duration for which the introspect URL response should be cached before it is fetched again.

Type string

Type of the Response Cache Store Policy.

Uri string

The uri from which to retrieve the key. It must be accessible without authentication.

IsSslVerifyDisabled bool

Defines whether or not to uphold SSL verification.

Keys []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey

The set of static public keys.

MaxCacheDurationInHours int

The duration for which the introspect URL response should be cached before it is fetched again.

Type string

Type of the Response Cache Store Policy.

Uri string

The uri from which to retrieve the key. It must be accessible without authentication.

isSslVerifyDisabled Boolean

Defines whether or not to uphold SSL verification.

keys List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey>

The set of static public keys.

maxCacheDurationInHours Integer

The duration for which the introspect URL response should be cached before it is fetched again.

type String

Type of the Response Cache Store Policy.

uri String

The uri from which to retrieve the key. It must be accessible without authentication.

isSslVerifyDisabled boolean

Defines whether or not to uphold SSL verification.

keys GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey[]

The set of static public keys.

maxCacheDurationInHours number

The duration for which the introspect URL response should be cached before it is fetched again.

type string

Type of the Response Cache Store Policy.

uri string

The uri from which to retrieve the key. It must be accessible without authentication.

is_ssl_verify_disabled bool

Defines whether or not to uphold SSL verification.

keys GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey]

The set of static public keys.

max_cache_duration_in_hours int

The duration for which the introspect URL response should be cached before it is fetched again.

type str

Type of the Response Cache Store Policy.

uri str

The uri from which to retrieve the key. It must be accessible without authentication.

isSslVerifyDisabled Boolean

Defines whether or not to uphold SSL verification.

keys List<Property Map>

The set of static public keys.

maxCacheDurationInHours Number

The duration for which the introspect URL response should be cached before it is fetched again.

type String

Type of the Response Cache Store Policy.

uri String

The uri from which to retrieve the key. It must be accessible without authentication.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey

Alg string

The algorithm intended for use with this key.

E string

The base64 url encoded exponent of the RSA public key represented by this key.

Format string

The format of the public key.

Key string

Information around the values for selector of an authentication/ routing branch.

KeyOps List<string>

The operations for which this key is to be used.

Kid string

A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

Kty string

The key type.

N string

The base64 url encoded modulus of the RSA public key represented by this key.

Use string

The intended use of the public key.

Alg string

The algorithm intended for use with this key.

E string

The base64 url encoded exponent of the RSA public key represented by this key.

Format string

The format of the public key.

Key string

Information around the values for selector of an authentication/ routing branch.

KeyOps []string

The operations for which this key is to be used.

Kid string

A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

Kty string

The key type.

N string

The base64 url encoded modulus of the RSA public key represented by this key.

Use string

The intended use of the public key.

alg String

The algorithm intended for use with this key.

e String

The base64 url encoded exponent of the RSA public key represented by this key.

format String

The format of the public key.

key String

Information around the values for selector of an authentication/ routing branch.

keyOps List<String>

The operations for which this key is to be used.

kid String

A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

kty String

The key type.

n String

The base64 url encoded modulus of the RSA public key represented by this key.

use String

The intended use of the public key.

alg string

The algorithm intended for use with this key.

e string

The base64 url encoded exponent of the RSA public key represented by this key.

format string

The format of the public key.

key string

Information around the values for selector of an authentication/ routing branch.

keyOps string[]

The operations for which this key is to be used.

kid string

A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

kty string

The key type.

n string

The base64 url encoded modulus of the RSA public key represented by this key.

use string

The intended use of the public key.

alg str

The algorithm intended for use with this key.

e str

The base64 url encoded exponent of the RSA public key represented by this key.

format str

The format of the public key.

key str

Information around the values for selector of an authentication/ routing branch.

key_ops Sequence[str]

The operations for which this key is to be used.

kid str

A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

kty str

The key type.

n str

The base64 url encoded modulus of the RSA public key represented by this key.

use str

The intended use of the public key.

alg String

The algorithm intended for use with this key.

e String

The base64 url encoded exponent of the RSA public key represented by this key.

format String

The format of the public key.

key String

Information around the values for selector of an authentication/ routing branch.

keyOps List<String>

The operations for which this key is to be used.

kid String

A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

kty String

The key type.

n String

The base64 url encoded modulus of the RSA public key represented by this key.

use String

The intended use of the public key.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy

ClientDetails List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail>

Client App Credential details.

FallbackRedirectPath string

The path to be used as fallback after OAuth2.

LogoutPath string

The path to be used as logout.

MaxExpiryDurationInHours int

The duration for which the OAuth2 success token should be cached before it is fetched again.

ResponseCode string

HTTP response code, can include context variables.

ResponseHeaderTransformations List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation>

A set of transformations to apply to HTTP headers that pass through the gateway.

ResponseMessage string

HTTP response message.

ResponseType string

Response Type.

Scopes List<string>

List of scopes.

SourceUriDetails List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail>

Auth endpoint details.

Type string

Type of the Response Cache Store Policy.

UseCookiesForIntermediateSteps bool

Defines whether or not to use cookies for OAuth2 intermediate steps.

UseCookiesForSession bool

Defines whether or not to use cookies for session maintenance.

UsePkce bool

Defines whether or not to support PKCE.

ClientDetails []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail

Client App Credential details.

FallbackRedirectPath string

The path to be used as fallback after OAuth2.

LogoutPath string

The path to be used as logout.

MaxExpiryDurationInHours int

The duration for which the OAuth2 success token should be cached before it is fetched again.

ResponseCode string

HTTP response code, can include context variables.

ResponseHeaderTransformations []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation

A set of transformations to apply to HTTP headers that pass through the gateway.

ResponseMessage string

HTTP response message.

ResponseType string

Response Type.

Scopes []string

List of scopes.

SourceUriDetails []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail

Auth endpoint details.

Type string

Type of the Response Cache Store Policy.

UseCookiesForIntermediateSteps bool

Defines whether or not to use cookies for OAuth2 intermediate steps.

UseCookiesForSession bool

Defines whether or not to use cookies for session maintenance.

UsePkce bool

Defines whether or not to support PKCE.

clientDetails List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail>

Client App Credential details.

fallbackRedirectPath String

The path to be used as fallback after OAuth2.

logoutPath String

The path to be used as logout.

maxExpiryDurationInHours Integer

The duration for which the OAuth2 success token should be cached before it is fetched again.

responseCode String

HTTP response code, can include context variables.

responseHeaderTransformations List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation>

A set of transformations to apply to HTTP headers that pass through the gateway.

responseMessage String

HTTP response message.

responseType String

Response Type.

scopes List<String>

List of scopes.

sourceUriDetails List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail>

Auth endpoint details.

type String

Type of the Response Cache Store Policy.

useCookiesForIntermediateSteps Boolean

Defines whether or not to use cookies for OAuth2 intermediate steps.

useCookiesForSession Boolean

Defines whether or not to use cookies for session maintenance.

usePkce Boolean

Defines whether or not to support PKCE.

clientDetails GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail[]

Client App Credential details.

fallbackRedirectPath string

The path to be used as fallback after OAuth2.

logoutPath string

The path to be used as logout.

maxExpiryDurationInHours number

The duration for which the OAuth2 success token should be cached before it is fetched again.

responseCode string

HTTP response code, can include context variables.

responseHeaderTransformations GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation[]

A set of transformations to apply to HTTP headers that pass through the gateway.

responseMessage string

HTTP response message.

responseType string

Response Type.

scopes string[]

List of scopes.

sourceUriDetails GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail[]

Auth endpoint details.

type string

Type of the Response Cache Store Policy.

useCookiesForIntermediateSteps boolean

Defines whether or not to use cookies for OAuth2 intermediate steps.

useCookiesForSession boolean

Defines whether or not to use cookies for session maintenance.

usePkce boolean

Defines whether or not to support PKCE.

client_details GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail]

Client App Credential details.

fallback_redirect_path str

The path to be used as fallback after OAuth2.

logout_path str

The path to be used as logout.

max_expiry_duration_in_hours int

The duration for which the OAuth2 success token should be cached before it is fetched again.

response_code str

HTTP response code, can include context variables.

response_header_transformations GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation]

A set of transformations to apply to HTTP headers that pass through the gateway.

response_message str

HTTP response message.

response_type str

Response Type.

scopes Sequence[str]

List of scopes.

source_uri_details GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail]

Auth endpoint details.

type str

Type of the Response Cache Store Policy.

use_cookies_for_intermediate_steps bool

Defines whether or not to use cookies for OAuth2 intermediate steps.

use_cookies_for_session bool

Defines whether or not to use cookies for session maintenance.

use_pkce bool

Defines whether or not to support PKCE.

clientDetails List<Property Map>

Client App Credential details.

fallbackRedirectPath String

The path to be used as fallback after OAuth2.

logoutPath String

The path to be used as logout.

maxExpiryDurationInHours Number

The duration for which the OAuth2 success token should be cached before it is fetched again.

responseCode String

HTTP response code, can include context variables.

responseHeaderTransformations List<Property Map>

A set of transformations to apply to HTTP headers that pass through the gateway.

responseMessage String

HTTP response message.

responseType String

Response Type.

scopes List<String>

List of scopes.

sourceUriDetails List<Property Map>

Auth endpoint details.

type String

Type of the Response Cache Store Policy.

useCookiesForIntermediateSteps Boolean

Defines whether or not to use cookies for OAuth2 intermediate steps.

useCookiesForSession Boolean

Defines whether or not to use cookies for session maintenance.

usePkce Boolean

Defines whether or not to support PKCE.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail

ClientId string

Client ID for the OAuth2/OIDC app.

ClientSecretId string

The OCID of the Oracle Vault Service secret resource.

ClientSecretVersionNumber string

The version number of the client secret to use.

Type string

Type of the Response Cache Store Policy.

ClientId string

Client ID for the OAuth2/OIDC app.

ClientSecretId string

The OCID of the Oracle Vault Service secret resource.

ClientSecretVersionNumber string

The version number of the client secret to use.

Type string

Type of the Response Cache Store Policy.

clientId String

Client ID for the OAuth2/OIDC app.

clientSecretId String

The OCID of the Oracle Vault Service secret resource.

clientSecretVersionNumber String

The version number of the client secret to use.

type String

Type of the Response Cache Store Policy.

clientId string

Client ID for the OAuth2/OIDC app.

clientSecretId string

The OCID of the Oracle Vault Service secret resource.

clientSecretVersionNumber string

The version number of the client secret to use.

type string

Type of the Response Cache Store Policy.

client_id str

Client ID for the OAuth2/OIDC app.

client_secret_id str

The OCID of the Oracle Vault Service secret resource.

client_secret_version_number str

The version number of the client secret to use.

type str

Type of the Response Cache Store Policy.

clientId String

Client ID for the OAuth2/OIDC app.

clientSecretId String

The OCID of the Oracle Vault Service secret resource.

clientSecretVersionNumber String

The version number of the client secret to use.

type String

Type of the Response Cache Store Policy.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation

FilterHeaders 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 List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader>

Rename HTTP headers as they pass through the gateway.

SetHeaders List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader>

Set HTTP headers as they pass through the gateway.

FilterHeaders []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 []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader

Rename HTTP headers as they pass through the gateway.

SetHeaders []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader

Set HTTP headers as they pass through the gateway.

filterHeaders 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 List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader>

Rename HTTP headers as they pass through the gateway.

setHeaders List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader>

Set HTTP headers as they pass through the gateway.

filterHeaders 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 GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader[]

Rename HTTP headers as they pass through the gateway.

setHeaders GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader[]

Set HTTP headers as they pass through the gateway.

filter_headers 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 GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader]

Rename HTTP headers as they pass through the gateway.

set_headers GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader]

Set HTTP headers as they pass through the gateway.

filterHeaders 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 List<Property Map>

Rename HTTP headers as they pass through the gateway.

setHeaders List<Property Map>

Set HTTP headers as they pass through the gateway.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader

items List<Property Map>

The list of headers.

type String

Type of the Response Cache Store Policy.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

name string

The case-insensitive name of the header. This name must be unique across transformation policies.

name str

The case-insensitive name of the header. This name must be unique across transformation policies.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader

items List<Property Map>

The list of headers.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem

From string

The original case-insensitive name of the header. This name must be unique across transformation policies.

To string

The new name of the header. This name must be unique across transformation policies.

From string

The original case-insensitive name of the header. This name must be unique across transformation policies.

To string

The new name of the header. This name must be unique across transformation policies.

from String

The original case-insensitive name of the header. This name must be unique across transformation policies.

to String

The new name of the header. This name must be unique across transformation policies.

from string

The original case-insensitive name of the header. This name must be unique across transformation policies.

to string

The new name of the header. This name must be unique across transformation policies.

from_ str

The original case-insensitive name of the header. This name must be unique across transformation policies.

to str

The new name of the header. This name must be unique across transformation policies.

from String

The original case-insensitive name of the header. This name must be unique across transformation policies.

to String

The new name of the header. This name must be unique across transformation policies.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader

items List<Property Map>

The list of headers.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeaderItem

IfExists 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 string

The case-insensitive name of the header. This name must be unique across transformation policies.

Values List<string>

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

IfExists 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 string

The case-insensitive name of the header. This name must be unique across transformation policies.

Values []string

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

ifExists 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 String

The case-insensitive name of the header. This name must be unique across transformation policies.

values List<String>

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

ifExists 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 string

The case-insensitive name of the header. This name must be unique across transformation policies.

values string[]

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

if_exists 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 str

The case-insensitive name of the header. This name must be unique across transformation policies.

values Sequence[str]

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

ifExists 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 String

The case-insensitive name of the header. This name must be unique across transformation policies.

values 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 string

Type of the Response Cache Store Policy.

Uri string

The uri from which to retrieve the key. It must be accessible without authentication.

Type string

Type of the Response Cache Store Policy.

Uri string

The uri from which to retrieve the key. It must be accessible without authentication.

type String

Type of the Response Cache Store Policy.

uri String

The uri from which to retrieve the key. It must be accessible without authentication.

type string

Type of the Response Cache Store Policy.

uri string

The uri from which to retrieve the key. It must be accessible without authentication.

type str

Type of the Response Cache Store Policy.

uri str

The uri from which to retrieve the key. It must be accessible without authentication.

type String

Type of the Response Cache Store Policy.

uri String

The uri from which to retrieve the key. It must be accessible without authentication.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy

AdditionalValidationPolicies List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy>

Additional JWT validation checks.

ClientDetails List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail>

Client App Credential details.

IsSslVerifyDisabled bool

Defines whether or not to uphold SSL verification.

Keys List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey>

The set of static public keys.

MaxCacheDurationInHours int

The duration for which the introspect URL response should be cached before it is fetched again.

SourceUriDetails List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail>

Auth endpoint details.

Type string

Type of the Response Cache Store Policy.

Uri string

The uri from which to retrieve the key. It must be accessible without authentication.

AdditionalValidationPolicies []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy

Additional JWT validation checks.

ClientDetails []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail

Client App Credential details.

IsSslVerifyDisabled bool

Defines whether or not to uphold SSL verification.

Keys []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey

The set of static public keys.

MaxCacheDurationInHours int

The duration for which the introspect URL response should be cached before it is fetched again.

SourceUriDetails []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail

Auth endpoint details.

Type string

Type of the Response Cache Store Policy.

Uri string

The uri from which to retrieve the key. It must be accessible without authentication.

additionalValidationPolicies List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy>

Additional JWT validation checks.

clientDetails List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail>

Client App Credential details.

isSslVerifyDisabled Boolean

Defines whether or not to uphold SSL verification.

keys List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey>

The set of static public keys.

maxCacheDurationInHours Integer

The duration for which the introspect URL response should be cached before it is fetched again.

sourceUriDetails List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail>

Auth endpoint details.

type String

Type of the Response Cache Store Policy.

uri String

The uri from which to retrieve the key. It must be accessible without authentication.

additionalValidationPolicies GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy[]

Additional JWT validation checks.

clientDetails GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail[]

Client App Credential details.

isSslVerifyDisabled boolean

Defines whether or not to uphold SSL verification.

keys GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey[]

The set of static public keys.

maxCacheDurationInHours number

The duration for which the introspect URL response should be cached before it is fetched again.

sourceUriDetails GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail[]

Auth endpoint details.

type string

Type of the Response Cache Store Policy.

uri string

The uri from which to retrieve the key. It must be accessible without authentication.

additional_validation_policies GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy]

Additional JWT validation checks.

client_details GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail]

Client App Credential details.

is_ssl_verify_disabled bool

Defines whether or not to uphold SSL verification.

keys GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey]

The set of static public keys.

max_cache_duration_in_hours int

The duration for which the introspect URL response should be cached before it is fetched again.

source_uri_details GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail]

Auth endpoint details.

type str

Type of the Response Cache Store Policy.

uri str

The uri from which to retrieve the key. It must be accessible without authentication.

additionalValidationPolicies List<Property Map>

Additional JWT validation checks.

clientDetails List<Property Map>

Client App Credential details.

isSslVerifyDisabled Boolean

Defines whether or not to uphold SSL verification.

keys List<Property Map>

The set of static public keys.

maxCacheDurationInHours Number

The duration for which the introspect URL response should be cached before it is fetched again.

sourceUriDetails List<Property Map>

Auth endpoint details.

type String

Type of the Response Cache Store Policy.

uri String

The uri from which to retrieve the key. It must be accessible without authentication.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy

Audiences List<string>

The list of intended recipients for the token.

Issuers List<string>

A list of parties that could have issued the token.

VerifyClaims List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim>

A list of claims which should be validated to consider the token valid.

Audiences []string

The list of intended recipients for the token.

Issuers []string

A list of parties that could have issued the token.

VerifyClaims []GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim

A list of claims which should be validated to consider the token valid.

audiences List<String>

The list of intended recipients for the token.

issuers List<String>

A list of parties that could have issued the token.

verifyClaims List<GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim>

A list of claims which should be validated to consider the token valid.

audiences string[]

The list of intended recipients for the token.

issuers string[]

A list of parties that could have issued the token.

verifyClaims GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim[]

A list of claims which should be validated to consider the token valid.

audiences Sequence[str]

The list of intended recipients for the token.

issuers Sequence[str]

A list of parties that could have issued the token.

verify_claims GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim]

A list of claims which should be validated to consider the token valid.

audiences List<String>

The list of intended recipients for the token.

issuers List<String>

A list of parties that could have issued the token.

verifyClaims List<Property Map>

A list of claims which should be validated to consider the token valid.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim

IsRequired 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 string

Information around the values for selector of an authentication/ routing branch.

Values List<string>

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

IsRequired 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 string

Information around the values for selector of an authentication/ routing branch.

Values []string

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

isRequired 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 String

Information around the values for selector of an authentication/ routing branch.

values List<String>

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

isRequired 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 string

Information around the values for selector of an authentication/ routing branch.

values string[]

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

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 str

Information around the values for selector of an authentication/ routing branch.

values Sequence[str]

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

isRequired 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 String

Information around the values for selector of an authentication/ routing branch.

values 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 string

Client ID for the OAuth2/OIDC app.

ClientSecretId string

The OCID of the Oracle Vault Service secret resource.

ClientSecretVersionNumber string

The version number of the client secret to use.

Type string

Type of the Response Cache Store Policy.

ClientId string

Client ID for the OAuth2/OIDC app.

ClientSecretId string

The OCID of the Oracle Vault Service secret resource.

ClientSecretVersionNumber string

The version number of the client secret to use.

Type string

Type of the Response Cache Store Policy.

clientId String

Client ID for the OAuth2/OIDC app.

clientSecretId String

The OCID of the Oracle Vault Service secret resource.

clientSecretVersionNumber String

The version number of the client secret to use.

type String

Type of the Response Cache Store Policy.

clientId string

Client ID for the OAuth2/OIDC app.

clientSecretId string

The OCID of the Oracle Vault Service secret resource.

clientSecretVersionNumber string

The version number of the client secret to use.

type string

Type of the Response Cache Store Policy.

client_id str

Client ID for the OAuth2/OIDC app.

client_secret_id str

The OCID of the Oracle Vault Service secret resource.

client_secret_version_number str

The version number of the client secret to use.

type str

Type of the Response Cache Store Policy.

clientId String

Client ID for the OAuth2/OIDC app.

clientSecretId String

The OCID of the Oracle Vault Service secret resource.

clientSecretVersionNumber String

The version number of the client secret to use.

type String

Type of the Response Cache Store Policy.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey

Alg string

The algorithm intended for use with this key.

E string

The base64 url encoded exponent of the RSA public key represented by this key.

Format string

The format of the public key.

Key string

Information around the values for selector of an authentication/ routing branch.

KeyOps List<string>

The operations for which this key is to be used.

Kid string

A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

Kty string

The key type.

N string

The base64 url encoded modulus of the RSA public key represented by this key.

Use string

The intended use of the public key.

Alg string

The algorithm intended for use with this key.

E string

The base64 url encoded exponent of the RSA public key represented by this key.

Format string

The format of the public key.

Key string

Information around the values for selector of an authentication/ routing branch.

KeyOps []string

The operations for which this key is to be used.

Kid string

A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

Kty string

The key type.

N string

The base64 url encoded modulus of the RSA public key represented by this key.

Use string

The intended use of the public key.

alg String

The algorithm intended for use with this key.

e String

The base64 url encoded exponent of the RSA public key represented by this key.

format String

The format of the public key.

key String

Information around the values for selector of an authentication/ routing branch.

keyOps List<String>

The operations for which this key is to be used.

kid String

A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

kty String

The key type.

n String

The base64 url encoded modulus of the RSA public key represented by this key.

use String

The intended use of the public key.

alg string

The algorithm intended for use with this key.

e string

The base64 url encoded exponent of the RSA public key represented by this key.

format string

The format of the public key.

key string

Information around the values for selector of an authentication/ routing branch.

keyOps string[]

The operations for which this key is to be used.

kid string

A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

kty string

The key type.

n string

The base64 url encoded modulus of the RSA public key represented by this key.

use string

The intended use of the public key.

alg str

The algorithm intended for use with this key.

e str

The base64 url encoded exponent of the RSA public key represented by this key.

format str

The format of the public key.

key str

Information around the values for selector of an authentication/ routing branch.

key_ops Sequence[str]

The operations for which this key is to be used.

kid str

A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

kty str

The key type.

n str

The base64 url encoded modulus of the RSA public key represented by this key.

use str

The intended use of the public key.

alg String

The algorithm intended for use with this key.

e String

The base64 url encoded exponent of the RSA public key represented by this key.

format String

The format of the public key.

key String

Information around the values for selector of an authentication/ routing branch.

keyOps List<String>

The operations for which this key is to be used.

kid String

A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

kty String

The key type.

n String

The base64 url encoded modulus of the RSA public key represented by this key.

use String

The intended use of the public key.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail

Type string

Type of the Response Cache Store Policy.

Uri string

The uri from which to retrieve the key. It must be accessible without authentication.

Type string

Type of the Response Cache Store Policy.

Uri string

The uri from which to retrieve the key. It must be accessible without authentication.

type String

Type of the Response Cache Store Policy.

uri String

The uri from which to retrieve the key. It must be accessible without authentication.

type string

Type of the Response Cache Store Policy.

uri string

The uri from which to retrieve the key. It must be accessible without authentication.

type str

Type of the Response Cache Store Policy.

uri str

The uri from which to retrieve the key. It must be accessible without authentication.

type String

Type of the Response Cache Store Policy.

uri String

The uri from which to retrieve the key. It must be accessible without authentication.

GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim

IsRequired 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 string

Information around the values for selector of an authentication/ routing branch.

Values List<string>

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

IsRequired 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 string

Information around the values for selector of an authentication/ routing branch.

Values []string

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

isRequired 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 String

Information around the values for selector of an authentication/ routing branch.

values List<String>

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

isRequired 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 string

Information around the values for selector of an authentication/ routing branch.

values string[]

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

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 str

Information around the values for selector of an authentication/ routing branch.

values Sequence[str]

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

isRequired 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 String

Information around the values for selector of an authentication/ routing branch.

values 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 string

String describing the expression with wildcards.

IsDefault bool

Information regarding whether this is the default branch.

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

Type string

Type of the Response Cache Store Policy.

Values List<string>

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

Expression string

String describing the expression with wildcards.

IsDefault bool

Information regarding whether this is the default branch.

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

Type string

Type of the Response Cache Store Policy.

Values []string

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

expression String

String describing the expression with wildcards.

isDefault Boolean

Information regarding whether this is the default branch.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

type String

Type of the Response Cache Store Policy.

values List<String>

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

expression string

String describing the expression with wildcards.

isDefault boolean

Information regarding whether this is the default branch.

name string

The case-insensitive name of the header. This name must be unique across transformation policies.

type string

Type of the Response Cache Store Policy.

values string[]

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

expression str

String describing the expression with wildcards.

is_default bool

Information regarding whether this is the default branch.

name str

The case-insensitive name of the header. This name must be unique across transformation policies.

type str

Type of the Response Cache Store Policy.

values Sequence[str]

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

expression String

String describing the expression with wildcards.

isDefault Boolean

Information regarding whether this is the default branch.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

type String

Type of the Response Cache Store Policy.

values 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 string

String describing the context variable used as selector.

Type string

Type of the Response Cache Store Policy.

Selector string

String describing the context variable used as selector.

Type string

Type of the Response Cache Store Policy.

selector String

String describing the context variable used as selector.

type String

Type of the Response Cache Store Policy.

selector string

String describing the context variable used as selector.

type string

Type of the Response Cache Store Policy.

selector str

String describing the context variable used as selector.

type str

Type of the Response Cache Store Policy.

selector String

String describing the context variable used as selector.

type String

Type of the Response Cache Store Policy.

GetDeploymentSpecificationRequestPolicyMutualTl

AllowedSans List<string>

Allowed list of CN or SAN which will be used for verification of certificate.

IsVerifiedCertificateRequired bool

Determines whether to enable client verification when API Consumer makes connection to the gateway.

AllowedSans []string

Allowed list of CN or SAN which will be used for verification of certificate.

IsVerifiedCertificateRequired bool

Determines whether to enable client verification when API Consumer makes connection to the gateway.

allowedSans List<String>

Allowed list of CN or SAN which will be used for verification of certificate.

isVerifiedCertificateRequired Boolean

Determines whether to enable client verification when API Consumer makes connection to the gateway.

allowedSans string[]

Allowed list of CN or SAN which will be used for verification of certificate.

isVerifiedCertificateRequired boolean

Determines whether to enable client verification when API Consumer makes connection to the gateway.

allowed_sans Sequence[str]

Allowed list of CN or SAN which will be used for verification of certificate.

is_verified_certificate_required bool

Determines whether to enable client verification when API Consumer makes connection to the gateway.

allowedSans List<String>

Allowed list of CN or SAN which will be used for verification of certificate.

isVerifiedCertificateRequired Boolean

Determines whether to enable client verification when API Consumer makes connection to the gateway.

GetDeploymentSpecificationRequestPolicyRateLimiting

RateInRequestsPerSecond int

The maximum number of requests per second to allow.

RateKey string

The key used to group requests together.

RateInRequestsPerSecond int

The maximum number of requests per second to allow.

RateKey string

The key used to group requests together.

rateInRequestsPerSecond Integer

The maximum number of requests per second to allow.

rateKey String

The key used to group requests together.

rateInRequestsPerSecond number

The maximum number of requests per second to allow.

rateKey string

The key used to group requests together.

rate_in_requests_per_second int

The maximum number of requests per second to allow.

rate_key str

The key used to group requests together.

rateInRequestsPerSecond Number

The maximum number of requests per second to allow.

rateKey String

The key used to group requests together.

GetDeploymentSpecificationRequestPolicyUsagePlan

TokenLocations 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 []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 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 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 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 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 List<GetDeploymentSpecificationRouteBackend>

The backend to forward requests to.

LoggingPolicies List<GetDeploymentSpecificationRouteLoggingPolicy>

Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.

Methods List<string>

A list of allowed methods on this route.

Path 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 List<GetDeploymentSpecificationRouteRequestPolicy>

Behavior applied to any requests received by the API on this route.

ResponsePolicies List<GetDeploymentSpecificationRouteResponsePolicy>

Behavior applied to any responses sent by the API for requests on this route.

Backends []GetDeploymentSpecificationRouteBackend

The backend to forward requests to.

LoggingPolicies []GetDeploymentSpecificationRouteLoggingPolicy

Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.

Methods []string

A list of allowed methods on this route.

Path 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 []GetDeploymentSpecificationRouteRequestPolicy

Behavior applied to any requests received by the API on this route.

ResponsePolicies []GetDeploymentSpecificationRouteResponsePolicy

Behavior applied to any responses sent by the API for requests on this route.

backends List<GetDeploymentSpecificationRouteBackend>

The backend to forward requests to.

loggingPolicies List<GetDeploymentSpecificationRouteLoggingPolicy>

Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.

methods List<String>

A list of allowed methods on this route.

path 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 List<GetDeploymentSpecificationRouteRequestPolicy>

Behavior applied to any requests received by the API on this route.

responsePolicies List<GetDeploymentSpecificationRouteResponsePolicy>

Behavior applied to any responses sent by the API for requests on this route.

backends GetDeploymentSpecificationRouteBackend[]

The backend to forward requests to.

loggingPolicies GetDeploymentSpecificationRouteLoggingPolicy[]

Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.

methods string[]

A list of allowed methods on this route.

path 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 GetDeploymentSpecificationRouteRequestPolicy[]

Behavior applied to any requests received by the API on this route.

responsePolicies GetDeploymentSpecificationRouteResponsePolicy[]

Behavior applied to any responses sent by the API for requests on this route.

backends GetDeploymentSpecificationRouteBackend]

The backend to forward requests to.

logging_policies GetDeploymentSpecificationRouteLoggingPolicy]

Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.

methods Sequence[str]

A list of allowed methods on this route.

path 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 GetDeploymentSpecificationRouteRequestPolicy]

Behavior applied to any requests received by the API on this route.

response_policies GetDeploymentSpecificationRouteResponsePolicy]

Behavior applied to any responses sent by the API for requests on this route.

backends List<Property Map>

The backend to forward requests to.

loggingPolicies List<Property Map>

Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.

methods List<String>

A list of allowed methods on this route.

path 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 List<Property Map>

Behavior applied to any requests received by the API on this route.

responsePolicies List<Property Map>

Behavior applied to any responses sent by the API for requests on this route.

GetDeploymentSpecificationRouteBackend

AllowedPostLogoutUris List<string>
Body string

The body of the stock response from the mock backend.

ConnectTimeoutInSeconds double

Defines a timeout for establishing a connection with a proxied server.

FunctionId string

The OCID of the Oracle Functions function resource.

Headers List<GetDeploymentSpecificationRouteBackendHeader>
IsSslVerifyDisabled bool

Defines whether or not to uphold SSL verification.

PostLogoutState string

Defines a state that should be shared on redirecting to postLogout URL.

ReadTimeoutInSeconds double

Defines a timeout for reading a response from the proxied server.

RoutingBackends List<GetDeploymentSpecificationRouteBackendRoutingBackend>

List of backends to chose from for Dynamic Routing.

SelectionSources List<GetDeploymentSpecificationRouteBackendSelectionSource>

Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.

SendTimeoutInSeconds double

Defines a timeout for transmitting a request to the proxied server.

Status int

The status code of the stock response from the mock backend.

Type string

Type of the Response Cache Store Policy.

Url string
AllowedPostLogoutUris []string
Body string

The body of the stock response from the mock backend.

ConnectTimeoutInSeconds float64

Defines a timeout for establishing a connection with a proxied server.

FunctionId string

The OCID of the Oracle Functions function resource.

Headers []GetDeploymentSpecificationRouteBackendHeader
IsSslVerifyDisabled bool

Defines whether or not to uphold SSL verification.

PostLogoutState string

Defines a state that should be shared on redirecting to postLogout URL.

ReadTimeoutInSeconds float64

Defines a timeout for reading a response from the proxied server.

RoutingBackends []GetDeploymentSpecificationRouteBackendRoutingBackend

List of backends to chose from for Dynamic Routing.

SelectionSources []GetDeploymentSpecificationRouteBackendSelectionSource

Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.

SendTimeoutInSeconds float64

Defines a timeout for transmitting a request to the proxied server.

Status int

The status code of the stock response from the mock backend.

Type string

Type of the Response Cache Store Policy.

Url string
allowedPostLogoutUris List<String>
body String

The body of the stock response from the mock backend.

connectTimeoutInSeconds Double

Defines a timeout for establishing a connection with a proxied server.

functionId String

The OCID of the Oracle Functions function resource.

headers List<GetDeploymentSpecificationRouteBackendHeader>
isSslVerifyDisabled Boolean

Defines whether or not to uphold SSL verification.

postLogoutState String

Defines a state that should be shared on redirecting to postLogout URL.

readTimeoutInSeconds Double

Defines a timeout for reading a response from the proxied server.

routingBackends List<GetDeploymentSpecificationRouteBackendRoutingBackend>

List of backends to chose from for Dynamic Routing.

selectionSources List<GetDeploymentSpecificationRouteBackendSelectionSource>

Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.

sendTimeoutInSeconds Double

Defines a timeout for transmitting a request to the proxied server.

status Integer

The status code of the stock response from the mock backend.

type String

Type of the Response Cache Store Policy.

url String
allowedPostLogoutUris string[]
body string

The body of the stock response from the mock backend.

connectTimeoutInSeconds number

Defines a timeout for establishing a connection with a proxied server.

functionId string

The OCID of the Oracle Functions function resource.

headers GetDeploymentSpecificationRouteBackendHeader[]
isSslVerifyDisabled boolean

Defines whether or not to uphold SSL verification.

postLogoutState string

Defines a state that should be shared on redirecting to postLogout URL.

readTimeoutInSeconds number

Defines a timeout for reading a response from the proxied server.

routingBackends GetDeploymentSpecificationRouteBackendRoutingBackend[]

List of backends to chose from for Dynamic Routing.

selectionSources GetDeploymentSpecificationRouteBackendSelectionSource[]

Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.

sendTimeoutInSeconds number

Defines a timeout for transmitting a request to the proxied server.

status number

The status code of the stock response from the mock backend.

type string

Type of the Response Cache Store Policy.

url string
allowed_post_logout_uris Sequence[str]
body str

The body of the stock response from the mock backend.

connect_timeout_in_seconds float

Defines a timeout for establishing a connection with a proxied server.

function_id str

The OCID of the Oracle Functions function resource.

headers GetDeploymentSpecificationRouteBackendHeader]
is_ssl_verify_disabled bool

Defines whether or not to uphold SSL verification.

post_logout_state str

Defines a state that should be shared on redirecting to postLogout URL.

read_timeout_in_seconds float

Defines a timeout for reading a response from the proxied server.

routing_backends GetDeploymentSpecificationRouteBackendRoutingBackend]

List of backends to chose from for Dynamic Routing.

selection_sources GetDeploymentSpecificationRouteBackendSelectionSource]

Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.

send_timeout_in_seconds float

Defines a timeout for transmitting a request to the proxied server.

status int

The status code of the stock response from the mock backend.

type str

Type of the Response Cache Store Policy.

url str
allowedPostLogoutUris List<String>
body String

The body of the stock response from the mock backend.

connectTimeoutInSeconds Number

Defines a timeout for establishing a connection with a proxied server.

functionId String

The OCID of the Oracle Functions function resource.

headers List<Property Map>
isSslVerifyDisabled Boolean

Defines whether or not to uphold SSL verification.

postLogoutState String

Defines a state that should be shared on redirecting to postLogout URL.

readTimeoutInSeconds Number

Defines a timeout for reading a response from the proxied server.

routingBackends List<Property Map>

List of backends to chose from for Dynamic Routing.

selectionSources List<Property Map>

Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.

sendTimeoutInSeconds Number

Defines a timeout for transmitting a request to the proxied server.

status Number

The status code of the stock response from the mock backend.

type String

Type of the Response Cache Store Policy.

url String

GetDeploymentSpecificationRouteBackendHeader

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

Value string

Value of the header.

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

Value string

Value of the header.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

value String

Value of the header.

name string

The case-insensitive name of the header. This name must be unique across transformation policies.

value string

Value of the header.

name str

The case-insensitive name of the header. This name must be unique across transformation policies.

value str

Value of the header.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

value String

Value of the header.

GetDeploymentSpecificationRouteBackendRoutingBackend

Backends List<GetDeploymentSpecificationRouteBackendRoutingBackendBackend>

The backend to forward requests to.

Keys List<GetDeploymentSpecificationRouteBackendRoutingBackendKey>

Information around the values for selector of an authentication/ routing branch.

Backends []GetDeploymentSpecificationRouteBackendRoutingBackendBackend

The backend to forward requests to.

Keys []GetDeploymentSpecificationRouteBackendRoutingBackendKey

Information around the values for selector of an authentication/ routing branch.

backends List<GetDeploymentSpecificationRouteBackendRoutingBackendBackend>

The backend to forward requests to.

keys List<GetDeploymentSpecificationRouteBackendRoutingBackendKey>

Information around the values for selector of an authentication/ routing branch.

backends GetDeploymentSpecificationRouteBackendRoutingBackendBackend[]

The backend to forward requests to.

keys GetDeploymentSpecificationRouteBackendRoutingBackendKey[]

Information around the values for selector of an authentication/ routing branch.

backends GetDeploymentSpecificationRouteBackendRoutingBackendBackend]

The backend to forward requests to.

keys GetDeploymentSpecificationRouteBackendRoutingBackendKey]

Information around the values for selector of an authentication/ routing branch.

backends List<Property Map>

The backend to forward requests to.

keys List<Property Map>

Information around the values for selector of an authentication/ routing branch.

GetDeploymentSpecificationRouteBackendRoutingBackendBackend

Body string

The body of the stock response from the mock backend.

ConnectTimeoutInSeconds double

Defines a timeout for establishing a connection with a proxied server.

FunctionId string

The OCID of the Oracle Functions function resource.

Headers List<GetDeploymentSpecificationRouteBackendRoutingBackendBackendHeader>
IsSslVerifyDisabled bool

Defines whether or not to uphold SSL verification.

ReadTimeoutInSeconds double

Defines a timeout for reading a response from the proxied server.

SendTimeoutInSeconds double

Defines a timeout for transmitting a request to the proxied server.

Status int

The status code of the stock response from the mock backend.

Type string

Type of the Response Cache Store Policy.

Url string
Body string

The body of the stock response from the mock backend.

ConnectTimeoutInSeconds float64

Defines a timeout for establishing a connection with a proxied server.

FunctionId string

The OCID of the Oracle Functions function resource.

Headers []GetDeploymentSpecificationRouteBackendRoutingBackendBackendHeader
IsSslVerifyDisabled bool

Defines whether or not to uphold SSL verification.

ReadTimeoutInSeconds float64

Defines a timeout for reading a response from the proxied server.

SendTimeoutInSeconds float64

Defines a timeout for transmitting a request to the proxied server.

Status int

The status code of the stock response from the mock backend.

Type string

Type of the Response Cache Store Policy.

Url string
body String

The body of the stock response from the mock backend.

connectTimeoutInSeconds Double

Defines a timeout for establishing a connection with a proxied server.

functionId String

The OCID of the Oracle Functions function resource.

headers List<GetDeploymentSpecificationRouteBackendRoutingBackendBackendHeader>
isSslVerifyDisabled Boolean

Defines whether or not to uphold SSL verification.

readTimeoutInSeconds Double

Defines a timeout for reading a response from the proxied server.

sendTimeoutInSeconds Double

Defines a timeout for transmitting a request to the proxied server.

status Integer

The status code of the stock response from the mock backend.

type String

Type of the Response Cache Store Policy.

url String
body string

The body of the stock response from the mock backend.

connectTimeoutInSeconds number

Defines a timeout for establishing a connection with a proxied server.

functionId string

The OCID of the Oracle Functions function resource.

headers GetDeploymentSpecificationRouteBackendRoutingBackendBackendHeader[]
isSslVerifyDisabled boolean

Defines whether or not to uphold SSL verification.

readTimeoutInSeconds number

Defines a timeout for reading a response from the proxied server.

sendTimeoutInSeconds number

Defines a timeout for transmitting a request to the proxied server.

status number

The status code of the stock response from the mock backend.

type string

Type of the Response Cache Store Policy.

url string
body str

The body of the stock response from the mock backend.

connect_timeout_in_seconds float

Defines a timeout for establishing a connection with a proxied server.

function_id str

The OCID of the Oracle Functions function resource.

headers GetDeploymentSpecificationRouteBackendRoutingBackendBackendHeader]
is_ssl_verify_disabled bool

Defines whether or not to uphold SSL verification.

read_timeout_in_seconds float

Defines a timeout for reading a response from the proxied server.

send_timeout_in_seconds float

Defines a timeout for transmitting a request to the proxied server.

status int

The status code of the stock response from the mock backend.

type str

Type of the Response Cache Store Policy.

url str
body String

The body of the stock response from the mock backend.

connectTimeoutInSeconds Number

Defines a timeout for establishing a connection with a proxied server.

functionId String

The OCID of the Oracle Functions function resource.

headers List<Property Map>
isSslVerifyDisabled Boolean

Defines whether or not to uphold SSL verification.

readTimeoutInSeconds Number

Defines a timeout for reading a response from the proxied server.

sendTimeoutInSeconds Number

Defines a timeout for transmitting a request to the proxied server.

status Number

The status code of the stock response from the mock backend.

type String

Type of the Response Cache Store Policy.

url String

GetDeploymentSpecificationRouteBackendRoutingBackendBackendHeader

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

Value string

Value of the header.

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

Value string

Value of the header.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

value String

Value of the header.

name string

The case-insensitive name of the header. This name must be unique across transformation policies.

value string

Value of the header.

name str

The case-insensitive name of the header. This name must be unique across transformation policies.

value str

Value of the header.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

value String

Value of the header.

GetDeploymentSpecificationRouteBackendRoutingBackendKey

Expression string

String describing the expression with wildcards.

IsDefault bool

Information regarding whether this is the default branch.

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

Type string

Type of the Response Cache Store Policy.

Values List<string>

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

Expression string

String describing the expression with wildcards.

IsDefault bool

Information regarding whether this is the default branch.

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

Type string

Type of the Response Cache Store Policy.

Values []string

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

expression String

String describing the expression with wildcards.

isDefault Boolean

Information regarding whether this is the default branch.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

type String

Type of the Response Cache Store Policy.

values List<String>

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

expression string

String describing the expression with wildcards.

isDefault boolean

Information regarding whether this is the default branch.

name string

The case-insensitive name of the header. This name must be unique across transformation policies.

type string

Type of the Response Cache Store Policy.

values string[]

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

expression str

String describing the expression with wildcards.

is_default bool

Information regarding whether this is the default branch.

name str

The case-insensitive name of the header. This name must be unique across transformation policies.

type str

Type of the Response Cache Store Policy.

values Sequence[str]

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

expression String

String describing the expression with wildcards.

isDefault Boolean

Information regarding whether this is the default branch.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

type String

Type of the Response Cache Store Policy.

values 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 string

String describing the context variable used as selector.

Type string

Type of the Response Cache Store Policy.

Selector string

String describing the context variable used as selector.

Type string

Type of the Response Cache Store Policy.

selector String

String describing the context variable used as selector.

type String

Type of the Response Cache Store Policy.

selector string

String describing the context variable used as selector.

type string

Type of the Response Cache Store Policy.

selector str

String describing the context variable used as selector.

type str

Type of the Response Cache Store Policy.

selector String

String describing the context variable used as selector.

type String

Type of the Response Cache Store Policy.

GetDeploymentSpecificationRouteLoggingPolicy

AccessLogs List<GetDeploymentSpecificationRouteLoggingPolicyAccessLog>

Configures the logging policies for the access logs of an API Deployment.

ExecutionLogs List<GetDeploymentSpecificationRouteLoggingPolicyExecutionLog>

Configures the logging policies for the execution logs of an API Deployment.

AccessLogs []GetDeploymentSpecificationRouteLoggingPolicyAccessLog

Configures the logging policies for the access logs of an API Deployment.

ExecutionLogs []GetDeploymentSpecificationRouteLoggingPolicyExecutionLog

Configures the logging policies for the execution logs of an API Deployment.

accessLogs List<GetDeploymentSpecificationRouteLoggingPolicyAccessLog>

Configures the logging policies for the access logs of an API Deployment.

executionLogs List<GetDeploymentSpecificationRouteLoggingPolicyExecutionLog>

Configures the logging policies for the execution logs of an API Deployment.

accessLogs GetDeploymentSpecificationRouteLoggingPolicyAccessLog[]

Configures the logging policies for the access logs of an API Deployment.

executionLogs GetDeploymentSpecificationRouteLoggingPolicyExecutionLog[]

Configures the logging policies for the execution logs of an API Deployment.

access_logs GetDeploymentSpecificationRouteLoggingPolicyAccessLog]

Configures the logging policies for the access logs of an API Deployment.

execution_logs GetDeploymentSpecificationRouteLoggingPolicyExecutionLog]

Configures the logging policies for the execution logs of an API Deployment.

accessLogs List<Property Map>

Configures the logging policies for the access logs of an API Deployment.

executionLogs List<Property Map>

Configures the logging policies for the execution logs of an API Deployment.

GetDeploymentSpecificationRouteLoggingPolicyAccessLog

IsEnabled bool

Whether this policy is currently enabled.

IsEnabled bool

Whether this policy is currently enabled.

isEnabled Boolean

Whether this policy is currently enabled.

isEnabled boolean

Whether this policy is currently enabled.

is_enabled bool

Whether this policy is currently enabled.

isEnabled Boolean

Whether this policy is currently enabled.

GetDeploymentSpecificationRouteLoggingPolicyExecutionLog

IsEnabled bool

Whether this policy is currently enabled.

LogLevel 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 bool

Whether this policy is currently enabled.

LogLevel 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 Boolean

Whether this policy is currently enabled.

logLevel 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 boolean

Whether this policy is currently enabled.

logLevel 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 bool

Whether this policy is currently enabled.

log_level 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 Boolean

Whether this policy is currently enabled.

logLevel 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 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 List<GetDeploymentSpecificationRouteRequestPolicyBodyValidation>

Validate the payload body of the incoming API requests on a specific route.

Cors List<GetDeploymentSpecificationRouteRequestPolicyCor>

Enable CORS (Cross-Origin-Resource-Sharing) request handling.

HeaderTransformations List<GetDeploymentSpecificationRouteRequestPolicyHeaderTransformation>

A set of transformations to apply to HTTP headers that pass through the gateway.

HeaderValidations List<GetDeploymentSpecificationRouteRequestPolicyHeaderValidation>

Validate the HTTP headers on the incoming API requests on a specific route.

QueryParameterTransformations List<GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation>

A set of transformations to apply to query parameters that pass through the gateway.

QueryParameterValidations List<GetDeploymentSpecificationRouteRequestPolicyQueryParameterValidation>

Validate the URL query parameters on the incoming API requests on a specific route.

ResponseCacheLookups List<GetDeploymentSpecificationRouteRequestPolicyResponseCacheLookup>

Base policy for Response Cache lookup.

Authorizations []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 []GetDeploymentSpecificationRouteRequestPolicyBodyValidation

Validate the payload body of the incoming API requests on a specific route.

Cors []GetDeploymentSpecificationRouteRequestPolicyCor

Enable CORS (Cross-Origin-Resource-Sharing) request handling.

HeaderTransformations []GetDeploymentSpecificationRouteRequestPolicyHeaderTransformation

A set of transformations to apply to HTTP headers that pass through the gateway.

HeaderValidations []GetDeploymentSpecificationRouteRequestPolicyHeaderValidation

Validate the HTTP headers on the incoming API requests on a specific route.

QueryParameterTransformations []GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation

A set of transformations to apply to query parameters that pass through the gateway.

QueryParameterValidations []GetDeploymentSpecificationRouteRequestPolicyQueryParameterValidation

Validate the URL query parameters on the incoming API requests on a specific route.

ResponseCacheLookups []GetDeploymentSpecificationRouteRequestPolicyResponseCacheLookup

Base policy for Response Cache lookup.

authorizations 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 List<GetDeploymentSpecificationRouteRequestPolicyBodyValidation>

Validate the payload body of the incoming API requests on a specific route.

cors List<GetDeploymentSpecificationRouteRequestPolicyCor>

Enable CORS (Cross-Origin-Resource-Sharing) request handling.

headerTransformations List<GetDeploymentSpecificationRouteRequestPolicyHeaderTransformation>

A set of transformations to apply to HTTP headers that pass through the gateway.

headerValidations List<GetDeploymentSpecificationRouteRequestPolicyHeaderValidation>

Validate the HTTP headers on the incoming API requests on a specific route.

queryParameterTransformations List<GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation>

A set of transformations to apply to query parameters that pass through the gateway.

queryParameterValidations List<GetDeploymentSpecificationRouteRequestPolicyQueryParameterValidation>

Validate the URL query parameters on the incoming API requests on a specific route.

responseCacheLookups List<GetDeploymentSpecificationRouteRequestPolicyResponseCacheLookup>

Base policy for Response Cache lookup.

authorizations 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 GetDeploymentSpecificationRouteRequestPolicyBodyValidation[]

Validate the payload body of the incoming API requests on a specific route.

cors GetDeploymentSpecificationRouteRequestPolicyCor[]

Enable CORS (Cross-Origin-Resource-Sharing) request handling.

headerTransformations GetDeploymentSpecificationRouteRequestPolicyHeaderTransformation[]

A set of transformations to apply to HTTP headers that pass through the gateway.

headerValidations GetDeploymentSpecificationRouteRequestPolicyHeaderValidation[]

Validate the HTTP headers on the incoming API requests on a specific route.

queryParameterTransformations GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation[]

A set of transformations to apply to query parameters that pass through the gateway.

queryParameterValidations GetDeploymentSpecificationRouteRequestPolicyQueryParameterValidation[]

Validate the URL query parameters on the incoming API requests on a specific route.

responseCacheLookups GetDeploymentSpecificationRouteRequestPolicyResponseCacheLookup[]

Base policy for Response Cache lookup.

authorizations 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 GetDeploymentSpecificationRouteRequestPolicyBodyValidation]

Validate the payload body of the incoming API requests on a specific route.

cors GetDeploymentSpecificationRouteRequestPolicyCor]

Enable CORS (Cross-Origin-Resource-Sharing) request handling.

header_transformations GetDeploymentSpecificationRouteRequestPolicyHeaderTransformation]

A set of transformations to apply to HTTP headers that pass through the gateway.

header_validations GetDeploymentSpecificationRouteRequestPolicyHeaderValidation]

Validate the HTTP headers on the incoming API requests on a specific route.

query_parameter_transformations GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation]

A set of transformations to apply to query parameters that pass through the gateway.

query_parameter_validations GetDeploymentSpecificationRouteRequestPolicyQueryParameterValidation]

Validate the URL query parameters on the incoming API requests on a specific route.

response_cache_lookups GetDeploymentSpecificationRouteRequestPolicyResponseCacheLookup]

Base policy for Response Cache lookup.

authorizations 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 List<Property Map>

Validate the payload body of the incoming API requests on a specific route.

cors List<Property Map>

Enable CORS (Cross-Origin-Resource-Sharing) request handling.

headerTransformations List<Property Map>

A set of transformations to apply to HTTP headers that pass through the gateway.

headerValidations List<Property Map>

Validate the HTTP headers on the incoming API requests on a specific route.

queryParameterTransformations List<Property Map>

A set of transformations to apply to query parameters that pass through the gateway.

queryParameterValidations List<Property Map>

Validate the URL query parameters on the incoming API requests on a specific route.

responseCacheLookups List<Property Map>

Base policy for Response Cache lookup.

GetDeploymentSpecificationRouteRequestPolicyAuthorization

AllowedScopes List<string>

A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.

Type string

Type of the Response Cache Store Policy.

AllowedScopes []string

A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.

Type string

Type of the Response Cache Store Policy.

allowedScopes List<String>

A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.

type String

Type of the Response Cache Store Policy.

allowedScopes string[]

A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.

type string

Type of the Response Cache Store Policy.

allowed_scopes Sequence[str]

A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.

type str

Type of the Response Cache Store Policy.

allowedScopes List<String>

A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.

type String

Type of the Response Cache Store Policy.

GetDeploymentSpecificationRouteRequestPolicyBodyValidation

Contents List<GetDeploymentSpecificationRouteRequestPolicyBodyValidationContent>

The content of the request body.

Required bool

Determines if the parameter is required in the request.

ValidationMode string

Validation behavior mode.

Contents []GetDeploymentSpecificationRouteRequestPolicyBodyValidationContent

The content of the request body.

Required bool

Determines if the parameter is required in the request.

ValidationMode string

Validation behavior mode.

contents List<GetDeploymentSpecificationRouteRequestPolicyBodyValidationContent>

The content of the request body.

required Boolean

Determines if the parameter is required in the request.

validationMode String

Validation behavior mode.

contents GetDeploymentSpecificationRouteRequestPolicyBodyValidationContent[]

The content of the request body.

required boolean

Determines if the parameter is required in the request.

validationMode string

Validation behavior mode.

contents GetDeploymentSpecificationRouteRequestPolicyBodyValidationContent]

The content of the request body.

required bool

Determines if the parameter is required in the request.

validation_mode str

Validation behavior mode.

contents List<Property Map>

The content of the request body.

required Boolean

Determines if the parameter is required in the request.

validationMode String

Validation behavior mode.

GetDeploymentSpecificationRouteRequestPolicyBodyValidationContent

MediaType string

The media type is a media type range subset restricted to the following schema

ValidationType string

Validation type defines the content validation method.

MediaType string

The media type is a media type range subset restricted to the following schema

ValidationType string

Validation type defines the content validation method.

mediaType String

The media type is a media type range subset restricted to the following schema

validationType String

Validation type defines the content validation method.

mediaType string

The media type is a media type range subset restricted to the following schema

validationType string

Validation type defines the content validation method.

media_type str

The media type is a media type range subset restricted to the following schema

validation_type str

Validation type defines the content validation method.

mediaType String

The media type is a media type range subset restricted to the following schema

validationType String

Validation type defines the content validation method.

GetDeploymentSpecificationRouteRequestPolicyCor

AllowedHeaders 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 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 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 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 bool

Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

MaxAgeInSeconds 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 []string

The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.

AllowedMethods []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 []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 []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 bool

Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

MaxAgeInSeconds 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 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 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 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 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 Boolean

Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

maxAgeInSeconds 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 string[]

The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.

allowedMethods 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 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 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 boolean

Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

maxAgeInSeconds 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 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 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 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 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 bool

Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

max_age_in_seconds 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 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 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 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 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 Boolean

Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

maxAgeInSeconds 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 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 List<GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader>

Rename HTTP headers as they pass through the gateway.

SetHeaders List<GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader>

Set HTTP headers as they pass through the gateway.

FilterHeaders []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 []GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader

Rename HTTP headers as they pass through the gateway.

SetHeaders []GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader

Set HTTP headers as they pass through the gateway.

filterHeaders 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 List<GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader>

Rename HTTP headers as they pass through the gateway.

setHeaders List<GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader>

Set HTTP headers as they pass through the gateway.

filterHeaders 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 GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader[]

Rename HTTP headers as they pass through the gateway.

setHeaders GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader[]

Set HTTP headers as they pass through the gateway.

filter_headers 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 GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader]

Rename HTTP headers as they pass through the gateway.

set_headers GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader]

Set HTTP headers as they pass through the gateway.

filterHeaders 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 List<Property Map>

Rename HTTP headers as they pass through the gateway.

setHeaders List<Property Map>

Set HTTP headers as they pass through the gateway.

GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader

Items List<GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem>

The list of headers.

Type string

Type of the Response Cache Store Policy.

Items []GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem

The list of headers.

Type string

Type of the Response Cache Store Policy.

items List<GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem>

The list of headers.

type String

Type of the Response Cache Store Policy.

items GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem[]

The list of headers.

type string

Type of the Response Cache Store Policy.

items GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem]

The list of headers.

type str

Type of the Response Cache Store Policy.

items List<Property Map>

The list of headers.

type String

Type of the Response Cache Store Policy.

GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

name string

The case-insensitive name of the header. This name must be unique across transformation policies.

name str

The case-insensitive name of the header. This name must be unique across transformation policies.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader

items List<Property Map>

The list of headers.

GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeaderItem

From string

The original case-insensitive name of the header. This name must be unique across transformation policies.

To string

The new name of the header. This name must be unique across transformation policies.

From string

The original case-insensitive name of the header. This name must be unique across transformation policies.

To string

The new name of the header. This name must be unique across transformation policies.

from String

The original case-insensitive name of the header. This name must be unique across transformation policies.

to String

The new name of the header. This name must be unique across transformation policies.

from string

The original case-insensitive name of the header. This name must be unique across transformation policies.

to string

The new name of the header. This name must be unique across transformation policies.

from_ str

The original case-insensitive name of the header. This name must be unique across transformation policies.

to str

The new name of the header. This name must be unique across transformation policies.

from String

The original case-insensitive name of the header. This name must be unique across transformation policies.

to String

The new name of the header. This name must be unique across transformation policies.

GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader

items List<Property Map>

The list of headers.

GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeaderItem

IfExists 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 string

The case-insensitive name of the header. This name must be unique across transformation policies.

Values List<string>

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

IfExists 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 string

The case-insensitive name of the header. This name must be unique across transformation policies.

Values []string

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

ifExists 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 String

The case-insensitive name of the header. This name must be unique across transformation policies.

values List<String>

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

ifExists 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 string

The case-insensitive name of the header. This name must be unique across transformation policies.

values string[]

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

if_exists 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 str

The case-insensitive name of the header. This name must be unique across transformation policies.

values Sequence[str]

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

ifExists 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 String

The case-insensitive name of the header. This name must be unique across transformation policies.

values 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 List<Property Map>
validationMode String

Validation behavior mode.

GetDeploymentSpecificationRouteRequestPolicyHeaderValidationHeader

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

Required bool

Determines if the parameter is required in the request.

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

Required bool

Determines if the parameter is required in the request.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

required Boolean

Determines if the parameter is required in the request.

name string

The case-insensitive name of the header. This name must be unique across transformation policies.

required boolean

Determines if the parameter is required in the request.

name str

The case-insensitive name of the header. This name must be unique across transformation policies.

required bool

Determines if the parameter is required in the request.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

required Boolean

Determines if the parameter is required in the request.

GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation

FilterQueryParameters 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 List<GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter>

Rename parameters on the query string as they pass through the gateway.

SetQueryParameters List<GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter>

Set parameters on the query string as they pass through the gateway.

FilterQueryParameters []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 []GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter

Rename parameters on the query string as they pass through the gateway.

SetQueryParameters []GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter

Set parameters on the query string as they pass through the gateway.

filterQueryParameters 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 List<GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter>

Rename parameters on the query string as they pass through the gateway.

setQueryParameters List<GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter>

Set parameters on the query string as they pass through the gateway.

filterQueryParameters 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 GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter[]

Rename parameters on the query string as they pass through the gateway.

setQueryParameters GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter[]

Set parameters on the query string as they pass through the gateway.

filter_query_parameters 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 GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter]

Rename parameters on the query string as they pass through the gateway.

set_query_parameters GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter]

Set parameters on the query string as they pass through the gateway.

filterQueryParameters 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 List<Property Map>

Rename parameters on the query string as they pass through the gateway.

setQueryParameters List<Property Map>

Set parameters on the query string as they pass through the gateway.

GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter

items List<Property Map>

The list of headers.

type String

Type of the Response Cache Store Policy.

GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

name string

The case-insensitive name of the header. This name must be unique across transformation policies.

name str

The case-insensitive name of the header. This name must be unique across transformation policies.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter

items List<Property Map>

The list of headers.

GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameterItem

From string

The original case-insensitive name of the header. This name must be unique across transformation policies.

To string

The new name of the header. This name must be unique across transformation policies.

From string

The original case-insensitive name of the header. This name must be unique across transformation policies.

To string

The new name of the header. This name must be unique across transformation policies.

from String

The original case-insensitive name of the header. This name must be unique across transformation policies.

to String

The new name of the header. This name must be unique across transformation policies.

from string

The original case-insensitive name of the header. This name must be unique across transformation policies.

to string

The new name of the header. This name must be unique across transformation policies.

from_ str

The original case-insensitive name of the header. This name must be unique across transformation policies.

to str

The new name of the header. This name must be unique across transformation policies.

from String

The original case-insensitive name of the header. This name must be unique across transformation policies.

to String

The new name of the header. This name must be unique across transformation policies.

GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter

items List<Property Map>

The list of headers.

GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameterItem

IfExists 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 string

The case-insensitive name of the header. This name must be unique across transformation policies.

Values List<string>

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

IfExists 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 string

The case-insensitive name of the header. This name must be unique across transformation policies.

Values []string

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

ifExists 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 String

The case-insensitive name of the header. This name must be unique across transformation policies.

values List<String>

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

ifExists 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 string

The case-insensitive name of the header. This name must be unique across transformation policies.

values string[]

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

if_exists 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 str

The case-insensitive name of the header. This name must be unique across transformation policies.

values Sequence[str]

A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

ifExists 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 String

The case-insensitive name of the header. This name must be unique across transformation policies.

values 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 List<Property Map>
validationMode String

Validation behavior mode.

GetDeploymentSpecificationRouteRequestPolicyQueryParameterValidationParameter

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

Required bool

Determines if the parameter is required in the request.

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

Required bool

Determines if the parameter is required in the request.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

required Boolean

Determines if the parameter is required in the request.

name string

The case-insensitive name of the header. This name must be unique across transformation policies.

required boolean

Determines if the parameter is required in the request.

name str

The case-insensitive name of the header. This name must be unique across transformation policies.

required bool

Determines if the parameter is required in the request.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

required Boolean

Determines if the parameter is required in the request.

GetDeploymentSpecificationRouteRequestPolicyResponseCacheLookup