Support for Server products ended Feb. 15, 2024.
Learn what this means for you.
Jira Service Management
Guides
Reference
Search
Support
Log in
REST API
Switch to classic view
REST API
About
Previous versions
Using the REST API
Experimental methods
Approval
Customer
Customer Request
Customer Transition
Jira Service Management Application
Organization
Organization Service Desk
Portals
Queue
Queue Settings
Request Attachment
Request Type
Request Type Permissions
Service Desk
Service Desk Customer
application-properties
applicationrole
attachment
avatar
cluster
comment
component
configuration
customFieldOption
customFields
dashboard
email-templates
field
filter
group
groups
groupuserpicker
index
index-snapshot
issue
issueLink
issueLinkType
issuesecurityschemes
issuetype
issuetypescheme
jql
licenseValidator
monitoring
mypermissions
mypreferences
myself
notificationscheme
password
permissions
permissionscheme
priority
priorityschemes
project
projectCategory
projects
projectvalidate
reindex
resolution
role
screens
search
securitylevel
serverInfo
session
settings
status
statuscategory
terminology
universal_avatar
upgrade
user
GET
Get user by username or key
PUT
Update user details
POST
Create new user
DEL
Delete user
GET
Get available accessibility personal settings
GET
Get validation for user anonymization
POST
Schedule user anonymization
GET
Get user anonymization progress
GET
Get validation for user anonymization rerun
POST
Schedule user anonymization rerun
DEL
Delete stale user anonymization task
POST
Add user to application
DEL
Remove user from application
GET
Find bulk assignable users
GET
Find assignable users by username
PUT
Update user avatar
POST
Create avatar from temporary
POST
Store temporary avatar using multipart
DEL
Delete avatar
GET
Get all avatars for user
GET
Get default columns for user
PUT
Set default columns for user
DEL
Reset default columns to system default
GET
Get duplicated users count
GET
Get duplicated users mapping
PUT
Update user password
GET
Find users with all specified permissions
GET
Find users for picker by query
GET
Get keys of all properties for a user
GET
Get the value of a specified user's property
PUT
Set the value of a specified user's property
DEL
Delete a specified user's property
GET
Find users by username
DEL
Delete user session
GET
Find users with browse permission
version
websudo
workflow
workflowscheme
worklog
Assets - AQL
Assets - Analytics
Assets - Archived Objects
Assets - Attachments
Assets - Comments
Assets - Icons
Assets - Index Configuration
Assets - Object
Assets - Object Archive
Assets - Object Attribute
Assets - Object Connected Tickets
Assets - Object Restore
Assets - Object Schema
Assets - Object Type
Assets - Object Type Attribute
Assets - Progress
Assets - QR Code
Assets - Status Types
Server
Jira Service Management / Reference / REST API
user
Postman Collection
OpenAPI
Operations
GET
/api/2/user
PUT
/api/2/user
POST
/api/2/user
DEL
/api/2/user
GET
/api/2/user/a11y/personal-settings
GET
/api/2/user/anonymization
POST
/api/2/user/anonymization
GET
/api/2/user/anonymization/progress
GET
/api/2/user/anonymization/rerun
POST
/api/2/user/anonymization/rerun
DEL
/api/2/user/anonymization/unlock
POST
/api/2/user/application
DEL
/api/2/user/application
GET
/api/2/user/assignable/multiProjectSearch
GET
/api/2/user/assignable/search
PUT
/api/2/user/avatar
POST
/api/2/user/avatar
POST
/api/2/user/avatar/temporary
DEL
/api/2/user/avatar/{id}
GET
/api/2/user/avatars
GET
/api/2/user/columns
PUT
/api/2/user/columns
DEL
/api/2/user/columns
GET
/api/2/user/duplicated/count
GET
/api/2/user/duplicated/list
PUT
/api/2/user/password
GET
/api/2/user/permission/search
GET
/api/2/user/picker
GET
/api/2/user/properties
GET
/api/2/user/properties/{propertyKey}
PUT
/api/2/user/properties/{propertyKey}
DEL
/api/2/user/properties/{propertyKey}
GET
/api/2/user/search
DEL
/api/2/user/session/{username}
GET
/api/2/user/viewissue/search
GET
Get user by username or key
Returns a user.
Request
Query parameters
Expand all
includeDeleted
boolean
key
string
username
string
Responses
200
OK
Returns a user.
application/json
UserBean
Show child properties
401
Unauthorized
403
Forbidden
404
Not Found
GET
/
api/
2/
user
curl
Node.js
Java
Python
PHP
1
2
3
4