User properties

Get user property

Returns the value of a user's property. If no property key is provided Get user property keys is called.

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

Permissions required:

  • Administer Jira global permission, to get a property from any user.
  • Access to Jira, to get a property from the calling user's record.
get/rest/api/2/user/properties/{propertyKey}

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/user/properties/{propertyKey}
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token, scopes: read:jira-user)

Path parameters

propertyKeystring required

The key of the user's property.

Query parameters

accountIdstring
Example:5b10ac8d82e05b22cc7d4ef5

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

userKeystring

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

usernamestring

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

Response

Returned if the request is successful.

keystring

The key of the property. Required on create and update.

valueunknown

Changes

No recorded changes to this operation across all 26 revisions of this API.