Get metadata for all policies
/apiplatform/management/v1/policies/metadata
Returns a collection of metadata for all available policies.
Users requesting this resource must be assigned the API Manager, or Gateway Manager role and must be issued the Manage API or View All Details grant for an API or the Manage Gateway or View All Details grant for a gateway.
Request
There are no request parameters for this operation.
Back to TopResponse
- application/json
200 Response
object
-
count(optional):
integer(int32)
The number of items in this collection.
array
-
Array of:
object PolicyMetadata
Policy metadata. See the operation's example for details.
object
403 Response
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
500 Response
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
Examples
The following example shows how to retrieve metadata for all available policies by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X GET
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/policies/metadata
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 200 OK Server: Oracle-Traffic-Director/12.2.1.0.0 Date: Mon, 02 Jan 2017 19:14:05 GMT Content-type: application/json X-oracle-dms-ecid: 7MlMH0vuR00000000 X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0 Transfer-encoding: chunked
Example of Response Body
The following example shows the contents of the response body in JSON format, including metadata for all of the available policies.
{ "count": 24, "items": [ { "ui": { "view": { "helpInfo": "#OauthHelpInfo", "js": "oauth-view.js", "helpUrl": "http://www.oracle.com", "html": "oauth-view.html", "helpTopicId": "policies.oauth" }, "edit": { "helpInfo": "#OauthHelpInfo", "js": "oauth-edit.js", "helpUrl": "http://www.oracle.com", "html": "oauth-edit.html", "helpTopicId": "policies.oauth" }, "l10nbundle": "L10n/oauth.json" }, "configuration": { "services": [ { "service": "oracle.apiplatform.policies.oauth.OAuthValidator", "type": "oracle.apiplatform.policies.sdk.validation.PolicyValidator" }, { "service": "oracle.apiplatform.policies.oauth.OAuthRuntimeFactory", "type": "oracle.apiplatform.policies.sdk.runtime.PolicyRuntimeFactory" } ] }, "name": "OAuth 2.0", "description": "Enforces using the OAuth 2.0 protocol, that access to this API is only available to request on behalf of one of the listed accounts below.", "type": "o:OAuth", "category": "@implementations.policyCategory.security", "version": "1.0", "constraints": { "singleton": true, "requestZone": "11", "direction": "REQUEST" }, "ocsgActionName": "OAuth", "revision": "1" }, { "ui": { "view": { "helpInfo": "#helpInfo", "js": "keyvalidation-view.js", "helpUrl": "http://www.oracle.com", "html": "keyvalidation-view.html", "helpTopicId": "policies.key-validation" }, "edit": { "helpInfo": "#helpInfo", "js": "keyvalidation-edit.js", "helpUrl": "http://www.oracle.com", "html": "keyvalidation-edit.html", "helpTopicId": "policies.key-validation" }, "l10nbundle": "L10n/keyvalidation.json" }, "configuration": { "services": [ { "service": "oracle.apiplatform.policies.keyvalidation.KeyValidationValidator", "type": "oracle.apiplatform.policies.sdk.validation.PolicyValidator" }, { "service": "oracle.apiplatform.policies.keyvalidation.KeyValidationRuntimeFactory", "type": "oracle.apiplatform.policies.sdk.runtime.PolicyRuntimeFactory" } ] }, "name": "Key Validation", "description": "Enforces that a valid key is provided in the request. The key must be valid and the application must be in the \"Registered\" state for this API.", "type": "o:KeyValidation", "category": "@implementations.policyCategory.security", "version": "1.0", "constraints": { "singleton": true, "requestZone": "10", "direction": "REQUEST" }, "ocsgActionName": "AppKeyValidation", "revision": "1" }, { "ui": { "view": { "helpInfo": "", "js": "", "helpUrl": "", "html": "", "helpTopicId": "" }, "edit": { "helpInfo": "", "js": "", "helpUrl": "", "html": "", "helpTopicId": "" }, "l10nbundle": "L10n/apiresponse.json" }, "configuration": { "services": [] }, "name": "API Response", "description": "Response from the API", "type": "o:ApiResponse", "category": "@implementations.policyCategory.endpoints", "version": "1.0", "constraints": { "singleton": true, "responseZone": "150", "after": [ "o:ServiceResponse/1.0" ], "required": true, "direction": "RESPONSE", "requires": [ "o:ApiRequest/1.0" ] }, "revision": "1" }, { "ui": { "view": { "helpInfo": "#helpInfo", "js": "apithrottlingdelay-view.js", "helpUrl": "http://www.oracle.com", "html": "apithrottlingdelay-view.html", "helpTopicId": "policies.api-throttling-delay" }, "edit": { "helpInfo": "#helpInfo", "js": "apithrottlingdelay-edit.js", "helpUrl": "http://www.oracle.com", "html": "apithrottlingdelay-edit.html", "helpTopicId": "policies.api-throttling-delay" }, "l10nbundle": "L10n/apithrottlingdelay.json" }, "configuration": { "services": [ { "service": "oracle.apiplatform.policies.apithrottlingdelay.ApiThrottlingDelayValidator", "type": "oracle.apiplatform.policies.sdk.validation.PolicyValidator" } ] }, "name": "API Throttling - Delay", "description": "Enforces a limit on the number of requests to this API before introducing additional latency. NOTE: this policy differs from the Application Rate Limiting or API Rate Limiting policies.", "type": "o:ApiThrottlingDelay", "category": "@implementations.policyCategory.trafficMgmt", "version": "1.0", "constraints": { "singleton": false, "requestZone": "30", "direction": "REQUEST" }, "ocsgActionName": "ApiThrottlingDelay", "revision": "1" }, { "ui": { "view": { "helpInfo": "#IPFilterHelpInfo", "js": "ipfilter-view.js", "helpUrl": "", "html": "ipfilter-view.html", "helpTopicId": "policies.ip-filtering" }, "edit": { "helpInfo": "#IPFilterHelpInfo", "js": "ipfilter-edit.js", "helpUrl": "", "html": "ipfilter-edit.html", "helpTopicId": "policies.ip-filtering" }, "l10nbundle": "L10n/ipfilter.json" }, "configuration": { "services": [ { "service": "oracle.apiplatform.policies.ipfilter.IPFilterValidator", "type": "oracle.apiplatform.policies.sdk.validation.PolicyValidator" } ] }, "name": "IP Filter Validation", "description": "Validates the IP address of the requester. Based on the value of IP the address, determine whether to pass or reject value.", "type": "o:IPFilterValidation", "category": "@implementations.policyCategory.security", "version": "1.0", "constraints": { "singleton": false, "requestZone": "30", "responseZone": "150", "direction": "REQUEST" }, "ocsgActionName": "IPFilterValidation", "revision": "1" }, { "ui": { "view": { "helpInfo": "#HelpInfo", "js": "applicationratelimiting-view.js", "helpUrl": "http://www.oracle.com", "html": "applicationratelimiting-view.html", "helpTopicId": "policies.application-rate-limiting" }, "edit": { "helpInfo": "#HelpInfo", "js": "applicationratelimiting-edit.js", "helpUrl": "http://www.oracle.com", "html": "applicationratelimiting-edit.html", "helpTopicId": "policies.application-rate-limiting" }, "l10nbundle": "L10n/applicationratelimiting.json" }, "configuration": { "services": [ { "service": "oracle.apiplatform.policies.appratelimit.AppRateLimitingValidator", "type": "oracle.apiplatform.policies.sdk.validation.PolicyValidator" } ] }, "name": "Application Rate Limiting", "description": "Enforces a limit on the total number of requests to this API per application. Rejects any requests above the defined limit. NOTE: this is different than API rate limiting", "type": "o:ApplicationRateLimiting", "category": "@implementations.policyCategory.trafficMgmt", "version": "1.0", "constraints": { "singleton": false, "requestZone": "30", "direction": "REQUEST" }, "ocsgActionName": "ApplicationRateLimiting", "revision": "1" }, { "ui": { "view": { "helpInfo": "#apiReqHelpInfo", "js": "api/request-view.js", "helpUrl": "http://www.oracle.com", "html": "api/request-view.html", "helpTopicId": "policies.api-request" }, "edit": { "helpInfo": "#apiReqHelpInfo", "js": "api/request-edit.js", "helpUrl": "http://www.oracle.com", "html": "api/request-edit.html", "helpTopicId": "policies.api-request" }, "l10nbundle": "L10n/request.json" }, "configuration": { "services": [ { "service": "oracle.apiplatform.policies.endpoints.validation.ApiRequestValidator", "type": "oracle.apiplatform.policies.sdk.validation.PolicyValidator" }, { "service": "oracle.apiplatform.policies.apirequest.ApiRequestRuntimeFactory", "type": "oracle.apiplatform.policies.sdk.runtime.PolicyRuntimeFactory" } ] }, "name": "API Request", "description": "This is the relative URI at which the gateway will receive requests for the API. The Gateway IP address, and API Endpoint URI will constitute the full URL for the API.", "type": "o:ApiRequest", "category": "@implementations.policyCategory.endpoints", "version": "1.0", "constraints": { "singleton": true, "requestZone": "5", "before": [ "o:ServiceRequest/1.0" ], "required": true, "direction": "REQUEST", "requires": [ "o:ApiResponse/1.0" ] }, "ocsgActionName": "ApiRequest", "revision": "1" }, { "ui": { "view": { "helpInfo": "#BasicAuthHelpInfo", "js": "basicauth-view.js", "helpUrl": "http://www.oracle.com", "html": "basicauth-view.html", "helpTopicId": "policies.basic-auth" }, "edit": { "helpInfo": "#BasicAuthHelpInfo", "js": "basicauth-edit.js", "helpUrl": "http://www.oracle.com", "html": "basicauth-edit.html", "helpTopicId": "policies.basic-auth" }, "l10nbundle": "L10n/basicauth.json" }, "configuration": { "services": [ { "service": "oracle.apiplatform.policies.basicauth.BasicAuthValidator", "type": "oracle.apiplatform.policies.sdk.validation.PolicyValidator" }, { "service": "oracle.apiplatform.policies.basicauth.BasicAuthRuntimeFactory", "type": "oracle.apiplatform.policies.sdk.runtime.PolicyRuntimeFactory" } ] }, "name": "Basic Auth", "description": "Enforces using the Basic Auth protocol, that access to this API is only available to request on behalf of one of the listed accounts below.", "type": "o:BasicAuth", "category": "@implementations.policyCategory.security", "version": "1.0", "constraints": { "singleton": false, "requestZone": "11", "direction": "REQUEST" }, "ocsgActionName": "BasicAuth", "revision": "1" }, { "ui": { "view": { "helpInfo": "#HelpInfo", "js": "ratelimiting-view.js", "helpUrl": "http://www.oracle.com", "html": "ratelimiting-view.html", "helpTopicId": "policies.api-rate-limiting" }, "edit": { "helpInfo": "#HelpInfo", "js": "ratelimiting-edit.js", "helpUrl": "http://www.oracle.com", "html": "ratelimiting-edit.html", "helpTopicId": "policies.api-rate-limiting" }, "l10nbundle": "L10n/ratelimiting.json" }, "configuration": { "services": [ { "service": "oracle.apiplatform.policies.apiratelimit.ApiRateLimitingValidator", "type": "oracle.apiplatform.policies.sdk.validation.PolicyValidator" } ] }, "name": "API Rate Limiting", "description": "Enforces a limit on the total number of requests to this API. Rejects any requests above the defined limit. NOTE: this is different than the application-based rate limiting.", "type": "o:apiRateLimiting", "category": "@implementations.policyCategory.trafficMgmt", "version": "1.0", "constraints": { "singleton": false, "requestZone": "30", "direction": "REQUEST" }, "ocsgActionName": "RateLimit", "revision": "1" }, { "ui": { "view": { "helpInfo": "#ServiceCalloutHelpInfo", "js": "servicecallout-view.js", "helpUrl": "http://www.oracle.com", "html": "servicecallout-view.html", "helpTopicId": "policies.service-callout" }, "edit": { "helpInfo": "#ServiceCalloutHelpInfo", "js": "servicecallout-edit.js", "helpUrl": "http://www.oracle.com", "html": "servicecallout-edit.html", "helpTopicId": "policies.service-callout" }, "l10nbundle": "L10n/servicecallout.json" }, "configuration": { "services": [ { "service": "oracle.apiplatform.policies.servicecallout.ServiceCalloutValidator", "type": "oracle.apiplatform.policies.sdk.validation.PolicyValidator" } ] }, "name": "Service Callout", "description": "Invokes the configured external service with or without payload, with the provided headers and process the incoming request on the basis of response HTTP Status Code from the external service.", "type": "o:ServiceCallout", "category": "@implementations.policyCategory.other", "version": "1.0", "constraints": { "singleton": false, "requestZone": "30", "responseZone": "150", "direction": "REQUEST" }, "ocsgActionName": "ServiceCallout", "revision": "1" }, { "ui": { "view": { "helpInfo": "", "js": "", "helpUrl": "", "html": "", "helpTopicId": "" }, "edit": { "helpInfo": "", "js": "", "helpUrl": "", "html": "", "helpTopicId": "" }, "l10nbundle": "L10n/serviceresponse.json" }, "name": "Service Response", "description": "Response from the service", "type": "o:ServiceResponse", "category": "@implementations.policyCategory.endpoints", "version": "1.0", "constraints": { "singleton": true, "before": [ "o:ApiResponse/1.0" ], "responseZone": "150", "required": true, "direction": "RESPONSE", "requires": [ "o:ServiceRequest/1.0" ] }, "revision": "1" }, { "ui": { "view": { "helpInfo": "#InterfaceFilteringHelpInfo", "js": "interfacefiltering-view.js", "helpUrl": "http://www.oracle.com", "html": "interfacefiltering-view.html", "helpTopicId": "policies.interface-filtering" }, "edit": { "helpInfo": "#InterfaceFilteringHelpInfo", "js": "interfacefiltering-edit.js", "helpUrl": "http://www.oracle.com", "html": "interfacefiltering-edit.html", "helpTopicId": "policies.interface-filtering" }, "l10nbundle": "L10n/interfacefiltering.json" }, "configuration": { "services": [ { "service": "oracle.apiplatform.policies.interfacefiltering.InterfaceFilteringValidator", "type": "oracle.apiplatform.policies.sdk.validation.PolicyValidator" }, { "service": "oracle.apiplatform.policies.interfacefiltering.InterfaceFilteringRuntimeFactory", "type": "oracle.apiplatform.policies.sdk.runtime.PolicyRuntimeFactory" } ] }, "name": "Interface Filtering", "description": "Evaluates the application generating the API request.", "type": "o:InterfaceFiltering", "category": "@implementations.policyCategory.interfaceMgmt", "version": "1.0", "constraints": { "singleton": false, "requestZone": "30", "direction": "REQUEST" }, "ocsgActionName": "InterfaceFiltering", "revision": "1" }, { "ui": { "view": { "helpInfo": "#helpInfo", "js": "groovyscript-view.js", "helpUrl": "http://www.oracle.com", "html": "groovyscript-view.html", "helpTopicId": "policies.groovy-script" }, "edit": { "helpInfo": "#helpInfo", "js": "groovyscript-edit.js", "helpUrl": "http://www.oracle.com", "html": "groovyscript-edit.html", "helpTopicId": "policies.groovy-script" }, "l10nbundle": "L10n/groovyscript.json" }, "configuration": { "services": [ { "service": "oracle.apiplatform.policies.groovyscript.GroovyScriptValidator", "type": "oracle.apiplatform.policies.sdk.validation.PolicyValidator" }, { "service": "oracle.apiplatform.policies.groovyscript.GroovyScriptRuntimeFactory", "type": "oracle.apiplatform.policies.sdk.runtime.PolicyRuntimeFactory" } ] }, "name": "Groovy Script", "description": "Executes Groovy script", "type": "o:GroovyScript", "category": "@implementations.policyCategory.other", "version": "1.0", "constraints": { "singleton": false, "requestZone": "30,40,50", "responseZone": "150", "direction": "REQUEST_OR_RESPONSE" }, "revision": "1" }, { "ui": { "view": { "helpInfo": "#headerHelpInfo", "js": "headerrouting-view.js", "helpUrl": "", "html": "headerrouting-view.html", "helpTopicId": "policies.header-based-routing" }, "edit": { "helpInfo": "#headerHelpInfo", "js": "headerrouting-edit.js", "helpUrl": "", "html": "headerrouting-edit.html", "helpTopicId": "policies.header-based-routing" }, "l10nbundle": "L10n/headerrouting.json" }, "configuration": { "services": [ { "service": "oracle.apiplatform.policies.headerrouting.HeaderBasedRoutingValidator", "type": "oracle.apiplatform.policies.sdk.validation.PolicyValidator" }, { "service": "oracle.apiplatform.policies.headerrouting.HeaderBasedRoutingRuntimeFactory", "type": "oracle.apiplatform.policies.sdk.runtime.PolicyRuntimeFactory" } ] }, "name": "Header Based Routing", "description": "The request will be routed based on the header. Can be used for security or to reduce the occurrence of failures/errors at the service layer", "type": "o:HeaderBasedRouting", "category": "@implementations.policyCategory.routing", "version": "1.0", "constraints": { "singleton": false, "requestZone": "50", "direction": "REQUEST" }, "ocsgActionName": "HeaderBasedRouting", "revision": "1" }, { "ui": { "view": { "helpInfo": "#gatewayHelpInfo", "js": "gatewayrouting-view.js", "helpUrl": "http://www.oracle.com", "html": "gatewayrouting-view.html", "helpTopicId": "policies.gateway-routing" }, "edit": { "helpInfo": "#gatewayHelpInfo", "js": "gatewayrouting-edit.js", "helpUrl": "http://www.oracle.com", "html": "gatewayrouting-edit.html", "helpTopicId": "policies.gateway-routing" }, "l10nbundle": "L10n/gatewayrouting.json" }, "configuration": { "services": [ { "service": "oracle.apiplatform.policies.gateway.routing.GatewayBasedRoutingValidator", "type": "oracle.apiplatform.policies.sdk.validation.PolicyValidator" }, { "service": "oracle.apiplatform.policies.gateway.routing.GatewayBasedRoutingRuntimeFactory", "type": "oracle.apiplatform.policies.sdk.runtime.PolicyRuntimeFactory" } ] }, "name": "Gateway Based Routing", "description": "The request will be routed based on the gateway.", "type": "o:GatewayBasedRouting", "category": "@implementations.policyCategory.routing", "version": "1.0", "constraints": { "singleton": false, "requestZone": "50", "direction": "REQUEST" }, "ocsgActionName": "GatewayBasedRouting", "revision": "1" }, { "ui": { "view": { "helpInfo": "#applicationHelpInfo", "js": "applicationrouting-view.js", "helpUrl": "http://www.oracle.com", "html": "applicationrouting-view.html", "helpTopicId": "policies.application-routing" }, "edit": { "helpInfo": "#applicationHelpInfo", "js": "applicationrouting-edit.js", "helpUrl": "http://www.oracle.com", "html": "applicationrouting-edit.html", "helpTopicId": "policies.application-routing" }, "l10nbundle": "L10n/applicationrouting.json" }, "configuration": { "services": [ { "service": "oracle.apiplatform.policies.application.ApplicationBasedRoutingActionValidator", "type": "oracle.apiplatform.policies.sdk.validation.PolicyValidator" }, { "service": "oracle.apiplatform.policies.application.ApplicationBasedRoutingRuntimeFactory", "type": "oracle.apiplatform.policies.sdk.runtime.PolicyRuntimeFactory" } ] }, "name": "Application Based Routing", "description": "The request will be routed based on the application.", "type": "o:ApplicationBasedRouting", "category": "@implementations.policyCategory.routing", "version": "1.0", "constraints": { "singleton": false, "requestZone": "50", "direction": "REQUEST" }, "ocsgActionName": "ApplicationBasedRouting", "revision": "1" }, { "ui": { "view": { "helpInfo": "#ServiceAuthHelpInfo", "js": "serviceauth-view.js", "helpUrl": "http://www.oracle.com", "html": "serviceauth-view.html", "helpTopicId": "policies.service-auth" }, "edit": { "helpInfo": "#ServiceAuthHelpInfo", "js": "serviceauth-edit.js", "helpUrl": "http://www.oracle.com", "html": "serviceauth-edit.html", "helpTopicId": "policies.service-auth" }, "l10nbundle": "L10n/serviceauth.json" }, "configuration": { "services": [ { "service": "oracle.apiplatform.policies.serviceauth.ServiceAuthValidator", "type": "oracle.apiplatform.policies.sdk.validation.PolicyValidator" }, { "service": "oracle.apiplatform.policies.serviceauth.ServiceAuthSecurityHandler", "type": "oracle.apiplatform.policies.sdk.security.PolicySecurityHandler" }, { "service": "oracle.apiplatform.policies.serviceauth.ServiceAuthRuntimeFactory", "type": "oracle.apiplatform.policies.sdk.runtime.PolicyRuntimeFactory" } ] }, "name": "Service Level Auth", "description": "Enforces using the Service Level Auth protocol, that access to this API is only available to request on behalf of one of the listed accounts below.", "type": "o:ServiceAuth", "category": "@implementations.policyCategory.security", "version": "1.0", "constraints": { "singleton": false, "requestZone": "40", "direction": "REQUEST" }, "revision": "1" }, { "ui": { "view": { "helpInfo": "#MethodMappingHelpInfo", "js": "methodmapping-view.js", "helpUrl": "http://www.oracle.com", "html": "methodmapping-view.html", "helpTopicId": "policies.method-mapping" }, "edit": { "helpInfo": "#MethodMappingHelpInfo", "js": "methodmapping-edit.js", "helpUrl": "http://www.oracle.com", "html": "methodmapping-edit.html", "helpTopicId": "policies.method-mapping" }, "l10nbundle": "L10n/methodmapping.json" }, "configuration": { "services": [ { "service": "oracle.apiplatform.policies.methodmapping.MethodMappingValidator", "type": "oracle.apiplatform.policies.sdk.validation.PolicyValidator" }, { "service": "oracle.apiplatform.policies.methodmapping.MethodMappingRuntimeFactory", "type": "oracle.apiplatform.policies.sdk.runtime.PolicyRuntimeFactory" } ] }, "name": "Method Mapping", "description": "Routes to backend service based on method", "type": "o:MethodMapping", "category": "@implementations.policyCategory.interfaceMgmt", "version": "1.0", "constraints": { "singleton": false, "requestZone": "30", "direction": "REQUEST" }, "ocsgActionName": "MethodMapping", "revision": "1" }, { "ui": { "view": { "helpInfo": "#CORSHelpInfo", "js": "cors-view.js", "helpUrl": "http://www.oracle.com", "html": "cors-view.html", "helpTopicId": "policies.cors" }, "edit": { "helpInfo": "#CORSHelpInfo", "js": "cors-edit.js", "helpUrl": "http://www.oracle.com", "html": "cors-edit.html", "helpTopicId": "policies.cors" }, "l10nbundle": "L10n/cors.json" }, "configuration": { "services": [ { "service": "oracle.apiplatform.policies.cors.CorsValidator", "type": "oracle.apiplatform.policies.sdk.validation.PolicyValidator" } ] }, "name": "CORS", "description": "Controls which domains are allowed to invoke this API.", "type": "o:CORS", "category": "@implementations.policyCategory.security", "version": "1.0", "constraints": { "singleton": false, "requestZone": "30", "direction": "REQUEST" }, "ocsgActionName": "CORS", "revision": "1" }, { "ui": { "view": { "helpInfo": "#LoggingHelpInfo", "js": "logging-view.js", "helpUrl": "http://www.oracle.com", "html": "logging-view.html", "helpTopicId": "policies.logging" }, "edit": { "helpInfo": "#LoggingHelpInfo", "js": "logging-edit.js", "helpUrl": "http://www.oracle.com", "html": "logging-edit.html", "helpTopicId": "policies.logging" }, "l10nbundle": "L10n/logging.json" }, "configuration": { "services": [ { "service": "oracle.apiplatform.policies.logging.LoggingValidationValidator", "type": "oracle.apiplatform.policies.sdk.validation.PolicyValidator" }, { "service": "oracle.apiplatform.policies.logging.LoggingRuntimeFactory", "type": "oracle.apiplatform.policies.sdk.runtime.PolicyRuntimeFactory" } ] }, "name": "Logging", "description": "Writes a message to the log.", "type": "o:Logging", "category": "@implementations.policyCategory.other", "version": "1.0", "constraints": { "singleton": false, "requestZone": "30,40,50", "responseZone": "150", "direction": "REQUEST_OR_RESPONSE" }, "ocsgActionName": "Logging", "revision": "1" }, { "ui": { "view": { "helpInfo": "#RedactionHelpInfo", "js": "redaction-view.js", "helpUrl": "http://www.oracle.com", "html": "redaction-view.html", "helpTopicId": "policies.field-redaction" }, "edit": { "helpInfo": "#RedactionHelpInfo", "js": "redaction-edit.js", "helpUrl": "http://www.oracle.com", "html": "redaction-edit.html", "helpTopicId": "policies.field-redaction" }, "l10nbundle": "L10n/redaction.json" }, "configuration": { "services": [ { "service": "oracle.apiplatform.policies.fieldredaction.FieldRedactionValidator", "type": "oracle.apiplatform.policies.sdk.validation.PolicyValidator" }, { "service": "oracle.apiplatform.policies.fieldredaction.FieldRedactionRuntimeFactory", "type": "oracle.apiplatform.policies.sdk.runtime.PolicyRuntimeFactory" } ] }, "name": "Redaction", "description": "Manages the fields and headers in the request or response payload. You can either explicitly include, or exclude, the headers and fields sent to the backend service (from the request flow) or sent to the client (from the response flow).", "type": "o:FieldRedaction", "category": "@implementations.policyCategory.interfaceMgmt", "version": "1.0", "constraints": { "singleton": false, "requestZone": "30", "responseZone": "150", "direction": "REQUEST_OR_RESPONSE" }, "ocsgActionName": "FieldRedaction", "revision": "1" }, { "ui": { "view": { "helpInfo": "resourceRoutingHelpInfo", "js": "resourcerouting-view.js", "helpUrl": "http://www.oracle.com", "html": "resourcerouting-view.html", "helpTopicId": "policies.resource-routing" }, "edit": { "helpInfo": "#resourceRoutingHelpInfo", "js": "resourcerouting-edit.js", "helpUrl": "http://www.oracle.com", "html": "resourcerouting-edit.html", "helpTopicId": "policies.resource-routing" }, "l10nbundle": "L10n/resourcerouting.json" }, "configuration": { "services": [ { "service": "oracle.apiplatform.policies.resourcerouting.ResourceBasedRoutingValidators", "type": "oracle.apiplatform.policies.sdk.validation.PolicyValidator" }, { "service": "oracle.apiplatform.policies.resourcerouting.ResourceBasedRoutingRuntimeFactory", "type": "oracle.apiplatform.policies.sdk.runtime.PolicyRuntimeFactory" } ] }, "name": "Resource Based Routing", "description": "The request will be routed based on the resource path. Can be used for security or to reduce the occurrence of failures/errors at the service layer", "type": "o:ResourceBasedRouting", "category": "@implementations.policyCategory.routing", "version": "1.0", "constraints": { "singleton": false, "requestZone": "50", "direction": "REQUEST" }, "ocsgActionName": "ResourceBasedRouting", "revision": "1" }, { "ui": { "view": { "helpInfo": "#headerHelpInfo", "js": "header-view.js", "helpUrl": "", "html": "header-view.html", "helpTopicId": "policies.header-validation" }, "edit": { "helpInfo": "#headerHelpInfo", "js": "header-edit.js", "helpUrl": "", "html": "header-edit.html", "helpTopicId": "policies.header-validation" }, "l10nbundle": "L10n/header.json" }, "configuration": { "services": [ { "service": "oracle.apiplatform.policies.header.HeaderValidationValidator", "type": "oracle.apiplatform.policies.sdk.validation.PolicyValidator" }, { "service": "oracle.apiplatform.policies.header.HeaderValidationRuntimeFactory", "type": "oracle.apiplatform.policies.sdk.runtime.PolicyRuntimeFactory" } ] }, "name": "Header Validation", "description": "Validates the presence and values of http headers. Can be used for security or to reduce the occurrence of failures/errors at the service layer", "type": "o:HeaderValidation", "category": "@implementations.policyCategory.interfaceMgmt", "version": "1.0", "constraints": { "singleton": false, "requestZone": "30", "responseZone": "150", "direction": "REQUEST" }, "ocsgActionName": "HeaderValidation", "revision": "1" }, { "ui": { "view": { "helpInfo": "#svcReqHelpInfo", "js": "service/request-view.js", "helpUrl": "http://www.oracle.com", "html": "service/request-view.html", "helpTopicId": "policies.service-request" }, "edit": { "helpInfo": "#svcReqHelpInfo", "js": "service/request-edit.js", "helpUrl": "http://www.oracle.com", "html": "service/request-edit.html", "helpTopicId": "policies.service-request" }, "l10nbundle": "L10n/request.json" }, "configuration": { "services": [ { "service": "oracle.apiplatform.policies.endpoints.validation.ServiceRequestValidator", "type": "oracle.apiplatform.policies.sdk.validation.PolicyValidator" }, { "service": "oracle.apiplatform.policies.servicerequest.ServiceRequestRuntimeFactory", "type": "oracle.apiplatform.policies.sdk.runtime.PolicyRuntimeFactory" } ] }, "name": "Service Request", "description": "Specify the backend service URL", "type": "o:ServiceRequest", "category": "@implementations.policyCategory.endpoints", "version": "1.0", "constraints": { "singleton": true, "requestZone": "100", "after": [ "o:ApiRequest/1.0" ], "required": true, "direction": "REQUEST", "requires": [ "o:ServiceResponse/1.0" ] }, "revision": "1" } ] }