ATatlassian
Group

Remove member from group using group id

Remove user as a member from a group.

Permissions required: User must be a site admin.

delete/wiki/rest/api/group/userByGroupId

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/wiki/rest/api/group/userByGroupId
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: write:confluence-groups

Query parameters

groupIdstring required

Id of the group whose membership is updated.

accountIdstring required

The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.

keystring

This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.

usernamestring

This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.

Response

Returned if the group was removed successfully.

Changes

No recorded changes to this operation across all 2 revisions of this API.