Users properties/settings




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/{JIRA_USER}/properties/login

where {JIRA_USER} is JIRA user name, like admin

Response format - JSON

Example

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


View user properties

Method type - GET

URL:

  • {JIRA_URL}/rest/extender/1.0/user/{JIRA_USER}/properties


where {JIRA_USER} is JIRA user name, like admin

Response format - JSON

Example

{
    "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/{JIRA_USER}/properties/{PROPERTIES_NAME}

where {JIRA_USER} is JIRA user name and {PROPERTIES_NAME} is properties name

Request format - JSON



Example

JSON body example
{
    "value":"Properties Value"
}


Example URL:



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

Example request JSON body

JSON body
{
    "value":"Another Extender test Properties Value"
}
If you add prefix (jira.meta.) for your properties like me, 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/{JIRA_USER}/properties/{PROPERTIES_NAME}

where {JIRA_USER} is JIRA user name and {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/{JIRA_USER}/settings

where {JIRA_USER} is JIRA user name, like admin

Response format - JSON

Example

{
    "keyboardShortcuts": true,
    "emailType": "html",
    "timeZone": "Atlantic/Cape_Verde",
    "shareFiltersAndDashboards": false,
    "language": "pl_PL",
    "notifyOwnChanges": false,
    "autoWatch": true,
    "issuePerPage": 999
}



Change user settings

Method type - PUT

URL:

  • {JIRA_URL}/rest/extender/1.0/user/{JIRA_USER}/settings/{SETTING_NAME}

where {JIRA_USER} is JIRA user name and {SETTING_NAME} is setting name (check Supported settings name)

Request format - JSON

Example

JSON body example
{
    "value":"Properties Value"
}

Example URL:

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

Example request JSON body

JSON body
{
    "value":999
}

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

User settings



Change user password

JIRA administrators can change passwords of all users

Users can change only his own password

Method type - PUT

URL: 

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

where {JIRA_USER} is JIRA user name

Request format - JSON

Example URL

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

Example request

JSON body example
{
    "password":"New_password_1234"
}

Example response

{
    "message": "password has been changed"
}
{
    "message": "permission violation"
}


Available languages

Method type - GET

URL:

  • {JIRA_URL}/rest/extender/1.0/user/settings/installedLanguages

Response format - JSON

Example

{
    "languages": [
        {
            "isDefault": true,
            "language": "en_US",
            "languageName": "angielski (Stany Zjednoczone Ameryki)"
        },
        {
            "isDefault": false,
            "language": "en_UK",
            "languageName": "angielski (UK)"
        },
        {
            "isDefault": false,
            "language": "fr_FR",
            "languageName": "francuski (Francja)"
        }
    ]
}


Available time zones

Method type - GET

URL:

  • {JIRA_URL}/rest/extender/1.0/user/settings/timeZones

Response format - JSON

Example

{
    "timeZones": [
        {
            "isDefault": false,
            "timeZoneName": "Greenwich Mean Time",
            "timeZone": "Africa/Abidjan"
        },
        {
            "isDefault": false,
            "timeZoneName": "Ghana Mean Time",
            "timeZone": "Africa/Accra"
        },
        {
            "isDefault": true,
            "timeZoneName": "Eastern African Time",
            "timeZone": "Africa/Addis_Ababa"
        }
    ]
}