v5

latestOpenAPI 3.0.1Apache 2.02026-08-046169702.3 MB

Groups

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

Query parameters

groupnamestring

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.

groupIdstring

The ID of the group. This parameter cannot be used with the groupName parameter.

Request body

accountIdstring

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

namestring

This property is no longer available. See the deprecation notice for details.

Response

Returned if the request is successful.

expandstring

Expand options that include additional group details in the response.

groupIdstring nullable

The ID of the group, which uniquely identifies the group across all Atlassian products. For example, 952d12c3-5b5b-4d04-bb32-44d383afc4b2.

namestring

The name of group.

selfstring uri

The URL for these group details.