Namespace Oci.ApigatewayService.Models

Classes

AccessLogPolicy

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

AnonymousRouteAuthorizationPolicy

For a type of ANONYMOUS, an authenticated API must have the "isAnonymousAccessAllowed" property set to "true" in the authentication policy.

AnyOfRouteAuthorizationPolicy

If authentication has been performed, validate whether the request scope (if any) applies to this route.

When dynamically routing and dynamically authenticating requests, the route or authentication server associated with a set of selection keys is used if the context variable in an incoming request exactly matches one of the keys in the set.

Api

An API is simple container for an API Specification. For more information, see API Gateway Concepts.

ApiCollection

Collection of API summaries.

ApiSpecification

The logical configuration of the API exposed by a deployment.

ApiSpecificationLoggingPolicies

Policies controlling the pushing of logs to OCI Public Logging.

ApiSpecificationRequestPolicies

Global behavior applied to all requests received by the API.

ApiSpecificationRoute

A single route that forwards requests to a particular backend and may contain some additional policies.

ApiSpecificationRouteBackend

The backend to forward requests to.

ApiSpecificationRouteBackendModelConverter

ApiSpecificationRouteRequestPolicies

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

ApiSpecificationRouteResponsePolicies

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

ApiSummary

A summary of the API.

ApiValidationDetail

Detail of a single error or warning.

ApiValidationDetails

Detail of an error or warning.

ApiValidationResult

The result of single validation.

ApiValidations

The result of validations conducted on the API.

AuthenticationOnlyRouteAuthorizationPolicy

Only authentication is performed for the request and authorization is skipped.

AuthenticationPolicy

Information on how to authenticate incoming requests.

AuthenticationPolicyModelConverter

AuthenticationServerPolicy

Policy for the details regarding each authentication server under dynamic authentication. We specify the value of selectors for which this authentication server must be selected for a request under keys. We specify the configuration details of authentication server under authenticationServerDetail.

BodyValidationRequestPolicy

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

CaBundle

Reference to the CA bundle that should be used on the gateway

CaBundleModelConverter

Certificate

A certificate contains information to be installed on a gateway to secure the traffic going through it. For more information, see API Gateway Concepts.

CertificateCollection

Collection of certificate summaries.

CertificateSummary

A summary of the certificate.

CertificatesCaBundle

CA bundle from Certificates Service that should be used on the gateway for TLS validation

CertificatesCertificateAuthority

Certificate Authority from Certificates Service that should be used on the gateway for TLS validation

ChangeApiCompartmentDetails

The new compartment details for the API.

ChangeCertificateCompartmentDetails

The new compartment details for the certificate.

ChangeDeploymentCompartmentDetails

The new compartment details for the deployment.

ChangeGatewayCompartmentDetails

The new compartment details for the gateway.

ChangeSubscriberCompartmentDetails

The new compartment details for the subscriber.

ChangeUsagePlanCompartmentDetails

The new compartment details for the usage plan.

Client

A Client.

ClientAppDetails

Client App Credential details.

ClientAppDetailsModelConverter

ClientSummary

A summary of a client.

ContentValidation

Content validation properties.

ContentValidationModelConverter

CorsPolicy

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

CreateApiDetails

Information about the new API.

CreateCertificateDetails

Information about a new certificate.

CreateDeploymentDetails

Information about a new deployment.

CreateGatewayDetails

Information about the new gateway.

CreateSdkDetails

Information about the new SDK.

CreateSubscriberDetails

Information about a new subscriber.

CreateUsagePlanDetails

Information about a new usage plan.

CustomAuthenticationPolicy

Use a function to validate a custom header or query parameter sent with the request authentication. A valid policy must specify either tokenHeader or tokenQueryParam.

CustomClientAppDetails

Client App Credentials to be provided again.

Deployment

A deployment deploys an API on a gateway. Avoid entering confidential information. For more information, see API Gateway Concepts.

DeploymentCollection

Collection of deployment summaries.

DeploymentSummary

A summary of the deployment.

DiscoveryUriSourceUriDetails

Discovery Uri information.

DynamicAuthenticationPolicy

Policy on how to authenticate requests when multiple authentication options are configured for a deployment. For an incoming request, the value of selector specified under selectionSource will be matched against the keys specified for each authentication server. The authentication server whose key matches the value of selector will be used for authentication.

DynamicRoutingBackend

Send the request to the backend dynamically selected based on the incoming request's context.

DynamicRoutingTypeRoutingBackend

Policy for the details regarding each routing backend under dynamic routing. We specify the value of selectors for which this routing backend must be selected for a request under keys. We specify the configuration details of routing backend under backend.

DynamicSelectionKey

Base policy for defining how to match the context variable in an incoming request with selection keys when dynamically routing and dynamically authenticating requests.

DynamicSelectionKeyModelConverter

Entitlement

A usage plan entitlement, comprising of rate limits, quotas and the deployments they are applied to.

EntitlementSummary

A summary of an entitlement included in a usage plan.

EntitlementTarget

An entitlement target, describing which deployment the entitlement should be applied to.

ExecutionLogPolicy

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

ExternalRespCache

Connection details for an external RESP based cache store for Response Caching.

FilterHeaderPolicy

Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.

FilterHeaderPolicyItem

A header to drop (with BLOCK) or pass through (with ALLOW).

FilterQueryParameterPolicy

Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.

FilterQueryParameterPolicyItem

A query parameter to drop (with BLOCK) or pass through (with ALLOW).

