apigateway.oracle.com/v1beta1¶
APIVersion: apigateway.oracle.com/v1beta1
This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.
Packages¶
| Package | Support | Latest release | Resources |
|---|---|---|---|
| API Gateway | preview | v2.1.0-alpha |
ApiGateway, ApiGatewayDeployment |
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| ApiGateway | Namespaced | Sample | API Gateway (v2.1.0-alpha) |
| ApiGatewayDeployment | Namespaced | Sample | API Gateway (v2.1.0-alpha) |
ApiGateway¶
Manage OCI API Gateway gateway resources.
Plural:apigatewaysScope:NamespacedAPIVersion:apigateway.oracle.com/v1beta1Sample: Sample (config/samples/apigateway_v1beta1_apigateway.yaml)Packages: API Gateway (v2.1.0-alpha)
Spec¶
ApiGatewaySpec defines the desired state of ApiGateway.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
caBundles |
An array of CA bundles that should be used on the Gateway for TLS validation. | list[object] |
No | - | - |
certificateId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource which can be empty string. | string |
No | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created. | string |
Yes | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource |
string |
No | - | - |
endpointType |
Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet. Example: PUBLIC or PRIVATE Validation: endpointType is immutable. |
string |
Yes | - | PRIVATE, PUBLIC |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
id |
The OCID of an existing API Gateway to bind to. | string |
No | - | - |
ipMode |
Determines whether the gateway has an IPv4 or IPv6 address assigned to it, or both. IPV4 means the gateway will only have an IPv4 address assigned to it, and IPV6 means the gateway will only have an IPv6 address assigned to it. DUAL_STACK means the gateway will have both an IPv4 and IPv6 address assigned to it. Example: IPV4 or IPV6 or DUAL_STACK |
string |
No | - | - |
ipv4AddressConfiguration |
ApiGatewayIpv4AddressConfiguration defines nested fields for ApiGateway.Ipv4AddressConfiguration. | object |
No | - | - |
ipv6AddressConfiguration |
ApiGatewayIpv6AddressConfiguration defines nested fields for ApiGateway.Ipv6AddressConfiguration. | object |
No | - | - |
locks |
Locks associated with this resource. | list[object] |
No | - | - |
networkSecurityGroupIds |
An array of Network Security Groups OCIDs associated with this API Gateway. | list[string] |
No | - | - |
responseCacheDetails |
ApiGatewayResponseCacheDetails defines nested fields for ApiGateway.ResponseCacheDetails. | object |
No | - | - |
subnetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet in which related resources are created. Validation: subnetId is immutable. | string |
Yes | - | - |
Spec.caBundles[]¶
ApiGatewayCaBundle defines nested fields for ApiGateway.CaBundle.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
caBundleId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. | string |
No | - | - |
certificateAuthorityId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
type |
- | string |
No | - | - |
Spec.ipv4AddressConfiguration¶
ApiGatewayIpv4AddressConfiguration defines nested fields for ApiGateway.Ipv4AddressConfiguration.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
reservedIpIds |
List of Reserved IP OCIDs created in VCN service. | list[string] |
No | - | - |
Spec.ipv6AddressConfiguration¶
ApiGatewayIpv6AddressConfiguration defines nested fields for ApiGateway.Ipv6AddressConfiguration.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
addresses |
List of IPv6 addresses that will be assigned to the gateway during creation. | list[string] |
No | - | - |
subnetCidrs |
List of IPv6 prefixes from which to provision IPv6 addresses from. This is required if more than one prefix exists on the subnet. | list[string] |
No | - | - |
Spec.locks[]¶
ApiGatewayLock defines nested fields for ApiGateway.Lock.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. | string |
No | - | - |
type |
Type of the lock. | string |
Yes | - | - |
Spec.responseCacheDetails¶
ApiGatewayResponseCacheDetails defines nested fields for ApiGateway.ResponseCacheDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
authenticationSecretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. | string |
No | - | - |
authenticationSecretVersionNumber |
The version number of the authentication secret to use. | integer (int64) |
No | - | - |
connectTimeoutInMs |
Defines the timeout for establishing a connection with the Response Cache. | integer |
No | - | - |
isSslEnabled |
Defines if the connection should be over SSL. | boolean |
No | - | - |
isSslVerifyDisabled |
Defines whether or not to uphold SSL verification. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
readTimeoutInMs |
Defines the timeout for reading data from the Response Cache. | integer |
No | - | - |
sendTimeoutInMs |
Defines the timeout for transmitting data to the Response Cache. | integer |
No | - | - |
servers |
The set of cache store members to connect to. At present only a single server is supported. | list[object] |
No | - | - |
type |
- | string |
No | - | - |
Spec.responseCacheDetails.servers[]¶
ApiGatewayResponseCacheDetailsServer defines nested fields for ApiGateway.ResponseCacheDetails.Server.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
host |
Hostname or IP address (IPv4 only) where the cache store is running. | string |
Yes | - | - |
port |
The port the cache store is exposed on. | integer |
Yes | - | - |
Status¶
ApiGatewayStatus defines the observed state of ApiGateway.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
caBundles |
An array of CA bundles that should be used on the Gateway for TLS validation. | list[object] |
No | - | - |
certificateId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. | string |
No | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created. | string |
No | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource |
string |
No | - | - |
endpointType |
Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet. Example: PUBLIC or PRIVATE |
string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
hostname |
The hostname for APIs deployed on the gateway. | string |
No | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. | string |
No | - | - |
ipAddresses |
An array of IP addresses associated with the gateway. | list[object] |
No | - | - |
ipMode |
Determines whether the gateway has an IPv4 or IPv6 address assigned to it, or both. IPV4 means the gateway will only have an IPv4 address assigned to it, and IPV6 means the gateway will only have an IPv6 address assigned to it. DUAL_STACK means the gateway will have both an IPv4 and IPv6 address assigned to it. Example: IPV4 or IPV6 or DUAL_STACK |
string |
No | - | - |
ipv4AddressConfiguration |
ApiGatewayIpv4AddressConfiguration defines nested fields for ApiGateway.Ipv4AddressConfiguration. | object |
No | - | - |
ipv6AddressConfiguration |
ApiGatewayIpv6AddressConfiguration defines nested fields for ApiGateway.Ipv6AddressConfiguration. | object |
No | - | - |
lifecycleDetails |
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. | string |
No | - | - |
lifecycleState |
The current state of the gateway. | string |
No | - | - |
locks |
Locks associated with this resource. | list[object] |
No | - | - |
networkSecurityGroupIds |
An array of Network Security Groups OCIDs associated with this API Gateway. | list[string] |
No | - | - |
responseCacheDetails |
ApiGatewayResponseCacheDetails defines nested fields for ApiGateway.ResponseCacheDetails. | object |
No | - | - |
status |
- | object |
Yes | - | - |
subnetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet in which related resources are created. | string |
No | - | - |
systemTags |
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
timeCreated |
The time this resource was created. An RFC3339 formatted datetime string. | string |
No | - | - |
timeUpdated |
The time this resource was last updated. An RFC3339 formatted datetime string. | string |
No | - | - |
Status.caBundles[]¶
ApiGatewayCaBundle defines nested fields for ApiGateway.CaBundle.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
caBundleId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. | string |
No | - | - |
certificateAuthorityId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
type |
- | string |
No | - | - |
Status.ipAddresses[]¶
ApiGatewayIpAddress defines nested fields for ApiGateway.IpAddress.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
ipAddress |
An IP address. | string |
No | - | - |
Status.ipv4AddressConfiguration¶
ApiGatewayIpv4AddressConfiguration defines nested fields for ApiGateway.Ipv4AddressConfiguration.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
reservedIpIds |
List of Reserved IP OCIDs created in VCN service. | list[string] |
No | - | - |
Status.ipv6AddressConfiguration¶
ApiGatewayIpv6AddressConfiguration defines nested fields for ApiGateway.Ipv6AddressConfiguration.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
addresses |
List of IPv6 addresses that will be assigned to the gateway during creation. | list[string] |
No | - | - |
subnetCidrs |
List of IPv6 prefixes from which to provision IPv6 addresses from. This is required if more than one prefix exists on the subnet. | list[string] |
No | - | - |
Status.locks[]¶
ApiGatewayLock defines nested fields for ApiGateway.Lock.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. | string |
No | - | - |
type |
Type of the lock. | string |
Yes | - | - |
Status.responseCacheDetails¶
ApiGatewayResponseCacheDetails defines nested fields for ApiGateway.ResponseCacheDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
authenticationSecretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. | string |
No | - | - |
authenticationSecretVersionNumber |
The version number of the authentication secret to use. | integer (int64) |
No | - | - |
connectTimeoutInMs |
Defines the timeout for establishing a connection with the Response Cache. | integer |
No | - | - |
isSslEnabled |
Defines if the connection should be over SSL. | boolean |
No | - | - |
isSslVerifyDisabled |
Defines whether or not to uphold SSL verification. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
readTimeoutInMs |
Defines the timeout for reading data from the Response Cache. | integer |
No | - | - |
sendTimeoutInMs |
Defines the timeout for transmitting data to the Response Cache. | integer |
No | - | - |
servers |
The set of cache store members to connect to. At present only a single server is supported. | list[object] |
No | - | - |
type |
- | string |
No | - | - |
Status.responseCacheDetails.servers[]¶
ApiGatewayResponseCacheDetailsServer defines nested fields for ApiGateway.ResponseCacheDetails.Server.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
host |
Hostname or IP address (IPv4 only) where the cache store is running. | string |
Yes | - | - |
port |
The port the cache store is exposed on. | integer |
Yes | - | - |
Status.status¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
ApiGatewayDeployment¶
Manage OCI API Gateway deployment routes and backend bindings.
Plural:apigatewaydeploymentsScope:NamespacedAPIVersion:apigateway.oracle.com/v1beta1Sample: Sample (config/samples/apigateway_v1beta1_apigatewaydeployment.yaml)Packages: API Gateway (v2.1.0-alpha)
Spec¶
ApiGatewayDeploymentSpec defines the desired state of ApiGatewayDeployment.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created. | string |
Yes | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource |
string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
gatewayId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. | string |
Yes | - | - |
id |
The OCID of an existing API Gateway Deployment to bind to. | string |
No | - | - |
locks |
Locks associated with this resource. | list[object] |
No | - | - |
pathPrefix |
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 (https://docs.oracle.com/iaas/Content/APIGateway/Tasks/apigatewaycreatingdeployment.htm). | string |
Yes | - | - |
routes |
Routes is the compatibility shorthand for specification.routes. Set either routes or specification.routes; the runtime rejects conflicting values. | list[object] |
No | - | - |
specification |
ApiGatewayDeploymentSpecification defines nested fields for ApiGatewayDeployment.Specification. | object |
No | - | - |
Spec.locks[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentLock defines nested fields for ApiGatewayDeployment.Lock.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. | string |
No | - | - |
type |
Type of the lock. | string |
Yes | - | - |
Spec.routes[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRoute defines nested fields for ApiGatewayDeployment.Specification.Route.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
backend |
ApiGatewayDeploymentSpecificationRouteBackend defines nested fields for ApiGatewayDeployment.Specification.Route.Backend. | object |
Yes | - | - |
loggingPolicies |
ApiGatewayDeploymentSpecificationRouteLoggingPolicies defines nested fields for ApiGatewayDeployment.Specification.Route.LoggingPolicies. | object |
No | - | - |
methods |
A list of allowed methods on this route. | list[string] |
No | - | - |
path |
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. | string |
Yes | - | - |
requestPolicies |
ApiGatewayDeploymentSpecificationRouteRequestPolicies defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies. | object |
No | - | - |
responsePolicies |
ApiGatewayDeploymentSpecificationRouteResponsePolicies defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies. | object |
No | - | - |
Spec.routes[].backend¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteBackend defines nested fields for ApiGatewayDeployment.Specification.Route.Backend.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
allowedPostLogoutUris |
A list of allowed post-logout URLs to which a request can be redirected after revoke access | list[string] |
No | - | - |
body |
The body of the stock response from the mock backend. | string |
No | - | - |
connectTimeoutInSeconds |
Defines a timeout for establishing a connection with a proxied server. | number |
No | - | - |
functionId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource. | string |
No | - | - |
headers |
The headers of the stock response from the mock backend. | list[object] |
No | - | - |
isSslVerifyDisabled |
Defines whether or not to uphold SSL verification. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
postLogoutState |
Defines a state that should be shared on redirecting to postLogout URL. | string |
No | - | - |
readTimeoutInSeconds |
Defines a timeout for reading a response from the proxied server. | number |
No | - | - |
routingBackends |
List of backends to chose from for Dynamic Routing. | list[object] |
No | - | - |
selectionSource |
ApiGatewayDeploymentSpecificationRouteBackendSelectionSource defines nested fields for ApiGatewayDeployment.Specification.Route.Backend.SelectionSource. | object |
No | - | - |
sendTimeoutInSeconds |
Defines a timeout for transmitting a request to the proxied server. | number |
No | - | - |
status |
The status code of the stock response from the mock backend. | integer |
No | - | - |
type |
- | string |
No | - | - |
url |
The url of the HTTP Backend | string |
No | - | - |
Spec.routes[].backend.headers[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteBackendHeader defines nested fields for ApiGatewayDeployment.Specification.Route.Backend.Header.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Name of the header. | string |
No | - | - |
value |
Value of the header. | string |
No | - | - |
Spec.routes[].backend.routingBackends[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteBackendRoutingBackend defines nested fields for ApiGatewayDeployment.Specification.Route.Backend.RoutingBackend.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
backend |
JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. | object (preserves unknown fields) |
Yes | - | - |
key |
ApiGatewayDeploymentSpecificationRouteBackendRoutingBackendKey defines nested fields for ApiGatewayDeployment.Specification.Route.Backend.RoutingBackend.Key. | object |
Yes | - | - |
Spec.routes[].backend.routingBackends[].key¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteBackendRoutingBackendKey defines nested fields for ApiGatewayDeployment.Specification.Route.Backend.RoutingBackend.Key.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
expression |
A selection key string containing a wildcard to match with the context variable in an incoming request. If the context variable matches the string, the request is sent to the route or authentication server associated with the selection key. Valid wildcards are '*' (zero or more characters) and '+' (one or more characters). The string can only contain one wildcard, and the wildcard must be at the start or the end of the string. | string |
No | - | - |
isDefault |
Specifies whether to use the route or authentication server associated with this selection key as the default. The default is used if the value of a context variable in an incoming request does not match any of the other selection key values when dynamically routing and dynamically authenticating requests. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
name |
Name assigned to the branch. | string |
Yes | - | - |
type |
- | string |
No | - | - |
values |
The set of selection keys to match with the context variable in an incoming request. If the context variable exactly matches one of the keys in the set, the request is sent to the route or authentication server associated with the set. | list[string] |
No | - | - |
Spec.routes[].backend.selectionSource¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteBackendSelectionSource defines nested fields for ApiGatewayDeployment.Specification.Route.Backend.SelectionSource.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
selector |
String describing the context variable used as selector. | string |
No | - | - |
type |
- | string |
No | - | - |
Spec.routes[].loggingPolicies¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteLoggingPolicies defines nested fields for ApiGatewayDeployment.Specification.Route.LoggingPolicies.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
accessLog |
ApiGatewayDeploymentSpecificationRouteLoggingPoliciesAccessLog defines nested fields for ApiGatewayDeployment.Specification.Route.LoggingPolicies.AccessLog. | object |
No | - | - |
executionLog |
ApiGatewayDeploymentSpecificationRouteLoggingPoliciesExecutionLog defines nested fields for ApiGatewayDeployment.Specification.Route.LoggingPolicies.ExecutionLog. | object |
No | - | - |
Spec.routes[].loggingPolicies.accessLog¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteLoggingPoliciesAccessLog defines nested fields for ApiGatewayDeployment.Specification.Route.LoggingPolicies.AccessLog.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isEnabled |
Enables pushing of access logs to the legacy OCI Object Storage log archival bucket. Oracle recommends using the OCI Logging service to enable, retrieve, and query access logs for an API Deployment. If there is an active log object for the API Deployment and its category is set to 'access' in OCI Logging service, the logs will not be uploaded to the legacy OCI Object Storage log archival bucket. Please note that the functionality to push to the legacy OCI Object Storage log archival bucket has been deprecated and will be removed in the future. | boolean |
No | - | - |
Spec.routes[].loggingPolicies.executionLog¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteLoggingPoliciesExecutionLog defines nested fields for ApiGatewayDeployment.Specification.Route.LoggingPolicies.ExecutionLog.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isEnabled |
Enables pushing of execution logs to the legacy OCI Object Storage log archival bucket. Oracle recommends using the OCI Logging service to enable, retrieve, and query execution logs for an API Deployment. If there is an active log object for the API Deployment and its category is set to 'execution' in OCI Logging service, the logs will not be uploaded to the legacy OCI Object Storage log archival bucket. Please note that the functionality to push to the legacy OCI Object Storage log archival bucket has been deprecated and will be removed in the future. | boolean |
No | - | - |
logLevel |
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. | string |
No | - | - |
Spec.routes[].requestPolicies¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPolicies defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
authorization |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesAuthorization defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.Authorization. | object |
No | - | - |
bodyValidation |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesBodyValidation defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.BodyValidation. | object |
No | - | - |
cors |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesCors defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.Cors. | object |
No | - | - |
headerTransformations |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformations defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations. | object |
No | - | - |
headerValidations |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderValidations defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderValidations. | object |
No | - | - |
queryParameterTransformations |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformations defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations. | object |
No | - | - |
queryParameterValidations |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterValidations defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterValidations. | object |
No | - | - |
responseCacheLookup |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesResponseCacheLookup defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.ResponseCacheLookup. | object |
No | - | - |
Spec.routes[].requestPolicies.authorization¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesAuthorization defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.Authorization.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
allowedScope |
A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive. | list[string] |
No | - | - |
jsonData |
- | string |
No | - | - |
type |
- | string |
No | - | - |
Spec.routes[].requestPolicies.bodyValidation¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesBodyValidation defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.BodyValidation.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
content |
The content of the request body. The key is a media type range (https://tools.ietf.org/html/rfc7231#appendix-D) subset restricted to the following schema key ::= ( / ( "" "/" "" ) / ( type "/" "*" ) / ( type "/" subtype ) ) For requests that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/* |
map[string, object] |
Yes | - | - |
required |
Determines if the request body is required in the request. | boolean |
No | - | - |
validationMode |
Validation behavior mode. In ENFORCING mode, upon a validation failure, the request will be rejected with a 4xx response and not sent to the backend. In PERMISSIVE mode, the result of the validation will be exposed as metrics while the request will follow the normal path. DISABLED type turns the validation off. |
string |
No | - | - |
Spec.routes[].requestPolicies.bodyValidation.content{}¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesBodyValidationContent defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.BodyValidation.Content.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
validationType |
- | string |
No | - | - |
Spec.routes[].requestPolicies.cors¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesCors defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.Cors.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
allowedHeaders |
The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers. | list[string] |
No | - | - |
allowedMethods |
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. | list[string] |
No | - | - |
allowedOrigins |
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. | list[string] |
Yes | - | - |
exposedHeaders |
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. | list[string] |
No | - | - |
isAllowCredentialsEnabled |
Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies. | boolean |
No | - | - |
maxAgeInSeconds |
The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0. | integer |
No | - | - |
Spec.routes[].requestPolicies.headerTransformations¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformations defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
filterHeaders |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.FilterHeaders. | object |
No | - | - |
renameHeaders |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.RenameHeaders. | object |
No | - | - |
setHeaders |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.SetHeaders. | object |
No | - | - |
Spec.routes[].requestPolicies.headerTransformations.filterHeaders¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.FilterHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
type |
BLOCK drops any headers that are in the list of items, so it acts as an exclusion list. ALLOW permits only the headers in the list and removes all others, so it acts as an inclusion list. | string |
Yes | - | - |
Spec.routes[].requestPolicies.headerTransformations.filterHeaders.items[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeadersItem defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.FilterHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
Spec.routes[].requestPolicies.headerTransformations.renameHeaders¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.RenameHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
Spec.routes[].requestPolicies.headerTransformations.renameHeaders.items[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeadersItem defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.RenameHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
from |
The original case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
to |
The new name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
Spec.routes[].requestPolicies.headerTransformations.setHeaders¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.SetHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
Spec.routes[].requestPolicies.headerTransformations.setHeaders.items[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeadersItem defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.SetHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
ifExists |
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. | string |
No | - | - |
name |
The case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
values |
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. | list[string] |
Yes | - | - |
Spec.routes[].requestPolicies.headerValidations¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderValidations defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderValidations.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
headers |
The List of Headers | list[object] |
No | - | - |
validationMode |
Validation behavior mode. In ENFORCING mode, upon a validation failure, the request will be rejected with a 4xx response and not sent to the backend. In PERMISSIVE mode, the result of the validation will be exposed as metrics while the request will follow the normal path. DISABLED type turns the validation off. |
string |
No | - | - |
Spec.routes[].requestPolicies.headerValidations.headers[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderValidationsHeader defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderValidations.Header.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Parameter name. | string |
Yes | - | - |
required |
Determines if the header is required in the request. | boolean |
No | - | - |
Spec.routes[].requestPolicies.queryParameterTransformations¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformations defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
filterQueryParameters |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParameters defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.FilterQueryParameters. | object |
No | - | - |
renameQueryParameters |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParameters defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.RenameQueryParameters. | object |
No | - | - |
setQueryParameters |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParameters defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.SetQueryParameters. | object |
No | - | - |
Spec.routes[].requestPolicies.queryParameterTransformations.filterQueryParameters¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParameters defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.FilterQueryParameters.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of query parameters. | list[object] |
Yes | - | - |
type |
BLOCK drops any query parameters that are in the list of items, so it acts as an exclusion list. ALLOW permits only the parameters in the list and removes all others, so it acts as an inclusion list. | string |
Yes | - | - |
Spec.routes[].requestPolicies.queryParameterTransformations.filterQueryParameters.items[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParametersItem defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.FilterQueryParameters.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The case-sensitive name of the query parameter. | string |
Yes | - | - |
Spec.routes[].requestPolicies.queryParameterTransformations.renameQueryParameters¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParameters defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.RenameQueryParameters.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of query parameters. | list[object] |
Yes | - | - |
Spec.routes[].requestPolicies.queryParameterTransformations.renameQueryParameters.items[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParametersItem defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.RenameQueryParameters.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
from |
The original case-sensitive name of the query parameter. This name must be unique across transformation policies. | string |
Yes | - | - |
to |
The new name of the query parameter. This name must be unique across transformation policies. | string |
Yes | - | - |
Spec.routes[].requestPolicies.queryParameterTransformations.setQueryParameters¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParameters defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.SetQueryParameters.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of query parameters. | list[object] |
Yes | - | - |
Spec.routes[].requestPolicies.queryParameterTransformations.setQueryParameters.items[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParametersItem defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.SetQueryParameters.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
ifExists |
If a query parameter 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. | string |
No | - | - |
name |
The case-sensitive name of the query parameter. This name must be unique across transformation policies. | string |
Yes | - | - |
values |
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. | list[string] |
Yes | - | - |
Spec.routes[].requestPolicies.queryParameterValidations¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterValidations defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterValidations.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
parameters |
The List of Query Parameters | list[object] |
No | - | - |
validationMode |
Validation behavior mode. In ENFORCING mode, upon a validation failure, the request will be rejected with a 4xx response and not sent to the backend. In PERMISSIVE mode, the result of the validation will be exposed as metrics while the request will follow the normal path. DISABLED type turns the validation off. |
string |
No | - | - |
Spec.routes[].requestPolicies.queryParameterValidations.parameters[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterValidationsParameter defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterValidations.Parameter.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Parameter name. | string |
Yes | - | - |
required |
Determines if the parameter is required in the request. | boolean |
No | - | - |
Spec.routes[].requestPolicies.responseCacheLookup¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesResponseCacheLookup defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.ResponseCacheLookup.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
cacheKeyAdditions |
A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available. | list[string] |
No | - | - |
isEnabled |
Whether this policy is currently enabled. | boolean |
No | - | - |
isPrivateCachingEnabled |
Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require. When false, any request with an Authorization header will not be stored in the Response Cache. If using the CustomAuthenticationPolicy then the tokenHeader/tokenQueryParam are also subject to this check. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
type |
- | string |
No | - | - |
Spec.routes[].responsePolicies¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteResponsePolicies defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
headerTransformations |
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformations defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations. | object |
No | - | - |
responseCacheStore |
ApiGatewayDeploymentSpecificationRouteResponsePoliciesResponseCacheStore defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.ResponseCacheStore. | object |
No | - | - |
Spec.routes[].responsePolicies.headerTransformations¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformations defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
filterHeaders |
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.FilterHeaders. | object |
No | - | - |
renameHeaders |
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.RenameHeaders. | object |
No | - | - |
setHeaders |
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.SetHeaders. | object |
No | - | - |
Spec.routes[].responsePolicies.headerTransformations.filterHeaders¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.FilterHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
type |
BLOCK drops any headers that are in the list of items, so it acts as an exclusion list. ALLOW permits only the headers in the list and removes all others, so it acts as an inclusion list. | string |
Yes | - | - |
Spec.routes[].responsePolicies.headerTransformations.filterHeaders.items[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeadersItem defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.FilterHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
Spec.routes[].responsePolicies.headerTransformations.renameHeaders¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.RenameHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
Spec.routes[].responsePolicies.headerTransformations.renameHeaders.items[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeadersItem defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.RenameHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
from |
The original case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
to |
The new name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
Spec.routes[].responsePolicies.headerTransformations.setHeaders¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.SetHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
Spec.routes[].responsePolicies.headerTransformations.setHeaders.items[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeadersItem defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.SetHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
ifExists |
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. | string |
No | - | - |
name |
The case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
values |
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. | list[string] |
Yes | - | - |
Spec.routes[].responsePolicies.responseCacheStore¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteResponsePoliciesResponseCacheStore defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.ResponseCacheStore.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
timeToLiveInSeconds |
Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires. | integer |
No | - | - |
type |
- | string |
No | - | - |
Spec.specification¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecification defines nested fields for ApiGatewayDeployment.Specification.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
loggingPolicies |
ApiGatewayDeploymentSpecificationLoggingPolicies defines nested fields for ApiGatewayDeployment.Specification.LoggingPolicies. | object |
No | - | - |
requestPolicies |
ApiGatewayDeploymentSpecificationRequestPolicies defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies. | object |
No | - | - |
routes |
A list of routes that this API exposes. | list[object] |
No | - | - |
Spec.specification.loggingPolicies¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationLoggingPolicies defines nested fields for ApiGatewayDeployment.Specification.LoggingPolicies.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
accessLog |
ApiGatewayDeploymentSpecificationLoggingPoliciesAccessLog defines nested fields for ApiGatewayDeployment.Specification.LoggingPolicies.AccessLog. | object |
No | - | - |
executionLog |
ApiGatewayDeploymentSpecificationLoggingPoliciesExecutionLog defines nested fields for ApiGatewayDeployment.Specification.LoggingPolicies.ExecutionLog. | object |
No | - | - |
Spec.specification.loggingPolicies.accessLog¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationLoggingPoliciesAccessLog defines nested fields for ApiGatewayDeployment.Specification.LoggingPolicies.AccessLog.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isEnabled |
Enables pushing of access logs to the legacy OCI Object Storage log archival bucket. Oracle recommends using the OCI Logging service to enable, retrieve, and query access logs for an API Deployment. If there is an active log object for the API Deployment and its category is set to 'access' in OCI Logging service, the logs will not be uploaded to the legacy OCI Object Storage log archival bucket. Please note that the functionality to push to the legacy OCI Object Storage log archival bucket has been deprecated and will be removed in the future. | boolean |
No | - | - |
Spec.specification.loggingPolicies.executionLog¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationLoggingPoliciesExecutionLog defines nested fields for ApiGatewayDeployment.Specification.LoggingPolicies.ExecutionLog.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isEnabled |
Enables pushing of execution logs to the legacy OCI Object Storage log archival bucket. Oracle recommends using the OCI Logging service to enable, retrieve, and query execution logs for an API Deployment. If there is an active log object for the API Deployment and its category is set to 'execution' in OCI Logging service, the logs will not be uploaded to the legacy OCI Object Storage log archival bucket. Please note that the functionality to push to the legacy OCI Object Storage log archival bucket has been deprecated and will be removed in the future. | boolean |
No | - | - |
logLevel |
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. | string |
No | - | - |
Spec.specification.requestPolicies¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPolicies defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
authentication |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthentication defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication. | object |
No | - | - |
cors |
ApiGatewayDeploymentSpecificationRequestPoliciesCors defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Cors. | object |
No | - | - |
dynamicAuthentication |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthentication defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication. | object |
No | - | - |
mutualTls |
ApiGatewayDeploymentSpecificationRequestPoliciesMutualTls defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.MutualTls. | object |
No | - | - |
rateLimiting |
ApiGatewayDeploymentSpecificationRequestPoliciesRateLimiting defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.RateLimiting. | object |
No | - | - |
usagePlans |
ApiGatewayDeploymentSpecificationRequestPoliciesUsagePlans defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.UsagePlans. | object |
No | - | - |
Spec.specification.requestPolicies.authentication¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesAuthentication defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
audiences |
The list of intended recipients for the token. | list[string] |
No | - | - |
cacheKey |
A list of keys from "parameters" attribute value whose values will be added to the cache key. | list[string] |
No | - | - |
functionId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource. | string |
No | - | - |
isAnonymousAccessAllowed |
Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization. | boolean |
No | - | - |
issuers |
A list of parties that could have issued the token. | list[string] |
No | - | - |
jsonData |
- | string |
No | - | - |
maxClockSkewInSeconds |
The maximum expected time difference between the system clocks of the token issuer and the API Gateway. | number |
No | - | - |
parameters |
A map where key is a user defined string and value is a context expressions whose values will be sent to the custom auth function. Values should contain an expression. Example: {"foo": "request.header[abc]"} |
map[string, string] |
No | - | - |
publicKeys |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationPublicKeys defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.PublicKeys. | object |
No | - | - |
tokenAuthScheme |
The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified. | string |
No | - | - |
tokenHeader |
The name of the header containing the authentication token. | string |
No | - | - |
tokenQueryParam |
The name of the query parameter containing the authentication token. | string |
No | - | - |
type |
- | string |
No | - | - |
validationFailurePolicy |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicy defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy. | object |
No | - | - |
validationPolicy |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationPolicy defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationPolicy. | object |
No | - | - |
verifyClaims |
A list of claims which should be validated to consider the token valid. | list[object] |
No | - | - |
Spec.specification.requestPolicies.authentication.publicKeys¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationPublicKeys defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.PublicKeys.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isSslVerifyDisabled |
Defines whether or not to uphold SSL verification. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
keys |
The set of static public keys. | list[object] |
No | - | - |
maxCacheDurationInHours |
The duration for which the JWKS should be cached before it is fetched again. | integer |
No | - | - |
type |
- | string |
No | - | - |
uri |
The uri from which to retrieve the key. It must be accessible without authentication. | string |
No | - | - |
Spec.specification.requestPolicies.authentication.publicKeys.keys[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationPublicKeysKey defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.PublicKeys.Key.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
alg |
The algorithm intended for use with this key. | string |
No | - | - |
e |
The base64 url encoded exponent of the RSA public key represented by this key. | string |
No | - | - |
format |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
key |
The content of the PEM-encoded public key. | string |
No | - | - |
key_ops |
The operations for which this key is to be used. | list[string] |
No | - | - |
kid |
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid". | string |
Yes | - | - |
kty |
The key type. | string |
No | - | - |
n |
The base64 url encoded modulus of the RSA public key represented by this key. | string |
No | - | - |
use |
The intended use of the public key. | string |
No | - | - |
Spec.specification.requestPolicies.authentication.validationFailurePolicy¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicy defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
clientDetails |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyClientDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ClientDetails. | object |
No | - | - |
fallbackRedirectPath |
The path to be used as fallback after OAuth2. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
logoutPath |
The path to be used as logout. | string |
No | - | - |
maxExpiryDurationInHours |
The duration for which the OAuth2 success token should be cached before it is fetched again. | integer |
No | - | - |
responseCode |
HTTP response code, can include context variables. | string |
No | - | - |
responseHeaderTransformations |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformations defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ResponseHeaderTransformations. | object |
No | - | - |
responseMessage |
HTTP response message. | string |
No | - | - |
responseType |
Response Type. | string |
No | - | - |
scopes |
List of scopes. | list[string] |
No | - | - |
sourceUriDetails |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicySourceUriDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.SourceUriDetails. | object |
No | - | - |
type |
- | string |
No | - | - |
useCookiesForIntermediateSteps |
Defines whether or not to use cookies for OAuth2 intermediate steps. | boolean |
No | - | - |
useCookiesForSession |
Defines whether or not to use cookies for session maintenance. | boolean |
No | - | - |
usePkce |
Defines whether or not to support PKCE. | boolean |
No | - | - |
Spec.specification.requestPolicies.authentication.validationFailurePolicy.clientDetails¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyClientDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ClientDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
clientId |
Client ID for the OAuth2/OIDC app. | string |
No | - | - |
clientSecretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. | string |
No | - | - |
clientSecretVersionNumber |
The version number of the client secret to use. | integer (int64) |
No | - | - |
jsonData |
- | string |
No | - | - |
type |
- | string |
No | - | - |
Spec.specification.requestPolicies.authentication.validationFailurePolicy.responseHeaderTransformations¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformations defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ResponseHeaderTransformations.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
filterHeaders |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsFilterHeaders defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ResponseHeaderTransformations.FilterHeaders. | object |
No | - | - |
renameHeaders |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsRenameHeaders defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ResponseHeaderTransformations.RenameHeaders. | object |
No | - | - |
setHeaders |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsSetHeaders defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ResponseHeaderTransformations.SetHeaders. | object |
No | - | - |
Spec.specification.requestPolicies.authentication.validationFailurePolicy.responseHeaderTransformations.filterHeaders¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsFilterHeaders defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ResponseHeaderTransformations.FilterHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
type |
BLOCK drops any headers that are in the list of items, so it acts as an exclusion list. ALLOW permits only the headers in the list and removes all others, so it acts as an inclusion list. | string |
Yes | - | - |
Spec.specification.requestPolicies.authentication.validationFailurePolicy.responseHeaderTransformations.filterHeaders.items[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsFilterHeadersItem defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ResponseHeaderTransformations.FilterHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
Spec.specification.requestPolicies.authentication.validationFailurePolicy.responseHeaderTransformations.renameHeaders¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsRenameHeaders defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ResponseHeaderTransformations.RenameHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
Spec.specification.requestPolicies.authentication.validationFailurePolicy.responseHeaderTransformations.renameHeaders.items[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsRenameHeadersItem defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ResponseHeaderTransformations.RenameHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
from |
The original case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
to |
The new name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
Spec.specification.requestPolicies.authentication.validationFailurePolicy.responseHeaderTransformations.setHeaders¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsSetHeaders defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ResponseHeaderTransformations.SetHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
Spec.specification.requestPolicies.authentication.validationFailurePolicy.responseHeaderTransformations.setHeaders.items[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsSetHeadersItem defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ResponseHeaderTransformations.SetHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
ifExists |
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. | string |
No | - | - |
name |
The case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
values |
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. | list[string] |
Yes | - | - |
Spec.specification.requestPolicies.authentication.validationFailurePolicy.sourceUriDetails¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicySourceUriDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.SourceUriDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
type |
- | string |
No | - | - |
uri |
The discovery URI for the auth server. | string |
No | - | - |
Spec.specification.requestPolicies.authentication.validationPolicy¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationPolicy defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationPolicy.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
additionalValidationPolicy |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyAdditionalValidationPolicy defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationPolicy.AdditionalValidationPolicy. | object |
No | - | - |
clientDetails |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyClientDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationPolicy.ClientDetails. | object |
No | - | - |
isSslVerifyDisabled |
Defines whether or not to uphold SSL verification. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
keys |
The set of static public keys. | list[object] |
No | - | - |
maxCacheDurationInHours |
The duration for which the JWKS should be cached before it is fetched again. | integer |
No | - | - |
sourceUriDetails |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationPolicySourceUriDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationPolicy.SourceUriDetails. | object |
No | - | - |
type |
- | string |
No | - | - |
uri |
The uri from which to retrieve the key. It must be accessible without authentication. | string |
No | - | - |
Spec.specification.requestPolicies.authentication.validationPolicy.additionalValidationPolicy¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyAdditionalValidationPolicy defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationPolicy.AdditionalValidationPolicy.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
audiences |
The list of intended recipients for the token. | list[string] |
No | - | - |
issuers |
A list of parties that could have issued the token. | list[string] |
No | - | - |
verifyClaims |
A list of claims which should be validated to consider the token valid. | list[object] |
No | - | - |
Spec.specification.requestPolicies.authentication.validationPolicy.additionalValidationPolicy.verifyClaims[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationPolicy.AdditionalValidationPolicy.VerifyClaim.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isRequired |
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. | boolean |
No | - | - |
key |
Name of the claim. | string |
Yes | - | - |
values |
The list of acceptable values for a given claim. If this value is "null" or empty and "isRequired" set to "true", then the presence of this claim in the JWT is validated. | list[string] |
No | - | - |
Spec.specification.requestPolicies.authentication.validationPolicy.clientDetails¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyClientDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationPolicy.ClientDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
clientId |
Client ID for the OAuth2/OIDC app. | string |
No | - | - |
clientSecretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. | string |
No | - | - |
clientSecretVersionNumber |
The version number of the client secret to use. | integer (int64) |
No | - | - |
jsonData |
- | string |
No | - | - |
type |
- | string |
No | - | - |
Spec.specification.requestPolicies.authentication.validationPolicy.keys[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyKey defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationPolicy.Key.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
alg |
The algorithm intended for use with this key. | string |
No | - | - |
e |
The base64 url encoded exponent of the RSA public key represented by this key. | string |
No | - | - |
format |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
key |
The content of the PEM-encoded public key. | string |
No | - | - |
key_ops |
The operations for which this key is to be used. | list[string] |
No | - | - |
kid |
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid". | string |
Yes | - | - |
kty |
The key type. | string |
No | - | - |
n |
The base64 url encoded modulus of the RSA public key represented by this key. | string |
No | - | - |
use |
The intended use of the public key. | string |
No | - | - |
Spec.specification.requestPolicies.authentication.validationPolicy.sourceUriDetails¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationPolicySourceUriDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationPolicy.SourceUriDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
type |
- | string |
No | - | - |
uri |
The discovery URI for the auth server. | string |
No | - | - |
Spec.specification.requestPolicies.authentication.verifyClaims[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationVerifyClaim defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.VerifyClaim.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isRequired |
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. | boolean |
No | - | - |
key |
Name of the claim. | string |
Yes | - | - |
values |
The list of acceptable values for a given claim. If this value is "null" or empty and "isRequired" set to "true", then the presence of this claim in the JWT is validated. | list[string] |
No | - | - |
Spec.specification.requestPolicies.cors¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesCors defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Cors.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
allowedHeaders |
The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers. | list[string] |
No | - | - |
allowedMethods |
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. | list[string] |
No | - | - |
allowedOrigins |
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. | list[string] |
Yes | - | - |
exposedHeaders |
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. | list[string] |
No | - | - |
isAllowCredentialsEnabled |
Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies. | boolean |
No | - | - |
maxAgeInSeconds |
The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0. | integer |
No | - | - |
Spec.specification.requestPolicies.dynamicAuthentication¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthentication defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
authenticationServers |
List of authentication servers to choose from during dynamic authentication. | list[object] |
Yes | - | - |
selectionSource |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationSelectionSource defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.SelectionSource. | object |
Yes | - | - |
Spec.specification.requestPolicies.dynamicAuthentication.authenticationServers[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServer defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
authenticationServerDetail |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetail defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail. | object |
Yes | - | - |
key |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerKey defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.Key. | object |
Yes | - | - |
Spec.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetail defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
audiences |
The list of intended recipients for the token. | list[string] |
No | - | - |
cacheKey |
A list of keys from "parameters" attribute value whose values will be added to the cache key. | list[string] |
No | - | - |
functionId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource. | string |
No | - | - |
isAnonymousAccessAllowed |
Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization. | boolean |
No | - | - |
issuers |
A list of parties that could have issued the token. | list[string] |
No | - | - |
jsonData |
- | string |
No | - | - |
maxClockSkewInSeconds |
The maximum expected time difference between the system clocks of the token issuer and the API Gateway. | number |
No | - | - |
parameters |
A map where key is a user defined string and value is a context expressions whose values will be sent to the custom auth function. Values should contain an expression. Example: {"foo": "request.header[abc]"} |
map[string, string] |
No | - | - |
publicKeys |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeys defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.PublicKeys. | object |
No | - | - |
tokenAuthScheme |
The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified. | string |
No | - | - |
tokenHeader |
The name of the header containing the authentication token. | string |
No | - | - |
tokenQueryParam |
The name of the query parameter containing the authentication token. | string |
No | - | - |
type |
- | string |
No | - | - |
validationFailurePolicy |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy. | object |
No | - | - |
validationPolicy |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationPolicy. | object |
No | - | - |
verifyClaims |
A list of claims which should be validated to consider the token valid. | list[object] |
No | - | - |
Spec.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.publicKeys¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeys defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.PublicKeys.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isSslVerifyDisabled |
Defines whether or not to uphold SSL verification. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
keys |
The set of static public keys. | list[object] |
No | - | - |
maxCacheDurationInHours |
The duration for which the JWKS should be cached before it is fetched again. | integer |
No | - | - |
type |
- | string |
No | - | - |
uri |
The uri from which to retrieve the key. It must be accessible without authentication. | string |
No | - | - |
Spec.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.publicKeys.keys[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeysKey defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.PublicKeys.Key.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
alg |
The algorithm intended for use with this key. | string |
No | - | - |
e |
The base64 url encoded exponent of the RSA public key represented by this key. | string |
No | - | - |
format |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
key |
The content of the PEM-encoded public key. | string |
No | - | - |
key_ops |
The operations for which this key is to be used. | list[string] |
No | - | - |
kid |
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid". | string |
Yes | - | - |
kty |
The key type. | string |
No | - | - |
n |
The base64 url encoded modulus of the RSA public key represented by this key. | string |
No | - | - |
use |
The intended use of the public key. | string |
No | - | - |
Spec.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationFailurePolicy¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
clientDetails |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ClientDetails. | object |
No | - | - |
fallbackRedirectPath |
The path to be used as fallback after OAuth2. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
logoutPath |
The path to be used as logout. | string |
No | - | - |
maxExpiryDurationInHours |
The duration for which the OAuth2 success token should be cached before it is fetched again. | integer |
No | - | - |
responseCode |
HTTP response code, can include context variables. | string |
No | - | - |
responseHeaderTransformations |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformations defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ResponseHeaderTransformations. | object |
No | - | - |
responseMessage |
HTTP response message. | string |
No | - | - |
responseType |
Response Type. | string |
No | - | - |
scopes |
List of scopes. | list[string] |
No | - | - |
sourceUriDetails |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.SourceUriDetails. | object |
No | - | - |
type |
- | string |
No | - | - |
useCookiesForIntermediateSteps |
Defines whether or not to use cookies for OAuth2 intermediate steps. | boolean |
No | - | - |
useCookiesForSession |
Defines whether or not to use cookies for session maintenance. | boolean |
No | - | - |
usePkce |
Defines whether or not to support PKCE. | boolean |
No | - | - |
Spec.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationFailurePolicy.clientDetails¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ClientDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
clientId |
Client ID for the OAuth2/OIDC app. | string |
No | - | - |
clientSecretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. | string |
No | - | - |
clientSecretVersionNumber |
The version number of the client secret to use. | integer (int64) |
No | - | - |
jsonData |
- | string |
No | - | - |
type |
- | string |
No | - | - |
Spec.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationFailurePolicy.responseHeaderTransformations¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformations defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ResponseHeaderTransformations.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
filterHeaders |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsFilterHeaders defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ResponseHeaderTransformations.FilterHeaders. | object |
No | - | - |
renameHeaders |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsRenameHeaders defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ResponseHeaderTransformations.RenameHeaders. | object |
No | - | - |
setHeaders |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsSetHeaders defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ResponseHeaderTransformations.SetHeaders. | object |
No | - | - |
Spec.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationFailurePolicy.responseHeaderTransformations.filterHeaders¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsFilterHeaders defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ResponseHeaderTransformations.FilterHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
type |
BLOCK drops any headers that are in the list of items, so it acts as an exclusion list. ALLOW permits only the headers in the list and removes all others, so it acts as an inclusion list. | string |
Yes | - | - |
Spec.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationFailurePolicy.responseHeaderTransformations.filterHeaders.items[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsFilterHeadersItem defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ResponseHeaderTransformations.FilterHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
Spec.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationFailurePolicy.responseHeaderTransformations.renameHeaders¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsRenameHeaders defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ResponseHeaderTransformations.RenameHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
Spec.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationFailurePolicy.responseHeaderTransformations.renameHeaders.items[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsRenameHeadersItem defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ResponseHeaderTransformations.RenameHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
from |
The original case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
to |
The new name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
Spec.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationFailurePolicy.responseHeaderTransformations.setHeaders¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsSetHeaders defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ResponseHeaderTransformations.SetHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
Spec.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationFailurePolicy.responseHeaderTransformations.setHeaders.items[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsSetHeadersItem defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ResponseHeaderTransformations.SetHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
ifExists |
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. | string |
No | - | - |
name |
The case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
values |
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. | list[string] |
Yes | - | - |
Spec.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationFailurePolicy.sourceUriDetails¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.SourceUriDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
type |
- | string |
No | - | - |
uri |
The discovery URI for the auth server. | string |
No | - | - |
Spec.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationPolicy¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationPolicy.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
additionalValidationPolicy |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationPolicy.AdditionalValidationPolicy. | object |
No | - | - |
clientDetails |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationPolicy.ClientDetails. | object |
No | - | - |
isSslVerifyDisabled |
Defines whether or not to uphold SSL verification. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
keys |
The set of static public keys. | list[object] |
No | - | - |
maxCacheDurationInHours |
The duration for which the JWKS should be cached before it is fetched again. | integer |
No | - | - |
sourceUriDetails |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationPolicy.SourceUriDetails. | object |
No | - | - |
type |
- | string |
No | - | - |
uri |
The uri from which to retrieve the key. It must be accessible without authentication. | string |
No | - | - |
Spec.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationPolicy.additionalValidationPolicy¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationPolicy.AdditionalValidationPolicy.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
audiences |
The list of intended recipients for the token. | list[string] |
No | - | - |
issuers |
A list of parties that could have issued the token. | list[string] |
No | - | - |
verifyClaims |
A list of claims which should be validated to consider the token valid. | list[object] |
No | - | - |
Spec.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationPolicy.additionalValidationPolicy.verifyClaims[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationPolicy.AdditionalValidationPolicy.VerifyClaim.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isRequired |
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. | boolean |
No | - | - |
key |
Name of the claim. | string |
Yes | - | - |
values |
The list of acceptable values for a given claim. If this value is "null" or empty and "isRequired" set to "true", then the presence of this claim in the JWT is validated. | list[string] |
No | - | - |
Spec.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationPolicy.clientDetails¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationPolicy.ClientDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
clientId |
Client ID for the OAuth2/OIDC app. | string |
No | - | - |
clientSecretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. | string |
No | - | - |
clientSecretVersionNumber |
The version number of the client secret to use. | integer (int64) |
No | - | - |
jsonData |
- | string |
No | - | - |
type |
- | string |
No | - | - |
Spec.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationPolicy.keys[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationPolicy.Key.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
alg |
The algorithm intended for use with this key. | string |
No | - | - |
e |
The base64 url encoded exponent of the RSA public key represented by this key. | string |
No | - | - |
format |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
key |
The content of the PEM-encoded public key. | string |
No | - | - |
key_ops |
The operations for which this key is to be used. | list[string] |
No | - | - |
kid |
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid". | string |
Yes | - | - |
kty |
The key type. | string |
No | - | - |
n |
The base64 url encoded modulus of the RSA public key represented by this key. | string |
No | - | - |
use |
The intended use of the public key. | string |
No | - | - |
Spec.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationPolicy.sourceUriDetails¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationPolicy.SourceUriDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
type |
- | string |
No | - | - |
uri |
The discovery URI for the auth server. | string |
No | - | - |
Spec.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.verifyClaims[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.VerifyClaim.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isRequired |
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. | boolean |
No | - | - |
key |
Name of the claim. | string |
Yes | - | - |
values |
The list of acceptable values for a given claim. If this value is "null" or empty and "isRequired" set to "true", then the presence of this claim in the JWT is validated. | list[string] |
No | - | - |
Spec.specification.requestPolicies.dynamicAuthentication.authenticationServers[].key¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerKey defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.Key.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
expression |
A selection key string containing a wildcard to match with the context variable in an incoming request. If the context variable matches the string, the request is sent to the route or authentication server associated with the selection key. Valid wildcards are '*' (zero or more characters) and '+' (one or more characters). The string can only contain one wildcard, and the wildcard must be at the start or the end of the string. | string |
No | - | - |
isDefault |
Specifies whether to use the route or authentication server associated with this selection key as the default. The default is used if the value of a context variable in an incoming request does not match any of the other selection key values when dynamically routing and dynamically authenticating requests. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
name |
Name assigned to the branch. | string |
Yes | - | - |
type |
- | string |
No | - | - |
values |
The set of selection keys to match with the context variable in an incoming request. If the context variable exactly matches one of the keys in the set, the request is sent to the route or authentication server associated with the set. | list[string] |
No | - | - |
Spec.specification.requestPolicies.dynamicAuthentication.selectionSource¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationSelectionSource defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.SelectionSource.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
selector |
String describing the context variable used as selector. | string |
No | - | - |
type |
- | string |
No | - | - |
Spec.specification.requestPolicies.mutualTls¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesMutualTls defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.MutualTls.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
allowedSans |
Allowed list of CN or SAN which will be used for verification of certificate. | list[string] |
No | - | - |
isVerifiedCertificateRequired |
Determines whether to enable client verification when API Consumer makes connection to the gateway. | boolean |
No | - | - |
Spec.specification.requestPolicies.rateLimiting¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesRateLimiting defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.RateLimiting.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
rateInRequestsPerSecond |
The maximum number of requests per second to allow. | integer |
Yes | - | - |
rateKey |
The key used to group requests together. | string |
Yes | - | - |
Spec.specification.requestPolicies.usagePlans¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRequestPoliciesUsagePlans defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.UsagePlans.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
tokenLocations |
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]" | list[string] |
Yes | - | - |
Spec.specification.routes[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRoute defines nested fields for ApiGatewayDeployment.Specification.Route.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
backend |
ApiGatewayDeploymentSpecificationRouteBackend defines nested fields for ApiGatewayDeployment.Specification.Route.Backend. | object |
Yes | - | - |
loggingPolicies |
ApiGatewayDeploymentSpecificationRouteLoggingPolicies defines nested fields for ApiGatewayDeployment.Specification.Route.LoggingPolicies. | object |
No | - | - |
methods |
A list of allowed methods on this route. | list[string] |
No | - | - |
path |
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. | string |
Yes | - | - |
requestPolicies |
ApiGatewayDeploymentSpecificationRouteRequestPolicies defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies. | object |
No | - | - |
responsePolicies |
ApiGatewayDeploymentSpecificationRouteResponsePolicies defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies. | object |
No | - | - |
Spec.specification.routes[].backend¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteBackend defines nested fields for ApiGatewayDeployment.Specification.Route.Backend.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
allowedPostLogoutUris |
A list of allowed post-logout URLs to which a request can be redirected after revoke access | list[string] |
No | - | - |
body |
The body of the stock response from the mock backend. | string |
No | - | - |
connectTimeoutInSeconds |
Defines a timeout for establishing a connection with a proxied server. | number |
No | - | - |
functionId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource. | string |
No | - | - |
headers |
The headers of the stock response from the mock backend. | list[object] |
No | - | - |
isSslVerifyDisabled |
Defines whether or not to uphold SSL verification. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
postLogoutState |
Defines a state that should be shared on redirecting to postLogout URL. | string |
No | - | - |
readTimeoutInSeconds |
Defines a timeout for reading a response from the proxied server. | number |
No | - | - |
routingBackends |
List of backends to chose from for Dynamic Routing. | list[object] |
No | - | - |
selectionSource |
ApiGatewayDeploymentSpecificationRouteBackendSelectionSource defines nested fields for ApiGatewayDeployment.Specification.Route.Backend.SelectionSource. | object |
No | - | - |
sendTimeoutInSeconds |
Defines a timeout for transmitting a request to the proxied server. | number |
No | - | - |
status |
The status code of the stock response from the mock backend. | integer |
No | - | - |
type |
- | string |
No | - | - |
url |
The url of the HTTP Backend | string |
No | - | - |
Spec.specification.routes[].backend.headers[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteBackendHeader defines nested fields for ApiGatewayDeployment.Specification.Route.Backend.Header.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Name of the header. | string |
No | - | - |
value |
Value of the header. | string |
No | - | - |
Spec.specification.routes[].backend.routingBackends[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteBackendRoutingBackend defines nested fields for ApiGatewayDeployment.Specification.Route.Backend.RoutingBackend.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
backend |
JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. | object (preserves unknown fields) |
Yes | - | - |
key |
ApiGatewayDeploymentSpecificationRouteBackendRoutingBackendKey defines nested fields for ApiGatewayDeployment.Specification.Route.Backend.RoutingBackend.Key. | object |
Yes | - | - |
Spec.specification.routes[].backend.routingBackends[].key¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteBackendRoutingBackendKey defines nested fields for ApiGatewayDeployment.Specification.Route.Backend.RoutingBackend.Key.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
expression |
A selection key string containing a wildcard to match with the context variable in an incoming request. If the context variable matches the string, the request is sent to the route or authentication server associated with the selection key. Valid wildcards are '*' (zero or more characters) and '+' (one or more characters). The string can only contain one wildcard, and the wildcard must be at the start or the end of the string. | string |
No | - | - |
isDefault |
Specifies whether to use the route or authentication server associated with this selection key as the default. The default is used if the value of a context variable in an incoming request does not match any of the other selection key values when dynamically routing and dynamically authenticating requests. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
name |
Name assigned to the branch. | string |
Yes | - | - |
type |
- | string |
No | - | - |
values |
The set of selection keys to match with the context variable in an incoming request. If the context variable exactly matches one of the keys in the set, the request is sent to the route or authentication server associated with the set. | list[string] |
No | - | - |
Spec.specification.routes[].backend.selectionSource¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteBackendSelectionSource defines nested fields for ApiGatewayDeployment.Specification.Route.Backend.SelectionSource.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
selector |
String describing the context variable used as selector. | string |
No | - | - |
type |
- | string |
No | - | - |
Spec.specification.routes[].loggingPolicies¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteLoggingPolicies defines nested fields for ApiGatewayDeployment.Specification.Route.LoggingPolicies.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
accessLog |
ApiGatewayDeploymentSpecificationRouteLoggingPoliciesAccessLog defines nested fields for ApiGatewayDeployment.Specification.Route.LoggingPolicies.AccessLog. | object |
No | - | - |
executionLog |
ApiGatewayDeploymentSpecificationRouteLoggingPoliciesExecutionLog defines nested fields for ApiGatewayDeployment.Specification.Route.LoggingPolicies.ExecutionLog. | object |
No | - | - |
Spec.specification.routes[].loggingPolicies.accessLog¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteLoggingPoliciesAccessLog defines nested fields for ApiGatewayDeployment.Specification.Route.LoggingPolicies.AccessLog.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isEnabled |
Enables pushing of access logs to the legacy OCI Object Storage log archival bucket. Oracle recommends using the OCI Logging service to enable, retrieve, and query access logs for an API Deployment. If there is an active log object for the API Deployment and its category is set to 'access' in OCI Logging service, the logs will not be uploaded to the legacy OCI Object Storage log archival bucket. Please note that the functionality to push to the legacy OCI Object Storage log archival bucket has been deprecated and will be removed in the future. | boolean |
No | - | - |
Spec.specification.routes[].loggingPolicies.executionLog¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteLoggingPoliciesExecutionLog defines nested fields for ApiGatewayDeployment.Specification.Route.LoggingPolicies.ExecutionLog.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isEnabled |
Enables pushing of execution logs to the legacy OCI Object Storage log archival bucket. Oracle recommends using the OCI Logging service to enable, retrieve, and query execution logs for an API Deployment. If there is an active log object for the API Deployment and its category is set to 'execution' in OCI Logging service, the logs will not be uploaded to the legacy OCI Object Storage log archival bucket. Please note that the functionality to push to the legacy OCI Object Storage log archival bucket has been deprecated and will be removed in the future. | boolean |
No | - | - |
logLevel |
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. | string |
No | - | - |
Spec.specification.routes[].requestPolicies¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPolicies defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
authorization |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesAuthorization defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.Authorization. | object |
No | - | - |
bodyValidation |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesBodyValidation defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.BodyValidation. | object |
No | - | - |
cors |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesCors defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.Cors. | object |
No | - | - |
headerTransformations |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformations defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations. | object |
No | - | - |
headerValidations |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderValidations defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderValidations. | object |
No | - | - |
queryParameterTransformations |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformations defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations. | object |
No | - | - |
queryParameterValidations |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterValidations defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterValidations. | object |
No | - | - |
responseCacheLookup |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesResponseCacheLookup defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.ResponseCacheLookup. | object |
No | - | - |
Spec.specification.routes[].requestPolicies.authorization¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesAuthorization defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.Authorization.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
allowedScope |
A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive. | list[string] |
No | - | - |
jsonData |
- | string |
No | - | - |
type |
- | string |
No | - | - |
Spec.specification.routes[].requestPolicies.bodyValidation¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesBodyValidation defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.BodyValidation.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
content |
The content of the request body. The key is a media type range (https://tools.ietf.org/html/rfc7231#appendix-D) subset restricted to the following schema key ::= ( / ( "" "/" "" ) / ( type "/" "*" ) / ( type "/" subtype ) ) For requests that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/* |
map[string, object] |
Yes | - | - |
required |
Determines if the request body is required in the request. | boolean |
No | - | - |
validationMode |
Validation behavior mode. In ENFORCING mode, upon a validation failure, the request will be rejected with a 4xx response and not sent to the backend. In PERMISSIVE mode, the result of the validation will be exposed as metrics while the request will follow the normal path. DISABLED type turns the validation off. |
string |
No | - | - |
Spec.specification.routes[].requestPolicies.bodyValidation.content{}¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesBodyValidationContent defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.BodyValidation.Content.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
validationType |
- | string |
No | - | - |
Spec.specification.routes[].requestPolicies.cors¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesCors defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.Cors.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
allowedHeaders |
The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers. | list[string] |
No | - | - |
allowedMethods |
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. | list[string] |
No | - | - |
allowedOrigins |
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. | list[string] |
Yes | - | - |
exposedHeaders |
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. | list[string] |
No | - | - |
isAllowCredentialsEnabled |
Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies. | boolean |
No | - | - |
maxAgeInSeconds |
The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0. | integer |
No | - | - |
Spec.specification.routes[].requestPolicies.headerTransformations¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformations defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
filterHeaders |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.FilterHeaders. | object |
No | - | - |
renameHeaders |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.RenameHeaders. | object |
No | - | - |
setHeaders |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.SetHeaders. | object |
No | - | - |
Spec.specification.routes[].requestPolicies.headerTransformations.filterHeaders¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.FilterHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
type |
BLOCK drops any headers that are in the list of items, so it acts as an exclusion list. ALLOW permits only the headers in the list and removes all others, so it acts as an inclusion list. | string |
Yes | - | - |
Spec.specification.routes[].requestPolicies.headerTransformations.filterHeaders.items[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeadersItem defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.FilterHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
Spec.specification.routes[].requestPolicies.headerTransformations.renameHeaders¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.RenameHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
Spec.specification.routes[].requestPolicies.headerTransformations.renameHeaders.items[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeadersItem defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.RenameHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
from |
The original case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
to |
The new name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
Spec.specification.routes[].requestPolicies.headerTransformations.setHeaders¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.SetHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
Spec.specification.routes[].requestPolicies.headerTransformations.setHeaders.items[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeadersItem defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.SetHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
ifExists |
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. | string |
No | - | - |
name |
The case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
values |
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. | list[string] |
Yes | - | - |
Spec.specification.routes[].requestPolicies.headerValidations¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderValidations defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderValidations.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
headers |
The List of Headers | list[object] |
No | - | - |
validationMode |
Validation behavior mode. In ENFORCING mode, upon a validation failure, the request will be rejected with a 4xx response and not sent to the backend. In PERMISSIVE mode, the result of the validation will be exposed as metrics while the request will follow the normal path. DISABLED type turns the validation off. |
string |
No | - | - |
Spec.specification.routes[].requestPolicies.headerValidations.headers[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderValidationsHeader defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderValidations.Header.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Parameter name. | string |
Yes | - | - |
required |
Determines if the header is required in the request. | boolean |
No | - | - |
Spec.specification.routes[].requestPolicies.queryParameterTransformations¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformations defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
filterQueryParameters |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParameters defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.FilterQueryParameters. | object |
No | - | - |
renameQueryParameters |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParameters defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.RenameQueryParameters. | object |
No | - | - |
setQueryParameters |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParameters defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.SetQueryParameters. | object |
No | - | - |
Spec.specification.routes[].requestPolicies.queryParameterTransformations.filterQueryParameters¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParameters defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.FilterQueryParameters.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of query parameters. | list[object] |
Yes | - | - |
type |
BLOCK drops any query parameters that are in the list of items, so it acts as an exclusion list. ALLOW permits only the parameters in the list and removes all others, so it acts as an inclusion list. | string |
Yes | - | - |
Spec.specification.routes[].requestPolicies.queryParameterTransformations.filterQueryParameters.items[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParametersItem defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.FilterQueryParameters.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The case-sensitive name of the query parameter. | string |
Yes | - | - |
Spec.specification.routes[].requestPolicies.queryParameterTransformations.renameQueryParameters¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParameters defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.RenameQueryParameters.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of query parameters. | list[object] |
Yes | - | - |
Spec.specification.routes[].requestPolicies.queryParameterTransformations.renameQueryParameters.items[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParametersItem defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.RenameQueryParameters.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
from |
The original case-sensitive name of the query parameter. This name must be unique across transformation policies. | string |
Yes | - | - |
to |
The new name of the query parameter. This name must be unique across transformation policies. | string |
Yes | - | - |
Spec.specification.routes[].requestPolicies.queryParameterTransformations.setQueryParameters¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParameters defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.SetQueryParameters.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of query parameters. | list[object] |
Yes | - | - |
Spec.specification.routes[].requestPolicies.queryParameterTransformations.setQueryParameters.items[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParametersItem defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.SetQueryParameters.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
ifExists |
If a query parameter 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. | string |
No | - | - |
name |
The case-sensitive name of the query parameter. This name must be unique across transformation policies. | string |
Yes | - | - |
values |
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. | list[string] |
Yes | - | - |
Spec.specification.routes[].requestPolicies.queryParameterValidations¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterValidations defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterValidations.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
parameters |
The List of Query Parameters | list[object] |
No | - | - |
validationMode |
Validation behavior mode. In ENFORCING mode, upon a validation failure, the request will be rejected with a 4xx response and not sent to the backend. In PERMISSIVE mode, the result of the validation will be exposed as metrics while the request will follow the normal path. DISABLED type turns the validation off. |
string |
No | - | - |
Spec.specification.routes[].requestPolicies.queryParameterValidations.parameters[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterValidationsParameter defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterValidations.Parameter.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Parameter name. | string |
Yes | - | - |
required |
Determines if the parameter is required in the request. | boolean |
No | - | - |
Spec.specification.routes[].requestPolicies.responseCacheLookup¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteRequestPoliciesResponseCacheLookup defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.ResponseCacheLookup.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
cacheKeyAdditions |
A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available. | list[string] |
No | - | - |
isEnabled |
Whether this policy is currently enabled. | boolean |
No | - | - |
isPrivateCachingEnabled |
Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require. When false, any request with an Authorization header will not be stored in the Response Cache. If using the CustomAuthenticationPolicy then the tokenHeader/tokenQueryParam are also subject to this check. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
type |
- | string |
No | - | - |
Spec.specification.routes[].responsePolicies¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteResponsePolicies defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
headerTransformations |
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformations defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations. | object |
No | - | - |
responseCacheStore |
ApiGatewayDeploymentSpecificationRouteResponsePoliciesResponseCacheStore defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.ResponseCacheStore. | object |
No | - | - |
Spec.specification.routes[].responsePolicies.headerTransformations¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformations defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
filterHeaders |
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.FilterHeaders. | object |
No | - | - |
renameHeaders |
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.RenameHeaders. | object |
No | - | - |
setHeaders |
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.SetHeaders. | object |
No | - | - |
Spec.specification.routes[].responsePolicies.headerTransformations.filterHeaders¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.FilterHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
type |
BLOCK drops any headers that are in the list of items, so it acts as an exclusion list. ALLOW permits only the headers in the list and removes all others, so it acts as an inclusion list. | string |
Yes | - | - |
Spec.specification.routes[].responsePolicies.headerTransformations.filterHeaders.items[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeadersItem defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.FilterHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
Spec.specification.routes[].responsePolicies.headerTransformations.renameHeaders¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.RenameHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
Spec.specification.routes[].responsePolicies.headerTransformations.renameHeaders.items[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeadersItem defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.RenameHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
from |
The original case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
to |
The new name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
Spec.specification.routes[].responsePolicies.headerTransformations.setHeaders¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.SetHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
Spec.specification.routes[].responsePolicies.headerTransformations.setHeaders.items[]¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeadersItem defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.SetHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
ifExists |
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. | string |
No | - | - |
name |
The case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
values |
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. | list[string] |
Yes | - | - |
Spec.specification.routes[].responsePolicies.responseCacheStore¶
Back to ApiGatewayDeployment spec
ApiGatewayDeploymentSpecificationRouteResponsePoliciesResponseCacheStore defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.ResponseCacheStore.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
timeToLiveInSeconds |
Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires. | integer |
No | - | - |
type |
- | string |
No | - | - |
Status¶
ApiGatewayDeploymentStatus defines the observed state of ApiGatewayDeployment.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created. | string |
No | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource |
string |
No | - | - |
endpoint |
The endpoint to access this deployment on the gateway. | string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
gatewayId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. | string |
No | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. | string |
No | - | - |
lifecycleDetails |
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. | string |
No | - | - |
lifecycleState |
The current state of the deployment. | string |
No | - | - |
locks |
Locks associated with this resource. | list[object] |
No | - | - |
pathPrefix |
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 (https://docs.oracle.com/iaas/Content/APIGateway/Tasks/apigatewaycreatingdeployment.htm). | string |
No | - | - |
specification |
ApiGatewayDeploymentSpecification defines nested fields for ApiGatewayDeployment.Specification. | object |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
timeCreated |
The time this resource was created. An RFC3339 formatted datetime string. | string |
No | - | - |
timeUpdated |
The time this resource was last updated. An RFC3339 formatted datetime string. | string |
No | - | - |
Status.locks[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentLock defines nested fields for ApiGatewayDeployment.Lock.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. | string |
No | - | - |
type |
Type of the lock. | string |
Yes | - | - |
Status.specification¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecification defines nested fields for ApiGatewayDeployment.Specification.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
loggingPolicies |
ApiGatewayDeploymentSpecificationLoggingPolicies defines nested fields for ApiGatewayDeployment.Specification.LoggingPolicies. | object |
No | - | - |
requestPolicies |
ApiGatewayDeploymentSpecificationRequestPolicies defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies. | object |
No | - | - |
routes |
A list of routes that this API exposes. | list[object] |
No | - | - |
Status.specification.loggingPolicies¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationLoggingPolicies defines nested fields for ApiGatewayDeployment.Specification.LoggingPolicies.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
accessLog |
ApiGatewayDeploymentSpecificationLoggingPoliciesAccessLog defines nested fields for ApiGatewayDeployment.Specification.LoggingPolicies.AccessLog. | object |
No | - | - |
executionLog |
ApiGatewayDeploymentSpecificationLoggingPoliciesExecutionLog defines nested fields for ApiGatewayDeployment.Specification.LoggingPolicies.ExecutionLog. | object |
No | - | - |
Status.specification.loggingPolicies.accessLog¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationLoggingPoliciesAccessLog defines nested fields for ApiGatewayDeployment.Specification.LoggingPolicies.AccessLog.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isEnabled |
Enables pushing of access logs to the legacy OCI Object Storage log archival bucket. Oracle recommends using the OCI Logging service to enable, retrieve, and query access logs for an API Deployment. If there is an active log object for the API Deployment and its category is set to 'access' in OCI Logging service, the logs will not be uploaded to the legacy OCI Object Storage log archival bucket. Please note that the functionality to push to the legacy OCI Object Storage log archival bucket has been deprecated and will be removed in the future. | boolean |
No | - | - |
Status.specification.loggingPolicies.executionLog¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationLoggingPoliciesExecutionLog defines nested fields for ApiGatewayDeployment.Specification.LoggingPolicies.ExecutionLog.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isEnabled |
Enables pushing of execution logs to the legacy OCI Object Storage log archival bucket. Oracle recommends using the OCI Logging service to enable, retrieve, and query execution logs for an API Deployment. If there is an active log object for the API Deployment and its category is set to 'execution' in OCI Logging service, the logs will not be uploaded to the legacy OCI Object Storage log archival bucket. Please note that the functionality to push to the legacy OCI Object Storage log archival bucket has been deprecated and will be removed in the future. | boolean |
No | - | - |
logLevel |
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. | string |
No | - | - |
Status.specification.requestPolicies¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPolicies defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
authentication |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthentication defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication. | object |
No | - | - |
cors |
ApiGatewayDeploymentSpecificationRequestPoliciesCors defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Cors. | object |
No | - | - |
dynamicAuthentication |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthentication defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication. | object |
No | - | - |
mutualTls |
ApiGatewayDeploymentSpecificationRequestPoliciesMutualTls defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.MutualTls. | object |
No | - | - |
rateLimiting |
ApiGatewayDeploymentSpecificationRequestPoliciesRateLimiting defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.RateLimiting. | object |
No | - | - |
usagePlans |
ApiGatewayDeploymentSpecificationRequestPoliciesUsagePlans defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.UsagePlans. | object |
No | - | - |
Status.specification.requestPolicies.authentication¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesAuthentication defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
audiences |
The list of intended recipients for the token. | list[string] |
No | - | - |
cacheKey |
A list of keys from "parameters" attribute value whose values will be added to the cache key. | list[string] |
No | - | - |
functionId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource. | string |
No | - | - |
isAnonymousAccessAllowed |
Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization. | boolean |
No | - | - |
issuers |
A list of parties that could have issued the token. | list[string] |
No | - | - |
jsonData |
- | string |
No | - | - |
maxClockSkewInSeconds |
The maximum expected time difference between the system clocks of the token issuer and the API Gateway. | number |
No | - | - |
parameters |
A map where key is a user defined string and value is a context expressions whose values will be sent to the custom auth function. Values should contain an expression. Example: {"foo": "request.header[abc]"} |
map[string, string] |
No | - | - |
publicKeys |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationPublicKeys defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.PublicKeys. | object |
No | - | - |
tokenAuthScheme |
The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified. | string |
No | - | - |
tokenHeader |
The name of the header containing the authentication token. | string |
No | - | - |
tokenQueryParam |
The name of the query parameter containing the authentication token. | string |
No | - | - |
type |
- | string |
No | - | - |
validationFailurePolicy |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicy defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy. | object |
No | - | - |
validationPolicy |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationPolicy defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationPolicy. | object |
No | - | - |
verifyClaims |
A list of claims which should be validated to consider the token valid. | list[object] |
No | - | - |
Status.specification.requestPolicies.authentication.publicKeys¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationPublicKeys defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.PublicKeys.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isSslVerifyDisabled |
Defines whether or not to uphold SSL verification. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
keys |
The set of static public keys. | list[object] |
No | - | - |
maxCacheDurationInHours |
The duration for which the JWKS should be cached before it is fetched again. | integer |
No | - | - |
type |
- | string |
No | - | - |
uri |
The uri from which to retrieve the key. It must be accessible without authentication. | string |
No | - | - |
Status.specification.requestPolicies.authentication.publicKeys.keys[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationPublicKeysKey defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.PublicKeys.Key.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
alg |
The algorithm intended for use with this key. | string |
No | - | - |
e |
The base64 url encoded exponent of the RSA public key represented by this key. | string |
No | - | - |
format |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
key |
The content of the PEM-encoded public key. | string |
No | - | - |
key_ops |
The operations for which this key is to be used. | list[string] |
No | - | - |
kid |
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid". | string |
Yes | - | - |
kty |
The key type. | string |
No | - | - |
n |
The base64 url encoded modulus of the RSA public key represented by this key. | string |
No | - | - |
use |
The intended use of the public key. | string |
No | - | - |
Status.specification.requestPolicies.authentication.validationFailurePolicy¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicy defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
clientDetails |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyClientDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ClientDetails. | object |
No | - | - |
fallbackRedirectPath |
The path to be used as fallback after OAuth2. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
logoutPath |
The path to be used as logout. | string |
No | - | - |
maxExpiryDurationInHours |
The duration for which the OAuth2 success token should be cached before it is fetched again. | integer |
No | - | - |
responseCode |
HTTP response code, can include context variables. | string |
No | - | - |
responseHeaderTransformations |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformations defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ResponseHeaderTransformations. | object |
No | - | - |
responseMessage |
HTTP response message. | string |
No | - | - |
responseType |
Response Type. | string |
No | - | - |
scopes |
List of scopes. | list[string] |
No | - | - |
sourceUriDetails |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicySourceUriDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.SourceUriDetails. | object |
No | - | - |
type |
- | string |
No | - | - |
useCookiesForIntermediateSteps |
Defines whether or not to use cookies for OAuth2 intermediate steps. | boolean |
No | - | - |
useCookiesForSession |
Defines whether or not to use cookies for session maintenance. | boolean |
No | - | - |
usePkce |
Defines whether or not to support PKCE. | boolean |
No | - | - |
Status.specification.requestPolicies.authentication.validationFailurePolicy.clientDetails¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyClientDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ClientDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
clientId |
Client ID for the OAuth2/OIDC app. | string |
No | - | - |
clientSecretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. | string |
No | - | - |
clientSecretVersionNumber |
The version number of the client secret to use. | integer (int64) |
No | - | - |
jsonData |
- | string |
No | - | - |
type |
- | string |
No | - | - |
Status.specification.requestPolicies.authentication.validationFailurePolicy.responseHeaderTransformations¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformations defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ResponseHeaderTransformations.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
filterHeaders |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsFilterHeaders defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ResponseHeaderTransformations.FilterHeaders. | object |
No | - | - |
renameHeaders |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsRenameHeaders defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ResponseHeaderTransformations.RenameHeaders. | object |
No | - | - |
setHeaders |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsSetHeaders defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ResponseHeaderTransformations.SetHeaders. | object |
No | - | - |
Status.specification.requestPolicies.authentication.validationFailurePolicy.responseHeaderTransformations.filterHeaders¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsFilterHeaders defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ResponseHeaderTransformations.FilterHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
type |
BLOCK drops any headers that are in the list of items, so it acts as an exclusion list. ALLOW permits only the headers in the list and removes all others, so it acts as an inclusion list. | string |
Yes | - | - |
Status.specification.requestPolicies.authentication.validationFailurePolicy.responseHeaderTransformations.filterHeaders.items[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsFilterHeadersItem defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ResponseHeaderTransformations.FilterHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
Status.specification.requestPolicies.authentication.validationFailurePolicy.responseHeaderTransformations.renameHeaders¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsRenameHeaders defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ResponseHeaderTransformations.RenameHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
Status.specification.requestPolicies.authentication.validationFailurePolicy.responseHeaderTransformations.renameHeaders.items[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsRenameHeadersItem defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ResponseHeaderTransformations.RenameHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
from |
The original case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
to |
The new name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
Status.specification.requestPolicies.authentication.validationFailurePolicy.responseHeaderTransformations.setHeaders¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsSetHeaders defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ResponseHeaderTransformations.SetHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
Status.specification.requestPolicies.authentication.validationFailurePolicy.responseHeaderTransformations.setHeaders.items[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsSetHeadersItem defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.ResponseHeaderTransformations.SetHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
ifExists |
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. | string |
No | - | - |
name |
The case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
values |
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. | list[string] |
Yes | - | - |
Status.specification.requestPolicies.authentication.validationFailurePolicy.sourceUriDetails¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicySourceUriDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationFailurePolicy.SourceUriDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
type |
- | string |
No | - | - |
uri |
The discovery URI for the auth server. | string |
No | - | - |
Status.specification.requestPolicies.authentication.validationPolicy¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationPolicy defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationPolicy.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
additionalValidationPolicy |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyAdditionalValidationPolicy defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationPolicy.AdditionalValidationPolicy. | object |
No | - | - |
clientDetails |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyClientDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationPolicy.ClientDetails. | object |
No | - | - |
isSslVerifyDisabled |
Defines whether or not to uphold SSL verification. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
keys |
The set of static public keys. | list[object] |
No | - | - |
maxCacheDurationInHours |
The duration for which the JWKS should be cached before it is fetched again. | integer |
No | - | - |
sourceUriDetails |
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationPolicySourceUriDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationPolicy.SourceUriDetails. | object |
No | - | - |
type |
- | string |
No | - | - |
uri |
The uri from which to retrieve the key. It must be accessible without authentication. | string |
No | - | - |
Status.specification.requestPolicies.authentication.validationPolicy.additionalValidationPolicy¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyAdditionalValidationPolicy defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationPolicy.AdditionalValidationPolicy.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
audiences |
The list of intended recipients for the token. | list[string] |
No | - | - |
issuers |
A list of parties that could have issued the token. | list[string] |
No | - | - |
verifyClaims |
A list of claims which should be validated to consider the token valid. | list[object] |
No | - | - |
Status.specification.requestPolicies.authentication.validationPolicy.additionalValidationPolicy.verifyClaims[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationPolicy.AdditionalValidationPolicy.VerifyClaim.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isRequired |
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. | boolean |
No | - | - |
key |
Name of the claim. | string |
Yes | - | - |
values |
The list of acceptable values for a given claim. If this value is "null" or empty and "isRequired" set to "true", then the presence of this claim in the JWT is validated. | list[string] |
No | - | - |
Status.specification.requestPolicies.authentication.validationPolicy.clientDetails¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyClientDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationPolicy.ClientDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
clientId |
Client ID for the OAuth2/OIDC app. | string |
No | - | - |
clientSecretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. | string |
No | - | - |
clientSecretVersionNumber |
The version number of the client secret to use. | integer (int64) |
No | - | - |
jsonData |
- | string |
No | - | - |
type |
- | string |
No | - | - |
Status.specification.requestPolicies.authentication.validationPolicy.keys[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyKey defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationPolicy.Key.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
alg |
The algorithm intended for use with this key. | string |
No | - | - |
e |
The base64 url encoded exponent of the RSA public key represented by this key. | string |
No | - | - |
format |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
key |
The content of the PEM-encoded public key. | string |
No | - | - |
key_ops |
The operations for which this key is to be used. | list[string] |
No | - | - |
kid |
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid". | string |
Yes | - | - |
kty |
The key type. | string |
No | - | - |
n |
The base64 url encoded modulus of the RSA public key represented by this key. | string |
No | - | - |
use |
The intended use of the public key. | string |
No | - | - |
Status.specification.requestPolicies.authentication.validationPolicy.sourceUriDetails¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationValidationPolicySourceUriDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.ValidationPolicy.SourceUriDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
type |
- | string |
No | - | - |
uri |
The discovery URI for the auth server. | string |
No | - | - |
Status.specification.requestPolicies.authentication.verifyClaims[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesAuthenticationVerifyClaim defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Authentication.VerifyClaim.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isRequired |
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. | boolean |
No | - | - |
key |
Name of the claim. | string |
Yes | - | - |
values |
The list of acceptable values for a given claim. If this value is "null" or empty and "isRequired" set to "true", then the presence of this claim in the JWT is validated. | list[string] |
No | - | - |
Status.specification.requestPolicies.cors¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesCors defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.Cors.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
allowedHeaders |
The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers. | list[string] |
No | - | - |
allowedMethods |
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. | list[string] |
No | - | - |
allowedOrigins |
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. | list[string] |
Yes | - | - |
exposedHeaders |
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. | list[string] |
No | - | - |
isAllowCredentialsEnabled |
Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies. | boolean |
No | - | - |
maxAgeInSeconds |
The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0. | integer |
No | - | - |
Status.specification.requestPolicies.dynamicAuthentication¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthentication defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
authenticationServers |
List of authentication servers to choose from during dynamic authentication. | list[object] |
Yes | - | - |
selectionSource |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationSelectionSource defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.SelectionSource. | object |
Yes | - | - |
Status.specification.requestPolicies.dynamicAuthentication.authenticationServers[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServer defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
authenticationServerDetail |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetail defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail. | object |
Yes | - | - |
key |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerKey defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.Key. | object |
Yes | - | - |
Status.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetail defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
audiences |
The list of intended recipients for the token. | list[string] |
No | - | - |
cacheKey |
A list of keys from "parameters" attribute value whose values will be added to the cache key. | list[string] |
No | - | - |
functionId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource. | string |
No | - | - |
isAnonymousAccessAllowed |
Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization. | boolean |
No | - | - |
issuers |
A list of parties that could have issued the token. | list[string] |
No | - | - |
jsonData |
- | string |
No | - | - |
maxClockSkewInSeconds |
The maximum expected time difference between the system clocks of the token issuer and the API Gateway. | number |
No | - | - |
parameters |
A map where key is a user defined string and value is a context expressions whose values will be sent to the custom auth function. Values should contain an expression. Example: {"foo": "request.header[abc]"} |
map[string, string] |
No | - | - |
publicKeys |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeys defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.PublicKeys. | object |
No | - | - |
tokenAuthScheme |
The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified. | string |
No | - | - |
tokenHeader |
The name of the header containing the authentication token. | string |
No | - | - |
tokenQueryParam |
The name of the query parameter containing the authentication token. | string |
No | - | - |
type |
- | string |
No | - | - |
validationFailurePolicy |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy. | object |
No | - | - |
validationPolicy |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationPolicy. | object |
No | - | - |
verifyClaims |
A list of claims which should be validated to consider the token valid. | list[object] |
No | - | - |
Status.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.publicKeys¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeys defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.PublicKeys.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isSslVerifyDisabled |
Defines whether or not to uphold SSL verification. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
keys |
The set of static public keys. | list[object] |
No | - | - |
maxCacheDurationInHours |
The duration for which the JWKS should be cached before it is fetched again. | integer |
No | - | - |
type |
- | string |
No | - | - |
uri |
The uri from which to retrieve the key. It must be accessible without authentication. | string |
No | - | - |
Status.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.publicKeys.keys[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeysKey defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.PublicKeys.Key.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
alg |
The algorithm intended for use with this key. | string |
No | - | - |
e |
The base64 url encoded exponent of the RSA public key represented by this key. | string |
No | - | - |
format |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
key |
The content of the PEM-encoded public key. | string |
No | - | - |
key_ops |
The operations for which this key is to be used. | list[string] |
No | - | - |
kid |
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid". | string |
Yes | - | - |
kty |
The key type. | string |
No | - | - |
n |
The base64 url encoded modulus of the RSA public key represented by this key. | string |
No | - | - |
use |
The intended use of the public key. | string |
No | - | - |
Status.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationFailurePolicy¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
clientDetails |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ClientDetails. | object |
No | - | - |
fallbackRedirectPath |
The path to be used as fallback after OAuth2. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
logoutPath |
The path to be used as logout. | string |
No | - | - |
maxExpiryDurationInHours |
The duration for which the OAuth2 success token should be cached before it is fetched again. | integer |
No | - | - |
responseCode |
HTTP response code, can include context variables. | string |
No | - | - |
responseHeaderTransformations |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformations defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ResponseHeaderTransformations. | object |
No | - | - |
responseMessage |
HTTP response message. | string |
No | - | - |
responseType |
Response Type. | string |
No | - | - |
scopes |
List of scopes. | list[string] |
No | - | - |
sourceUriDetails |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.SourceUriDetails. | object |
No | - | - |
type |
- | string |
No | - | - |
useCookiesForIntermediateSteps |
Defines whether or not to use cookies for OAuth2 intermediate steps. | boolean |
No | - | - |
useCookiesForSession |
Defines whether or not to use cookies for session maintenance. | boolean |
No | - | - |
usePkce |
Defines whether or not to support PKCE. | boolean |
No | - | - |
Status.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationFailurePolicy.clientDetails¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ClientDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
clientId |
Client ID for the OAuth2/OIDC app. | string |
No | - | - |
clientSecretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. | string |
No | - | - |
clientSecretVersionNumber |
The version number of the client secret to use. | integer (int64) |
No | - | - |
jsonData |
- | string |
No | - | - |
type |
- | string |
No | - | - |
Status.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationFailurePolicy.responseHeaderTransformations¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformations defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ResponseHeaderTransformations.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
filterHeaders |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsFilterHeaders defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ResponseHeaderTransformations.FilterHeaders. | object |
No | - | - |
renameHeaders |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsRenameHeaders defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ResponseHeaderTransformations.RenameHeaders. | object |
No | - | - |
setHeaders |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsSetHeaders defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ResponseHeaderTransformations.SetHeaders. | object |
No | - | - |
Status.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationFailurePolicy.responseHeaderTransformations.filterHeaders¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsFilterHeaders defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ResponseHeaderTransformations.FilterHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
type |
BLOCK drops any headers that are in the list of items, so it acts as an exclusion list. ALLOW permits only the headers in the list and removes all others, so it acts as an inclusion list. | string |
Yes | - | - |
Status.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationFailurePolicy.responseHeaderTransformations.filterHeaders.items[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsFilterHeadersItem defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ResponseHeaderTransformations.FilterHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
Status.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationFailurePolicy.responseHeaderTransformations.renameHeaders¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsRenameHeaders defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ResponseHeaderTransformations.RenameHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
Status.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationFailurePolicy.responseHeaderTransformations.renameHeaders.items[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsRenameHeadersItem defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ResponseHeaderTransformations.RenameHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
from |
The original case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
to |
The new name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
Status.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationFailurePolicy.responseHeaderTransformations.setHeaders¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsSetHeaders defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ResponseHeaderTransformations.SetHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
Status.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationFailurePolicy.responseHeaderTransformations.setHeaders.items[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsSetHeadersItem defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.ResponseHeaderTransformations.SetHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
ifExists |
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. | string |
No | - | - |
name |
The case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
values |
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. | list[string] |
Yes | - | - |
Status.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationFailurePolicy.sourceUriDetails¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationFailurePolicy.SourceUriDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
type |
- | string |
No | - | - |
uri |
The discovery URI for the auth server. | string |
No | - | - |
Status.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationPolicy¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationPolicy.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
additionalValidationPolicy |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationPolicy.AdditionalValidationPolicy. | object |
No | - | - |
clientDetails |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationPolicy.ClientDetails. | object |
No | - | - |
isSslVerifyDisabled |
Defines whether or not to uphold SSL verification. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
keys |
The set of static public keys. | list[object] |
No | - | - |
maxCacheDurationInHours |
The duration for which the JWKS should be cached before it is fetched again. | integer |
No | - | - |
sourceUriDetails |
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationPolicy.SourceUriDetails. | object |
No | - | - |
type |
- | string |
No | - | - |
uri |
The uri from which to retrieve the key. It must be accessible without authentication. | string |
No | - | - |
Status.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationPolicy.additionalValidationPolicy¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationPolicy.AdditionalValidationPolicy.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
audiences |
The list of intended recipients for the token. | list[string] |
No | - | - |
issuers |
A list of parties that could have issued the token. | list[string] |
No | - | - |
verifyClaims |
A list of claims which should be validated to consider the token valid. | list[object] |
No | - | - |
Status.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationPolicy.additionalValidationPolicy.verifyClaims[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationPolicy.AdditionalValidationPolicy.VerifyClaim.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isRequired |
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. | boolean |
No | - | - |
key |
Name of the claim. | string |
Yes | - | - |
values |
The list of acceptable values for a given claim. If this value is "null" or empty and "isRequired" set to "true", then the presence of this claim in the JWT is validated. | list[string] |
No | - | - |
Status.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationPolicy.clientDetails¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationPolicy.ClientDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
clientId |
Client ID for the OAuth2/OIDC app. | string |
No | - | - |
clientSecretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. | string |
No | - | - |
clientSecretVersionNumber |
The version number of the client secret to use. | integer (int64) |
No | - | - |
jsonData |
- | string |
No | - | - |
type |
- | string |
No | - | - |
Status.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationPolicy.keys[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationPolicy.Key.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
alg |
The algorithm intended for use with this key. | string |
No | - | - |
e |
The base64 url encoded exponent of the RSA public key represented by this key. | string |
No | - | - |
format |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
key |
The content of the PEM-encoded public key. | string |
No | - | - |
key_ops |
The operations for which this key is to be used. | list[string] |
No | - | - |
kid |
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid". | string |
Yes | - | - |
kty |
The key type. | string |
No | - | - |
n |
The base64 url encoded modulus of the RSA public key represented by this key. | string |
No | - | - |
use |
The intended use of the public key. | string |
No | - | - |
Status.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.validationPolicy.sourceUriDetails¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetails defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.ValidationPolicy.SourceUriDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
type |
- | string |
No | - | - |
uri |
The discovery URI for the auth server. | string |
No | - | - |
Status.specification.requestPolicies.dynamicAuthentication.authenticationServers[].authenticationServerDetail.verifyClaims[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.AuthenticationServerDetail.VerifyClaim.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isRequired |
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. | boolean |
No | - | - |
key |
Name of the claim. | string |
Yes | - | - |
values |
The list of acceptable values for a given claim. If this value is "null" or empty and "isRequired" set to "true", then the presence of this claim in the JWT is validated. | list[string] |
No | - | - |
Status.specification.requestPolicies.dynamicAuthentication.authenticationServers[].key¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerKey defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.AuthenticationServer.Key.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
expression |
A selection key string containing a wildcard to match with the context variable in an incoming request. If the context variable matches the string, the request is sent to the route or authentication server associated with the selection key. Valid wildcards are '*' (zero or more characters) and '+' (one or more characters). The string can only contain one wildcard, and the wildcard must be at the start or the end of the string. | string |
No | - | - |
isDefault |
Specifies whether to use the route or authentication server associated with this selection key as the default. The default is used if the value of a context variable in an incoming request does not match any of the other selection key values when dynamically routing and dynamically authenticating requests. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
name |
Name assigned to the branch. | string |
Yes | - | - |
type |
- | string |
No | - | - |
values |
The set of selection keys to match with the context variable in an incoming request. If the context variable exactly matches one of the keys in the set, the request is sent to the route or authentication server associated with the set. | list[string] |
No | - | - |
Status.specification.requestPolicies.dynamicAuthentication.selectionSource¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesDynamicAuthenticationSelectionSource defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.DynamicAuthentication.SelectionSource.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
selector |
String describing the context variable used as selector. | string |
No | - | - |
type |
- | string |
No | - | - |
Status.specification.requestPolicies.mutualTls¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesMutualTls defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.MutualTls.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
allowedSans |
Allowed list of CN or SAN which will be used for verification of certificate. | list[string] |
No | - | - |
isVerifiedCertificateRequired |
Determines whether to enable client verification when API Consumer makes connection to the gateway. | boolean |
No | - | - |
Status.specification.requestPolicies.rateLimiting¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesRateLimiting defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.RateLimiting.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
rateInRequestsPerSecond |
The maximum number of requests per second to allow. | integer |
Yes | - | - |
rateKey |
The key used to group requests together. | string |
Yes | - | - |
Status.specification.requestPolicies.usagePlans¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRequestPoliciesUsagePlans defines nested fields for ApiGatewayDeployment.Specification.RequestPolicies.UsagePlans.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
tokenLocations |
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]" | list[string] |
Yes | - | - |
Status.specification.routes[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRoute defines nested fields for ApiGatewayDeployment.Specification.Route.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
backend |
ApiGatewayDeploymentSpecificationRouteBackend defines nested fields for ApiGatewayDeployment.Specification.Route.Backend. | object |
Yes | - | - |
loggingPolicies |
ApiGatewayDeploymentSpecificationRouteLoggingPolicies defines nested fields for ApiGatewayDeployment.Specification.Route.LoggingPolicies. | object |
No | - | - |
methods |
A list of allowed methods on this route. | list[string] |
No | - | - |
path |
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. | string |
Yes | - | - |
requestPolicies |
ApiGatewayDeploymentSpecificationRouteRequestPolicies defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies. | object |
No | - | - |
responsePolicies |
ApiGatewayDeploymentSpecificationRouteResponsePolicies defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies. | object |
No | - | - |
Status.specification.routes[].backend¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteBackend defines nested fields for ApiGatewayDeployment.Specification.Route.Backend.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
allowedPostLogoutUris |
A list of allowed post-logout URLs to which a request can be redirected after revoke access | list[string] |
No | - | - |
body |
The body of the stock response from the mock backend. | string |
No | - | - |
connectTimeoutInSeconds |
Defines a timeout for establishing a connection with a proxied server. | number |
No | - | - |
functionId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource. | string |
No | - | - |
headers |
The headers of the stock response from the mock backend. | list[object] |
No | - | - |
isSslVerifyDisabled |
Defines whether or not to uphold SSL verification. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
postLogoutState |
Defines a state that should be shared on redirecting to postLogout URL. | string |
No | - | - |
readTimeoutInSeconds |
Defines a timeout for reading a response from the proxied server. | number |
No | - | - |
routingBackends |
List of backends to chose from for Dynamic Routing. | list[object] |
No | - | - |
selectionSource |
ApiGatewayDeploymentSpecificationRouteBackendSelectionSource defines nested fields for ApiGatewayDeployment.Specification.Route.Backend.SelectionSource. | object |
No | - | - |
sendTimeoutInSeconds |
Defines a timeout for transmitting a request to the proxied server. | number |
No | - | - |
status |
The status code of the stock response from the mock backend. | integer |
No | - | - |
type |
- | string |
No | - | - |
url |
The url of the HTTP Backend | string |
No | - | - |
Status.specification.routes[].backend.headers[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteBackendHeader defines nested fields for ApiGatewayDeployment.Specification.Route.Backend.Header.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Name of the header. | string |
No | - | - |
value |
Value of the header. | string |
No | - | - |
Status.specification.routes[].backend.routingBackends[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteBackendRoutingBackend defines nested fields for ApiGatewayDeployment.Specification.Route.Backend.RoutingBackend.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
backend |
JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. | object (preserves unknown fields) |
Yes | - | - |
key |
ApiGatewayDeploymentSpecificationRouteBackendRoutingBackendKey defines nested fields for ApiGatewayDeployment.Specification.Route.Backend.RoutingBackend.Key. | object |
Yes | - | - |
Status.specification.routes[].backend.routingBackends[].key¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteBackendRoutingBackendKey defines nested fields for ApiGatewayDeployment.Specification.Route.Backend.RoutingBackend.Key.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
expression |
A selection key string containing a wildcard to match with the context variable in an incoming request. If the context variable matches the string, the request is sent to the route or authentication server associated with the selection key. Valid wildcards are '*' (zero or more characters) and '+' (one or more characters). The string can only contain one wildcard, and the wildcard must be at the start or the end of the string. | string |
No | - | - |
isDefault |
Specifies whether to use the route or authentication server associated with this selection key as the default. The default is used if the value of a context variable in an incoming request does not match any of the other selection key values when dynamically routing and dynamically authenticating requests. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
name |
Name assigned to the branch. | string |
Yes | - | - |
type |
- | string |
No | - | - |
values |
The set of selection keys to match with the context variable in an incoming request. If the context variable exactly matches one of the keys in the set, the request is sent to the route or authentication server associated with the set. | list[string] |
No | - | - |
Status.specification.routes[].backend.selectionSource¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteBackendSelectionSource defines nested fields for ApiGatewayDeployment.Specification.Route.Backend.SelectionSource.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
selector |
String describing the context variable used as selector. | string |
No | - | - |
type |
- | string |
No | - | - |
Status.specification.routes[].loggingPolicies¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteLoggingPolicies defines nested fields for ApiGatewayDeployment.Specification.Route.LoggingPolicies.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
accessLog |
ApiGatewayDeploymentSpecificationRouteLoggingPoliciesAccessLog defines nested fields for ApiGatewayDeployment.Specification.Route.LoggingPolicies.AccessLog. | object |
No | - | - |
executionLog |
ApiGatewayDeploymentSpecificationRouteLoggingPoliciesExecutionLog defines nested fields for ApiGatewayDeployment.Specification.Route.LoggingPolicies.ExecutionLog. | object |
No | - | - |
Status.specification.routes[].loggingPolicies.accessLog¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteLoggingPoliciesAccessLog defines nested fields for ApiGatewayDeployment.Specification.Route.LoggingPolicies.AccessLog.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isEnabled |
Enables pushing of access logs to the legacy OCI Object Storage log archival bucket. Oracle recommends using the OCI Logging service to enable, retrieve, and query access logs for an API Deployment. If there is an active log object for the API Deployment and its category is set to 'access' in OCI Logging service, the logs will not be uploaded to the legacy OCI Object Storage log archival bucket. Please note that the functionality to push to the legacy OCI Object Storage log archival bucket has been deprecated and will be removed in the future. | boolean |
No | - | - |
Status.specification.routes[].loggingPolicies.executionLog¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteLoggingPoliciesExecutionLog defines nested fields for ApiGatewayDeployment.Specification.Route.LoggingPolicies.ExecutionLog.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isEnabled |
Enables pushing of execution logs to the legacy OCI Object Storage log archival bucket. Oracle recommends using the OCI Logging service to enable, retrieve, and query execution logs for an API Deployment. If there is an active log object for the API Deployment and its category is set to 'execution' in OCI Logging service, the logs will not be uploaded to the legacy OCI Object Storage log archival bucket. Please note that the functionality to push to the legacy OCI Object Storage log archival bucket has been deprecated and will be removed in the future. | boolean |
No | - | - |
logLevel |
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. | string |
No | - | - |
Status.specification.routes[].requestPolicies¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteRequestPolicies defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
authorization |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesAuthorization defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.Authorization. | object |
No | - | - |
bodyValidation |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesBodyValidation defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.BodyValidation. | object |
No | - | - |
cors |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesCors defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.Cors. | object |
No | - | - |
headerTransformations |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformations defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations. | object |
No | - | - |
headerValidations |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderValidations defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderValidations. | object |
No | - | - |
queryParameterTransformations |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformations defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations. | object |
No | - | - |
queryParameterValidations |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterValidations defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterValidations. | object |
No | - | - |
responseCacheLookup |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesResponseCacheLookup defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.ResponseCacheLookup. | object |
No | - | - |
Status.specification.routes[].requestPolicies.authorization¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteRequestPoliciesAuthorization defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.Authorization.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
allowedScope |
A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive. | list[string] |
No | - | - |
jsonData |
- | string |
No | - | - |
type |
- | string |
No | - | - |
Status.specification.routes[].requestPolicies.bodyValidation¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteRequestPoliciesBodyValidation defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.BodyValidation.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
content |
The content of the request body. The key is a media type range (https://tools.ietf.org/html/rfc7231#appendix-D) subset restricted to the following schema key ::= ( / ( "" "/" "" ) / ( type "/" "*" ) / ( type "/" subtype ) ) For requests that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/* |
map[string, object] |
Yes | - | - |
required |
Determines if the request body is required in the request. | boolean |
No | - | - |
validationMode |
Validation behavior mode. In ENFORCING mode, upon a validation failure, the request will be rejected with a 4xx response and not sent to the backend. In PERMISSIVE mode, the result of the validation will be exposed as metrics while the request will follow the normal path. DISABLED type turns the validation off. |
string |
No | - | - |
Status.specification.routes[].requestPolicies.bodyValidation.content{}¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteRequestPoliciesBodyValidationContent defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.BodyValidation.Content.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
validationType |
- | string |
No | - | - |
Status.specification.routes[].requestPolicies.cors¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteRequestPoliciesCors defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.Cors.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
allowedHeaders |
The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers. | list[string] |
No | - | - |
allowedMethods |
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. | list[string] |
No | - | - |
allowedOrigins |
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. | list[string] |
Yes | - | - |
exposedHeaders |
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. | list[string] |
No | - | - |
isAllowCredentialsEnabled |
Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies. | boolean |
No | - | - |
maxAgeInSeconds |
The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0. | integer |
No | - | - |
Status.specification.routes[].requestPolicies.headerTransformations¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformations defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
filterHeaders |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.FilterHeaders. | object |
No | - | - |
renameHeaders |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.RenameHeaders. | object |
No | - | - |
setHeaders |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.SetHeaders. | object |
No | - | - |
Status.specification.routes[].requestPolicies.headerTransformations.filterHeaders¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.FilterHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
type |
BLOCK drops any headers that are in the list of items, so it acts as an exclusion list. ALLOW permits only the headers in the list and removes all others, so it acts as an inclusion list. | string |
Yes | - | - |
Status.specification.routes[].requestPolicies.headerTransformations.filterHeaders.items[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeadersItem defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.FilterHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
Status.specification.routes[].requestPolicies.headerTransformations.renameHeaders¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.RenameHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
Status.specification.routes[].requestPolicies.headerTransformations.renameHeaders.items[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeadersItem defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.RenameHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
from |
The original case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
to |
The new name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
Status.specification.routes[].requestPolicies.headerTransformations.setHeaders¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.SetHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
Status.specification.routes[].requestPolicies.headerTransformations.setHeaders.items[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeadersItem defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderTransformations.SetHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
ifExists |
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. | string |
No | - | - |
name |
The case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
values |
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. | list[string] |
Yes | - | - |
Status.specification.routes[].requestPolicies.headerValidations¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderValidations defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderValidations.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
headers |
The List of Headers | list[object] |
No | - | - |
validationMode |
Validation behavior mode. In ENFORCING mode, upon a validation failure, the request will be rejected with a 4xx response and not sent to the backend. In PERMISSIVE mode, the result of the validation will be exposed as metrics while the request will follow the normal path. DISABLED type turns the validation off. |
string |
No | - | - |
Status.specification.routes[].requestPolicies.headerValidations.headers[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteRequestPoliciesHeaderValidationsHeader defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.HeaderValidations.Header.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Parameter name. | string |
Yes | - | - |
required |
Determines if the header is required in the request. | boolean |
No | - | - |
Status.specification.routes[].requestPolicies.queryParameterTransformations¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformations defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
filterQueryParameters |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParameters defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.FilterQueryParameters. | object |
No | - | - |
renameQueryParameters |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParameters defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.RenameQueryParameters. | object |
No | - | - |
setQueryParameters |
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParameters defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.SetQueryParameters. | object |
No | - | - |
Status.specification.routes[].requestPolicies.queryParameterTransformations.filterQueryParameters¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParameters defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.FilterQueryParameters.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of query parameters. | list[object] |
Yes | - | - |
type |
BLOCK drops any query parameters that are in the list of items, so it acts as an exclusion list. ALLOW permits only the parameters in the list and removes all others, so it acts as an inclusion list. | string |
Yes | - | - |
Status.specification.routes[].requestPolicies.queryParameterTransformations.filterQueryParameters.items[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParametersItem defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.FilterQueryParameters.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The case-sensitive name of the query parameter. | string |
Yes | - | - |
Status.specification.routes[].requestPolicies.queryParameterTransformations.renameQueryParameters¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParameters defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.RenameQueryParameters.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of query parameters. | list[object] |
Yes | - | - |
Status.specification.routes[].requestPolicies.queryParameterTransformations.renameQueryParameters.items[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParametersItem defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.RenameQueryParameters.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
from |
The original case-sensitive name of the query parameter. This name must be unique across transformation policies. | string |
Yes | - | - |
to |
The new name of the query parameter. This name must be unique across transformation policies. | string |
Yes | - | - |
Status.specification.routes[].requestPolicies.queryParameterTransformations.setQueryParameters¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParameters defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.SetQueryParameters.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of query parameters. | list[object] |
Yes | - | - |
Status.specification.routes[].requestPolicies.queryParameterTransformations.setQueryParameters.items[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParametersItem defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterTransformations.SetQueryParameters.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
ifExists |
If a query parameter 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. | string |
No | - | - |
name |
The case-sensitive name of the query parameter. This name must be unique across transformation policies. | string |
Yes | - | - |
values |
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. | list[string] |
Yes | - | - |
Status.specification.routes[].requestPolicies.queryParameterValidations¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterValidations defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterValidations.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
parameters |
The List of Query Parameters | list[object] |
No | - | - |
validationMode |
Validation behavior mode. In ENFORCING mode, upon a validation failure, the request will be rejected with a 4xx response and not sent to the backend. In PERMISSIVE mode, the result of the validation will be exposed as metrics while the request will follow the normal path. DISABLED type turns the validation off. |
string |
No | - | - |
Status.specification.routes[].requestPolicies.queryParameterValidations.parameters[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteRequestPoliciesQueryParameterValidationsParameter defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.QueryParameterValidations.Parameter.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Parameter name. | string |
Yes | - | - |
required |
Determines if the parameter is required in the request. | boolean |
No | - | - |
Status.specification.routes[].requestPolicies.responseCacheLookup¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteRequestPoliciesResponseCacheLookup defines nested fields for ApiGatewayDeployment.Specification.Route.RequestPolicies.ResponseCacheLookup.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
cacheKeyAdditions |
A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available. | list[string] |
No | - | - |
isEnabled |
Whether this policy is currently enabled. | boolean |
No | - | - |
isPrivateCachingEnabled |
Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require. When false, any request with an Authorization header will not be stored in the Response Cache. If using the CustomAuthenticationPolicy then the tokenHeader/tokenQueryParam are also subject to this check. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
type |
- | string |
No | - | - |
Status.specification.routes[].responsePolicies¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteResponsePolicies defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
headerTransformations |
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformations defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations. | object |
No | - | - |
responseCacheStore |
ApiGatewayDeploymentSpecificationRouteResponsePoliciesResponseCacheStore defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.ResponseCacheStore. | object |
No | - | - |
Status.specification.routes[].responsePolicies.headerTransformations¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformations defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
filterHeaders |
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.FilterHeaders. | object |
No | - | - |
renameHeaders |
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.RenameHeaders. | object |
No | - | - |
setHeaders |
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.SetHeaders. | object |
No | - | - |
Status.specification.routes[].responsePolicies.headerTransformations.filterHeaders¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.FilterHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
type |
BLOCK drops any headers that are in the list of items, so it acts as an exclusion list. ALLOW permits only the headers in the list and removes all others, so it acts as an inclusion list. | string |
Yes | - | - |
Status.specification.routes[].responsePolicies.headerTransformations.filterHeaders.items[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeadersItem defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.FilterHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
Status.specification.routes[].responsePolicies.headerTransformations.renameHeaders¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.RenameHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
Status.specification.routes[].responsePolicies.headerTransformations.renameHeaders.items[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeadersItem defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.RenameHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
from |
The original case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
to |
The new name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
Status.specification.routes[].responsePolicies.headerTransformations.setHeaders¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeaders defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.SetHeaders.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
The list of headers. | list[object] |
Yes | - | - |
Status.specification.routes[].responsePolicies.headerTransformations.setHeaders.items[]¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeadersItem defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.HeaderTransformations.SetHeaders.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
ifExists |
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. | string |
No | - | - |
name |
The case-insensitive name of the header. This name must be unique across transformation policies. | string |
Yes | - | - |
values |
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. | list[string] |
Yes | - | - |
Status.specification.routes[].responsePolicies.responseCacheStore¶
Back to ApiGatewayDeployment status
ApiGatewayDeploymentSpecificationRouteResponsePoliciesResponseCacheStore defines nested fields for ApiGatewayDeployment.Specification.Route.ResponsePolicies.ResponseCacheStore.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
timeToLiveInSeconds |
Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires. | integer |
No | - | - |
type |
- | string |
No | - | - |
Status.status¶
Back to ApiGatewayDeployment status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Back to ApiGatewayDeployment status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
Back to ApiGatewayDeployment status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
Back to ApiGatewayDeployment status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |