Open Context Protocol is live! 🚀 Read the launch post
setDefaultShareScope

setDefaultShareScope

Set default share scope

Details

  • Method: PUT
  • Path: /rest/api/3/filter/defaultShareScope
  • Operation ID: setDefaultShareScope

Parameters

{
  "scope": {
    "description": "The scope of the default sharing for new filters and dashboards:\n\n *  `AUTHENTICATED` Shared with all logged-in users.\n *  `GLOBAL` Shared with all logged-in users. This shows as `AUTHENTICATED` in the response.\n *  `PRIVATE` Not shared with any users.",
    "required": true,
    "location": "body",
    "type": "string",
    "enum": [
      "GLOBAL",
      "AUTHENTICATED",
      "PRIVATE"
    ]
  }
}

Response Schema

{
  "additionalProperties": false,
  "description": "Details of the scope of the default sharing for new filters and dashboards.",
  "properties": {
    "scope": {
      "description": "The scope of the default sharing for new filters and dashboards:\n\n *  `AUTHENTICATED` Shared with all logged-in users.\n *  `GLOBAL` Shared with all logged-in users. This shows as `AUTHENTICATED` in the response.\n *  `PRIVATE` Not shared with any users.",
      "enum": [
        "GLOBAL",
        "AUTHENTICATED",
        "PRIVATE"
      ],
      "type": "string"
    }
  },
  "required": [
    "scope"
  ],
  "type": "object",
  "xml": {
    "name": "defaultShareScope"
  }
}

Usage

from ocp_agent import OCPAgent

agent = OCPAgent()
await agent.register_api('jira')

# Call this tool
result = await agent.call_tool('setDefaultShareScope', {
    # Add required parameters here
})