Jump to

• Request
• Response
• Examples

Get policy types

get

/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 Top

Response

Supported Media Types

• application/json

200 Response

The collection of policy types.

Body ()

Root Schema : GetPolicyIdsResponse

Match All

Show Source

• object CollectionResponseFeature
• object GetPolicyIdsResponse-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResponseFeature"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/PolicyId"
                    }
                }
            }
        }
    ]
}

Nested Schema : CollectionResponseFeature

Type: object

Show Source

• count(optional): integer(int32)
  The number of items in this collection.

{
    "properties":{
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"The number of items in this collection."
        }
    }
}

Nested Schema : GetPolicyIdsResponse-allOf[1]

Type: object

Show Source

• items(optional): array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PolicyId"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object PolicyId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PolicyId"
    }
}

Nested Schema : PolicyId

Type: object

Show Source

• type: string
  The policy type, like o:KeyValidation.
• version: string
  The policy version.

{
    "type":"object",
    "required":[
        "type",
        "version"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"The policy type, like <code>o:KeyValidation</code>."
        },
        "version":{
            "type":"string",
            "description":"The policy version."
        }
    }
}

403 Response

Forbidden.

Body ()

Root Schema : Error

Type: object

Show Source

• 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

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

500 Response

Unexpected error.

Body ()

Root Schema : Error

Type: object

Show Source

• 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

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Back to Top

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"
    }
  ]
}

Back to Top