Returns a user.
boolean
string
string
Returns a user.
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/api/2/user' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Modify user. The 'value' fields present will override the existing value. Fields skipped in request will not be changed.
string
string
User details
boolean
array<string>
string
string
string
string
string
string
string
Returned if the user exists and the caller has permission to edit it.
1
2
3
4
5
curl --request PUT \
--url 'http://{baseurl}/rest/api/2/user' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'Create user. By default created user will not be notified with email. If password field is not set then password will be randomly generated.
User details
boolean
array<string>
string
string
string
string
string
string
string
Returned if the user was created.
1
2
3
4
5
curl --request POST \
--url 'http://{baseurl}/rest/api/2/user' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'Removes user and its references (like project roles associations, watches, history). Note: user references will not be removed if multiple User Directories are used and there is a user with the same name existing in another directory (shadowing user).
string
string
Returned if the user was deleted successfully.
1
2
3
curl --request DELETE \
--url 'http://{baseurl}/rest/api/2/user' \
--user 'email@example.com:<api_token>'Returns available accessibility personal settings along with enabled property that indicates the currently logged-in user preference.
This request has no parameters.
Returned when validation succeeded.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/2/user/a11y/personal-settings' \
--header 'Accept: application/json'Validates user anonymization process.
string
string
Returned when validation succeeded.
1
2
curl --request GET \
--url 'http://{baseurl}/rest/api/2/user/anonymization'Schedules a user anonymization process. Requires system admin permission.
JSON containing parameters to schedule the anonymization process with
string
string
Returned if the process was scheduled. Note that it can still fail the extended validation once its execution starts.
1
2
3
curl --request POST \
--url 'http://{baseurl}/rest/api/2/user/anonymization' \
--header 'Content-Type: application/json'Returns information about a user anonymization operation progress.
integer
Returns a representation of the progress of the user anonymization operation.
1
2
curl --request GET \
--url 'http://{baseurl}/rest/api/2/user/anonymization/progress'Validates user anonymization re-run process.
string
string
string
string
Returned when validation succeeded.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/2/user/anonymization/rerun' \
--header 'Accept: application/json'Schedules a user anonymization process. Requires system admin permission.
JSON containing parameters to schedule the anonymization process with
string
string
string
string
Returned if the process was scheduled. Note that it can still fail the extended validation once its execution starts.
1
2
3
curl --request POST \
--url 'http://{baseurl}/rest/api/2/user/anonymization/rerun' \
--header 'Content-Type: application/json'Removes stale user anonymization task, for scenarios when the node that was executing it is no longer alive. Use it only after making sure that the parent node of the task is actually down, and not just having connectivity issues.
This request has no parameters.
Returned when anonymization task has been successfully removed.
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/2/user/anonymization/unlock'Add user to given application. Admin permission will be required to perform this operation.
string
string
Returned if the user exists, the caller has permission to add user to application and user was successfully added to application.
1
2
3
curl --request POST \
--url 'http://{baseurl}/rest/api/2/user/application' \
--user 'email@example.com:<api_token>'Remove user from given application. Admin permission will be required to perform this operation.
string
string
Returned if the user exists, the caller has permission to remove user from application and the user was successfully removed from application.
1
2
3
curl --request DELETE \
--url 'http://{baseurl}/rest/api/2/user/application' \
--user 'email@example.com:<api_token>'Returns a list of users that match the search string and can be assigned issues for all the given projects.
integer
string
string
Returns a list of users that match the search string.
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/api/2/user/assignable/multiProjectSearch' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Returns a list of users that match the search string. This resource cannot be accessed anonymously. Please note that this resource should be called with an issue key when a list of assignable users is retrieved. For create only a project key should be supplied. The list of assignable users may be incorrect if it's called with the project key for editing.
string
integer
string
integer
string
Returns a list of users that match the search string.
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/api/2/user/assignable/search' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Updates the avatar for the user.
string
New avatar details
string
string
boolean
Returns updated avatar
1
2
3
4
5
curl --request PUT \
--url 'http://{baseurl}/rest/api/2/user/avatar' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'Converts temporary avatar into a real avatar
string
Cropping instructions
integer
integer
integer
boolean
string
Returns created avatar
1
2
3
4
5
curl --request POST \
--url 'http://{baseurl}/rest/api/2/user/avatar' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'Creates temporary avatar using multipart. The response is sent back as JSON stored in a textarea. This is because the client uses remote iframing to submit avatars using multipart. So we must send them a valid HTML page back from which the client parses the JSON from.
Creating a temporary avatar is part of a 3-step process in uploading a new avatar for a user: upload, crop, confirm. This endpoint allows you to use a multipart upload instead of sending the image directly as the request body.
You must use "avatar" as the name of the upload parameter:
curl -c cookiejar.txt -X POST -u admin:admin -H "X-Atlassian-Token: no-check"
-F "avatar=@mynewavatar.png;type=image/png"
'http://localhost:8090/jira/rest/api/2/user/avatar/temporary?username=admin'
string
The file data
any
Returns temporary avatar cropping instructions embeded in HTML page. Error messages will also be embeded in the page.
1
2
3
4
curl --request POST \
--url 'http://{baseurl}/rest/api/2/user/avatar/temporary' \
--user 'email@example.com:<api_token>' \
--header 'Accept: text/html'Deletes avatar
integer
Requiredstring
Returned if the avatar is successfully deleted.
1
2
3
curl --request DELETE \
--url 'http://{baseurl}/rest/api/2/user/avatar/{id}' \
--user 'email@example.com:<api_token>'Returns all avatars which are visible for the currently logged in user.
string
Returns a map containing a list of avatars for both custom an system avatars
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/api/2/user/avatars' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Returns the default columns for the given user. Admin permission will be required to get columns for a user other than the currently logged in user.
string
Returns a list of columns for configured for the given user
ColumnOptions
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/api/2/user/columns' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Sets the default columns for the given user. Admin permission will be required to get columns for a user other than the currently logged in user.
string
array<string>
Returned when the columns is saved successfully
1
2
3
curl --request PUT \
--url 'http://{baseurl}/rest/api/2/user/columns' \
--user 'email@example.com:<api_token>'Reset the default columns for the given user to the system default. Admin permission will be required to get columns for a user other than the currently logged in user.
string
Returned when the columns are reset successfully
1
2
3
curl --request DELETE \
--url 'http://{baseurl}/rest/api/2/user/columns' \
--user 'email@example.com:<api_token>'Returns a list of users that match the search string. This resource cannot be accessed anonymously. Duplicated means that the user has an account in more than one directory and either more than one account is active or the only active account does not belong to the directory with the highest priority. The data returned by this endpoint is cached for 10 minutes and the cache is flushed when any User Directory is added, removed, enabled, disabled, or synchronized. A System Administrator can also flush the cache manually. Related JAC ticket: https://jira.atlassian.com/browse/JRASERVER-68797
boolean
Returns a list of users that match the search string.
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/api/2/user/duplicated/count' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Returns duplicated users mapped to their directories with an indication if their accounts are active or not. Duplicated means that the user has an account in more than one directory and either more than one account is active or the only active account does not belong to the directory with the highest priority. The data returned by this endpoint is cached for 10 minutes and the cache is flushed when any User Directory is added, removed, enabled, disabled, or synchronized. A System Administrator can also flush the cache manually. Related JAC ticket: https://jira.atlassian.com/browse/JRASERVER-68797
boolean
Returns all avatars which are visible for the currently logged in user.
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/api/2/user/duplicated/list' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Modify user password.
string
string
Password details
string
string
Returned if the user exists and the caller has permission to edit it.
1
2
3
4
curl --request PUT \
--url 'http://{baseurl}/rest/api/2/user/password' \
--user 'email@example.com:<api_token>' \
--header 'Content-Type: application/json'Returns a list of active users that match the search string and have all specified permissions for the project or issue. This resource can be accessed by users with ADMINISTER_PROJECT permission for the project or global ADMIN or SYSADMIN rights. This endpoint can cause serious performance issues and will be removed in Jira 9.0.
string
string
integer
string
integer
string
Returns a list of users that match the search string.
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/api/2/user/permission/search' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Returns a list of users matching query with highlighting.
integer
string
array<string>
boolean
Returns a list of users matching query with highlighting.
UserPickerResultsBean
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/api/2/user/picker' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Returns the keys of all properties for the user identified by the key or by the id.
string
string
Returned if the user was found.
1
2
curl --request GET \
--url 'http://{baseurl}/rest/api/2/user/properties'Returns the value of the property with a given key from the user identified by the key or by the id.
string
Requiredstring
string
Returned if the user property was found.
1
2
curl --request GET \
--url 'http://{baseurl}/rest/api/2/user/properties/{propertyKey}'Sets the value of the specified user's property. You can use this resource to store a custom data against the user identified by the key or by the id. The user who stores the data is required to have permissions to administer the user.
string
Requiredstring
string
The request containing value of the user's property. The value has to be a valid, non-empty JSON conforming to http://tools.ietf.org/html/rfc4627. The maximum length of the property value is 32768 bytes.
string
Returned if the user property is successfully updated.
1
2
3
curl --request PUT \
--url 'http://{baseurl}/rest/api/2/user/properties/{propertyKey}' \
--header 'Content-Type: application/json'Removes the property from the user identified by the key or by the id. The user who removes the property is required to have permissions to administer the user.
string
Requiredstring
string
Returned if the user property was removed successfully.
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/2/user/properties/{propertyKey}'Finds users.
boolean
integer
boolean
integer
string
Returns a list of users.
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/api/2/user/search' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Invalidates session of given user.
string
RequiredReturned when the session is invalidated successfully.
1
2
3
curl --request DELETE \
--url 'http://{baseurl}/rest/api/2/user/session/{username}' \
--user 'email@example.com:<api_token>'Returns a list of active users that match the search string. This resource cannot be accessed anonymously and requires the Browse Users global permission. Given an issue key this resource will provide a list of users that match the search string and have the browse issue permission for the issue provided.
string
string
integer
string
Returns a list of users that match the search string.
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/api/2/user/viewissue/search' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Rate this page: