api/permissions

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

Examples

Add permission to a group:

sonar.permissions.add_permission_to_group(groupName="sonar-users", permission="scan", projectKey="my_project")

or:

sonar.permissions.add_permission_to_group(groupName="sonar-users", permission="profileadmin")

or for project:

sonar.permissions.add_permission_to_group(groupName="sonar-users", permission="scan", projectKey="my_project")

Remove a permission from a group:

sonar.permissions.remove_permission_from_group(groupName="sonar-users", permission="scan", projectKey="my_project")

or:

sonar.permissions.remove_permission_from_group(groupName="sonar-users", permission="profileadmin")

Add permission to a user:

sonar.permissions.add_permission_to_user(login="kevin", permission="codeviewer", projectKey="my_project")

or:

sonar.permissions.add_permission_to_user(login="kevin", permission="gateadmin")

Remove permission from a user:

sonar.permissions.remove_permission_from_user(login="kevin", permission="codeviewer", projectKey="my_project")

or:

sonar.permissions.remove_permission_from_user(login="kevin", permission="gateadmin")

Apply a permission template to one project.:

sonar.permissions.apply_template_to_project(templateName="test-template", projectKey="my_project")

Apply a permission template to several projects.:

sonar.permissions.apply_template_to_projects(templateName="test-template", projects="my_project,another_project")

Add a group to a permission template.:

sonar.permissions.add_group_to_template(groupName="sonar-users", templateName="test-template",
                                        permission="user")

Remove a group from a permission template.:

sonar.permissions.remove_group_from_template(groupName="sonar-users", templateName="test-template",
                                             permission="user")

Add a project creator to a permission template.:

sonar.permissions.add_project_creator_to_template(templateName="test-template", permission="user")

Remove a project creator from a permission template.:

sonar.permissions.remove_project_creator_from_template(templateName="test-template", permission="user")

Add a user to a permission template.:

sonar.permissions.add_user_to_template(login="kevin", templateName="test-template", permission="codeviewer")

Remove a user from a permission template.:

sonar.permissions.remove_user_from_template(login="kevin",
                                            templateName="test-template",
                                            permission="codeviewer"
                                            )

Create a permission template.:

sonar.permissions.create_template("test-template", description="test template", projectKeyPattern=".*\.finance\..*")

Delete a permission template.:

sonar.permissions.delete_template(templateName="test-template")

List permission templates.:

templates = sonar.permissions.search_templates()

Retrieve users for specified template id.:

templateUsers = sonar.permissions.get_template_users(templateId="AXQqe0yfjOKlq86mQn4t");

Retrieve groups for specified template id.:

templateGroups = sonar.permissions.get_template_groups(templateId="AXQqe0yfjOKlq86mQn4t");

Set a permission template as default.:

sonar.permissions.set_default_template(templateName="test-template")

Update a permission template.:

sonar.permissions.update_template(id="AXQqe0yfjOKlq86mQn4t",
                                  templateName="test-permission-template",
                                  description="test permission template",
                                  projectKeyPattern=".*\.finance\..*"
                                  )