new user()
The user class for the Jira Connector
Properties:
Name | Type | Description |
---|---|---|
connector |
IConnector | the jira connector instance |
model |
Model | the model definition |
- Source:
Methods
find(options, callbackopt) → {Promise.<Array>}
Returns a list of users that match the search string and/or property. This resource cannot be accessed anonymously.
Parameters:
Name | Type | Attributes | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | The request options passed onto the Jira API. Properties
|
||||||||||||||||||||||||||||||||||||
callback |
<optional> |
if supplied, called with Array of matching records |
- Source:
Returns:
Array of matching records
- Type
- Promise.<Array>
findById(options, callbackopt) → {Promise.<Object>}
Returns a user. This resource cannot be accessed anonymously. The resource accepts the expand param that is used to include, hidden by default, parts of response. This can be used to include: groups - all groups, including nested groups, to which user belongs applicationRoles - application roles defines to which application user has access
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | The request options passed onto the Jira API. Properties
|
|||||||||||||
callback |
<optional> |
if supplied, called with Array of matching records |
- Source:
Returns:
the selected Project
- Type
- Promise.<Object>
login(options, callbackopt) → {Promise.<Array>}
Creates a new session for a user in JIRA. Once a session has been successfully created it can be used to access any of JIRA's remote APIs and also the web UI
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | The request options passed onto the Jira API. Properties
|
||||||||||
callback |
<optional> |
if supplied, called with Array of matching records |
- Source:
Returns:
Array of matching records
- Type
- Promise.<Array>
logout(options, callbackopt) → {Promise.<Array>}
Logs the current user out of JIRA, destroying the existing session, if any.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | The request options passed onto the Jira API. Properties
|
|||||||||||||
callback |
<optional> |
if supplied, called with Array of matching records |
- Source:
Returns:
Array of matching records
- Type
- Promise.<Array>