REST API - Groups

General informations



Get group users

Method type - GET

URL:

  • {CONFLUENCE_URL}/rest/extender/1.0/group/getUsers/{GROUP}
  • {CONFLUENCE_URL}/rest/extender/1.0/group/getUsers/{GROUP}?showBasicDetails=true
  • {CONFLUENCE_URL}/rest/extender/1.0/group/getUsers/{GROUP}?showExtendedDetails=true

where {GROUP} group name in Confluence.

Response format - JSON


Example URL: 

  • {CONFLUENCE_URL}/rest/extender/1.0/group/getUsers/confluence-users
  • {CONFLUENCE_URL}/rest/extender/1.0/group/getUsers/confluence-users?showBasicDetails=true
  • {CONFLUENCE_URL}/rest/extender/1.0/group/getUsers/confluence-users?showExtendedDetails=true

Parameters:

  • showBasicDetails, showExtendedDetails - for details please check Example response

  • dateFormat - define date format for date fields in output JSON - default format ‘yyyy-MM-dd'

Example response:

Without parameters

With parameter showBasicDetails=true

With parameter showExtendedDetails=true



Get all groups

Method type - GET

URL:

  • {CONFLUENCE_URL}/rest/extender/1.0/group/getGroups

Response format - JSON


Example response:




Add groups

Method type - 

URL:

  • {CONFLUENCE_URL}/rest/extender/1.0/group/addGroups

Request format - JSON

Example

Response format - JSON

Example



Remove groups

Method type - 

URL:

  • {CONFLUENCE_URL}/rest/extender/1.0/group/removeGroups

Request format - JSON

Example

Response format - JSON

Example


Add users to group

Method type - 

URL:

  • {CONFLUENCE_URL}/rest/extender/1.0/group/addUsers/{GROUP}

where {GROUP} group name in Confluence.

Request format - JSON

Example

Response format - JSON

Example




Remove users from group

Method type - 

URL:

  • {CONFLUENCE_URL}/rest/extender/1.0/group/removeUsers/{GROUP}

where {GROUP} group name in Confluence.

Request format - JSON

Example

Response format - JSON

Example



Pagination

This REST API uses pagination to improve performance for all Jira users. Pagination is enforced for methods that could return a large collection of items. When you make a request to a paged API, the response will wrap the returned array of values in a JSON object with paging metadata, for example:

Where:

  • startAt is the index of the first item returned in the page of results.
  • maxResults is the maximum number of items that can be returned per page. Each API endpoint may have a different limit for the number of items returned, and these limits may change without notice. (default value - 1000)
  • total is the total number of items contained in all pages. This number may change as the client requests the subsequent pages, therefore the client should always assume that the requested page can be empty.