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

getUserPropertyKeys

Get user property keys

Details

  • Method: GET
  • Path: /rest/api/3/user/properties
  • Operation ID: getUserPropertyKeys

Parameters

{
  "accountId": {
    "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.",
    "required": false,
    "location": "query",
    "type": "string"
  },
  "userKey": {
    "description": "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
    "required": false,
    "location": "query",
    "type": "string"
  },
  "username": {
    "description": "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
    "required": false,
    "location": "query",
    "type": "string"
  }
}

Response Schema

{
  "additionalProperties": false,
  "description": "List of property keys.",
  "properties": {
    "keys": {
      "description": "Property key details.",
      "items": {
        "additionalProperties": false,
        "description": "Property key details.",
        "properties": {
          "key": {
            "description": "The key of the property.",
            "readOnly": true,
            "type": "string"
          },
          "self": {
            "description": "The URL of the property.",
            "readOnly": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "readOnly": true,
      "type": "array"
    }
  },
  "type": "object"
}

Usage

from ocp_agent import OCPAgent

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

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