Users properties/settings

Owned by Adam Labus
Feb 09, 2023
4 min read

View user login properties

Available ONLY for Jira Administrators

Available since v. 1.1.0

Available since v. 1.9.0 - Added Change user settings API, View user settings API, Available languages API, Available time zones API

Available since v. 1.23.* - Added Change password API

Method type - GET

URL: {JIRA_URL}/rest/extender/1.0/user/{USER_NAME}/properties/login

  • where {USER_NAME} is JIRA user name, like admin

Response format - JSON

Example response

{ "maxAuthenticationAttemptsAllowed": 3, "isElevatedSecurityCheckRequired": false, "lastFailedLoginTimeDate": null, "lastFailedLoginTimeMilliseconds": null, "currentFailedLoginCount": 0, "lastLoginTimeDate": "2018-03-24 20:37:35.891", "lastLoginTimeMilliseconds": 1521920255891, "previousLoginTimeMilliseconds": 1521919464732, "previousLoginTimeDate": "2018-03-24 20:24:24.732", "totalFailedLoginCount": null, "loginCount": 79 }

View user properties

Method type - GET

URL: {JIRA_URL}/rest/extender/1.0/user/{USER_NAME}/properties

  • where {USER_NAME} is JIRA user name, like admin

Response format - JSON

Example response

{ "properties": { "jira.onboarding.first.use.flow.current.sequence": "nextStep", "jira.onboarding.first.use.flow.started": "jiraFirstUseFlow", "jira.meta.extenderPropertiesKey": "Extender test Properties Value", "jira.meta.extenderAnotherPropertiesKey": "Another Extender test Properties Value" } }

Add/Set user properties

Method type - PUT

URL: {JIRA_URL}/rest/extender/1.0/user/{USER_NAME}/properties/{PROPERTIES_NAME}

  • where {USER_NAME} is JIRA user name

  • where {PROPERTIES_NAME} is properties name

Example URL:

  • {JIRA_URL}/rest/extender/1.0/user/admin/properties/jira.meta.extenderAnotherPropertiesKey

Request format - JSON

Example request

{ "value":"Another Extender test Properties Value" }

If you add prefix (jira.meta.) for your properties, you can see property into user view {JIRA_URL}/jira/secure/admin/user/ViewUser.jspa?name=admin

Delete user properties

Method type - DELETE

URL: {JIRA_URL}/rest/extender/1.0/user/{USER_NAME}/properties/{PROPERTIES_NAME}

  • where {USER_NAME} is JIRA user name

  • where {PROPERTIES_NAME} is properties name

Example URL:

  • {JIRA_URL}/rest/extender/1.0/user/admin/properties/jira.meta.extenderAnotherPropertiesKey

View user settings

Method type - GET

URL: {JIRA_URL}/rest/extender/1.0/user/{USER_NAME}/settings

  • where {USER_NAME} is JIRA user name, like admin

Response format - JSON

Example response

Change user settings

Method type - PUT

URL: {JIRA_URL}/rest/extender/1.0/user/{USER_NAME}/settings/{SETTING_NAME}

  • where {USER_NAME} is JIRA user name

  • where {SETTING_NAME} is setting name (check Supported settings name)

Example URL:

  • {JIRA_URL}/rest/extender/1.0/user/admin/settings/issuePerPage

Request format - JSON

Example request

Supported settings name

  • issuePerPage - Page size, value from 1 to 1000

  • emailType - Email Type, value html or text

  • language - Language, value - please see language value in Available languages

  • timeZone - Time Zone, value - please see timeZone value in Available time zones

  • notifyOwnChanges - My Changes, value true or false

  • shareFiltersAndDashboards - Filter and Dashboard Sharing, value true or false

  • keyboardShortcuts - Keyboard shortcuts, value true or false

  • autoWatch - Autowatch, value true or false

Clear user CAPTCHA

Available ONLY for Jira Administrators

Method type - DELETE

URL:  {JIRA_URL}/rest/extender/1.0/user/captcha/{USER_NAME}

  • where {USER_NAME} is JIRA user name

Response format - JSON

Example response

Change user password

Method type - PUT

URL:  {JIRA_URL}/rest/extender/1.0/user/{USER_NAME}/password 

  • where {USER_NAME} is JIRA user name

Example URL

  • {JIRA_URL}/rest/extender/1.0/user/jonhy/password 

Request format - JSON

Example request

Response format - JSON

Example response

Available languages

Method type - GET

URL: {JIRA_URL}/rest/extender/1.0/user/settings/installedLanguages

Response format - JSON

Example response

Available time zones

Method type - GET

URL: {JIRA_URL}/rest/extender/1.0/user/settings/timeZones

Response format - JSON

Example response