Module jira::gen::apis::groups_api

Structs

AddUserToGroupParams	struct for passing parameters to the method add_user_to_group
BulkGetGroupsParams	struct for passing parameters to the method bulk_get_groups
CreateGroupParams	struct for passing parameters to the method create_group
FindGroupsParams	struct for passing parameters to the method find_groups
GetGroupParams	struct for passing parameters to the method get_group
GetUsersFromGroupParams	struct for passing parameters to the method get_users_from_group
RemoveGroupParams	struct for passing parameters to the method remove_group
RemoveUserFromGroupParams	struct for passing parameters to the method remove_user_from_group

Enums

AddUserToGroupError	struct for typed errors of method add_user_to_group
BulkGetGroupsError	struct for typed errors of method bulk_get_groups
CreateGroupError	struct for typed errors of method create_group
FindGroupsError	struct for typed errors of method find_groups
GetGroupError	struct for typed errors of method get_group
GetUsersFromGroupError	struct for typed errors of method get_users_from_group
RemoveGroupError	struct for typed errors of method remove_group
RemoveUserFromGroupError	struct for typed errors of method remove_user_from_group

Functions

add_user_to_group	Adds a user to a group. Permissions required: Site administration (that is, member of the site-admin group).
bulk_get_groups	Returns a paginated list of groups. Permissions required: Browse users and groups global permission.
create_group	Creates a group. Permissions required: Site administration (that is, member of the site-admin group).
find_groups	Returns a list of groups whose names contain a query string. A list of group names can be provided to exclude groups from the results. The primary use case for this resource is to populate a group picker suggestions list. To this end, the returned object includes the html field where the matched query term is highlighted in the group name with the HTML strong tag. Also, the groups list is wrapped in a response object that contains a header for use in the picker, specifically Showing X of Y matching groups. The list returns with the groups sorted. If no groups match the list criteria, an empty list is returned. This operation can be accessed anonymously. Permissions required: Browse projects project permission. Anonymous calls and calls by users without the required permission return an empty list.
get_group	This operation is deprecated, use group/member. Returns all users in a group. Permissions required: Administer Jira global permission.
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: Administer Jira global permission.
remove_group	Deletes a group. Permissions required: Site administration (that is, member of the site-admin strategic group).
remove_user_from_group	Removes a user from a group. Permissions required: Site administration (that is, member of the site-admin group).