GRgravitee-io
SharedPolicyGroups

Get all shared policy group for a policy plugin usage

Changed on
get/shared-policy-groups/policy-plugins

Request

  • Base URL
    /management/v2/environments/DEFAULT (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /management/v2/environments/DEFAULT/shared-policy-groups/policy-plugins
  • Auth
    • HTTP basic
    • or API key in cookie Auth-Graviteeio-APIM

Response

Shared policy group found

idstring

The unique ID of the shared policy group

policyIdstring

The id of shared-policy-group plugin

namestring

The name of the shared policy group

descriptionstring

The description of the shared policy group

prerequisiteMessagestring

The prerequisite message of the shared policy group. This message is displayed to the user to help understand the prerequisite to use the shared policy group.

apiType'A2A_PROXY' | 'AUTHZ' | 'EDGE' | 'LLM_PROXY' | 'MCP_PROXY' | 'MESSAGE' | 'PROXY' | 'NATIVE'

API's type.

phase'ENTRYPOINT_CONNECT' | 'REQUEST' | 'RESPONSE' | 'INTERACT' | 'PUBLISH' | 'SUBSCRIBE'

The execution phase of a policy.

Example response

[
  {
    "name": "My Shared Policy Group",
    "description": "This is a shared policy group",
    "prerequisiteMessage": "The resource cache \"my-cache\" is required",
    "apiType": "MESSAGE",
    "phase": "REQUEST"
  }
]

Changes

  • d1cab18ccf47Revision changes
    • warning

      added the new AUTHZ enum value to the / response property for the response status

  • 34e152417e4eRevision changes
    • warning

      added the new EDGE enum value to the / response property for the response status