Atlassian The Jira Cloud platform REST API — User Properties

naftiko: 1.0.0-alpha2
info:
  label: Atlassian The Jira Cloud platform REST API — User Properties
  description: 'Atlassian The Jira Cloud platform REST API — User Properties. 4 operations. Lead operation: Atlassian Get
    User Property Keys. Self-contained Naftiko capability covering one Atlassian business surface.'
  tags:
  - Atlassian
  - User Properties
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ATLASSIAN_API_KEY: ATLASSIAN_API_KEY
capability:
  consumes:
  - type: http
    namespace: jira-user-properties
    baseUri: https://your-domain.atlassian.net
    description: Atlassian The Jira Cloud platform REST API — User Properties business capability. Self-contained, no shared
      references.
    resources:
    - name: rest-api-3-user-properties
      path: /rest/api/3/user/properties
      operations:
      - name: atlassiangetuserpropertykeys
        method: GET
        description: Atlassian Get User Property Keys
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: query
          type: string
          description: The account ID of the user, which uniquely identifies the user across all Atlassian products. For example,
            *5b10ac8d82e05b22cc7d4ef5*.
        - name: userKey
          in: query
          type: string
          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/p
        - name: username
          in: query
          type: string
          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/p
    - name: rest-api-3-user-properties-propertyKey
      path: /rest/api/3/user/properties/{propertyKey}
      operations:
      - name: atlassiandeleteuserproperty
        method: DELETE
        description: Atlassian Delete User Property
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: query
          type: string
          description: The account ID of the user, which uniquely identifies the user across all Atlassian products. For example,
            *5b10ac8d82e05b22cc7d4ef5*.
        - name: userKey
          in: query
          type: string
          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/p
        - name: username
          in: query
          type: string
          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/p
        - name: propertyKey
          in: path
          type: string
          description: The key of the user's property.
          required: true
      - name: atlassiangetuserproperty
        method: GET
        description: Atlassian Get User Property
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: query
          type: string
          description: The account ID of the user, which uniquely identifies the user across all Atlassian products. For example,
            *5b10ac8d82e05b22cc7d4ef5*.
        - name: userKey
          in: query
          type: string
          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/p
        - name: username
          in: query
          type: string
          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/p
        - name: propertyKey
          in: path
          type: string
          description: The key of the user's property.
          required: true
      - name: atlassiansetuserproperty
        method: PUT
        description: Atlassian Set User Property
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: query
          type: string
          description: The account ID of the user, which uniquely identifies the user across all Atlassian products. For example,
            *5b10ac8d82e05b22cc7d4ef5*.
        - name: userKey
          in: query
          type: string
          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/p
        - name: username
          in: query
          type: string
          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/p
        - name: propertyKey
          in: path
          type: string
          description: The key of the user's property. The maximum length is 255 characters.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.ATLASSIAN_API_KEY}}'
  exposes:
  - type: rest
    namespace: jira-user-properties-rest
    port: 8080
    description: REST adapter for Atlassian The Jira Cloud platform REST API — User Properties. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/3/user/properties
      name: rest-api-3-user-properties
      description: REST surface for rest-api-3-user-properties.
      operations:
      - method: GET
        name: atlassiangetuserpropertykeys
        description: Atlassian Get User Property Keys
        call: jira-user-properties.atlassiangetuserpropertykeys
        with:
          accountId: rest.accountId
          userKey: rest.userKey
          username: rest.username
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/user/properties/{propertykey}
      name: rest-api-3-user-properties-propertykey
      description: REST surface for rest-api-3-user-properties-propertyKey.
      operations:
      - method: DELETE
        name: atlassiandeleteuserproperty
        description: Atlassian Delete User Property
        call: jira-user-properties.atlassiandeleteuserproperty
        with:
          accountId: rest.accountId
          userKey: rest.userKey
          username: rest.username
          propertyKey: rest.propertyKey
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: atlassiangetuserproperty
        description: Atlassian Get User Property
        call: jira-user-properties.atlassiangetuserproperty
        with:
          accountId: rest.accountId
          userKey: rest.userKey
          username: rest.username
          propertyKey: rest.propertyKey
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: atlassiansetuserproperty
        description: Atlassian Set User Property
        call: jira-user-properties.atlassiansetuserproperty
        with:
          accountId: rest.accountId
          userKey: rest.userKey
          username: rest.username
          propertyKey: rest.propertyKey
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: jira-user-properties-mcp
    port: 9090
    transport: http
    description: MCP adapter for Atlassian The Jira Cloud platform REST API — User Properties. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: atlassian-get-user-property-keys
      description: Atlassian Get User Property Keys
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-user-properties.atlassiangetuserpropertykeys
      with:
        accountId: tools.accountId
        userKey: tools.userKey
        username: tools.username
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-delete-user-property
      description: Atlassian Delete User Property
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: jira-user-properties.atlassiandeleteuserproperty
      with:
        accountId: tools.accountId
        userKey: tools.userKey
        username: tools.username
        propertyKey: tools.propertyKey
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-user-property
      description: Atlassian Get User Property
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-user-properties.atlassiangetuserproperty
      with:
        accountId: tools.accountId
        userKey: tools.userKey
        username: tools.username
        propertyKey: tools.propertyKey
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-set-user-property
      description: Atlassian Set User Property
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: jira-user-properties.atlassiansetuserproperty
      with:
        accountId: tools.accountId
        userKey: tools.userKey
        username: tools.username
        propertyKey: tools.propertyKey
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.