View user login properties

note

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 -

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

where {USER_NAME} is JIRA user name, like admin

Response format -

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 -

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

where {USER_NAME} is JIRA user name, like admin

Response format -

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 -

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 -

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

Extender for Jira > Users properties/settings > Zrzut-ekranu-2017-12-06-o-17.11.03-1-1024x279.png

Delete user properties

Method type -

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 -

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

where {USER_NAME} is JIRA user name, like admin

Response format -

Example response

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

Change user settings

Method type -

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 -

Example request

{
    "value":"Properties Value"
}

{
    "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

Extender for Jira > Users properties/settings > Zrzut ekranu 2018-05-01 o 08.04.13.png

Clear user CAPTCHA

note

Available ONLY for Jira Administrators

Available since v. 3.23.*

Method type -

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

where {USER_NAME} is JIRA user name

Response format -

Example response

{
    "message": "done"
}

Change user password

JIRA administrators can change passwords of all users

Users can change only his own password

Method type -

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 -

Example request

{
    "password":"New_password_1234"
}

Response format -

Example response

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

{
    "message": "permission violation"
}

Available languages

Method type -

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

Response format -

Example response

{
    "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 -

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

Response format -

Example response

{
    "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"
        }
    ]
}