POST /rest/api/2/group/user

Adds a user to a group.

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

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name 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.

Request body fields

Name Type Required Description
name String No

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

accountId String No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.