FixedTTLResponseCacheStorePolicy

How a response from a backend is cached in the Response Cache.

Gateway

A gateway is a virtual network appliance in a regional subnet. A gateway routes inbound traffic to back-end services including public, private, and partner HTTP APIs, as well as Oracle Functions. Avoid entering confidential information. For more information, see API Gateway Concepts.

GatewayCollection

Collection of gateway summaries.

GatewaySummary

A summary of the gateway.

HTTPBackend

Send the request to an HTTP backend.

HeaderFieldSpecification

Header in key/value pair.

HeaderTransformationPolicy

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

HeaderValidationItem

Header validation properties.

HeaderValidationRequestPolicy

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

IpAddress

IP address associated with the gateway.

JsonWebKey

A JSON Web Key that represents the public key used for verifying the JWT signature.

JsonWebTokenClaim

An individual JWT claim.

JwtAuthenticationPolicy

Validate a JWT token present in the header or query parameter. A valid policy must specify either tokenHeader or tokenQueryParam.

ModifyResponseValidationFailurePolicy

Policy to specify how to modify the response code, body and headers.

MutualTlsDetails

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

NoCache

Configures the gateway with no caching. Cache lookup and store policies will not be supported.

NoContentValidation

No content validation properties.

OAuth2LogoutBackend

Backend which when called triggers OAuth2 logout.

OAuth2ResponseValidationFailurePolicy

Policy to specify OAuth2 flow configuration.

OracleFunctionBackend

Send the request to an Oracle Functions function.

PemEncodedPublicKey

A PEM-encoded public key used for verifying the JWT signature.

PublicKeySet

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

PublicKeySetModelConverter

QueryParameterTransformationPolicy

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

QueryParameterValidationItem

Query parameter validation properties.

QueryParameterValidationRequestPolicy

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

Quota

Quota policy for a usage plan.

RateLimit

Rate-limiting policy for a usage plan.

RateLimitingPolicy

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

RemoteJsonWebKeySet

A set of public keys that is retrieved at run-time from a remote location to verify the JWT signature. The set should only contain JWK-formatted keys.

RenameHeaderPolicy

Rename HTTP headers as they pass through the gateway.

RenameHeaderPolicyItem

The value will be a copy of the original value of the source header and will not be affected by any other transformation policies applied to that header.

RenameQueryParameterPolicy

Rename parameters on the query string as they pass through the gateway.

RenameQueryParameterPolicyItem

The value will be a copy of the original value of the source parameter and will not be affected by any other transformation policies applied to that parameter.

RequestParameterValidation

Common parameter validation properties.

ResponseCacheDetails

Base Gateway response cache.

ResponseCacheDetailsModelConverter

ResponseCacheLookupPolicy

Base policy for Response Cache lookup.

ResponseCacheLookupPolicyModelConverter

ResponseCacheRespServer

Details of a RESP based cache store server

ResponseCacheStorePolicy

Base policy for how a response from a backend is cached in the Response Cache.

ResponseCacheStorePolicyModelConverter

RouteAuthorizationPolicy

If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.

RouteAuthorizationPolicyModelConverter

Sdk

Information about the SDK.

SdkCollection

Collection of the existing SDKs.

SdkLanguageOptionalParameters

List of additional applicable parameters for any given target language.

SdkLanguageOptionalParametersAllowedValue

Allowed value object.

SdkLanguageTypeCollection

Collection of available SDK target languages.

SdkLanguageTypeSummary

SDK target language details.

SdkLanguageTypes

SDK target language details.

SdkSummary

A summary of the SDK.

SelectionSourcePolicy

The type of selector to use when dynamically routing and dynamically authenticating requests.

SelectionSourcePolicyModelConverter

SetHeaderPolicy

Set HTTP headers as they pass through the gateway.

SetHeaderPolicyItem

Set will add a new header if it was not in the original request. If the header already exists on the request, you can choose to override, append, or skip it.

SetQueryParameterPolicy

Set parameters on the query string as they pass through the gateway.

SetQueryParameterPolicyItem

Set will add a new query parameter if it was not in the original request. If the parameter already exists on the request, you can choose to override, append, or skip it.

SimpleLookupPolicy

Provides ability to vary the cache key using context expressions.

SingleSelectionSourcePolicy

The single context variable in an incoming request to match against specified selection keys when dynamically routing and dynamically authenticating requests.

SourceUriDetails

Auth endpoint details.

SourceUriDetailsModelConverter

StaticPublicKey

A static public key which is used to verify the JWT signature.

StaticPublicKeyModelConverter

StaticPublicKeySet

A set of static public keys that will be used to verify the JWT signature.

StockResponseBackend

Send the request to a mock backend.

Subscriber

A subscriber, which encapsulates a number of clients and usage plans that they are subscribed to.

SubscriberCollection

Collection of subscriber summaries.

SubscriberSummary

A summary of a subscriber.

TokenAuthenticationPolicy

Validate a token present in the header or query parameter. A valid policy must specify either tokenHeader or tokenQueryParam.

TokenAuthenticationRemoteDiscoveryValidationPolicy

Instrospect Url based validation retrieved at run-time from a remote location to verify the provided token.

TokenAuthenticationRemoteJWKSValidationPolicy

A set of public keys that is retrieved at run-time from a remote location to verify the JWT signature. The set should only contain JWK-formatted keys.

TokenAuthenticationStaticKeysValidationPolicy

A set of static public keys that will be used to verify the JWT signature.