new Group()
Group
Properties:
Name | Type | Description |
---|---|---|
connector |
IConnector | the jira connector instance |
- Source:
Methods
addUserToGroup(options, callbackopt) → {Promise.<any>}
Adds given user to a group.
Returns the current state of the group.A name of requested group.
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
create(options, callbackopt) → {Promise.<any>}
Creates a group by given group parameter
Returns REST representation for the requested group.
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
deleteById(options, callbackopt) → {Promise.<any>}
Deletes a group by given group parameter.
Returns no content(mandatory) The name of the group to delete.If you delete a group and content is restricted to that group, the content will be hidden from all users. To prevent this, use this parameter to specify a different group to transfer the restrictions (comments and worklogs only) to.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
|||||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
findById(options, callbackopt) → {Promise.<any>}
Returns REST representation for the requested group. Allows to get list of active users belonging to the specified group and its subgroups if "users" expand option is provided. You can page through users list by using indexes in expand param. For example to get users from index 10 to index 15 use "users[10:15]" expand value. This will return 6 users (if there are at least 16 users in this group). Indexes are 0-based and inclusive.
This resource is deprecated, please use group/member API instead.A name of requested group.List of fields to expand. Currently only available expand is "users".
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
|||||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
getUsersFromGroup(options, callbackopt) → {Promise.<any>}
This resource returns a paginated list of users who are members of the specified group and its subgroups. Users in the page are ordered by user names. User of this resource is required to have sysadmin or admin permissions.a name of the group for which members will be returned.Default: falseinactive users will be included in the response if set to true.Default: 0the index of the first user in group to return (0 based).Default: 50the maximum number of users to return (max 50).
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
|||||||||||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
removeUserFromGroup(options, callbackopt) → {Promise.<any>}
Removes given user from a group.
Returns no contentA name of requested group.User to remove from a group
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
|||||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>