Atlassian · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Atlassian User Properties API
10 actions
10 updates
phrasing
extends
openapi/atlassian-user-properties-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Atlassian's API. It is a proposal applied on top of the contract, not a document Atlassian publishes.
What the actions change
x-apievangelist-phrasing
Targets 10
$.info
$.paths['/wiki/rest/api/user/{userId}/property'].get
$.paths['/wiki/rest/api/user/{userId}/property/{key}'].get
$.paths['/wiki/rest/api/user/{userId}/property/{key}'].put
$.paths['/wiki/rest/api/user/{userId}/property/{key}'].post
$.paths['/wiki/rest/api/user/{userId}/property/{key}'].delete
$.paths['/rest/api/3/user/properties'].get
$.paths['/rest/api/3/user/properties/{propertyKey}'].get
$.paths['/rest/api/3/user/properties/{propertyKey}'].put
$.paths['/rest/api/3/user/properties/{propertyKey}'].delete
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Atlassian User Properties API
version: 1.0.0
extends: openapi/atlassian-user-properties-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 9
- target: $.paths['/wiki/rest/api/user/{userId}/property'].get
update:
x-apievangelist-phrasing:
intent: List a Confluence user's property keys
effect: read
questions:
- Which properties has my app stored on a Confluence user?
- Can I page through all property keys for one Confluence user?
instructions:
- text: List the Confluence property keys for user {userId}.
slots:
userId: path.userId
- text: Show Confluence user {userId}'s properties, {limit} at a time.
slots:
userId: path.userId
limit: query.limit
method: generated
generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/user/{userId}/property/{key}'].get
update:
x-apievangelist-phrasing:
intent: Get a Confluence user property by key
effect: read
questions:
- What value is stored in a particular Confluence user property?
- Can I read one Confluence entity property on a user by its key?
instructions:
- text: Get Confluence user {userId}'s property {key}.
slots:
userId: path.userId
key: path.key
- text: Read property {key} stored on Confluence user {userId}.
slots:
key: path.key
userId: path.userId
method: generated
generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/user/{userId}/property/{key}'].put
update:
x-apievangelist-phrasing:
intent: Update a Confluence user property's value
effect: write
questions:
- Can I change the value of an existing Confluence user property?
- Is it possible to rename a Confluence user property key, or only change its value?
instructions:
- text: Update Confluence user {userId}'s property {key} to {value}.
slots:
userId: path.userId
key: path.key
value: requestBody.value
- text: Change the value of property {key} on Confluence user {userId} to {value}.
slots:
key: path.key
userId: path.userId
value: requestBody.value
method: generated
generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/user/{userId}/property/{key}'].post
update:
x-apievangelist-phrasing:
intent: Create a Confluence user property
effect: write
questions:
- How do I store custom data on a Confluence user?
- Can my app create a new property on a Confluence user account?
instructions:
- text: Create property {key} with value {value} on Confluence user {userId}.
slots:
key: path.key
value: requestBody.value
userId: path.userId
- text: Add a new Confluence user property {key} for {userId}.
slots:
key: path.key
userId: path.userId
method: generated
generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/user/{userId}/property/{key}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a Confluence user property
effect: destructive
questions:
- Can I remove a property from a Confluence user?
- What's the way to clear custom data stored on a Confluence user?
instructions:
- text: Delete property {key} from Confluence user {userId}.
slots:
key: path.key
userId: path.userId
- text: Remove Confluence user {userId}'s {key} property.
slots:
userId: path.userId
key: path.key
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/user/properties'].get
update:
x-apievangelist-phrasing:
intent: List a Jira user's property keys
effect: read
questions:
- Which custom properties are stored against a Jira user?
- Can I list all property keys on a Jira user account?
instructions:
- text: List the Jira user property keys for account {accountId}.
slots:
accountId: query.accountId
- text: Show the property keys stored on Jira user {accountId}.
slots:
accountId: query.accountId
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/user/properties/{propertyKey}'].get
update:
x-apievangelist-phrasing:
intent: Get a Jira user property's value
effect: read
questions:
- What value does a specific property hold on a Jira user?
- Can I read custom data my app saved on a Jira user?
instructions:
- text: Get Jira user property {propertyKey} for account {accountId}.
slots:
propertyKey: path.propertyKey
accountId: query.accountId
- text: Read property {propertyKey} on Jira user {accountId}.
slots:
propertyKey: path.propertyKey
accountId: query.accountId
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/user/properties/{propertyKey}'].put
update:
x-apievangelist-phrasing:
intent: Set a Jira user property
effect: write
questions:
- How do I store custom data against a Jira user?
- Can I create or overwrite a property on a Jira user account?
instructions:
- text: Set Jira user property {propertyKey} for account {accountId}.
slots:
propertyKey: path.propertyKey
accountId: query.accountId
- text: Save property {propertyKey} on Jira user {accountId}.
slots:
propertyKey: path.propertyKey
accountId: query.accountId
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/user/properties/{propertyKey}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a Jira user property
effect: destructive
questions:
- Can I remove a custom property from a Jira user?
- Will deleting a Jira user property affect the properties Jira itself maintains?
instructions:
- text: Delete Jira user property {propertyKey} from account {accountId}.
slots:
propertyKey: path.propertyKey
accountId: query.accountId
- text: Remove property {propertyKey} on Jira user {accountId}.
slots:
propertyKey: path.propertyKey
accountId: query.accountId
method: generated
generated: '2026-10-01'
Work with this as data
Every overlay here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for openapi overlays
4 MCP tools reach this
find_overlaysBrowse and filter every overlay in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/atlassian-user-properties-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.