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

getAssignedPermissionScheme

Get assigned permission scheme

Details

  • Method: GET
  • Path: /rest/api/3/project/{projectKeyOrId}/permissionscheme
  • Operation ID: getAssignedPermissionScheme

Parameters

{
  "projectKeyOrId": {
    "description": "The project ID or project key (case sensitive).",
    "required": true,
    "location": "path",
    "type": "string"
  },
  "expand": {
    "description": "Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include:\n\n *  `all` Returns all expandable information.\n *  `field` Returns information about the custom field granted the permission.\n *  `group` Returns information about the group that is granted the permission.\n *  `permissions` Returns all permission grants for each permission scheme.\n *  `projectRole` Returns information about the project role granted the permission.\n *  `user` Returns information about the user who is granted the permission.",
    "required": false,
    "location": "query",
    "type": "string"
  }
}

Response Schema

{
  "additionalProperties": true,
  "description": "Details of a permission scheme.",
  "properties": {
    "description": {
      "description": "A description for the permission scheme.",
      "type": "string"
    },
    "expand": {
      "description": "The expand options available for the permission scheme.",
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "description": "The ID of the permission scheme.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "name": {
      "description": "The name of the permission scheme. Must be unique.",
      "type": "string"
    },
    "permissions": {
      "description": "The permission scheme to create or update. See [About permission schemes and grants](../api-group-permission-schemes/#about-permission-schemes-and-grants) for more information.",
      "items": {
        "additionalProperties": true,
        "description": "Details about a permission granted to a user or group.",
        "properties": {
          "holder": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PermissionHolder"
              }
            ],
            "description": "The user or group being granted the permission. It consists of a `type`, a type-dependent `parameter` and a type-dependent `value`. See [Holder object](../api-group-permission-schemes/#holder-object) in *Get all permission schemes* for more information."
          },
          "id": {
            "description": "The ID of the permission granted details.",
            "format": "int64",
            "readOnly": true,
            "type": "integer"
          },
          "permission": {
            "description": "The permission to grant. This permission can be one of the built-in permissions or a custom permission added by an app. See [Built-in permissions](../api-group-permission-schemes/#built-in-permissions) in *Get all permission schemes* for more information about the built-in permissions. See the [project permission](https://developer.atlassian.com/cloud/jira/platform/modules/project-permission/) and [global permission](https://developer.atlassian.com/cloud/jira/platform/modules/global-permission/) module documentation for more information about custom permissions.",
            "type": "string"
          },
          "self": {
            "description": "The URL of the permission granted details.",
            "format": "uri",
            "readOnly": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "scope": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Scope"
        }
      ],
      "description": "The scope of the permission scheme."
    },
    "self": {
      "description": "The URL of the permission scheme.",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

Usage

from ocp_agent import OCPAgent

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

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