{
  "opencollection": "1.0.0",
  "info": {
    "name": "SonarQube Cloud Web authentication user_groups API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "user_groups",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Add a user to a group. 'id' or 'name' must be provided. Requires the following permission: 'Administer System'.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://sonarcloud.io/api/user_groups/add_user",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "query",
                "description": "Group id"
              },
              {
                "name": "login",
                "value": "g.hopper",
                "type": "query",
                "description": "User login"
              },
              {
                "name": "name",
                "value": "sonar-administrators",
                "type": "query",
                "description": "Group name"
              },
              {
                "name": "organization",
                "value": "my-org",
                "type": "query",
                "description": "Key of organization"
              }
            ]
          },
          "docs": "Add a user to a group. 'id' or 'name' must be provided. Requires the following permission: 'Administer System'."
        },
        {
          "info": {
            "name": "Create a group. Requires the following permission: 'Administer System'.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://sonarcloud.io/api/user_groups/create",
            "params": [
              {
                "name": "description",
                "value": "Default group for new users",
                "type": "query",
                "description": "Description for the new group. A group description cannot be larger than 200 characters."
              },
              {
                "name": "name",
                "value": "sonar-users",
                "type": "query",
                "description": "Name for the new group. A group name cannot be larger than 255 characters and must be unique. The value 'anyone' (whatever the case) is reserved and cannot be used."
              },
              {
                "name": "organization",
                "value": "my-org",
                "type": "query",
                "description": "Key of organization"
              }
            ]
          },
          "docs": "Create a group. Requires the following permission: 'Administer System'."
        },
        {
          "info": {
            "name": "Delete a group. The default groups cannot be deleted. 'id' or 'name' must be provided. Requires the following permiss...",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://sonarcloud.io/api/user_groups/delete",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "query",
                "description": "Group id"
              },
              {
                "name": "name",
                "value": "sonar-administrators",
                "type": "query",
                "description": "Group name"
              },
              {
                "name": "organization",
                "value": "my-org",
                "type": "query",
                "description": "Key of organization"
              }
            ]
          },
          "docs": "Delete a group. The default groups cannot be deleted. 'id' or 'name' must be provided. Requires the following permission: 'Administer System'."
        },
        {
          "info": {
            "name": "Remove a user from a group. 'id' or 'name' must be provided. Requires the following permission: 'Administer System'.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://sonarcloud.io/api/user_groups/remove_user",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "query",
                "description": "Group id"
              },
              {
                "name": "login",
                "value": "g.hopper",
                "type": "query",
                "description": "User login"
              },
              {
                "name": "name",
                "value": "sonar-administrators",
                "type": "query",
                "description": "Group name"
              },
              {
                "name": "organization",
                "value": "my-org",
                "type": "query",
                "description": "Key of organization"
              }
            ]
          },
          "docs": "Remove a user from a group. 'id' or 'name' must be provided. Requires the following permission: 'Administer System'."
        },
        {
          "info": {
            "name": "Search for user groups. Requires the following permission: 'Administer System'.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://sonarcloud.io/api/user_groups/search",
            "params": [
              {
                "name": "f",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of the fields to be returned in response. All the fields are returned by default."
              },
              {
                "name": "organization",
                "value": "my-org",
                "type": "query",
                "description": "Key of organization"
              },
              {
                "name": "p",
                "value": "42",
                "type": "query",
                "description": "1-based page number"
              },
              {
                "name": "ps",
                "value": "20",
                "type": "query",
                "description": "Page size. Must be greater than 0 and less or equal than 500"
              },
              {
                "name": "q",
                "value": "sonar-users",
                "type": "query",
                "description": "Limit search to names that contain the supplied string."
              }
            ]
          },
          "docs": "Search for user groups. Requires the following permission: 'Administer System'."
        },
        {
          "info": {
            "name": "Update a group. Requires the following permission: 'Administer System'.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://sonarcloud.io/api/user_groups/update",
            "params": [
              {
                "name": "description",
                "value": "Default group for new users",
                "type": "query",
                "description": "New optional description for the group. A group description cannot be larger than 200 characters. If value is not defined, then description is not changed."
              },
              {
                "name": "id",
                "value": "42",
                "type": "query",
                "description": "Identifier of the group."
              },
              {
                "name": "name",
                "value": "my-group",
                "type": "query",
                "description": "New optional name for the group. A group name cannot be larger than 255 characters and must be unique. Value 'anyone' (whatever the case) is reserved and cannot be used. If value is empty or not defined, then name is not changed."
              }
            ]
          },
          "docs": "Update a group. Requires the following permission: 'Administer System'."
        },
        {
          "info": {
            "name": "Search for users with membership information with respect to a group. Requires the following permission: 'Administer ...",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://sonarcloud.io/api/user_groups/users",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "query",
                "description": "Group id"
              },
              {
                "name": "name",
                "value": "sonar-administrators",
                "type": "query",
                "description": "Group name"
              },
              {
                "name": "organization",
                "value": "my-org",
                "type": "query",
                "description": "Key of organization"
              },
              {
                "name": "p",
                "value": "42",
                "type": "query",
                "description": "1-based page number"
              },
              {
                "name": "ps",
                "value": "20",
                "type": "query",
                "description": "Page size. Must be greater than 0."
              },
              {
                "name": "q",
                "value": "freddy",
                "type": "query",
                "description": "Limit search to names or logins that contain the supplied string."
              },
              {
                "name": "selected",
                "value": "",
                "type": "query",
                "description": "Depending on the value, show only selected items (selected=selected), deselected items (selected=deselected), or all items with their selection status (selected=all)."
              }
            ]
          },
          "docs": "Search for users with membership information with respect to a group. Requires the following permission: 'Administer System'."
        }
      ]
    }
  ],
  "bundled": true
}