• Access Mode
  • Admin Group
  • Admin Space
  • Admin User
  • Admin Users
  • Attachments
  • Backup and Restore
  • Category
  • Child Content
  • Cluster information
  • Content Blueprint
  • Content Body
  • Content Descendant
  • Content Labels
  • Content Property
  • Content Resource
  • Content Restrictions
  • Content Version
  • Content Watchers
  • Global Permissions
  • GlobalColorScheme
  • Group
  • Instance Metrics
  • Label
  • Long Task
  • Search
  • Server Information
  • Space
  • Space Label
  • Space Permissions
  • Space Property
  • Space Watchers
  • SpaceColorScheme
  • User
  • User Group
  • User Watch
  • Webhooks
  • Other operations
Server
Confluence Data Center / / REST API

User Group

Postman Collection
OpenAPI
Operations
PUT/rest/api/user/{username}/group/{groupName}DEL/rest/api/user/{username}/group/{groupName}
PUT

Update user group

Add the given User identified by username to the given Group identified by groupName. This method is idempotent i.e., if the membership already exists then no action will be taken.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

groupName

string

Required
username

string

Required

Responses

No Content if the user is successfully added to the group

PUT/rest/api/user/{username}/group/{groupName}
1 2 curl --request PUT \ --url 'http://{baseurl}/confluence/rest/api/user/{username}/group/{groupName}'
DEL

Delete user group

Removes the given User identified by username from the given Group identified by groupName. This method is idempotent i.e., if the membership already exists then no action will be taken.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

groupName

string

Required
username

string

Required

Responses

No Content if the user is successfully removed from the group

DEL/rest/api/user/{username}/group/{groupName}
1 2 curl --request DELETE \ --url 'http://{baseurl}/confluence/rest/api/user/{username}/group/{groupName}'

Rate this page: