How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Atlassian User Properties API

The User Properties API from Atlassian — 4 operation(s) for user properties.

Atlassian User Properties API is one of 183 APIs that Atlassian publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 17 JSON Schema definitions.

Tagged areas include User Properties. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 17 JSON Schemas.

This API exposes 9 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: //your-domain.atlassian.net, https://your-domain.atlassian.net.

9 operations 4 paths 8 schemas 2 DELETE4 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Servers
//your-domain.atlassian.net
https://your-domain.atlassian.net
Authentication
HTTP Basic, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 3

Atlassian User Properties API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It supports OAuth 2.0 (oAuthDefinitions) using the authorizationCode flow, exposing 73 scopes. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 183 scopes.

  • basicAuth — You can access this resource via basic auth.
  • oAuthDefinitions — This API uses OAuth 2 with the authorizationCode grant flow.
  • OAuth2 — OAuth2 scopes for Jira

Paths & Operations 9

Across 4 paths, the API surfaces 9 operations — 2 DELETE, 4 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

User Properties 9
GET
/wiki/rest/api/user/{userId}/property
Atlassian Get User Properties
atlassianGetuserproperties 3 params → 200400401403404
GET
/wiki/rest/api/user/{userId}/property/{key}
Atlassian Get User Property
atlassianGetuserproperty 2 params → 200400401403404
PUT
/wiki/rest/api/user/{userId}/property/{key}
Atlassian Update User Property
atlassianUpdateuserproperty 2 params body → 204400401403404
POST
/wiki/rest/api/user/{userId}/property/{key}
Atlassian Create User Property By Key
atlassianCreateuserproperty 2 params body → 201400401403404409
DELETE
/wiki/rest/api/user/{userId}/property/{key}
Atlassian Delete User Property
atlassianDeleteuserproperty 2 params → 204400401403404
GET
/rest/api/3/user/properties
Atlassian Get User Property Keys
atlassianGetuserpropertykeys 3 params → 200400401403404
DELETE
/rest/api/3/user/properties/{propertyKey}
Atlassian Delete User Property
atlassianDeleteuserproperty 4 params → 204400401403404
GET
/rest/api/3/user/properties/{propertyKey}
Atlassian Get User Property
atlassianGetuserproperty 4 params → 200400401403404
PUT
/rest/api/3/user/properties/{propertyKey}
Atlassian Set User Property
atlassianSetuserproperty 4 params body → 200201400401403404405

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are UserProperty (6 properties), UserPropertyKeyArray (5 properties), PropertyKey (2 properties), EntityProperty (2 properties). Each schema is shown below with its type and property counts.

UserPropertyKeyArray
object
5 properties 1 required
GenericLinks
object
UserPropertyCreate
object
1 property 1 required
UserProperty
object
6 properties 5 required
UserPropertyUpdate
object
1 property 1 required
PropertyKeys
object
List of property keys.
1 property
PropertyKey
object
Property key details.
2 properties
EntityProperty
object
An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atlassian-user-properties-api-openapi.yml Raw ↑

Other APIs Atlassian publishes across the network.

Atlassian Jira Software Backlog API
Atlassian Jira Software Board API
Atlassian Jira Software Epic API
Atlassian Jira Software Sprint API
Atlassian Jira Software Development Information API
Atlassian Jira Software Feature Flags API
Atlassian Jira Software Deployments API
Atlassian Jira Software Builds API
Atlassian Jira Software Remote Links API
Atlassian Jira Software Security Information API
Atlassian Jira Service Management Customer API
Atlassian Jira Service Management Info API
Where this information came from

This is an independent, third-party profile of Atlassian User Properties API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.