{
  "opencollection": "1.0.0",
  "info": {
    "name": "Atlassian Admin Account Group API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Group",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Atlassian Get Group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/wiki/rest/api/group/by-name",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "The name of the group. This is the same as the group name shown in\nthe Confluence administration console."
              }
            ]
          },
          "docs": "Returns a user group for a given group name.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>Permission to access the Confluence site ('Can use' global permission)."
        },
        {
          "info": {
            "name": "Atlassian Get Group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/wiki/rest/api/group/by-id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "The id of the group."
              }
            ]
          },
          "docs": "Returns a user group for a given group id.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>Permission to access the Confluence site ('Can use' global permission)."
        },
        {
          "info": {
            "name": "Atlassian Delete User Group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.atlassian.com/wiki/rest/api/group/by-id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "Id of the group to delete."
              }
            ]
          },
          "docs": "Delete user group.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>User must be a site admin."
        },
        {
          "info": {
            "name": "Atlassian Get Group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/wiki/rest/api/group/:groupName",
            "params": [
              {
                "name": "groupName",
                "value": "",
                "type": "path",
                "description": "The name of the group. This is the same as the group name shown in\nthe Confluence administration console."
              }
            ]
          },
          "docs": "Returns a user group for a given group name.<br><br>Use updated Get group API<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>Permission to access the Confluence site ('Can use' global permission)."
        },
        {
          "info": {
            "name": "Atlassian Get Group Members",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/wiki/rest/api/group/member",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "The name of the group to be queried for its members."
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "The starting index of the returned users."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of users to return per page.\nNote, this is restricted by fixed system limit of 200 which is to say if the limit parameter\nexceeds 200, this API will return a maximum of 200 users per page."
              },
              {
                "name": "shouldReturnTotalSize",
                "value": "",
                "type": "query",
                "description": "Whether to include total size parameter in the results.\nNote, fetching total size property is an expensive operation; use it if your use case needs this value."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "A multi-value parameter indicating which properties of the user to\nexpand.\n\n  - `operations` returns the operations that the user is allowed to do.\n  - `personalSpace` returns the user's personal space, if it exists.\n  - `isExternalCollaborator` returns whether the user is an external collaborator user."
              }
            ]
          },
          "docs": "Returns the users that are members of a group.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>Permission to access the Confluence site ('Can use' global permission)."
        },
        {
          "info": {
            "name": "Atlassian Get Group Members",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/wiki/rest/api/group/:groupName/member",
            "params": [
              {
                "name": "groupName",
                "value": "",
                "type": "path",
                "description": "The name of the group to be queried for its members."
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "The starting index of the returned users."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of users to return per page.\nNote, this may be restricted by fixed system limits."
              }
            ]
          },
          "docs": "Returns the users that are members of a group.<br><br>Use updated Get group API<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>Permission to access the Confluence site ('Can use' global permission)."
        },
        {
          "info": {
            "name": "Atlassian Search Groups by Partial Query",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/wiki/rest/api/group/picker",
            "params": [
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "the search term used to query results."
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "The starting index of the returned groups."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of groups to return per page.\nNote, this is restricted to a maximum limit of 200 groups."
              },
              {
                "name": "shouldReturnTotalSize",
                "value": "",
                "type": "query",
                "description": "Whether to include total size parameter in the results.\nNote, fetching total size property is an expensive operation; use it if your use case needs this value."
              }
            ]
          },
          "docs": "Get search results of groups by partial query provided."
        },
        {
          "info": {
            "name": "Atlassian Add Member to Group by Groupid",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.atlassian.com/wiki/rest/api/group/userByGroupId",
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "query",
                "description": "GroupId of the group whose membership is updated"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds a user as a member in a group represented by its groupId<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>User must be a site admin."
        },
        {
          "info": {
            "name": "Atlassian Remove Member From Group Using Group Id",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.atlassian.com/wiki/rest/api/group/userByGroupId",
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "query",
                "description": "Id of the group whose membership is updated."
              },
              {
                "name": "key",
                "value": "",
                "type": "query",
                "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."
              },
              {
                "name": "username",
                "value": "",
                "type": "query",
                "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."
              },
              {
                "name": "accountId",
                "value": "",
                "type": "query",
                "description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`."
              }
            ]
          },
          "docs": "Remove user as a member from a group.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>User must be a site admin."
        },
        {
          "info": {
            "name": "Atlassian Get Group Members",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/wiki/rest/api/group/:groupId/membersByGroupId",
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "The id of the group to be queried for its members."
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "The starting index of the returned users."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of users to return per page.\nNote, this may be restricted by fixed system limits."
              },
              {
                "name": "shouldReturnTotalSize",
                "value": "",
                "type": "query",
                "description": "Whether to include total size parameter in the results.\nNote, fetching total size property is an expensive operation; use it if your use case needs this value."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "A multi-value parameter indicating which properties of the user to\nexpand.\n\n  - `operations` returns the operations that the user is allowed to do.\n  - `personalSpace` returns the user's personal space, if it exists.\n  - `isExternalCollaborator` returns whether the user is an external collaborator user."
              }
            ]
          },
          "docs": "Returns the users that are members of a group.<br><br>Use updated Get group API<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>Permission to access the Confluence site ('Can use' global permission)."
        },
        {
          "info": {
            "name": "Atlassian Add Member to Group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.atlassian.com/wiki/rest/api/group/user",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Name of the group whose membership is updated"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds a user as a member in a group.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>User must be a site admin."
        },
        {
          "info": {
            "name": "Atlassian Remove Member From Group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.atlassian.com/wiki/rest/api/group/user",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Name of the group whose membership is updated."
              },
              {
                "name": "key",
                "value": "",
                "type": "query",
                "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."
              },
              {
                "name": "username",
                "value": "",
                "type": "query",
                "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."
              },
              {
                "name": "accountId",
                "value": "",
                "type": "query",
                "description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`."
              }
            ]
          },
          "docs": "Remove user as a member from a group.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>User must be a site admin."
        },
        {
          "info": {
            "name": "Atlassian Get Groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/wiki/rest/api/group",
            "params": [
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "The starting index of the returned groups."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of groups to return per page.\nNote, this may be restricted by fixed system limits."
              },
              {
                "name": "accessType",
                "value": "",
                "type": "query",
                "description": "The group permission level for which to filter results."
              }
            ]
          },
          "docs": "Returns all user groups. The returned groups are ordered alphabetically in<br>ascending order by group name.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>Permission to access the Confluence site ('Can use' global permission)."
        },
        {
          "info": {
            "name": "Atlassian Create New User Group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.atlassian.com/wiki/rest/api/group",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new user group.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>User must be a site admin."
        },
        {
          "info": {
            "name": "Atlassian Delete User Group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.atlassian.com/wiki/rest/api/group",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Name of the group to delete."
              }
            ]
          },
          "docs": "Delete user group.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>User must be a site admin."
        }
      ]
    }
  ],
  "bundled": true
}