Get user property keys

GET

/rest/api/3/user/properties

Returns the keys of all properties for a user.

Note: This operation does not access the user properties created and maintained in Jira.

Permissions required:

Administer Jira global permission, to access the property keys on any user.

Access to Jira, to access the calling user's property keys.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://jira.local:8080/jira/rest//rest/api/3/user/properties'

Response Example

200 - Success

{"keys":[{"self":"https://your-domain.atlassian.net/rest/api/3/issue/EX-2/properties/issue.support","key":"issue.support"}]}

Request

Query Params

accountId

string

optional

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

userKey

string

optional

This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

username

string

optional

This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

Responses

🟢200Returned if the request is successful.

application/json

Body

List of property keys.

keys

array[object (PropertyKey) {2}]

read-onlyoptional

Property key details.

key

string

read-onlyoptional

The key of the property.

self

string

read-onlyoptional

The URL of the property.

🟠400Returned if `accountId` is missing.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠403Returned if the user does not have the necessary permission or is not accessing their user record.

🟠404Returned if the user is not found.

Modified at 2023-07-13 03:27:27

Find users with browse permission

Get user property