Atlassian The Confluence Cloud REST API — User Properties

naftiko: 1.0.0-alpha2
info:
  label: Atlassian The Confluence Cloud REST API — User Properties
  description: 'Atlassian The Confluence Cloud REST API — User Properties. 5 operations. Lead operation: Atlassian Get User
    Properties. 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: confluence-user-properties
    baseUri: ''
    description: Atlassian The Confluence Cloud REST API — User Properties business capability. Self-contained, no shared
      references.
    resources:
    - name: wiki-rest-api-user-userId-property
      path: /wiki/rest/api/user/{userId}/property
      operations:
      - name: atlassiangetuserproperties
        method: GET
        description: Atlassian Get User Properties
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: userId
          in: path
          type: string
          description: The account ID of the user to be queried for its properties.
          required: true
        - name: start
          in: query
          type: integer
          description: The starting index of the returned properties.
        - name: limit
          in: query
          type: integer
          description: The maximum number of properties to return per page.
    - name: wiki-rest-api-user-userId-property-key
      path: /wiki/rest/api/user/{userId}/property/{key}
      operations:
      - name: atlassiangetuserproperty
        method: GET
        description: Atlassian Get User Property
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: userId
          in: path
          type: string
          description: The account ID of the user to be queried for its properties.
          required: true
        - name: key
          in: path
          type: string
          description: The key of the user property.
          required: true
      - name: atlassianupdateuserproperty
        method: PUT
        description: Atlassian Update User Property
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: userId
          in: path
          type: string
          description: The account ID of the user. The accountId uniquely identifies the user across all Atlassian
          required: true
        - name: key
          in: path
          type: string
          description: The key of the user property.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: atlassiancreateuserproperty
        method: POST
        description: Atlassian Create User Property By Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: userId
          in: path
          type: string
          description: The account ID of the user. The accountId uniquely identifies the user across all Atlassian
          required: true
        - name: key
          in: path
          type: string
          description: The key of the user property.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: atlassiandeleteuserproperty
        method: DELETE
        description: Atlassian Delete User Property
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: userId
          in: path
          type: string
          description: The account ID of the user. The accountId uniquely identifies the user across all Atlassian
          required: true
        - name: key
          in: path
          type: string
          description: The key of the user property.
          required: true
    authentication:
      type: bearer
      token: '{{env.ATLASSIAN_API_KEY}}'
  exposes:
  - type: rest
    namespace: confluence-user-properties-rest
    port: 8080
    description: REST adapter for Atlassian The Confluence Cloud REST API — User Properties. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/wiki/rest/api/user/{userid}/property
      name: wiki-rest-api-user-userid-property
      description: REST surface for wiki-rest-api-user-userId-property.
      operations:
      - method: GET
        name: atlassiangetuserproperties
        description: Atlassian Get User Properties
        call: confluence-user-properties.atlassiangetuserproperties
        with:
          userId: rest.userId
          start: rest.start
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/user/{userid}/property/{key}
      name: wiki-rest-api-user-userid-property-key
      description: REST surface for wiki-rest-api-user-userId-property-key.
      operations:
      - method: GET
        name: atlassiangetuserproperty
        description: Atlassian Get User Property
        call: confluence-user-properties.atlassiangetuserproperty
        with:
          userId: rest.userId
          key: rest.key
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: atlassianupdateuserproperty
        description: Atlassian Update User Property
        call: confluence-user-properties.atlassianupdateuserproperty
        with:
          userId: rest.userId
          key: rest.key
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: atlassiancreateuserproperty
        description: Atlassian Create User Property By Key
        call: confluence-user-properties.atlassiancreateuserproperty
        with:
          userId: rest.userId
          key: rest.key
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: atlassiandeleteuserproperty
        description: Atlassian Delete User Property
        call: confluence-user-properties.atlassiandeleteuserproperty
        with:
          userId: rest.userId
          key: rest.key
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: confluence-user-properties-mcp
    port: 9090
    transport: http
    description: MCP adapter for Atlassian The Confluence Cloud REST API — User Properties. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: atlassian-get-user-properties
      description: Atlassian Get User Properties
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: confluence-user-properties.atlassiangetuserproperties
      with:
        userId: tools.userId
        start: tools.start
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-user-property
      description: Atlassian Get User Property
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: confluence-user-properties.atlassiangetuserproperty
      with:
        userId: tools.userId
        key: tools.key
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-update-user-property
      description: Atlassian Update User Property
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: confluence-user-properties.atlassianupdateuserproperty
      with:
        userId: tools.userId
        key: tools.key
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-create-user-property-key
      description: Atlassian Create User Property By Key
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: confluence-user-properties.atlassiancreateuserproperty
      with:
        userId: tools.userId
        key: tools.key
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-delete-user-property
      description: Atlassian Delete User Property
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: confluence-user-properties.atlassiandeleteuserproperty
      with:
        userId: tools.userId
        key: tools.key
      outputParameters:
      - type: object
        mapping: $.