Open Context Protocol is live! 🚀 Read the launch post

getUserProperty

Get user property

Details

  • Method: GET
  • Path: /rest/api/3/user/properties/{propertyKey}
  • Operation ID: getUserProperty

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"
  },
  "propertyKey": {
    "description": "The key of the user's property.",
    "required": true,
    "location": "path",
    "type": "string"
  }
}

Response Schema

{
  "additionalProperties": false,
  "description": "An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).",
  "properties": {
    "key": {
      "description": "The key of the property. Required on create and update.",
      "type": "string"
    },
    "value": {
      "description": "The value of the property. Required on create and update."
    }
  },
  "type": "object"
}

Usage

from ocp_agent import OCPAgent

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

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