group

add-user-to

Add user to group

Adds a user to a group.

Permissions required: Site administration (that is, member of the site-admin group).

POST /rest/api/3/group/user

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--groupId	string	No	The ID of the group. This parameter cannot be used with the groupName parameter.
--groupname	string	No	As a group's name can change, use of groupId is recommended to identify a group.
The name of the group. This parameter cannot be used with the groupId parameter.

Example:

jr group add-user-to

bulk-get

Bulk get groups

Returns a paginated list of groups.

Permissions required: Browse users and groups global permission.

GET /rest/api/3/group/bulk

Flag	Type	Required	Description
--accessType	string	No	The access level of a group. Valid values: 'site-admin', 'admin', 'user'.
--applicationKey	string	No	The application key of the product user groups to search for. Valid values: 'jira-servicedesk', 'jira-software', 'jira-product-discovery', 'jira-core'.
--groupId	string	No	The ID of a group. To specify multiple IDs, pass multiple groupId parameters. For example, groupId=5b10a2844c20165700ede21g&groupId=5b10ac8d82e05b22cc7d4ef5.
--groupName	string	No	The name of a group. To specify multiple names, pass multiple groupName parameters. For example, groupName=administrators&groupName=jira-software-users.
--maxResults	string	No	The maximum number of items to return per page.
--startAt	string	No	The index of the first item to return in a page of results (page offset).

Example:

jr group bulk-get

create

Create group

Creates a group.

Permissions required: Site administration (that is, member of the site-admin group).

POST /rest/api/3/group

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)

Example:

jr group create

get

Get group

This operation is deprecated, use group/member.

Returns all users in a group.

Permissions required: either of:

• Browse users and groups global permission.
• Administer Jira global permission.

GET /rest/api/3/group

Flag	Type	Required	Description
--expand	string	No	List of fields to expand.
--groupId	string	No	The ID of the group. This parameter cannot be used with the groupName parameter.
--groupname	string	No	As a group's name can change, use of groupId is recommended to identify a group.
The name of the group. This parameter cannot be used with the groupId parameter.

Example:

jr group get

get-users-from

Get users from group

Returns a paginated list of all users in a group.

Note that users are ordered by username, however the username is not returned in the results due to privacy reasons.

Permissions required: either of:

• Browse users and groups global permission.
• Administer Jira global permission.

GET /rest/api/3/group/member

Flag	Type	Required	Description
--groupId	string	No	The ID of the group. This parameter cannot be used with the groupName parameter.
--groupname	string	No	As a group's name can change, use of groupId is recommended to identify a group.
The name of the group. This parameter cannot be used with the groupId parameter.
--includeInactiveUsers	string	No	Include inactive users.
--maxResults	string	No	The maximum number of items to return per page (number should be between 1 and 50).
--startAt	string	No	The index of the first item to return in a page of results (page offset).

Example:

jr group get-users-from

remove

Remove group

Deletes a group.

Permissions required: Site administration (that is, member of the site-admin strategic group).

DELETE /rest/api/3/group

Flag	Type	Required	Description
--groupId	string	No	The ID of the group. This parameter cannot be used with the groupname parameter.
--groupname	string	No
--swapGroup	string	No	As a group's name can change, use of swapGroupId is recommended to identify a group.
The group to transfer restrictions to. Only comments and worklogs are transferred. If restrictions are not transferred, comments and worklogs are inaccessible after the deletion. This parameter cannot be used with the swapGroupId parameter.
--swapGroupId	string	No	The ID of the group to transfer restrictions to. Only comments and worklogs are transferred. If restrictions are not transferred, comments and worklogs are inaccessible after the deletion. This parameter cannot be used with the swapGroup parameter.

Example:

jr group remove

remove-user-from

Remove user from group

Removes a user from a group.

Permissions required: Site administration (that is, member of the site-admin group).

DELETE /rest/api/3/group/user

Flag	Type	Required	Description
--accountId	string	No	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
--groupId	string	No	The ID of the group. This parameter cannot be used with the groupName parameter.
--groupname	string	No	As a group's name can change, use of groupId is recommended to identify a group.
The name of the group. This parameter cannot be used with the groupId parameter.
--username	string	No	This parameter is no longer available. See the deprecation notice for details.

Example:

jr group remove-user-from