Get policy types
/apiplatform/management/v1/policies
Returns a collection of the available policy types. The type and version of each policy are returned.
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.
object
-
type:
string
The policy type, like
o:KeyValidation
. -
version:
string
The policy version.
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 all of the 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
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 18:51:53 GMT Content-length: 1082 Content-type: application/json X-oracle-dms-ecid: UGEem0aLW00000000 X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0
Example of Response Body
The following example shows the contents of the response body in JSON format, including the names and versions of the available policies.
{ "count": 24, "items": [ { "type": "o:OAuth", "version": "1.0" }, { "type": "o:KeyValidation", "version": "1.0" }, { "type": "o:ApiResponse", "version": "1.0" }, { "type": "o:ApiThrottlingDelay", "version": "1.0" }, { "type": "o:IPFilterValidation", "version": "1.0" }, { "type": "o:ApplicationRateLimiting", "version": "1.0" }, { "type": "o:ApiRequest", "version": "1.0" }, { "type": "o:BasicAuth", "version": "1.0" }, { "type": "o:apiRateLimiting", "version": "1.0" }, { "type": "o:ServiceCallout", "version": "1.0" }, { "type": "o:ServiceResponse", "version": "1.0" }, { "type": "o:InterfaceFiltering", "version": "1.0" }, { "type": "o:GroovyScript", "version": "1.0" }, { "type": "o:HeaderBasedRouting", "version": "1.0" }, { "type": "o:GatewayBasedRouting", "version": "1.0" }, { "type": "o:ApplicationBasedRouting", "version": "1.0" }, { "type": "o:ServiceAuth", "version": "1.0" }, { "type": "o:MethodMapping", "version": "1.0" }, { "type": "o:CORS", "version": "1.0" }, { "type": "o:Logging", "version": "1.0" }, { "type": "o:FieldRedaction", "version": "1.0" }, { "type": "o:ResourceBasedRouting", "version": "1.0" }, { "type": "o:HeaderValidation", "version": "1.0" }, { "type": "o:ServiceRequest", "version": "1.0" } ] }