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

getProjectRoleDetails

Get project role details

Details

  • Method: GET
  • Path: /rest/api/3/project/{projectIdOrKey}/roledetails
  • Operation ID: getProjectRoleDetails

Parameters

{
  "projectIdOrKey": {
    "description": "The project ID or project key (case sensitive).",
    "required": true,
    "location": "path",
    "type": "string"
  },
  "currentMember": {
    "description": "Whether the roles should be filtered to include only those the user is assigned to.",
    "required": false,
    "location": "query",
    "type": "boolean"
  },
  "excludeConnectAddons": {
    "description": "",
    "required": false,
    "location": "query",
    "type": "boolean"
  },
  "excludeOtherServiceRoles": {
    "description": "Do not return the default JSM company-managed space from CSM spaces, or the default CSM roles from JSM spaces.",
    "required": false,
    "location": "query",
    "type": "boolean"
  }
}

Response Schema

{
  "items": {
    "additionalProperties": false,
    "description": "Details about a project role.",
    "properties": {
      "admin": {
        "description": "Whether this role is the admin role for the project.",
        "readOnly": true,
        "type": "boolean"
      },
      "default": {
        "description": "Whether this role is the default role for the project.",
        "readOnly": true,
        "type": "boolean"
      },
      "description": {
        "description": "The description of the project role.",
        "readOnly": true,
        "type": "string"
      },
      "id": {
        "description": "The ID of the project role.",
        "format": "int64",
        "readOnly": true,
        "type": "integer"
      },
      "name": {
        "description": "The name of the project role.",
        "type": "string"
      },
      "roleConfigurable": {
        "description": "Whether the roles are configurable for this project.",
        "readOnly": true,
        "type": "boolean"
      },
      "scope": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Scope"
          }
        ],
        "description": "The scope of the role. Indicated for roles associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).",
        "readOnly": true
      },
      "self": {
        "description": "The URL the project role details.",
        "format": "uri",
        "readOnly": true,
        "type": "string"
      },
      "translatedName": {
        "description": "The translated name of the project role.",
        "type": "string"
      }
    },
    "type": "object"
  },
  "type": "array"
}

Usage

from ocp_agent import OCPAgent

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

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