new UserClient(jiraClient)
Used to access Jira REST endpoints in '/rest/auth/1/session'
Parameters:
| Name | Type | Description |
|---|---|---|
jiraClient |
JiraClient |
- Source:
Methods
all(opts, callbackopt) → {Promise}
Returns a list of users that match the search string. This resource cannot be accessed anonymously.
Parameters:
| Name | Type | Attributes | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
Object | The request options sent to the Jira API. Properties
|
||||||||||||||||
callback |
callback |
<optional> |
Called when the search results are retrieved. |
- Source:
Returns:
Resolved when the search results are retrieved.
- Type
- Promise
changePassword(opts, callbackopt) → {Promise}
Modify user password.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
The request options sent to the Jira API Properties
|
||||||||||||||
callback |
<optional> |
Called when the password has been set. |
- Source:
Returns:
Resolved when the password has been set.
- Type
- Promise
convertTemporaryAvatar(opts, callbackopt) → {Promise}
Converts temporary avatar into a real avatar
Parameters:
| Name | Type | Attributes | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
Object | The request options sent to the Jira API Properties
|
||||||||||
callback |
<optional> |
Called when the avatar has been converted |
- Source:
Returns:
Resolved when the avatar has been converted
- Type
- Promise
createTemporaryAvatar(opts, callbackopt) → {Promise}
Creates temporary avatar. Creating a temporary avatar is part of a 3-step process in uploading a new avatar for a user: upload, crop, confirm.
Parameters:
| Name | Type | Attributes | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
Object | The request options sent to the Jira API Properties
|
||||||||||
callback |
<optional> |
Called when the temporary avatar has been uploaded. |
- Source:
Returns:
Resolved when the temporary avatar has been uploaded.
- Type
- Promise
createUser(opts, callbackopt) → {Promise}
Create user. By default created user will not be notified with email. If password field is not set then password will be randomly generated.
Parameters:
| Name | Type | Attributes | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
opts |
The request options sent to the Jira API. Properties
|
||||||||
callback |
<optional> |
Called when the user has been created. |
- Source:
Returns:
Resolved when the user has been created.
- Type
- Promise
deleteAvatar(opts, callbackopt) → {Promise}
Deletes avatar
Parameters:
| Name | Type | Attributes | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
Object | The request options sent to the Jira API Properties
|
||||||||||
callback |
<optional> |
Called when the avatar has been deleted. |
- Source:
Returns:
Resolved when the avatar has been deleted.
- Type
- Promise
deleteUser(opts, callbackopt) → {Promise}
Removes user.
Parameters:
| Name | Type | Attributes | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
The request options sent to the Jira API Properties
|
|||||||||||
callback |
<optional> |
Called when the user has been deleted. |
- Source:
Returns:
Resolved when the user has been deleted.
- Type
- Promise
editUser(opts, callbackopt) → {Promise}
Modify user. The "value" fields present will override the existing value. Fields skipped in request will not be changed.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
The request options sent to the Jira API Properties
|
||||||||||||||
callback |
<optional> |
Called when the user has been edited. |
- Source:
Returns:
Resolved when the user has been edited.
- Type
- Promise
getAvatars(opts, callbackopt) → {Promise}
Returns all avatars which are visible for the currently logged in user.
Parameters:
| Name | Type | Attributes | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
opts |
Object | The request options sent to the Jira API Properties
|
|||||||
callback |
<optional> |
Called when the avatars have been retrieved. |
- Source:
Returns:
Resolved when the avatars have been retrieved.
- Type
- Promise
getDefaultColumns(opts, callbackopt) → {Promise}
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.
Parameters:
| Name | Type | Attributes | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
opts |
Object | The request options sent to the Jira API Properties
|
|||||||
callback |
<optional> |
Called when the columns have been retrieved. |
- Source:
Returns:
Resolved when the columns have been retrieved.
- Type
- Promise
getUser(opts, callbackopt) → {Promise}
Get a user. This resource cannot be accessed anonymously.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
The request options sent to the Jira API Properties
|
||||||||||||||||||||||
callback |
callback |
<optional> |
Called when the user has been retrieved. |
- Source:
Returns:
Resolved when the user has been retrieved.
- Type
- Promise
multiProjectSearchAssignable(opts, callbackopt) → {Promise}
Returns a list of users that match the search string and can be assigned issues for all the given projects. This resource cannot be accessed anonymously.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
Object | The request options sent to the Jira API Properties
|
|||||||||||||||||||||
callback |
<optional> |
Called when the search results have been retrieved. |
- Source:
Returns:
Resolved when the search results have been retrieved.
- Type
- Promise
resetDefaultColumns(opts, callbackopt) → {Promise}
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.
Parameters:
| Name | Type | Attributes | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
opts |
Object | The request options sent to the Jira API Properties
|
|||||||
callback |
<optional> |
Called when the columns have been reset. |
- Source:
Returns:
Resolved when the columns have been reset.
- Type
- Promise
search(optsopt, callbackopt) → {Promise}
Returns a list of users that match the search string. This resource cannot be accessed anonymously.
Parameters:
| Name | Type | Attributes | Description | |||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
Object |
<optional> |
The request options sent to the Jira API. Properties
|
|||||||||||||||||||||||||||||||||||||||||||||
callback |
callback |
<optional> |
Called when the search results are retrieved. |
- Source:
Returns:
Resolved when the search results are retrieved.
- Type
- Promise
searchAssignable(opts, callbackopt) → {Promise}
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 editing. 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.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
Object | The request options sent to the Jira API Properties
|
|||||||||||||||||||||||||||||
callback |
<optional> |
Called when the search results have been retrieved. |
- Source:
Returns:
Resolved when the search results have been retrieved.
- Type
- Promise
searchPermissions(opts, callbackopt) → {Promise}
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.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
Object | The request options sent to the jira API Properties
|
|||||||||||||||||||||||||||||
callback |
<optional> |
Called when the search results are retrieved. |
- Source:
Returns:
Resolved when the search results are retrieved.
- Type
- Promise
searchPicker(opts, callbackopt) → {Promise}
Returns a list of users matching query with highlighting. This resource cannot be accessed anonymously.
Parameters:
| Name | Type | Attributes | Description | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
The request options sent to the Jira API. Properties
|
|||||||||||||||||||||||||||
callback |
<optional> |
Called when the search results are retrieved. |
- Source:
Returns:
Resolved when the search results are retrieved.
- Type
- Promise
setDefaultColumns(opts, callbackopt) → {Promise}
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.
Parameters:
| Name | Type | Attributes | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
Object | The request options sent to the Jira API Properties
|
||||||||||
callback |
<optional> |
Called when the columns have been set. |
- Source:
Returns:
Resolved when the columns have been set.
- Type
- Promise
viewIssueSearch(opts, callbackopt) → {Promise}
Returns a list of active users that match the search string. This resource cannot be accessed anonymously. 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.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
Object | The request options sent to the Jira API. Properties
|
|||||||||||||||||||||||||||||||
callback |
<optional> |
Called when data has been retrieved |
- Source:
Returns:
Resolved when data has been retrieved
- Type
- Promise