# SonarSource permissions API

**Canonical:** https://apis.io/apis/sonarsource/sonarsource-permissions-api/  
**Provider:** SonarSource — https://apis.io/providers/sonarsource/  
**Base URL:** https://sonarcloud.io/api  
**Documentation:** https://docs.sonarsource.com/sonarqube-cloud/advanced-setup/web-api/

SonarSource permissions API is one of 33 APIs that [SonarSource](https://apis.io/providers/sonarsource/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Permissions. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

Manage permission templates, and the granting and revoking of permissions at the global and project levels.

## Operations (17)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/permissions/add_group` | Add permission to a group. This service defaults to global permissions, but can be limited to project permissions by ... |
| POST | `/api/permissions/add_group_to_template` | Add a group to a permission template. The group id or group name must be provided. Requires the permission 'Administe... |
| POST | `/api/permissions/add_project_creator_to_template` | Add a project creator to a permission template. Requires the permission 'Administer' on the organization. |
| POST | `/api/permissions/add_user` | Add permission to a user. This service defaults to global permissions, but can be limited to project permissions by p... |
| POST | `/api/permissions/add_user_to_template` | Add a user to a permission template. Requires the permission 'Administer' on the organization. |
| POST | `/api/permissions/apply_template` | Apply a permission template to one project. The project id or project key must be provided. The template id or name m... |
| POST | `/api/permissions/bulk_apply_template` | Apply a permission template to several projects. The template id or name must be provided. Requires the permission 'A... |
| POST | `/api/permissions/create_template` | Create a permission template. Requires the permission 'Administer' on the organization. |
| POST | `/api/permissions/delete_template` | Delete a permission template. Requires the permission 'Administer' on the organization. |
| POST | `/api/permissions/remove_group` | Remove a permission from a group. This service defaults to global permissions, but can be limited to project permissi... |
| POST | `/api/permissions/remove_group_from_template` | Remove a group from a permission template. The group id or group name must be provided. Requires the permission 'Admi... |
| POST | `/api/permissions/remove_project_creator_from_template` | Remove a project creator from a permission template. Requires the permission 'Administer' on the organization. |
| POST | `/api/permissions/remove_user` | Remove permission from a user. This service defaults to global permissions, but can be limited to project permissions... |
| POST | `/api/permissions/remove_user_from_template` | Remove a user from a permission template. Requires the permission 'Administer' on the organization. |
| GET | `/api/permissions/search_templates` | List permission templates. Requires the permission 'Administer' on the organization. |
| POST | `/api/permissions/set_default_template` | Set a permission template as default. Requires the permission 'Administer' on the organization. |
| POST | `/api/permissions/update_template` | Update a permission template. Requires the permission 'Administer' on the organization. |

## Machine-readable artifacts (4)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/sonarsource/refs/heads/main/openapi/sonarsource-permissions-api-openapi.yml
- **APIReference** — https://docs.sonarsource.com/sonarqube-cloud/advanced-setup/web-api/
- **Documentation** — https://docs.sonarsource.com/sonarqube-cloud/advanced-setup/web-api/
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/sonarsource/refs/heads/main/data-model/sonarsource-data-model.yml

## Other SonarSource APIs (12)

- [SonarSource authentication API](https://apis.io/apis/sonarsource/sonarsource-authentication-api/)
- [SonarSource ce API](https://apis.io/apis/sonarsource/sonarsource-ce-api/)
- [SonarSource components API](https://apis.io/apis/sonarsource/sonarsource-components-api/)
- [SonarSource duplications API](https://apis.io/apis/sonarsource/sonarsource-duplications-api/)
- [SonarSource favorites API](https://apis.io/apis/sonarsource/sonarsource-favorites-api/)
- [SonarSource favourites API](https://apis.io/apis/sonarsource/sonarsource-favourites-api/)
- [SonarSource hotspots API](https://apis.io/apis/sonarsource/sonarsource-hotspots-api/)
- [SonarSource issues API](https://apis.io/apis/sonarsource/sonarsource-issues-api/)
- [SonarSource languages API](https://apis.io/apis/sonarsource/sonarsource-languages-api/)
- [SonarSource measures API](https://apis.io/apis/sonarsource/sonarsource-measures-api/)
- [SonarSource metrics API](https://apis.io/apis/sonarsource/sonarsource-metrics-api/)
- [SonarSource notifications API](https://apis.io/apis/sonarsource/sonarsource-notifications-api/)

## Tags

Permissions

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/sonarsource/sonarsource-permissions-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/sonarsource/.