CorsPolicy¶
- class oci.apigateway.models.CorsPolicy(**kwargs)¶
Bases:
objectEnable CORS (Cross-Origin-Resource-Sharing) request handling.
Methods:
__init__(**kwargs)Initializes a new CorsPolicy object with values from keyword arguments.
Attributes:
Gets the allowed_headers of this CorsPolicy.
Gets the allowed_methods of this CorsPolicy.
[Required] Gets the allowed_origins of this CorsPolicy.
Gets the exposed_headers of this CorsPolicy.
Gets the is_allow_credentials_enabled of this CorsPolicy.
Gets the max_age_in_seconds of this CorsPolicy.
- __init__(**kwargs)¶
Initializes a new CorsPolicy object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
allowed_origins (list[str]) – The value to assign to the allowed_origins property of this CorsPolicy.
allowed_methods (list[str]) – The value to assign to the allowed_methods property of this CorsPolicy.
allowed_headers (list[str]) – The value to assign to the allowed_headers property of this CorsPolicy.
exposed_headers (list[str]) – The value to assign to the exposed_headers property of this CorsPolicy.
is_allow_credentials_enabled (bool) – The value to assign to the is_allow_credentials_enabled property of this CorsPolicy.
max_age_in_seconds (int) – The value to assign to the max_age_in_seconds property of this CorsPolicy.
- property allowed_headers¶
Gets the allowed_headers of this CorsPolicy. The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. ‘*’ will allow all headers.
- Returns
The allowed_headers of this CorsPolicy.
- Return type
list[str]
- property allowed_methods¶
Gets the allowed_methods of this CorsPolicy. 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.
- Returns
The allowed_methods of this CorsPolicy.
- Return type
list[str]
- property allowed_origins¶
[Required] Gets the allowed_origins of this CorsPolicy. 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.
- Returns
The allowed_origins of this CorsPolicy.
- Return type
list[str]
- property exposed_headers¶
Gets the exposed_headers of this CorsPolicy. 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.
- Returns
The exposed_headers of this CorsPolicy.
- Return type
list[str]
- property is_allow_credentials_enabled¶
Gets the is_allow_credentials_enabled of this CorsPolicy. Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- Returns
The is_allow_credentials_enabled of this CorsPolicy.
- Return type
bool
- property max_age_in_seconds¶
Gets the max_age_in_seconds of this CorsPolicy. The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
- Returns
The max_age_in_seconds of this CorsPolicy.
- Return type
int