Apigateway¶
API for the API Gateway service. |
|
API for the API Gateway service. |
|
API for the API Gateway service. |
|
API for the API Gateway service. |
|
API for the API Gateway service. |
|
API for the API Gateway service. |
|
This class provides a wrapper around |
|
This class provides a wrapper around |
|
This class provides a wrapper around |
|
This class provides a wrapper around |
|
This class provides a wrapper around |
|
This class provides a wrapper around |
Models¶
Configures the logging policies for the access logs of an API Deployment. |
|
Used to add a resource lock. |
|
Additional JWT validation checks. |
|
For a type of ANONYMOUS, an authenticated API must have the "isAnonymousAccessAllowed" property set to "true" in the authentication policy. |
|
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. |
|
An API is simple container for an API Specification. |
|
Collection of API summaries. |
|
The logical configuration of the API exposed by a deployment. |
|
Policies controlling the pushing of logs to OCI Public Logging. |
|
Global behavior applied to all requests received by the API. |
|
A single route that forwards requests to a particular backend and may contain some additional policies. |
|
The backend to forward requests to. |
|
Behavior applied to any requests received by the API on this route. |
|
Behavior applied to any responses sent by the API for requests on this route. |
|
A summary of the API. |
|
Detail of a single error or warning. |
|
Detail of an error or warning. |
|
The result of single validation. |
|
The result of validations conducted on the API. |
|
|
Only authentication is performed for the request and authorization is skipped. |
Information on how to authenticate incoming requests. |
|
Policy for the details regarding each authentication server under dynamic authentication. |
|
Validate the payload body of the incoming API requests on a specific route. |
|
Reference to the CA bundle that should be used on the gateway |
|
A certificate contains information to be installed on a gateway to secure the traffic going through it. |
|
Collection of certificate summaries. |
|
A summary of the certificate. |
|
CA bundle from Certificates Service that should be used on the gateway for TLS validation |
|
Certificate Authority from Certificates Service that should be used on the gateway for TLS validation |
|
The new compartment details for the API. |
|
The new compartment details for the certificate. |
|
The new compartment details for the deployment. |
|
The new compartment details for the gateway. |
|
The new compartment details for the subscriber. |
|
The new compartment details for the usage plan. |
|
A Client. |
|
Client App Credential details. |
|
A summary of a client. |
|
Content validation properties. |
|
Enable CORS (Cross-Origin-Resource-Sharing) request handling. |
|
Information about the new API. |
|
Information about a new certificate. |
|
Information about a new deployment. |
|
Information about the new gateway. |
|
Information about the new SDK. |
|
Information about a new subscriber. |
|
Information about a new usage plan. |
|
Use a function to validate a custom header or query parameter sent with the request authentication. |
|
Client App Credentials to be provided again. |
|
A deployment deploys an API on a gateway. |
|
Collection of deployment summaries. |
|
A summary of the deployment. |
|
Discovery Uri information. |
|
Policy on how to authenticate requests when multiple authentication options are configured for a deployment. |
|
Send the request to the backend dynamically selected based on the incoming request's context. |
|
Policy for the details regarding each routing backend under dynamic routing. |
|
Base policy for defining how to match the context variable in an incoming request with selection keys when dynamically routing and dynamically authenticating requests. |
|
A usage plan entitlement, comprising of rate limits, quotas and the deployments they are applied to. |
|
A summary of an entitlement included in a usage plan. |
|
An entitlement target, describing which deployment the entitlement should be applied to. |
|
Configures the logging policies for the execution logs of an API Deployment. |
|
Connection details for an external RESP based cache store for Response Caching. |
|
Filter HTTP headers as they pass through the gateway. |
|
A header to drop (with BLOCK) or pass through (with ALLOW). |
|
Filter parameters from the query string as they pass through the gateway. |
|
A query parameter to drop (with BLOCK) or pass through (with ALLOW). |
|
How a response from a backend is cached in the Response Cache. |
|
A gateway is a virtual network appliance in a regional subnet. |
|
Collection of gateway summaries. |
|
A summary of the gateway. |
|
Send the request to an HTTP backend. |
|
Header in key/value pair. |
|
A set of transformations to apply to HTTP headers that pass through the gateway. |
|
Header validation properties. |
|
Validate the HTTP headers on the incoming API requests on a specific route. |
|
IP address associated with the gateway. |
|
IPv4 address configuration details that should be used when creating the gateway. |
|
IPv6 address configuration details that should be used when creating the gateway. |
|
A JSON Web Key that represents the public key used for verifying the JWT signature. |
|
An individual JWT claim. |
|
Validate a JWT token present in the header or query parameter. |
|
Policy to specify how to modify the response code, body and headers. |
|
Properties used to configure client mTLS verification when API Consumer makes connection to the gateway. |
|
Configures the gateway with no caching. |
|
No content validation properties. |
|
Backend which completes OAuth2/OIDC flow post redirection from Idp. |
|
Backend which when called triggers OAuth2 logout. |
|
Policy to specify OAuth2 flow configuration. |
|
Send the request to an Oracle Functions function. |
|
A PEM-encoded public key used for verifying the JWT signature. |
|
A set of Public Keys that will be used to verify the JWT signature. |
|
A set of transformations to apply to query parameters that pass through the gateway. |
|
Query parameter validation properties. |
|
Validate the URL query parameters on the incoming API requests on a specific route. |
|
Quota policy for a usage plan. |
|
Rate-limiting policy for a usage plan. |
|
Limit the number of requests that should be handled for the specified window using a specfic key. |
|
A set of public keys that is retrieved at run-time from a remote location to verify the JWT signature. |
|
Used to remove a resource lock. |
|
Rename HTTP headers as they pass through the gateway. |
|
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. |
|
Rename parameters on the query string as they pass through the gateway. |
|
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. |
|
Common parameter validation properties. |
|
Resource locks are used to prevent certain APIs from being called for the resource. |
|
Base Gateway response cache. |
|
Base policy for Response Cache lookup. |
|
Details of a RESP based cache store server |
|
Base policy for how a response from a backend is cached in the Response Cache. |
|
If authentication has been performed, validate whether the request scope (if any) applies to this route. |
|
Information about the SDK. |
|
Collection of the existing SDKs. |
|
List of additional applicable parameters for any given target language. |
|
|
Allowed value object. |
Collection of available SDK target languages. |
|
SDK target language details. |
|
SDK target language details. |
|
A summary of the SDK. |
|
The type of selector to use when dynamically routing and dynamically authenticating requests. |
|
Set HTTP headers as they pass through the gateway. |
|
Set will add a new header if it was not in the original request. |
|
Set parameters on the query string as they pass through the gateway. |
|
Set will add a new query parameter if it was not in the original request. |
|
Provides ability to vary the cache key using context expressions. |
|
The single context variable in an incoming request to match against specified selection keys when dynamically routing and dynamically authenticating requests. |
|
Auth endpoint details. |
|
A static public key which is used to verify the JWT signature. |
|
A set of static public keys that will be used to verify the JWT signature. |
|
Send the request to a mock backend. |
|
A subscriber, which encapsulates a number of clients and usage plans that they are subscribed to. |
|
Collection of subscriber summaries. |
|
A summary of a subscriber. |
|
Validate a token present in the header or query parameter. |
|
|
Instrospect Url based validation retrieved at run-time from a remote location to verify the provided token. |
|
A set of public keys that is retrieved at run-time from a remote location to verify the JWT signature. |
|
A set of static public keys that will be used to verify the JWT signature. |
Authentication Policies for the Token Authentication types. |
|
The information to be updated. |
|
The information to be updated. |
|
The information to be updated. |
|
The information to be updated. |
|
The information to be updated. |
|
The information to be updated. |
|
The information to be updated. |
|
A usage plan controls access of subscribers to deployments, controlling rate limits and quotas for usage. |
|
Collection of usage plan summaries. |
|
A summary of the usage plan. |
|
Usage plan policies for this deployment |
|
Client App Credentials to be used from validation block. |
|
Source Uri information to be used from validation block. |
|
Policy for defining behaviour on validation failure. |
|
Top-level validation policy mixin (not directly used). |
|
When dynamically routing and dynamically authenticating requests, the route or authentication server associated with a selection key containing a wildcard is used if the context variable in an incoming request matches that key. |
|
A description of the work request status. |
|
Collection of work request summaries. |
|
An error encountered while executing a work request. |
|
Collection of work request errors. |
|
A log message from the execution of a work request. |
|
Collection of work request logs. |
|
A resource created or operated on by a work request. |
|
A summary of the work request. |